Wikipedia:Twinkle/doc

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

Installation

Installing Twinkle is easy. Refer to the "quick info" section of the script's page for easy-to-follow instructions. Before you start using Twinkle, you should read this page to familiarize yourself with some of the possibilities and functions of Twinkle. There are multitudes of options that you can configure to change some of the default behaviours of Twinkle.

Note: Never forget that you take full responsibility for any action performed using Twinkle. You must understand Wikipedia policies and use this tool within these policies, or risk being blocked.

Twinkle practice / sandbox

Several practice sandboxes exist that can be used to test the behavior of Twinkle.

• To test article tagging, use Draft:Sandbox.
• To test user-page tagging (warn, welcome, and talkback), use the user warnings sandbox.

Note: Please don't use these pages to test speedy deletion, nominate for deletion, or request page protection, as these will place notifications on actual Wikipedia admin boards. Also, please don't unlink backlinks in the sandboxes, as this will remove links to the sandboxes.

Troubleshooting installation

Twinkle installation may fail completely for several reasons:

• You must be registered, and your account must be autoconfirmed (it must be at least four days old and have at least ten edits), to use Twinkle.
• You must use a supported web browser. Twinkle does not work with Internet Explorer version 8 or older; hence, it will not work on Internet Explorer on Windows XP, and you may need to upgrade to Internet Explorer 9 if you use Windows Vista or Windows 7.
• If you are using older versions of Opera, Safari, or Firefox, try enabling the JavaScript Standard Library gadget under your preferences → Gadgets → Library and compatibility gadgets.
• After installation, you may have to clear your browser cache. Instructions on how to do this can be found at Wikipedia:Bypass your cache.
• In case of manual installation, Twinkle must be installed in your skin's .js file (not .css).
• If you have switched skins and are not using the Gadget version of Twinkle, make sure that your current skin's script file is actually importing Twinkle.
• If you're using Windows, and you're using a touchscreen, you may need to tap and hold the "TW" button in order to get the options to come up.

If you have tried all of the above suggestions and you still cannot use Twinkle, or if you notice other problems, check the discussion page and, if needed, post the issue there. If you do, please include the following information:

1. What is the behaviour you're seeing?
2. What is the behaviour you're expecting to see?
3. How can the incorrect behaviour be reproduced? Describe exactly what you're doing and seeing.
4. Confirm that you have tried bypassing your browser cache.
5. Make note of your browser, browser version, operating system, and operating system version.
6. Append relevant JavaScript errors your browser logged. To do that, open your JavaScript console or error console, and copy the relevant error messages. Where you find your javascript console depends on your browser:
   • Internet Explorer: Press F12; refresh the Wikipedia page; JavaScript errors appear on the "Console" tab of the F12 tools.
   • Firefox: Menu → Tools → Error console (or Firefox Button → Web Developer → Error Console). You should click the "Errors" button at the top to hide the vast number of ignorable warnings, etc.
   • Opera: Menu → Page → Developer Tools → Error Console.
   • Chrome: Page menu → Developer → JavaScript Console (Ctrl+Shift+J).
   • Safari: Page menu → Develop → Show Error Console (Ctrl+Alt+C or Shift+Command+J). You might have to enable it first in Preferences → Advanced.

You are strongly urged to have a look at http://www.chiark.greenend.org.uk/~sgtatham/bugs.html for hints on how to report bugs effectively, to make sure the issue you are describing can be resolved as promptly as possible.

Installing individual Twinkle modules

Previously, it was possible to install Twinkle modules individually. This method of installation no longer applies. The recommended ways to install Twinkle are described at Wikipedia:Twinkle#Installation.

Modules

Twinkle is made up of many "modules", each providing a quicker way of carrying out a certain maintenance task. Most modules can be accessed through the tabs along the top of each page (in the Monobook skin), or under the "TW" drop-down menu next to the search box (in the Vector skin). Some modules appear only on specific page types, besides on an article in any namespace, these are available when viewing diff pages ("since mine" etc) and userpages (warning etc).

