Wikipedia:Twinkle

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Not to be confused with Twinkle (software).
"WP:TW" redirects here. For other uses, see Wikipedia:Transwiki log, or WikiProjects Torchwood or Taiwan.
For the Twinkle preferences panel, see Wikipedia:Twinkle/Preferences.
Shortcuts:
Mr. Twinkly

Twinkle is a set of JavaScript functions that gives autoconfirmed registered users many extra options to assist them in common Wikipedia maintenance tasks, and to help them deal with acts of vandalism. It provides users with three types of rollback functions and includes a full library of speedy deletion functions, user warnings and welcomes, maintenance tags, semi-automatic reporting of vandals, and much, much more.

A screenshot of Twinkle's page protection requesting feature.

Twinkle, developed by AzaToth, has its origins as a reversion script based on ideas found in Aaron Schulz's script collection. It has grown quickly into a tool with many more capabilities than its reversion roots and is used by thousands of Wikipedians.

The collection of tools formerly known as Friendly, developed by Ioeth, is now part of Twinkle.


Quick info

Getting started
To enable Twinkle on your account, receiving any future updates automatically, you can simply enable the "Twinkle" gadget in the Gadgets section of your Preferences page. (Don't forget to click "Save" at the bottom of the list of gadgets!) After installing, you may need to bypass your browser cache.
Customizing Twinkle
To modify many aspects of Twinkle's operation, you can visit the Twinkle preferences panel. Make your changes, and click "Save changes" at the bottom of the page. Then make sure to completely clear your browser cache so your changes take effect.
Getting help
There is comprehensive information about Twinkle at the documentation page. If that page does not answer your question, consider asking at the talk page. IRC users can connect to the #wikipedia-userscripts or #wikipedia-en IRC channels.
Reporting bugs or requesting features
Twinkle is under active development, and we generally fix bugs reasonably quickly. If you find a bug, please help out by reporting it at our GitHub repository (you will need to have a GitHub account). If you don't want to create a GitHub account, or you have a request for a new feature that could be added to Twinkle, you can ask at the talk page.
Notes
  • Twinkle does not work on Internet Explorer (IE) versions 8 or earlier. If you use Windows Vista or Windows 7, you can upgrade to IE9 or IE11 respectively, under which Twinkle will work. If you have Windows XP or earlier (which cannot run IE9 or later), try installing another browser such as Mozilla Firefox or Google Chrome, as Twinkle is functional on most other modern browsers (including modern smartphone browsers).
  • Some browser add-ons may interfere with Twinkle. If Twinkle still does not load after following the instructions above, consider disabling one or more of your add-ons and then restarting your browser.

For a visual demonstration of many of the aforementioned items, it may be useful to view the "Twinkle" video tutorial on WMF Labs.

Is Twinkle loading unreliably?

In the past, you could install Twinkle by adding the text importScript('User:AzaToth/twinkle.js'); to your personal script page. However, this practice can make Twinkle load unreliably (Twinkle might not load on every page you visit, or it might show up but not work properly).

To rectify this problem, you should remove the line importScript('User:AzaToth/twinkle.js'); from your personal script file, and then turn on the Twinkle gadget using the instructions above.

If you have any old configuration set up using TwinkleConfig and/or FriendlyConfig, it will still be effective. However, if you use the preferences panel to modify your configuration, you are advised to remove all old Twinkle/Friendly configuration variables from your skin JavaScript file.

Documentation and configuration

Before using Twinkle, one really should read its documentation to familiarize oneself with some of the possibilities and functions of Twinkle. There are multitudes of options that one can configure to change some of the default behaviours of Twinkle.

Abuse

Shortcuts:

Never forget that one takes full responsibility for any action performed using Twinkle. One must understand Wikipedia policies and use this tool within these policies or risk having one's account being blocked. Anti-vandalism tools, such as Twinkle, Huggle, and rollback, should not be used to undo good-faith changes unless an appropriate edit summary is used.

Userboxes

Users of this tool can also add any of these userboxes to their page.

Code Result
 {{User:UBX/Twinkle}}
This user is a recent changes patroller with Twinkle!
Transclusions
 {{User:UBX/Twinkle2}}
Wikipedia:Twinkle This user reverts vandalism in the blink of an eye with Twinkle!
Transclusions
 {{User:UBX/Twinkle3}}
Police man Twinkle Head.svg This user reports vandalism in the blink of an eye with Twinkle!
Transclusions
 {{User:UBX/Twinkle4}}
Police man Twinkle Head.svg This user watches over Wikipedia with the help of Twinkle!
Transclusions
 {{User:UBX/Twinkleadmin}}
Police man Twinkle Head.svg This user performs administrator tasks in the blink of an eye with Twinkle!
Transclusions
 {{Template:User Newpages with Twinkle}}
Police man Twinkle Head.svg This user is a new pages patroller with Twinkle!
Transclusions
 {{User:Xenon54/Userboxes/Twinkle}}
Chocolate chip cookies.jpg

This user welcomes new users with Twinkle!

Transclusions
 {{User:Xenon54/Userboxes/Twinkle2}}
Face-smile.svg This user welcomes new users with Twinkle!
Transclusions
 {{User:Xenon54/Userboxes/Twinkle3}}
{{underlinked}}

This user tags articles for maintenance with Twinkle!

Transclusions
 {{User:Arctic Fox/UBX/Twinkle}}
Peace dove.svg

This user welcomes new users with Twinkle!

Transclusions
 {{User:Powergate92/Userboxes/Twinkle}}
Chocolate chip cookies.jpg This user welcomes new users and tags articles using Twinkle {{tag}}
Transclusions
 {{User:Skittleys/Userboxes/Twinkle|tag=TAGNAME}}
{{COI}}

This user tags articles with Twinkle!

Transclusions
 {{User:Me and/Userboxen/Twinkle}}
Police man Twinkle Head.svg This user maintains Wikipedia with the help of Twinkle!
Transclusions

Also, there is the Twinkle topicon {{Twinkle topicon}}.

Twinkle on other wikis

A common request on the Twinkle talk page comes from those who wish to use Twinkle on other wikis. Some parts of Twinkle are easily portable to other MediaWiki-based wikis: the revert/rollback module, for example. But most modules have been designed only with English Wikipedia in mind. For instance, the CSD module relies on templates which most likely do not exist on other wikis.

Users who wish to make Twinkle's functionality available on other wiki projects should consider the following suggestions:

  • The "fluff" (revert/rollback), "diff" (quick access to diff pages), and "unlink" (automated orphaning) modules can be used elsewhere without modification (or with minimal modification). In the future, it is possible that these scripts will be packaged and made available for a quick setup and update process. For individual users, this can be done by following the instructions here.
  • If you wish to harness more of Twinkle's functionality, you may like to find a willing, JavaScript-savvy user on your wiki who can tweak Twinkle scripts to suit your site. The Twinkle developers are happy to help these efforts, to a reasonable degree: just ask at WT:TW, or join the #wikipedia-userscripts IRC channel (but be prepared to wait for an answer).
  • The morebits.js library is likely to be of use to script developers, both here on English Wikipedia and other MediaWiki-based wikis. The latest version can be found at the Twinkle GitHub repository. The comment at the top of the file should be read to find out more.