Wikipedia:WikiProject User scripts/Scripts/Twinkle/doc

From Wikipedia, the free encyclopedia

Once Twinkle is installed, you will be presented with a number of additional tabs or links, depending on the page you are on.

Contents 1 Installation 1.1 Installing individual Twinkle modules 2 Additions for all users 2.1 Article tabs 2.1.1 csd 2.1.2 rpp 2.1.2.1 Request for Page Protection 2.1.3 prod 2.1.4 xfd 2.1.4.1 AfD 2.1.4.2 TfD 2.1.4.3 IfD/PUI 2.1.4.4 CfD 2.1.4.5 MfD 2.1.4.6 RfD 2.1.4.7 SfD 2.2 Image namespace 2.2.1 di 2.3 User tabs 2.3.1 warn 2.3.2 arv 2.4 Additional links 2.4.1 Special:Contributions/USER 2.4.2 Difference between revisions 3 Additions available for admins only 3.1 Speedy deletion 3.2 Batch image deletion 3.3 Batch deletion 3.4 Batch protection 4 Configuration 4.1 revertMaxRevisions 4.2 userTalkPageMode 4.3 showSharedIPNotice 4.4 openTalkPage 4.5 openTalkPageOnAutoRevert 4.6 openAOLAnonTalkPage 4.7 summaryAd 4.8 deletionSummaryAd 4.9 protectionSummaryAd 4.10 watchSpeedyPages 4.11 watchProdPages 4.12 openUserTalkPageOnSpeedyDelete 4.13 watchRevertedPages 4.14 markRevertedPagesAsMinor 4.15 deleteTalkPageOnDelete (admin only) 4.16 watchWarnings 4.17 markAIVReportAsMinor 4.18 markSpeedyPagesAsMinor 4.19 offerReasonOnNormalRevert 4.20 orphanBacklinksOnSpeedyDelete (admin only)

[edit] Installation

Installing Twinkle is easy. Refer to the Installation section of the script's page for easy-to-follow instructions.

[edit] Installing individual Twinkle modules

If you just want to use one or more of the individual modules, here they are listed with their dependencies. Do not add these if you've already chosen the complete script, as they would just be duplicates.

For the revert functionality, add:

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinklefluff.js');

For a collection of user warning templates, add:

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinklewarn.js');

For vandalism reporting functionality (based on WP:ARV), add:

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinklearv.js');

For speedy deletion, add:

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinklespeedy.js');

For relatively speedy deletion of images, add:

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinkleimage.js');

For multiple revisions diff tabs, add:

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinklediff.js');

For protection of pages, or requesting protection, add:

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinkleprotect.js');

For proposing deletion, add:

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinkleprod.js');

For nominating for deletion (xfd), add:

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinklexfd.js');

For removing of backlinks and instances of images (like admin speedy but without the deletion):

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinkleunlink.js');

For removing images on a particular page or in a category, and deleting them (admin only)

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinkledelimages.js');

For deleting pages linked on a particular page, or in an category (admin only)

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinklebatchdelete.js');

For protecting pages linked on a particular page, or in an category (admin only)

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinklebatchprotect.js');

For deletion of expired prods in a category (admin only)

importScript('User:AzaToth/morebits.js');
importScript('User:AzaToth/twinkledeprod.js');

[edit] Additions for all users

Most additions that Twinkle gives are available to all users who have installed it.

[edit] Article tabs

When looking at an article page, there are a number of additional tabs that perform different functions

[edit] csd

csd stands for Criteria for Speedy Deletion. If you believe an article meets a criterion for Speedy Deletion, click on the tab, and select the appropriate reason. Note that you will be presented with a different list if the article is in the Image namespace. Twinkle will add the appropriate notice on the article's page, and will automatically put a notice on the talk page of the editor who created the article.

[edit] rpp

[edit] Request for Page Protection

Sends a request for protection to the page of the same name. Used for heavily vandalized articles or for articles that are current and likely will have traffic due to a real-life occurrence.

[edit] prod

Proposed Deletion - On the article page, leaves a template for proposing an article for deletion, and automatically notifies the article's creator.

[edit] xfd

Anything for Deletion - Use this tab to nominate a page for deletion in one of the following categories:

[edit] AfD

Articles for Deletion - articles in the mainspace that may not meet requirements for inclusion on Wikipedia, but do not meet speedy deletion requirements, and are more controversial than a proposed deletion. This will automatically tag the article, create an AfD entry, add the entry to the log, and notify the article creator of the nomination.

[edit] TfD

Templates for Deletion - similar to the AfD criteria, but used with templates, not articles.