Besides the main Twinkle menu offering options, Rollbacking and automatic welcoming appear right next to the revision links while viewing diffs and the former even on user contrib pages right after each individual edit.

CSD (speedy deletion)

Speedy deletion dialog

CSD stands for Criteria for Speedy Deletion. If you believe an article meets one of the criteria for speedy deletion, you can use this Twinkle module to quickly tag it for deletion.

Using this module

Click on the CSD tab. You will be presented with a list of reasons, which differ depending on which namespace the page you are viewing is in. Previously, when you selected one of the items, Twinkle began acting right away; now you must press submit to start the process. This can be changed in Twinkle preferences. You may be prompted for extra information (such as a rationale, URL of copyvio, etc.), and then the page will be tagged with the appropriate template (for instance, clicking "G5: Banned user" tags the page with {{db-banned}}).

• If you have the Notify if possible box checked, and your Twinkle preferences are set appropriately, the user who created the page will be notified using a boilerplate warning template, as requested by speedy deletion policy. If the creator's talk page does not exist, they will also be welcomed, using the {{firstarticle}} template. Normally, there is no reason to un-check the "notify" box; however, consider that the notification may or may not be appropriate (see WP:DTTR and WP:TTR), so use it with care.
• The Tag with multiple criteria option at the top of the window opens a series of further windows, where you will be able to choose several criteria to be included in the {{db-multiple}} template. The list of criteria is somewhat smaller than that for non-multiple CSD – each code appears only once, due to the way {{db-multiple}} is implemented. Once you have chosen all the criteria that apply, click the "Submit query" button. No more than eleven criteria may be selected for multiple tagging, but it is rare to apply more than two at a time.
• In your Twinkle preferences, you can turn on the CSD userspace log. This feature keeps a log in your userspace of all pages you nominate for CSD. Because pages that are deleted do not appear in your contributions, using this feature is the only way that non-admins can track their deletion taggings and evaluate how many were deleted. It is also useful for tracking declined speedy deletions (by the presence of blue links in the log, as opposed to red links) and learning from them, hence helping you to improve your tagging habits.
• Nominating a page for CSD will add the page to your watchlist by default, for most criteria. You can disable this, or choose a different set of criteria, in your Twinkle preferences. Additionally, when using CSD on a page reached from Special:NewPages, Twinkle will automatically mark the page as patrolled. Again, you can disable this using preferences.

Take note

• Twinkle CSD offers a quick easy way to tag pages for speedy deletion. However, always keep in mind that you are responsible for all actions taken using Twinkle, so always think twice before tagging a borderline case with a CSD tag. Also, remember not to bite the newbies.
• Twinkle does not notify page creators when tagging with certain criteria (including G6 and G8). This is to prevent notifications in cases where they are not really needed, or where they will possibly be counterproductive (such as for CSD G5 - banned user). You can enable notifications for these criteria in your Twinkle preferences, if you especially want them: but note that warning templates for some criteria do not actually exist.

Extra functionality for administrators

Admins can delete pages using Twinkle (and optionally the associated talk page and/or all redirects). The deletion reason can be changed before deletion takes place.

RPP/PP (page protection)

Protection request dialog

RPP/PP, short for Request for Page Protection, is a module which sends a request for protection or unprotection to the page of the same name. It is commonly used for heavily vandalized articles, or for articles that are current and are likely to have high traffic due to real-life events.

Using this module

Click on the RPP tab on the article page. You will be prompted to choose the type of action, depending on which you will get different options:

• Request page protection: Use this option if you want to request protection via WP:RPP. You will have to choose the type of protection, and you can also specify reason and duration (indefinite or temporary) of protection.
• Tag page with protection template: You will be able to choose tagging options. Here you will choose the protection template (or choose none if you want to remove the existing one). You can also choose to iconify the template, displaying it as a small keylock in the corner of the page instead of a large box, or wrap protection template with <noinclude> so that it won't be transcluded.

