Wikipedia:Huggle

From Wikipedia, the free encyclopedia

Shortcuts: WP:HUGGLE WP:HUGG WP:HUG WP:HG

Huggle is a tool for dealing with vandalism. Its nature requires that it is capable of editing pages quickly, and of making many edits in a short space of time. Such features must be used with caution. Use of Huggle by new or inexperienced users is not recommended. Use of Huggle is subject to Wikipedia policies and guidelines. Abuse or inappropriate use will be dealt with by removal of access or blocking of your user account. Responsibility for edits rests with the owner of the account with which they are made. "Use of an automated tool" is not an excuse.

Contents 1 Requirements 2 Obtaining huggle 3 Using huggle 3.1 Creating a configuration page 3.2 Logging in 3.3 The interface 3.4 Main toolbar 3.5 Navigation toolbar 3.6 Actions toolbar 3.7 Menu options 4 Removing huggle 5 Configuration 5.1 Manual configuration 6 Keyboard shortcuts

Requirements

• 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.
• Internet connection
• Wikipedia user account
• Rollback, which may be requested here
• Configuration subpage in user space; see below

Optional, but recommended:

• 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 can be downloaded using the links below. The main downloads are hosted by Atyndall and SourceForge and mirror links are hosted on a slower server by Drini and Universidad Nacional Autónoma de México. For queries regarding this service, please contact Atyndall or Drini.

• Current version (0.7.10) – mirror

If you are upgrading from an older version, read the list of changes before using the new version.

Source code may be requested by email if desired.

Using huggle

Creating a configuration page

To use huggle, you must create a user subpage at Special:Mypage/huggle.css. This subpage allows you to configure huggle per-account. 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 subpage:

enable:true

Huggle will add additional lines to this page based on configuration options you select; see Configuration below.

Logging in

At the login screen, enter your Wikipedia username and password, unless you're using Huggle for another project. If so, select that project in the drop-down menu, and enter your username and password for that project. 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.

To jump to a different page or user, type the page or user name in the appropriate field. Recently selected pages and users can be seen by clicking the drop-down arrows.

Main toolbar

• Next edit: If the revision displayed is not vandalism, click this button to ignore it and advance to the next one. If the button is gray and there are no more revisions in the queue, either your connection dropped, or not much editing is being done and you have checked everything; wait a while for more revisions to appear.
• Ignore user: If many edits by the same user appear and it is clear that the user is contributing constructively, this button will cause all subsequent contributions by that user to be ignored. Huggle will identify and ignore some users itself. Registered users are added to the whitelist, and always ignored; anonymous users are ignored only for that session.
• Revert will do just that. 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.

  Consecutive instances of vandalism by multiple users must be dealt with by manually finding the last good revision of the page. 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. It is not necessary to do this if all vandalism is the work of a single user.

  By default, an automatically-generated summary will be used. To use a different summary, click the arrow next to the "Revert" button, and select a summary or click "Other summary..." and type one in. The list of summaries can be customized; see the configuration section.

• 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).
• Template message acts on the revision on the right of the diff currently being viewed. Select an item from the list to leave the appropriate template message, or "Other message..." to say something else. The list of messages can be customized; see the configuration section.
• 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.
• Cancel will cancel all edits and other actions currently in progress. Edits that have been submitted but not yet saved are undone once they have saved. Edits which have already been saved must be reversed with the Undo button.
• Undo allows various actions to be reversed. It is not related to Wikipedia's undo function. Undo can only be used to reverse an edit if the edit is still the most recent to the page; for other cases, it is necessary to navigate to the appropriate page and revision and use the "Revert" function.

Navigation toolbar

• Browse back and Browse forward will go back and forward through your browsing history, rather than the history of the current page.
• Open in browser opens whatever is being viewed in your web browser.
• New tab opens a new tab.
• Close tab closes the currently selected tab.
• Previous, next, current buttons navigate through the history of the currently selected page, and the contributions of the currently selected user.
• Diff to current shows 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 instances of vandalism have been partially reverted.

Actions toolbar

Page

• View will view the current page.
• Edit will open a new window containing an edit form for the current page.
• Tag allows tagging of a page for speedy or proposed deletion, or the prepending of some other tag or tags to the page. Also supports XfD nomiminations
• Delete, only available to administrators, deletes the 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

• Info will display information about the selected user, including block log, warning log and number of edits.
• 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.

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.
• Reconnect IRC feed will disconnect and reconnect your connection to the IRC feed if you are using it. If Wikipedia is functioning but no new revisions appear in the queue, try this.
• Options allows various configuration options to be changed.

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.
• Move moves the page.

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.
• Feedback opens the Feedback page. Leave feedback there.

Removing huggle

If you no longer wish to use Huggle, you may simply stop using it. You may wish to request the deletion of your configuration subpage, as it will no longer be needed. You may also wish to remove yourself from the user list.

Administrators may prevent any user from using Huggle by blanking and protecting their /huggle.css configuration subpage.

Configuration

Various options can be configured by the user. Huggle will store these options on the wiki in your /huggle.css subpage. To change these options, select System > Options from within Huggle toolbar. The configuration subpage will then be updated when the options window is closed.

Manual configuration

If you wish to edit it directly, 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. Values can break across lines provided these extra lines begin with one or more spaces.

User configuration options

• enable – true/false. Huggle will not work unless this is present and set to true.
• anonymous - string. Whether to show the contributions of anonymous users. Available values: "yes", "no", "only". Default: 'yes'.
• 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.
• 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.
• extend-reports - true/false. Whether to extend vandalism reports in the event of further vandalism. 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'.
• revert-summaries - comma-separated list. Summaries available in the revert drop-down menu. Use \, to include a literal comma.
• 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.
• show-queue - true/false. Whether to show the revision queue. Default: true.
• templates - comma-separated list. Templates to show in the templates drop-down menu. Each item of the list is a pair of values separated by a semicolon; the first is the text displayed in the menu, and the second is the name of the template to be used. Use \, to include a literal comma, \; to include a literal semicolon.
• 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'.

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. Keyboard shortcuts may be customized; go to System -> Options... and select the Keyboard tab.