[edit] IfD/PUI

Images and media for deletion/Possibly unfree images -

[edit] CfD

Categories for Discussion - Choose the type of action requested:

• Deletion
• Merge
• Renaming
• Convert into article

[edit] MfD

Miscellany for deletion - Portals, WikiProjects, user pages, and other pages outside of the mainspace.

[edit] RfD

Redirects for discussion -

[edit] SfD

Stub types for deletion -

[edit] Image namespace

[edit] di

Deletable Image - This part of Twinkle tags images without fair use rationales, sources, or copyright information.

[edit] User tabs

When looking at a User or User talk page, there are two more additional tabs

[edit] warn

The warn tab allows you to leave one of a variety of warning messages on a user's talk page. To use, first click the warn tab. A window will appear with the following options:

• Two drop-down menus with the warning level and warning type (see list of warnings)
• The article name to reference for the warning (this is often automatically populated if you are warning on a user talk page that was opened as the result of a Twinkle rollback)
• Any additional comments that you wish to be included in the warning message.

Clicking Submit will post the chosen warning to the user's talk page and then refresh the page in your browser.

[edit] arv

Advance Reporting and Vetting

This functions similarly to the warn tab. When on a user's page or talk page, click this button to report them to administrators for several possible infractions:

• Vandalism - Reports the user to Administrator intervention against vandalism; use this when the user has vandalized after a final warning has been issued. If you have just reverted the user's vandalism and the user talk page has opened, the fields about the vandalized article (title, revision IDs) should be automatically filled in. Check the appropriate boxes that apply to the user.
  • Vandalism after final warning given - should be checked for most reports
  • Vandalism after recent release of block
  • Evidently vandalism only account - for username accounts only, with no constructive edits
  • Account is evidently a spambot or a compromised account
• Username - Reports the user to Usernames for administrator attention. Check the policies at Wikipedia:Username policy to ensure that one of the 5 general reasons applies before ticking off the subexamples.
• Sockpuppet - Use this to report that a case of suspected sockpuppetry, including the suspected puppeteer and relevant evidence. It will create a new page at Suspected sock puppets.

[edit] Additional links

[edit] Special:Contributions/USER

[edit] Difference between revisions

When viewing a diff between revisions of a page, Twinkle will place four new links above the previous revision and the new revision:

1. restore this version - This will make that version of the page current.
2. rollback (AGF) - Labels the original edit as AGF in edit summary.
3. rollback - Performs rollback, then asks for input for edit summary.
4. rollback (VANDAL) - Labels rollback as vandalism in edit summary, and opens vandal's talk page.

[edit] Additions available for admins only

[edit] Speedy deletion

For admins, the default action for csd is to delete the page. Option exist to turn it into the other behaviour to tag the page for deletion. If Orphan backlinks is checked, all backlinks to this page or image instances of the particular image is removed.

[edit] Batch image deletion

This module allows to delete several images found on a page, or in a category, and unlinks them from pages. As this module is fully automatic, great care to know what it will do is required. It might not be the best solution in some categories. You should be quite careful with this script, as it has the potential to cause massive damage if used improperly.

[edit] Batch deletion

Similar to batch image deletion, but for normal pages instead. The reason why two modules is that it's not exactly the same.

[edit] Batch protection

Similar to batch deletion, but protects the pages instead. It's used often as an emergency option against heavy multiple-page vandalism.

[edit] Configuration

To configure Twinkle, copy the text below called TwinkleConfig, and paste it in your monobook.js file. (Per temporal disalignment it should not matter if you put the config before or after the includes). Each line in the object contains a specific setting which is described below. When changing settings, make sure not to remove the comma from the end of each line, and remember that some browsers dislike a comma on the last line.

This is the default configuration:

TwinkleConfig = {
        revertMaxRevisions              :       50,
        userTalkPageMode                :       'window',
        showSharedIPNotice              :       true,
        openTalkPage                    :       [ 'agf', 'norm', 'vand' ],
        openTalkPageOnAutoRevert        :       false,
        summaryAd                       :       " using [[WP:TWINKLE|TW]]",
        deletionSummaryAd               :       " using [[WP:TWINKLE|TW]]",
        protectionSummaryAd             :       " using [[WP:TWINKLE|TW]]",
        watchSpeedyPages                :       [ 'g3', 'g5', 'g10', 'g11', 'g12' ],
        watchProdPages                  :       true,
        openUserTalkPageOnSpeedyDelete  :       [ 'g1', 'g2', 'g10', 'g11', 'g12', 'a1', 'a7', 'i3', 'i4', 'i5', 'i6', 'i7', 'u3', 't1' ],
        watchRevertedPages              :       [ 'agf', 'norm', 'vand', 'torev' ],
        markRevertedPagesAsMinor        :       [ 'agf', 'norm', 'vand', 'torev' ],
        deleteTalkPageOnDelete          :       false,
        watchWarnings                   :       true,
        markAIVReportAsMinor            :       true,
        markSpeedyPagesAsMinor          :       true,
        offerReasonOnNormalRevert       :       true,
        orphanBacklinksOnSpeedyDelete   :       {orphan:true, exclude:['g6']}
};