Take note

If you open RPP on the page that doesn't exist you won't be able to select Tag page with protection template box and you will only be able to apply Create Protection.

Extra functionality for administrators

For administrators, this module is called PP. Admins also get extra tools to actually apply protection to the page instead of just making a request.

PROD (proposed deletion)

Proposed deletion dialog

PROD is short for Proposed Deletion, a process whereby articles or files that are deemed to be uncontroversial targets for deletion can be deleted if there is no objection within seven days. Twinkle allows you to quickly apply PROD tags.

A similar process, proposed deletion of biographies of living people, can be used on BLP articles that are completely unsourced. The article will then be deleted after seven days, unless at least one source (reliable or not) is introduced to the article. You can also use Twinkle to tag articles for BLP PROD.

The PROD tab only appears on articles, files and books, as they are the only pages eligible for the PROD deletion process.

Using this module

Click on the PROD tab on the page. You will be prompted to choose a PROD type (regular PROD or BLP PROD - see above). If you select regular PROD, you will need to enter a reason explaining why the page may be eligible for deletion. BLP PROD nominations do not require a reason.

• If you have the Notify if possible box checked, the user who created the page will be notified by substituting the {{prodwarning}} template on their talk page. (For BLP PROD, it is not possible to turn off the notification, and the {{prodwarningBLP}} template is used instead.) Please note that, at present, Twinkle does not give the creator a welcome message, even if their talk page does not exist.
• When you tag a page that already contains a PROD tag, Twinkle will ask whether you would like to endorse the existing PROD, using the {{prod-2}} template. If an article contains a regular PROD tag, and you choose to apply a BLP PROD tag in Twinkle, the {{prod-2}} tag is applied with the reason "unsourced BLP".
• In your Twinkle preferences, you can turn on the PROD userspace log. This feature keeps a log in your userspace of all pages you tag for PROD and BLP PROD. Because pages that are deleted do not appear in your contributions, using this feature is the only way that non-admins can track their PROD taggings and evaluate how many are deleted or declined.
• By default, tagging for PROD or BLP PROD will add the page to your watchlist. You can disable this in your Twinkle preferences.

Take note

Proposed deletion tags are only for uncontroversial deletions. If the deletion may be controversial, consider using Twinkle's XfD module instead. On the other hand, if the page falls under one of the speedy deletion criteria, you should instead use the CSD module, to ensure more rapid page deletion.

Extra functionality for administrators

Administrators have additional access to Twinkle's de-PROD tool, which automatically clears a daily PROD category.

XfD (deletion discussions)

XfD, short for Anything for Deletion, is a collective term for the venues where the deletion of pages on Wikipedia is discussed. You can use Twinkle to quickly start a deletion discussion for any page. You can additionally use it to request speedy renaming of categories through the speedy CFD process.

See Wikipedia:Deletion venues for help on choosing an appropriate discussion venue.

Upon running the XfD tool, several things happen: the page is tagged with a deletion notice; the deletion discussion is created (this involves creating a new page for AfD and MfD); the discussion page is transcluded onto the daily list (for AfD and MfD only); the page creator is notified (if you requested it); and (optionally for MfD) the owner of the userspace is notified.

Using this module

Click on the XfD tab. In the window that appears, you can choose the deletion discussion forum that is appropriate for the page. Normally Twinkle's initial choice is fine, but sometimes it gets it wrong (especially for userboxes in the Template: namespace, which need to be sent to MfD).

When you choose (or Twinkle chooses for you) a discussion venue, you will be presented with additional options specific to that venue, as follows:

• AfD:
  • Wrap deletion tag with <noinclude>: This is a rarely-used option that is only needed for articles that are transcluded.
  • Deletion discussion category: Due to the large volume of deletion discussions at AfD, a sorting system is in place, so users can track deletion discussions that are relevant to their interests and editing. Choose the most appropriate category; if you're totally unsure, choose "indiscernible or unclassifiable topic".
