KidzSearch Encyclopedia:Twinkle/doc
 | Be advised 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 losing access to the tool or being blocked. |
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 really 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 the article 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 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:
- What is the behaviour you're seeing?
- What is the behaviour you're expecting to see?
- How can the incorrect behaviour be reproduced? Describe exactly what you're doing and seeing.
- Confirm that you have tried bypassing your browser cache.
- Make note of your browser, browser version, operating system, and operating system version.
- 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).
QD (quick deletion)
QD stands for quick deletion. If you believe an article meets one of the criteria for quick deletion, you can use this Twinkle module to quickly tag it for deletion.
Using this module
Click on the QD tab. You will be presented with a list of reasons (see screenshot), which differ depending on which namespace the page you are viewing is in. When you select a criteria and then hit the "Submit query" button, the page will be tagged with the QD template (for example, clicking "G2: Test page" tags the page with {{qd}}).
- If you have the Notify if possible box checked, and your Twinkle preferences are set in the right way, the user who created the page will be notified using a warning template. 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.
- Once you check the "Tag with multiple criteria box", the radio buttons will turn into check boxes, and you can choose up to 3 reasons (see screenshot). These criteria will be grouped into {{qd-multiple}}.
- In your Twinkle preferences, you can turn on the QD userspace log. This feature keeps a log in your userspace of all pages you request to QD. 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 quick deletions and learning from them, so they can help you to improve your tagging "skills".
- Nominating a page for QD 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 QD on a page reached from Special:NewPages and you are a patroller, Twinkle will automatically mark the page as patrolled. Again, you can disable this using preferences.
Take note
- Twinkle can give you the ability to add QD-templates very quickly to articles. However, always keep in mind that you are responsible for all actions taken using Twinkle, so always think twice before you tag an article. 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 linked talk page and/or all redirects). The deletion reason can be changed before they delete it.
RfD (Requests for deletion)
RfD, short for Requests for deletion, is a seven-day discussion where all users can talk about the best way to handle an article. This can be used when deletion is unsure or may need discussion.
Upon running the RfD tool, several things happen: the page is tagged with a deletion notice; the deletion discussion is created; the discussion page is transcluded onto the daily list and the page creator is notified (if you requested it).
Using this module
Click on the RfD tab.
- If the Notify if possible is checked, Twinkle will give the user, who created the page, a notification using the warning template {{RFDNote}}.
Of course, you must specify a reason why the page should be deleted. You can use full wiki formatting in your reason.
RfD 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 RfD module. More information is available at the preferences panel.
No userspace log function exists for RfD, as records of all deletion discussions are kept in project space.
Take note
Sometimes, during RfD 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 seems to have freezed while nominating for RfD, 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 AFD debates; if you are looking for one, you might like en:User:Mr.Z-man/closeAFD.
Last
This option shows you a diff between the current revision of a page and the previous one.
Unlink
This option unlinks backlinks. 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
The tag tab will tag the article or redirect with the template(s) of your choice.
All templates that are checked will be added to the article (in their proper respective locations). Templates that support it will automatically be added with the date parameter populated to the current month and year. If the "Group into {{Multiple issues}} if possible" checkbox is ticked, Twinkle will group supported templates inside an {{Multiple issues}} template, if there are four or more. All other selected templates are then added to the article normally. If there are three or fewer selected templates that are supported by the {{Multiple issues}} template, the setting is ignored, and all templates are added to the article normally.
One templates in the list, {{notability}}, allow you to select from a list of subcategories. The standard template is the default, and selecting a subcategory is not required, but it does place a more specific version of the template on the article.
If you are viewing a redirect page (in any namespace), the tab will present you with a set of redirect categorization tags, from Category:Redirect templates.
Stub
The stub tab will tag the article with one more stub template(s) of your choice. See also the Simple Stub Project.
Note: There is currently a bug, that adds the stub template even after the metadata (interwiki, cat etc.). The issue is tracked and will be fixed as soon as possible.
ARV
ARV stands for Advance Reporting and Vetting (a backronym). When on any user namespace page, or on Special:Contributions/USER, click this button to report them to administrators:
- Vandalism - Reports the user to Vandalism in progress; 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
Warn (user talk warnings)
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)
- 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.
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.
The following templates are supported:
- {{talkback}}
- {{you've got mail}}
- {{wb}}
More can be added per request on Wikipedia talk:Twinkle.
Wel (welcome)
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 use" 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.
The shared IP tab will tag the IP as a shared IP address.
Following templates are supported:
- {{SharedIP}}
- {{SchoolIP}}
- {{SharedIPCORP}}
- {{ISP}}
Revert and rollback
When viewing a diff between revisions of a page, Twinkle will place four new links above the previous revision and the new revision:
- restore this version - Reverts all edits to that version (allows edit summary).
- rollback (AGF) - Labels the original edit as AGF in edit summary (allows edit summary). (preview)
- rollback - Performs rollback, then asks for input for edit summary.
- rollback (VANDAL) - Labels rollback as vandalism in edit summary, and opens vandal's talk page (does NOT allow edit summary).
Note that the 3 rollback links will only show up on the current revision. If you are viewing a diff between 2 old revisions of a page, only the "restore this version" links will show.
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
- Similar to batch image deletion, but for normal pages instead. There are two modules because the processes are not identical. This one is good for closing huge mass AfDs or TfDs.
- Batch undeletion
- Similar to batch deletion, but undeletes instead. Only works on user subpages, so you have to create a list of pages (or transclude one) in your userspace.
- Batch protection
- Similar to batch deletion, but protects the pages instead. It's used often as an emergency option against heavy multiple-page vandalism.
- Traverse
- It wades through a category of images, and for each image it displays it, the page, the history, the file history, the file usage, and allows you to delete it.
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):
<source lang="javascript"> window.Twinkle.prefs = {
"twinkle": {
// Place all preferences here, except for Shared IP, Tag, Welcome, and Talkback preferences
// For example:
revertMaxRevisions: 13,
summaryAd: " BTW, I use Twinkle.",
proddeleteChunks: 20
},
"friendly": {
// Place preferences for Shared IP, Tag, Welcome, and Talkback in here
// For example:
watchTaggedPages: true,
talkbackHeading: "Talkback just for you..."
}
}; </source>
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. batchDeleteMinCutOff- Defines how many current pages should be left in the process of being deleted before a new batch is allowed to be initialized. It is recommended that you not change this configuration parameter. Default is
5. 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. batchProtectMinCutOff- Defines how many current pages should be left in the process of being protected before a new batch is allowed to be initialized. It is recommended that you not change this configuration parameter. Default is
5. 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. batchUndeleteMinCutOff- Defines how many current pages should be left in the process of being undeleted before a new batch is allowed to be initialized. It is recommended that you not change this configuration parameter. Default is
5. deliChunks- Defines the number of images that will be processed at a time when doing a batch deletion. It is recommended that you not change this configuration parameter. Default is
500. deliMax- Defines the maximum number of images that will be processed when doing a batch deletion. It is recommended that you not change this configuration parameter. Default is
5000. proddeleteChunks- Defines how many pages should be processed at a time when performing batch prod deletions. The server limit is 50. It is recommended that you not change this configuration parameter. Default is
50.
The default location of the Twinkle menu items in the Vector skin is in a drop-down menu; in all other skins they are displayed on the top row of tabs. If you like, you can change the location and layout of those items on your page by manually setting some options in your twinkleoptions.js:
"portletArea"
"portletId"
"portletName"
"portletType"
"portletNext"
For example, if you want to move the items to the toolbox menu on the left-hand side of the screen, add the line "portletId": "p-tb", to your Twinkle preferences, like so:
<source lang="javascript">
window.Twinkle.prefs = {
"twinkle": {
// ...
"portletId": "p-tb",
// ...
},
// ...
}; </source>
If you want to display the items as tabs as in the old monobook skin, add the line "portletId": "p-views", to your Twinkle preferences, like so:
<source lang="javascript">
window.Twinkle.prefs = {
"twinkle": {
// ...
"portletId": "p-views",
// ...
},
// ...
}; </source>
portletId is the ID of the portlet you'd like the menus to appear in. In these case, 'p-tb' indicates the toolbar, while 'p-views' indicates the menu bar. For a full list see the catalogue of CSS classes).
Alternatively, you can create a new menu just for the Twinkle items. In that case, add <source lang="javascript"> window.Twinkle.prefs = {
"twinkle": {
// ...
"portletArea": "column-one",
"portletId" : "p-twinkle",
"portletName": "Twinkle",
"portletNext": "p-search",
// ...
},
// ...
}; </source>
The portletId parameter now refers to the specific Twinkle tool set, 'p-twinkle'. portletArea indicates where the menu should appear (the value 'column-one' is the sidebar for Monobook; for Vector it is 'panel' and for Modern it is 'mw_portlets'; Other options include 'left-navigation' and 'right-navigation' in Vector and 'mw_contentwrapper' in Modern, which will appear on a new level above the other tabs). Change portletNext to dictate which ID the new Twinkle menu should precede; in this case 'p-search' means it will come before the search box. Change the portletName parameter to change the name displayed named along with the new menu, if applicable - in this case, "Twinkle".
Ask for support at the Twinkle talk page if you're unsure what to change.