Alternatively, you may wish to only copy the settings you wish to change.

TwinkleConfig = {
        key     :       value,
        key     :       value,
        ...
        key     :       value
};

[edit] revertMaxRevisions

Defines the maximum of revision to query. The server limit is 50, default is 50

[edit] userTalkPageMode

Defines how the talk page of target person should be opened.

Argument is a string with following values:

'window'

opens a popup window

'tab'

tries if possible to open in a new tab (may and may not work)

'blank'

similar to default mode, but force it into a clean new window, instead of remembering the window

Default is 'window'

[edit] showSharedIPNotice

Defines if warning to an anonymous IP address should be accompanied with a shared IP notice.

Argument is a boolean, default set to true.

[edit] openTalkPage

Defines what types of actions should result in opening of user talk page

Argument is an array, default to [ 'agf', 'norm', 'vand' ].

[edit] openTalkPageOnAutoRevert

Defines if talk page should be opened when calling revert from contrib page, this is because from there, actions may be multiple, and opening talk page not suitable. If set to true, openTalkPage defines then if talk page will be opened.

Argument is a boolean, default to false.

[edit] openAOLAnonTalkPage

Defines if Talk pages of anonymous AOL users should be opened.

Argument is a boolean, default to false.

[edit] summaryAd

Defines what summary Ad to be added.

Argument is a string, default to using [[WP:TWINKLE|TW]].

[edit] deletionSummaryAd

Defines what deletion summary Ad to be added.

Argument is a string, default to using [[WP:TWINKLE|TW]].

[edit] protectionSummaryAd

Defines what protection summary Ad to be added.

Argument is a string, default to using [[WP:TWINKLE|TW]].

[edit] watchSpeedyPages

Defines what types of speedy deletions/requests should result in the page to be added to the watchlist

Argument is an array, consisting of the normalized CSD criteria (g1, a1 etc...)

Default is [ 'g3', 'g5', 'g10', 'g11', 'g12' ].

[edit] watchProdPages

Defines if prods (proposed deletions) should be added to your watchlist

Argument is a boolean, default is true

[edit] openUserTalkPageOnSpeedyDelete

Defines what types of speedy deletions/requests should result in opening of the user talk page of first contributor

Argument is an array, consisting of the normalized CSD criteria (g1, a1 etc...)

Default is [ 'g1', 'g2', 'g10', 'g11', 'g12', 'a1', 'a7', 'i3', 'i4', 'i5', 'i6', 'i7', 'u3', 't1' ].

[edit] watchRevertedPages

Defines what types of actions should result in page to be added to watchlist.

Argument is an array, and the values might be 'vand', 'norm', 'agf' and 'torev'

Default is [ 'agf', 'norm', 'vand', 'torev' ].

To remove watching, replace with [ ],

[edit] markRevertedPagesAsMinor

Defines what types of actions should mark edit as minor.

Argument is an array, and the values might be 'vand', 'norm', 'agf' and 'torev'

Default is [ 'agf', 'norm', 'vand', 'torev' ].

[edit] deleteTalkPageOnDelete (admin only)

Defines if the talk page, if it exists, also should be deleted on speedy delete.

Argument is a boolean, default to false.

[edit] watchWarnings

Defines if warnings to users should be added to the watchlist.

Argument is boolean, default is true.

[edit] markAIVReportAsMinor

Defines if reports to AIV should be marked as minor, if false, default per preference is applied

Argument is boolean, default is true.

[edit] markSpeedyPagesAsMinor

Defines if speedy deletion requests should be marked as minor, if false, default per preference is applied

Argument is boolean, default is true.

[edit] offerReasonOnNormalRevert

Defines if a prompt should be given for an optional edit summary for normal reverts

Argument is boolean, default is true

[edit] orphanBacklinksOnSpeedyDelete (admin only)

Defines if backlinks to a page should be eliminated, by a limit to namespace 0 and 100.

Argument is a hash, default is true and exclude g6 (housekeeping).