• TfD:
  • Wrap deletion tag with <noinclude>: This option should be selected for templates that are substituted, so that the deletion tag doesn't get substituted onto other pages.
  • Inline deletion tag: This option should be selected for templates that appear in line with text: templates such as the infamous {{fact}}, and other referencing-related templates. If you do not select this option, a line break and wide deletion notice will appear above every instance of the template (as is intended for non-inline templates, like navboxes and cleanup tags).
• FfD has no extra options.
• CfD
  • Type of action wanted: You can specify whether the category should be deleted, renamed, merged, or converted into a list in article space. The three last options prompt for a Target page in the box beneath - this is the category to merge with, the name to which the category should be renamed, or the article to which the category should be converted.
• CfD/S
  • C2 sub-criterion: See WP:C2 to choose an appropriate sub-criterion.
  • New name: The title to which the category should be renamed.
• MfD
  • Wrap deletion tag with <noinclude>: Use this option for userboxes, and other items that are transcluded (like some project pages, and pieces of portals).
  • Also notify owner of userspace if they are not the page creator (User: and User talk: namespaces only): If the page you are nominating was not created by the same user who has it in their userspace (for example, rescued articles), the owner of the userspace will be notified about the deletion. (It is usually best to leave this option on, except when in the userspace of problem users.)
• RfD has no extra options.

There is one option that applies to all deletion venues:

• The Notify if possible box, when checked, will cause Twinkle to give the user who created the page an appropriate notification using a boilerplate warning template. This is usually a good idea, but not always necessary, particularly in the case of malfeasant editors. For MfD, the owner of the userspace can also be notified: see above under MfD.

Of course, you must specify a reason why the page should be deleted. You can use full wiki formatting in your reason.

XfD-related pages can be added to your watchlist if you choose this option in your Twinkle preferences. By default, no pages are added to your watchlist when using Twinkle's XfD module. More information is available at the preferences panel.

No userspace log function exists for XfD, as records of all deletion discussions are kept in project space.

Take note

Sometimes, during XfD processing, Twinkle may stall, particularly while adding the discussion to the daily list. The reason for this is unknown; it is believed to be a server issue. If Twinkle stalls while nominating for XfD, be patient. You may need to wait more than 20 seconds in some cases.

Extra tools for administrators

Twinkle does not include a tool to help admins close XFD debates; if you are looking for one, you might like XFDcloser.

Last

This option shows you a diff between the current revision of a page and the previous one.

Additionally, when viewing any diff, the options "since", "since mine" and "current" will be available.

Unlink

An example of the unlink feature from the screenshot of a user's contribution page. The URL in the edit summary would normally be where the reasoning for unlinking appears.

This option unlinks backlinks, but is only available to extended confirmed users. Backlinks are links from other pages to a given page. Unlinking them delinks the terms linking to that given page. This is often necessary after speedy deletion to prevent a page on a non-notable, vandalism, or other problematic topic from being recreated. It prevents a bunch of redlinks from showing up all over the place when you delete an article. Depending on the article being deleted, you may or may not want to unlink backlinks.

Tag

Twinkle's tag functionality.

The tag tab will tag the article, redirect or file with the template(s) of your choice.

All templates that are checked will be added to the article in their proper respective locations. For article tags, the date parameter populated to the current month and year is automatically added. On articles, if there are two or more tags (already existing + selected), Twinkle will group the supported templates inside a {{Multiple issues}} template. Any selected templates that are not supported in {{Multiple issues}} are added normally.

