User:Pluma/adoption/igloo

igloo is a browser-based, JavaScript tool for handling vandalism on Wikipedia. I only give this task to adoptees whose main directive is to revert vandalism. Not only does add links to the location of the vandalism; instead, it implements a full in-browser GUI for watching recent changes, finding and reverting vandalism, warning users and reporting or blocking them. Since Igloo warns the users whose edits you revert with vandalsim warnings, Igloo should be used only to revert vandalism, not just any edit. For edits that should be undone, yet are not vandalism, undo them manually or use Twinkle. You can find details about igloo changes and development here.

'''igloo is in an alpha test. You are responsible for any actions your account performs with it, ''even if the action reveals a bug or is otherwise unexpected, so you have to be really careful when using it. It is so easy to revert vandalism with it that it is easy to make mistakes.'

Requirements
igloo has the following operating requirements:
 * Mozilla Firefox 3+ or Google Chrome (igloo doesn't work with Internet Explorer or Safari)
 * Full JavaScript-enabled — JavaScript limitations may prevent it from running correctly
 * A fast internet connection
 * rollback rights

Installation
igloo is designed for, and compatible with, the monobook and vector skins — other skins are not guaranteed to work and your mileage may vary.
 * Add  importScript('User:Ale_jrb/Scripts/igloo.js'); // User:Ale_jrb/Scripts/igloo  to your monobook.js page or your vector.js page
 * Completely clear your browser cache. Bypassing the cache is occasionally ineffective, and may result in the igloo modules failing to communicate.
 * Be sure to add exceptions to any script blocking add-ons such as NoScript.
 * Go to this page and click "launch Igloo"

Using igloo
igloo is quite a large program, with several advanced features. To get the most out of igloo, including how to make full use of the vandalism detection engine and edit filters, you should make sure to have a look at the help page before using the program. The page contains full usage instructions, as well as tips for dealing with common errors. See igloo help.

Filters
igloo uses filters to detect common vandalism from the metadata, without the user having to view the page. This system helps to prioritise changes for people to view, improving vandal reversion efficiency. The built-in filters will detect many types of common vandalism, but it is nevertheless possible to create and manage your own filters, and disable filters if required.

Managing filters
Filters are managed from the 'filters' tab in the 'settings' panel, accessed from the cog icon. The list of filters attached to your account is on the left side of the window - filters you have disabled will be shaded red. It is not possible to edit the built-in filters, but they can be viewed by clicking the 'view filter' option. If you want to disable a filter, or re-enable one, view it and select 'enable/disable filter'.

Creating filters
New filters are created by clicking the 'New filter' button. Your filter will be assigned a random ID, and immediately appear in your filter list. To edit the filter, click the edit button next to it.

Filters are executed on the metadata of all changes when they are retrieved from the Wikipedia API. A filter consists of a set of conditions and a set of events. If all the conditions of the filter are found to be true, the events will be executed on that change. The filter code is very forgiving - events and conditions can be in any order, and the filter will still operate. Important note: because the filters are executed before the user views the page, they cannot operate on the content of the page.

Conditions

if [summary/oldsize/newsize/changesize/tags/title/user/score] [NOT/!] [regexmatch/contains/==/] [your value]

''NB. only include NOT or ! if you wish to negate the condition''

Events

set [score/id] [absolute/relative] [your value]

set comment [your value]

Data inclusion

igloo will automatically replace certain data terms with the relevant data in [your value] sections, in order to perform comparisons. The syntax is %DATA##%, where ## is either ME or a number between 0 and 10. The data points are as follows:

%DATA0% = page title

%DATA1% = user who made the change

%DATA2% = revision id

%DATA3% = new page (true or false)

%DATA4% = igloo score of the change (from 0 - 1.0 unless modified by another filter) at the time of execution

%DATA5% = change flags

%DATA6% = old length of the page

%DATA7% = new length of the page

%DATA8% = length change (e.g. newlen - oldlen)

%DATA9% = edit summary

%DATA10% = edit filter tags for this edit

%DATAME% = your username

Other

Lines that start with // are comments, and will be ignored. Note that the // must be followed immediately by a space, or the filter will not parse.

Homework
Since this tool requires rollback rights, and if you have reverted a substantial amount of vandalism, I would suggest you go to Rollback feature to get rollback rights. Please read all the text on that page, for you will need it if you get the feature. Once you have read that page and also Help:Reverting carefully, you can request rollback rights here. If you receive rollback rights, launch Igloo and revert three cases of vandalism, while remembering that Igloo should be used only to revert vandalism, not just any edit. pluma  Ø  01:14, 19 October 2011 (UTC)