User:Mike.lifeguard/Twinkle Speedy documentation

Twinkle Speedy, still in beta^(bugs), is a script that administrators, editors and rolbackers may use to help make new page patrolling and related tasks easier. This script tags pages, and notifies users as required for many of the most common things you'll need templates for while patrolling using the familiar Twinkle interface. The script cannot be used unless you have the appropriate rights; the script will probably fail in Internet Explorer, has been tested in Firefox, and may work in Opera, Camino, Google Chrome, and Safari.

This script allows tagging for speedy deletion, VFD, copyvio, no license info, NowCommons, and more. As well, the script will leave a message on the user's talk page when a standard template message exists.

As with the original Twinkle script, all edits made are your responsibility regardless of bugs in the script. If that scares you, then wait until there are no more bugs. If you or the script make mistakes, clean them up; it's not the end of the world. But if you're recklessly making a big mess, and I see it, you'll probably have your access to this script removed by me. Also, the tooltips are not policy - you're responsible for knowing what Wikibooks policies and guidelines are, and following them.

What does the script do?

Allows you to speedily tag for ~~deletion~~ many things (below), and notify users on their talk page as required.

This script is considered mostly stable, but still in development. It will likely be beta in perpetuity. Bug reports and feature requests can be listed here.

Installation

The easiest way to install this script is through my preferences (Gadgets tab) - check off the box for Twinkle Speedy and click save.

Beta Version (mostly stable): This will become a Gadgets option at some point in the future when bugs are gone and expansion of functionality is complete. For now, you may add the following lines to your monobook.js to use the semi-stable version:

import_script('MediaWiki:Gadget-morebits.js');
import_script('MediaWiki:Gadget-twinklespeedy.js');

Save the page

Alpha Version (development): A development version (not for the faint of heart; this will frequently be broken) is available for those who want to help with development.

import_script('MediaWiki:Gadget-morebits.js');
import_script('User:Mike.lifeguard/TSdev.js');

Save the page

Purge your browser cache: After saving, you may have to bypass your browser's cache to see the changes. Mozilla / Firefox / Safari: hold down Shift while clicking Reload, or press Ctrl-Shift-R (Cmd-Shift-R on Apple Mac); Konqueror: simply click the Reload button, or press F5; Opera users may need to completely clear their cache in Tools→Preferences.

Users of Opera or old versions of Firefox, Camino or Safari: You should enable JavaScript Standard Library in my preferences (Gadgets tab) for the best chance of this script working properly.

Tag-only, don't delete

The red rectangle indicates the three main settings. The first is Tag only, don't delete which is checked by default to keep admins from deleting. The script will fail if non-admins try to use the script with this box unchecked. The second is Orphan backlinks, which is unchecked by default. This is currently buggy, and shouldn't be used. The third option is Notify if possible, which is checked by default. This will leave the appropriate template message on the relevant user's talk page. If there is no template message for the option you've selected, this will have no effect. When tagging many pages or images of a single user, please uncheck this to avoid flooding their talk page. The green rectangle indicates options available for all pages. The purple arrow indicates an option available only in the userspace.

Admins should be careful to note whether the "tag page only, don't delete" box is checked, as the options do different things based on this. You will get incorrect behaviour if you're not paying attention. The box is checked by default so you won't delete pages by accident. You'll have to remove the safety if you want to use the big gun.

Note that not all of these options apply to new page patrol, but are included here for convenience.

Notifying/warning users

Please be careful with this checkbox. When enabled, it will notify users when appropriate. If you're tagging many pages or images by the same user, please disable it after the first one so that they're not inundated with template messages. Instead leave them a note that "this applies to all your uploads." You can only notify the user for these cases; all other cases must be done manually.

Templates used

If you have never seen or used these templates, please familiarize yourself with policy, and read the templates in their entirety before using them.

Users will be notified when using the following options:

{{vfd}} → {{subst:Vfd warning|Page|~~~~}}
{{query}} → {{subst:Query notice|Page|~~~~}}
{{copyvio}} → {{subst:Nothanks|Page|~~~~}}
{{subst:nld}} → {{subst:Image copyright|Image|~~~~}}
{{subst:nfur}} → {{subst:Image fairuse|Image|~~~~}}
{{subst:bfu}} → {{subst:Image badfairuse|Image|~~~~}}
{{split}}
{{cleanup-nc}}
{{transwiki|WikiWiki}}

Orphan backlinks

This feature is currently buggy; I advise you not to use it for now

This allows you to unlink the page from other pages in the main namespace. The script will orphan backlinks when on the following options:

