The Sims Wiki:Twinkle/doc

Installation
To install Twinkle, first make sure that you are an autoconfirmed user. Autoconfirmed users have been registered on the wiki for at least four days and have made at least ten edits to the wiki. You won't be able to use Twinkle if you don't meet this requirement.

Next, make sure JavaScript is enabled in your browser. You should be using the latest version of any modern browser, like Google Chrome or Mozilla Firefox. Twinkle doesn't work on Internet Explorer 8 or earlier.

Then, follow these steps in order:
 * 1) Go to your preferences page
 * 2) Click on the "Gadgets" tab
 * 3) Click on the checkbox next to where it says ""
 * 4) Click '' at the bottom of the page

Twinkle should now be installed and ready to go. Make sure you understand The Sims Wiki's policies before making any edits.

Experimenting with Twinkle
Do not experiment with Twinkle randomly on any page. Because Twinkle makes real edits that can notify real users and administrators, you should not test Twinkle on articles or on most pages. You can usually test Twinkle in your own userspace, but keep in mind that some actions will still notify administrators, even if only momentarily.

You can safely test issuing user warnings to users on User talk:192.0.2.16 and User talk:2001:DB8:10:0:0:0:0:1. Since those IP addresses aren't connected to anybody, nobody will be notified.

Modules
Twinkle is made up of many different "modules" that each provide a quicker way of carrying out a specific maintenance task. Most of these modules can be accessed under the "TW" dropdown menu at the top of each page. Some modules only appear on specific page types. For example, the "User warning" module only appears on user talk pages.

Reverting
Twinkle adds four different revert links at the top of every diff page.

Restore this version
The "Restore this version" link appears above any revision that is not the latest version of the page. When used, it will ask you to provide an optional edit summary, and then will revert the page to that revision, undoing any changes made since.

Rollback
If the newer version in the diff is the latest version of the page, Twinkle will display three "rollback" links instead of the "Restore this version" link. All are functionally identical in that they will revert all consecutive edits made by the same author to the last revision not made by that author. It is like the rollback tool, only that non-rollbackers can use it.


 * "rollback (AGF) " will ask you for an edit summary when clicked. It will then revert the edit with an assume good faith label. This is good if you need to revert edits made in good faith but don't want to sound so harsh and cold.
 * "rollback " will ask you for an edit summary when clicked, and then revert the edit with a standard label.
 * "rollback (VANDAL) " works like regular MediaWiki rollback; it will not ask you for an edit summary and will work without confirmation by default.

Twinkle's rollback links should not be confused with the default MediaWiki rollback tool. MediaWiki rollback is clearly distinguished from Twinkle rollback in that it will appear next to the username of the user who made the edit, while Twinkle rollback appears above the timestamp of the edit. MediaWiki rollback will also tell you how many edits it will revert when clicked. MediaWiki rollback is only available to administrators, content moderators, and users who have been explicitly granted the tool. The end result of both Twinkle and MediaWiki rollback are the same (in that the page is reverted to the last edit not made by the most recent author), although technically they revert in different ways. MediaWiki rollback uses a functionality built into the software itself, while Twinkle rollback performs a series of undos until it reaches the desired edit, then saves the edit. Twinkle rollback is also only capable of reverting up to 50 edits at once.

Welcoming users
A welcome link will appear next to the username in the diff view if the user's talk page is empty.

Warning users
Twinkle lets you leave a templated user warning message on a user's user talk page. To use, click the "Warn" tab. A window will appear with the following options:


 * Two dropdown menus: the menu at the top lets you select the warning level or warning type, while the bottom lets you select from a list of warnings under that warning type.
 * Linked page: the article name to reference for the warning. If you used Twinkle's rollback links and have popups enabled in your browser, this will automatically be filled.
 * Any additional comments you want to be included at the end of the warning message.
 * Preview: this lets you preview the warning message that will be sent to the user.

Click Submit to post the chosen warning and message to the user's talk page. The page will then reload shortly after.

You can add your own custom list of warning messages that displays below the default set of warning templates. Visit your Twinkle preferences and look under the "Warn user" section.