User:Ale jrb/Scripts/igloo/Help

The intention is that igloo become quite a large script, with several advanced and useful features. As it is still very much in development, however, I have not got round to creating - and definitely not documenting - most of the current and intended features. You're free to expand this page, but if you need any help at the moment, just leave a note on my talk page. Thanks! A le_Jrb talk 13:54, 13 July 2010 (UTC)

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.