Wikipedia:Huggle

Home Feedback Configuration Development Other pages Download Manual IRC Chat Suggestions, feature requests, bug reports and questions Global config Project config Templates User config Source code Issue tracker Change log Localization Project members Whitelist Icons Sandbox

Huggle is an application for dealing with vandalism.

Requirements

Required

• Windows 2000 / XP / Vista
• .NET Framework 2.0 – already installed if you have Vista, or AWB or another .NET 2.0 application, otherwise download here.
• Wikipedia user account
• Configuration subpage in user space; see below

Optional, but recommended

• Rollback
• IRC access (for irc.wikimedia.org recent changes feed)
• Broadband or faster Internet connection (dial-up users should disable preloading and may experience slowness)

Obtaining huggle

Huggle is currently in development. It is not guaranteed to work correctly, or even at all, and may change substantially in future.

New versions will be sent out by e-mail when available. The current version is User:Gurch/Huggle/Version.css. Older versions will continue to function.

Source code is not currently available, though may be in future.

Using huggle

Creating a configuration page

In order to use huggle, you must create a user subpage at Special:Mypage/huggle.css. This subpage allows you to configure huggle per-account, and also allows administrators to control use of huggle by particular contributors should this be necessary. It is not a CSS stylesheet, but naming it this way means that only you and administrators can edit it.

To enable huggle, add the following line to the page:

enable:true

Additional lines may be added to the page to control huggle's operation; see Configuration below.

Logging in

At the login screen, enter your Wikipedia username and password. Under "Edit source", choose "IRC recent changes feed" if possible; if you only have web access, choose "Special:Recentchanges". The latter is slower, though on a fast connection there is not much difference.

The interface

Most of the screen is taken up by a display of the difference between two revisions, or "diff", which is to be reviewed for vandalism.

The page and the author of the revision are displayed one above the other; the rows of coloured squares next to the page and user represent the page history and the user's contributions, respectively. Each square represents one revision.

In the page history display, the two revisions boxed in red are the two that are being compared in the diff. In the contributions display, the revision boxed in red is the more recent of the two revisions, on the right of the diff. Revisions in the contributions display enclosed by a blue border are the most recent revision to that page.

To jump to a revision in the page history or contributions display, click it.

Icons displayed in these squares have various meanings, as summarized below:

A black square indicates that there are no older revisions in the history or the user's contributions.

Finding vandalism

Revisions are queued internally based on their resemblence to vandalism.

If the revision displayed is not vandalism, click the "Next diff" button to ignore the diff shown and advance to the next one. If the button is gray, there are no more diffs in the queue, either because your connection dropped, or because not much editing is being done.

If many edits by the same user appear and it is clear that the user is contributing constructively, press "Ignore user". All contributions by that user will subsequently be ignored. Users listed in the whitelist are always ignored. Huggle will identify and ignore some users itself.

Reverting

Reversions behave in one of two ways:

• If the revision being viewed is the most recent one, the revert button will either rollback the page, or act as though rollback was being used. This reverts all consecutive contributions by the last editor to the page.
• If an older revision is being viewed, the revert button will revert to whichever edit is on the left of the diff display.

It is important to locate the correct revision to revert to before doing so. To move back in the page history, click the Previous revision button; to move forward, click Next revision and to move back to the most recent revision, click Last revision. You can also navigate by clicking in the history display.

When there are multiple consecutive instances of vandalism, find the last good revision of the page and navigate such that that revision appears on the left of the diff, then press Revert. It is not necessary to do this if all vandalism is the work of a single user.

In most cases, only the most recent edit will be vandalism, and it is not necessary to navigate through the page history at all. Simply pressing "Revert" will revert to the previous version, that being on the left of the display by default. If the previous revision was the work of a trusted user – which can be seen by checking the history display – it can usually be assumed that that version is free of vandalism.

Rollback is limited to 5 per minute for non-administrators. Huggle will fall back to normal reverts when this limit is reached.