As of June 2019, it is also possible to remove existing tags from articles (but not from redirects or files). Existing tags (even the ones that Twinkle doesn't normally support) are listed checked at the top. Unchecking a tag and submitting would remove the tag.

On redirect pages (in any namespace), the tab will present you with a set of redirect categorization tags, from Category:Redirect templates.

DI (delayed speedy deletion for files)

Pseudo-speedy file deletion dialog

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

ARV

ARV stands for Advance Reporting and Vetting. When on any user namespace page, or on Special:Contributions/USER, 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
  • Account is a promotion only account
• Username - Reports the user to Usernames for administrator attention. Check the policies at Wikipedia:Username policy to ensure that one of the 4 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 Sockpuppet investigations.
• Edit warring - Reports the user to the edit warring noticeboard. Provides input for you to select the user's reverts, warnings sent to them, and attempts to resolve the problem on the talk page.

Warn (user talk warnings)

Warning dialog

On user talk pages, 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. Your browser has to allow pop-ups from Wikipedia for the talk page to open automatically.)
• 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.

Twinkle is capable of adding a custom list of templates that displays below the default set of warning templates. If you have installed Twinkle, you can use the "Custom warning templates to display" option in your Twinkle preferences under "Warn user".

TB (talkback)

The tb tab will allow you to easily leave a variety of user notification templates on other users' talk pages. It supports most of the options that you would have available as if you were leaving the template by hand.

Some (but not all) of the templates supported are:

