Documentation and configuration
Before using Twinkle, you should read its documentation to familiarize yourself with its possibilities and functions. Experienced Twinkle users are welcome to expand or improve the documentation based on their use of the tool.
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 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.
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.
Twinkle has its origins as a reversion script based on ideas found in Aaron Schulz's script collection. It was developed by AzaToth and released in 2007. It has grown into a tool with many more capabilities than its reversion roots and is used by thousands of Wikipedians. The toolset has expanded over the years: the collection of tools formerly known as Friendly, developed by Ioeth, became part of Twinkle in 2011, and a new module to make user blocking a smoother process for administrators was developed in 2015. Other major contributors include Amalthea, MusikAnimal, and This, that and the other. The gadget continues to be updated and improved, in order to accommodate user requests and changes to Wikipedia processes.
Use 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.
morebits.jslibrary 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.