• Revert and warn: Most of the time, a user warning should be provided along with the revert. The "Revert and warn" button will do this; if the revert is successful, huggle will check the user's talk page for existing warnings and issue one with an appropriate level. If the user already has a final warning, huggle will automatically issue a vandalism report. (If you are an administrator, you will instead be asked if you wish to block the user).
• Revert with summary: In cases where the revision is not obvious vandalism, it should not be reverted without an explanation. Such an explanation may be provided by clicking this button and entering an edit summary.
• Warn acts on the revision on the right of the diff currently being viewed; it will check the user's talk page and issue an appropriate warning or vandalism report. While huggle will issue warnings automatically when appropriate, this function can be used to deal with vandalism by multiple users, in succession, to the same page – locate the last good revision and revert to it, then navigate to an instance of vandalism from each user and issue a warning.
• Diff to current revision will show the difference between the older of the two revisions currently selected, and the newest revision to the page. Its function is equivalent to the "cur" links on history pages. This can be used to check that the right revision is being reverted to when dealing with situations where multiple instanes of vandalism have been partially reverted.
• Browse back and Browse forward will go back and forward through your browsing history, rather than the history of the current page.

Other buttons

Browser

• New tab will open a new tab.
• Close tab will close the currently selected tab.
• Open in browser will open whatever is being viewed in your web browser.

Page

• View will view the current page.
• Edit will open an edit form for the current page in your web browser.
• History will retrieve 50 revisions from the page history and add them to the history display. Normally, only edits made while huggle has been running will be shown in the display; this allows older history to be navigated more easily. Repeated presses of the button will retrieve older revisions in blocks of 50.
• Move will prompt for a destination and summary and then move the page there.
• Tag will prompt for some text and a summary and then insert that text at the top of the page; this is useful for tagging pages.
• Speedy will prompt for a speedy deletion criterion and then tag the page, optionally notifying the user. If you are an administrator, this button becomes Delete, which will prompt for a deletion summary and then delete the current page.
• Watch will add the page to your Wikipedia watchlist. If the page is already on your watchlist, this button will be highlighted orange, and clicking it will remove the page from your watchlist.

User

• Contribs will retrieve 50 user contributions and add them to the contributions display in a similar manner to the history function.
• Talk will display the current user's talk page.
• Message will prompt for a message and post it to the current user's talk page.
• Report will prompt for an explanation and then issue a vandalism report for the current user. Note that huggle will do this automatically when appropriate. You may also issue username reports by changing "Report to:". If you are an administrator, this button becomes Block, which will prompt for block summary, time and options and then block the current user.

Menu options

The following functions are available only from the menus; many of the functions explained above are also available from the menus, but are not repeated here.

System menu

• Show new messages will appear only when you have new messages on your talk page; clicking it will show those messages. When you have messages, an orange bar will appear above diffs to inform you of this.
• Reload configuration will apply any changes made to your configuration subpage. Restarting huggle will also apply changes.

Queue menu

• Trim prompts for a cutoff point and then removes all edits older than that from the queue, useful if resuming after huggle has been running and idle for some time.
• Clear removes all currently queued revisions from the queue.

Page menu

• View latest revision shows the page as it currently exists, rather than as it did at the time of the currently selected revision. (If you are viewing the latest revision to the page, there is no difference).
• Request protection prompts for a protection level and reason and then requests protection of the current page.
• Tag -> Proposed deletion will tag a page for proposed deletion after prompting for a reason, notifying the user.

Browser menu

• Close other tabs closes all tabs except the currently selected tab.
• Show new edits to this page toggles showing new edits as explained by the show-new-edits configuration setting. This change affects only the current tab. This mode is enabled by default, unless disabled in your configuration.
• Show new contributions by this user toggles showing new contributions in a similar way to that in which new edits to the page are shown, except that new contributions by the current user, rather than new edits to the current page, will be shown. Again, this change affects only the current tab. This mode is disabled by default.

Help menu

• Show documentation opens this documentation page in your web browser.

Configuration

Your configuration subpage, Special:Mypage/huggle.css, should consist of a series of lines of the form option:value, where option is one of the values listed below. Option names are not case-sensitive. Blank lines, lines starting with # and unrecognized options are ignored.

• enable – true/false. Huggle will not work unless this is present and set to true.