• {{talkback}}
• {{please see}}
• {{you've got mail}}
• {{AN-notice}}
• {{ANI-notice}}
• {{AN3-notice}}
• {{COIN-notice}}
• {{DRN-notice}}

More may be added in the future.

Wel (welcome)

Twinkle's welcome functionality.

The wel tab will welcome the user with a selected template.

If an article is specified in the input field, and the template supports an article link, Twinkle will automatically link the template to the article you specified. All templates that support this are marked with an asterisk ("*"). In the case of normal welcome templates, the article would be one that the user contributed positively to. In the case of problem user welcome templates, the article would be one that the user vandalized or did not contribute positively to. This input field is automatically populated if the vanarticle URL parameter is found, which is populated by Twinkle after doing a rollback.

Twinkle is capable of supporting a custom list of templates that displays below the standard set of Welcome templates. If you have installed Twinkle, you can add a list of templates that you would like to be added to the Welcome dialogue by changing the "Custom welcome templates to display" option in your Twinkle preferences. Any templates added to this list, when selected, will simply be placed on the user's talk page with no heading, no arguments, and will be followed by your signature.

Shared IP tagging

The shared IP tab will tag the IP as a shared IP address.

Most of the Shared IP templates require that the name of the organization that owns or operates the IP address be entered. If one of these templates is selected, Twinkle will require that you fill in the "Organization name" input field, which supports wikitext.

Restore and rollback

Twinkle's rollback functionality on a diff page.

When you view a diff between versions of a page, Twinkle will place extra links above the two columns of the diff display.

Restore this version

The "Restore this version" link appears above any version that is not the latest version (in either or both columns) and when used will revert to that version, effectively undoing any changes since. A box is provided to input an edit summary.

Rollback

Not to be confused with the rollback user right.

When the newer version in the diff is the latest version of the page, three "rollback" links instead appear above it. Any of these will revert all consecutive edits by the same editor immediately preceding the new version. Any bot edits that follow the editor's consecutive edits can also be included in the revert.

Thus rollback is identical to the core undo functionality, only it will potentially include a whole chunk of edits by the same editor (and optionally bot edits too) at the same time.

1. rollback (AGF) - Performs rollback, then provides an edit summary box, pre-filled with an AGF label. AGF stands for Assume Good Faith, meaning the label is written in a friendly encouraging tone as opposed to a stern warning tone. (preview)
2. rollback - Performs rollback, then provides an empty edit summary box.
3. vandalism - Performs rollback and opens vandal's talk page so you can easily add an appropriate warning template (does NOT allow edit summary; edit summary will be automatically filled).

Twinkle's welcome option displayed in diff.

A welcome link will also appear next to a user in a diff view if the user's talk page is empty. Depending on your preferences, this link will automatically welcome the user with the template specified in the "Template to use when welcoming automatically" preference, or open the user's talk page with Twinkle's welcome dialogue already visible (by default). This feature is available when viewing any diff across all namespaces.

Modules for administrators

As well as having access to more features in some of the main modules, administrators also have some modules to themselves:

Batch deletion ("D-batch")

This module allows you to delete all or some pages in a category, or linked from a given page, or from Special:PrefixIndex. It is also possible to delete talk pages of the linked pages, delete some or all subpages of those pages, delete redirects to the pages, and unlink them from articles and portals. This is useful for closing huge mass AfDs or TfDs, or clearing timed speedy deletion categories (like the dated subcategories of Category:Wikipedia files with unknown source).

Once you select your options and click Submit, this module runs automatically, so it's important to take great care to know what it will do. It might not be the best solution in some circumstances. You should be quite careful with this script, as it has the potential to cause massive damage if used improperly.

Batch undeletion ("Und-batch")

Similar to batch deletion, but undeletes instead. You have to create a list of pages (or transclude one) in your userspace, and then invoke the script from this page. Can also undelete talk pages of the concerned pages, if they once existed.

Batch protection ("P-batch")

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

De-prod

See the PROD section above.

Configuration

The easiest way to configure Twinkle is by using the preferences panel, located at Wikipedia:Twinkle/Preferences. There is a wide variety of options available.

Technical details

The Twinkle preferences panel works by saving a JSON object to Special:MyPage/twinkleoptions.js, which is then read by Twinkle every time you load a page. (That might sound like a performance hit, but your browser will normally cache your personal options page, so it doesn't have to be downloaded every time.)

If the preferences panel goes wrong, or you want to set up some of the advanced preferences described below, you can manually edit Special:MyPage/twinkleoptions.js. Its format is as follows (non-JavaScript-savvy users beware):

window.Twinkle.prefs = {
  "optionsVersion": 2,
  "revertMaxRevisions": 13,
  "proddeleteChunks": 20,
  "watchTaggedPages": true,
  "talkbackHeading": "Talkback just for you..."
};

Advanced parameters

These parameters are handy to tweak if your browser or network connection is struggling to perform operations without encountering database locks or network timeouts. They are not shown in the preferences panel, and must be modified by manually editing Special:MyPage/twinkleoptions.js.

Regular users can take advantage of the following parameter:

revertMaxRevisions

Defines the maximum number of revisions to query when looking for a clean revision to roll back to. The server limit is 50. Default is 50.

Administrators can use other parameters to fine-tune batch operations, etc.

batchdeleteChunks

Defines how many pages should be processed at a time when performing batch deletions. The server limit is 50. It is recommended that you not change this configuration parameter. Default is 50.

batchMax

Defines how many pages should be processed at most by any batch function. It is recommended that you not change this configuration parameter. Default is 5000.

batchProtectChunks

Defines how many pages should be processed at a time when performing batch protections. The server limit is 50. It is recommended that you not change this configuration parameter. Default is 50.

batchundeleteChunks

Defines how many pages should be processed at a time when performing batch undeletions. The server limit is 50. It is recommended that you not change this configuration parameter. Default is 50.

proddeleteChunks

Defines how many pages should be processed at a time when performing batch PROD deletions with the "deprod" module. The server limit is 50. It is recommended that you not change this configuration parameter. Default is 50.

Hiding individual Twinkle tabs

In the Monobook skin, each Twinkle module is given its own tab. This can take up a large amount of screen space, especially for administrators, and you may prefer to hide some rarely-used Twinkle tabs. To hide tabs, go to Wikipedia:Twinkle/Preferences#general and use the "Turn off the selected Twinkle modules:" option.

Default watchlist options

With the advent of temporary watchlisting, the default watch time for most options is 1 month. Notable exceptions are for welcoming users (3 months), SPI report creation (yes), XfD discussion (default prefs), and RfPP requests (yes).

Possible values for watchlisting (in your Twinkle preferences) are:

• Add to watchlist indefinitely
• Don't add to watchlist
• Follow your site preferences
• 1 week
• 1 month
• 3 months
• 6 months