Help:Gadget-Twinkle

From: Everything Food & Drink.org
Jump to: navigation, search
Shortcuts:
EFD:TWINKLE
EFD:TW
Mr. Twinkly

Twinkle is a set of JavaScript functions that gives autoconfirmed registered users many extra options to assist them in common Everything Food & Drink project 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 wiki users.

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


Quick info[edit]

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. Note that some of your browser's 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 reloading the page.
Getting help
There is comprehensive developer information about Twinkle at the documentation page. If that page does not answer your question, consider asking locally here Twinkle talk page or Twinkle's home talk page at Wikipedia. IRC users and developers can connect to Wikipedia's channels #wikipedia-userscripts connect or #wikipedia-en connect or if you need local help, this projects IRC channel #everythingfoodanddrink connect, if you do not have a IRC client you can still connect through this website, here.
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.
Note
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 IE10 respectively, under which Twinkle will work. If you have Windows XP (which can't be upgraded past IE8) or earlier, try installing another browser, as Twinkle should be functional on most other modern browsers. Twinkle should work on most modern stock Android browsers and Chrome OS.

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?[edit]

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[edit]

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 behaviors of Twinkle.

Abuse[edit]

Shortcuts:
EFD:TWINKLEABUSE
EFD:TWABUSE

Never forget that one takes full responsibility for any action performed using Twinkle. One must understand project policies and guidelines 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[edit]

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

Code Result Users
{{Template:UBX/Twinkle}}
Police man Twinkle Head.svg This user watches over
Everything Food & Drink project with the help of Twinkle!
Transclusions

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

Twinkle on other wikis[edit]

See:Wikipedia:Twinkle/Localization