• auto-advance – true/false. After reverting a revision, automatically advance to the next diff. Default: false.
• auto-whitelist - true/false. Whether to automatically whitelist users. Default: true.
• chat - true/false. Whether to connect to #huggle on Freenode and display chat window at the bottom of the screen (use buttons at bottom-left to switch between chat/log). Default: false.
• chat-nick - string. Nick to use with chat window; cannot be the same as a nick already connected to Freenode or it will not work. Default is your username prefixed by 'h_'; the h_ is not displayed in huggle's chat window but will be displayed by other IRC clients.
• chat-identify - true/false. If true, will prompt for a password to identify when connected to chat. Nick must be registered for this to do anything. Since chat is limited to one channel in which anyone can speak, this is not necessary, but if you are paranoid you may wish to be cloaked. Default: false.
• confirm-multiple – true/false. Ask for confirmation if reverting multiple edits by the same user. (Does not ask for confirmation when explicitly reverting to an older revision in the page history, as it is obvious in such cases that multiple edits are to be reverted). Default: false.
• confirm-same - true/false. Ask for confirmation if the revision being reverted to was made by the same user that is being reverted. Default: true.
• irc-port – integer. Port to use when connecting to IRC. Use any integer from 6664 – 6669, inclusive. Default: 6667.
• minor – comma-separated list. Types of edit to mark as minor. Available values: "reverts", "warnings", "tags", "reports", "notifications" and "other". Use "none" for none. Default: 'reverts'.
• namespaces – comma-separated list. Namespaces to check for vandalism. Use "article" for main namespace, "all" for all namespaces, "alltalk" for all talk namespaces. Prefix by "-" to exclude. Default: 'all'.
• new-pages - true/false. Whether to include new pages in the queue. Default: false.
• preload – integer. How many diffs to preload in advance. Preloading reduces wait time for diff loads but slows other requests slightly. Set to 0 to disable preloading. Do not set to more than about 5. Default: 2. Disabling this is recommended if you have a slow connection.
• report - string. What to do when asked to warn a user with a final warning. Use "none" to do nothing, "prompt" to prompt for a user report, and "auto" to issue the report automatically. Default: 'auto'.
• rollback – true/false. Use rollback if available. Default: true.
• show-new-edits – true/false. If the page currently being viewed is edited, jump to a diff of that edit. Default: true.
• tray-icon - true/false. Display an icon in the notification area, allows application to be minimized to the tray. Default: false.
• update-whitelist – true/false. Whether to update the shared whitelist on exit. Default: true.
• watchlist – comma-separated list. Types of edit which should add the page to your watchlist. Available values: "reverts", "warnings", "tags", "reports", "notifications" and "other". Use "none" for none. Default: 'none'.

Administrator options

The following options have effect only when used with an administrator account:

• admin - true/false. Use administrator functions (block/delete) if available. Default: true.
• block-prompt - true/false. Whether to show the block form if asked to warn a user with a final warning. Default: true.
• block-reason – string. Default block reason on block form. Default: '[[Wikipedia:Vandalism|Vandalism]]'.
• blocktime – string. Default block expiry time when blocking logged-in users. Default: 'indefinite'.
• blocktime-anon – string. Default block expiry time when blocking anonymous users. Default: '24 hours'.

Example configuration

enable:true

# No rollback
rollback:false

# Watch pages I revert
watchlist:reverts

# Don't check user space
namespaces:all,-user

# Don't jump to new edits
show-new-edits:false

Keyboard shortcuts

Operation is quicker when using keyboard shortcuts. Note that giving focus to the browser window prevents shortcuts working; click any button to take focus from the browser window.

Main window

Browsing

• [ – Browse back
• ] – Browse forward
• Space - Show next diff
• Z - Previous revision
• X - Next revision
• C - Current revision
• Ctrl + Z - Previous contribution
• Ctrl + X - Next contribution
• Ctrl + C - Latest contribution
• D - Show diff to current revision
• O - Open page in external browser
• Ctrl + Tab - Next tab
• Ctrl + Shift + Tab - Previous tab

Actions

• B - Report user / Block user
• J - Jump to page
• Ctrl + J - Jump to user
• I - Ignore user
• Ctrl + I - Unignore user
• Q - Revert and warn
• R - Revert
• Y - Revert with summary
• W - Warn
• B - Report user / Block user
• T - View user talk page
• N - Message user
• H - Retrieve history
• U - Retrieve contributions
• V - View page (this revision)
• Ctrl + V - View page (latest revision)
• E - Edit page
• M - Show new messages
• G – Tag page
• S - Speedy tag page / Delete page
• P - Prod tag page
• L - Add/remove page to/from watchlist

Warning form

• 1-4 - select level
• A - automatically select level
• V - vandalism warning
• T - editing tests warning
• S - spam warning