Nonsense, spam or vandalism pages
Copyright violations (text or images)
Foreign language content
Pages with no content
Corrupt images
Images with no license information (these images shouldn't be used until this info is provided)
Fair use images with no rationale (these images shouldn't be used until this info is provided)
Images with a bad license (these images shouldn't be used until this info is provided)

Tagging and deleting

Admins are reminded that each radio button does a different thing based on whether the Tag-only box is checked or not. In essence, the Tag-only is for the beginning of a process, and disabling it (to enable deletion) is for the end of a process. For speedy deletion, where the start and end are the same if you're an admin (just delete it) then you're welcome to go ahead with Tag-only off and delete.

Image options

In the Image: namespace, additional options are available, and the content namespace options are not available. Template names are shown in some cases for clarity.

Duplicate image: {{delete}}

If tag-only: Tag the image for deletion because it is a duplicate of some other image. Have the image name ready at the prompt (no Image: prefix)
If deleting: Deletes the image because it is a duplicate of some other image. Have the image name ready at the prompt (no Image: prefix).

Corrupt or empty image: {{delete}}

If tag-only: Tag this image for deletion because it is corrupt or empty.
If deleting: Deletes the image because it is corrupt or empty.

Improper license: {{delete}}

Tag-only: will tag this image for deletion because it's marked as "for non-commercial use only", "non-derivative use" or "used with permission."
If deleting: will delete the image because it has a bad license.

Lack of licensing information: {{subst:nld}}

Tag-only: Tags an image with {{subst:nld}} and notifies the uploader. Please unselect notification to leave only one notification when tagging multiple uploads by the same user.
If deleting: Admins can delete images tagged with {{subst:nld}} for over 7 days with this option.

Unused unfree copyrighted images: {{delete}}

Tag-only: This will tag images for deletion because they are unused, but have a fair use claim.
If deleting: Admins may delete images which are unused, but have a fair use claim after they've been tagged as such for 7 days.

Missing fair-use rationale: {{subst:nfur}}

Tag-only: Tags images with a fair use claim but no rationale.
If deleting: Admins may delete images with this option when they have been tagged for over 7 days as not having a fair use rationale.

Invalid fair-use claim: {{subst:bfu}}

Tag-only: Tags this image because it has an obviously bad fair use claim, or otherwise invalid license like "non-commercial use only" etc.
If deleting: Admins may use this to delete images with obviously bad fair use claims.

Images available as bit-for-bit identical copies on Commons: {{nowcommons}}

Tag-only: Tags the image with {{nowcommons}}.
If deleting: Check that if the filename on commons is different from here that all links are updated. This tool will unlink images if you let it; BE CAREFUL and check the checkbox - do you really want to unlink the image? Check that the commons image exists, is the same, and has good license and source info. Have the commons image name (no Image: prefix) ready at the prompt.

Image copyright violation: {{copyvio}}

Tag-only: Tags the image with {{copyvio}}. Please have the source ready at the prompt (full url including http://) if available. If not, then enter a short reason why you think it's a copyvio.
If deleting: Admins may use this to delete images which have been tagged with {{copyvio}} for over 7 days. You should allow TW to unlink these images.

Modules

In the content namespaces, some additional options are available.

{{query}}

Tag-only: This will tag a page with {{query}}. You may add an optional comment in this template.
If deleting: Admins can use this option to delete a page that has been tagged with {{query}} for over 7 days (only). For pages that have no meaningful content but haven't been tagged (and don't deserve to be), use the general deletion option, and provide a reason when prompted.

No meaningful content: {{delete}}

Tag-only: This will add a deletion template.
If deleting: Admins can use this option to delete pages with no meaningful content.

{{new book}}

Tag-only: This will add {{new book}}
If deleting: Impossible; you'll generate a warning and nothing will happen

{{transwiki}}

Tag-only: This will tag a page for transwiki.
If deleting: Admins may use this to delete a page after the transwiki is complete.

{{split}}

Tag-only: This will tag a page for being too long
If deleting: This will delete the page, so don't do this. A fix is coming.

General criteria

Nonsense, spam or vandalism page: {{delete}}

Tag-only: Tags the page for speedy deletion because it's a bad page.
If deleting: Admins may delete nonsense pages here.

Recreation of deleted material: {{delete}}; Tag-only: Will tag this page for speedy deletion because it's a repost of content previously deleted at WB:VFD.; If deleting: Admins may delete reposted content here. Consider create-protection depending on the logs.

VFD: {{vfd}}

Tag-only: You'll tag it for deletion by VFD; create the appropriate section at WB:VFD.
If deleting: Admins may use this to delete after a VFD (please have the pagename of the archived discussion ready at the prompt).

Generic Speedy deletion: {{delete}}

Tag-only: You'll be prompted for a reason.
If deleting: Admins can use this for speedy deletions which don't fit elsewhere. Have a reason ready at the prompt.

Author requests deletion: {{delete}}

Tag-only: Use this to request deletion of your own pages, or request speedy deletions for another user.
If deleting: Admins can delete page by author request here.

Author blanked: {{delete}}

Tag-only: Tags a page for deletion if the author blanked it.
If deleting: Admins may take a blanking by the only author to be a deletion request and delete here.

Talk pages whose corresponding module does not exist: {{delete}}

Tag-only: This will tag the page for deletion because the corresponding page doesn't exist.
If deleting: Admins may delete talk pages with no content page here. CAREFUL: this doesn't apply to talk page archives or pages in the User talk: namespace.

Copyright violation: {{copyvio}}

Tag-only: Adds {{copyvio}}; please have the url ready at the prompt including http://
If deleting: Admins can use this to delete a page tagged with {{copyvio}} for more than 7 days. Have the source ready at the prompt

Redirects

Redirects to nonexistent pages: {{delete}}

Tag-only: This will tag the page for deletion because it redirects to a nonexistent page
If deleting: Admins may use this to delete broken redirects.

Orphaned redirects: {{delete}}

Tag-only: This will tag the page for deletion because it's an orphaned redirect.
If deleting: Admins can delete orphaned redirects here when they're not needed (keep, for example, common misspellings)

User pages

User request: {{delete}}

Tag-only: Use this to request deletion of pages in your userspace.
If deleting: Admins may use this to delete pages in the userspace upon request.

Templates

Template for deletion: {{delete}}

Tag-only: Use this to request deletion of templates.
If deleting: Admins may delete templates with this option.

Bug reports

Report bugs here by adding a bullet with the problem or request and signing it.