 | Warning: You take full responsibility for any action you perform using Twinkle. You must understand Bharatpedia policies and use this tool within these policies, or risk being blocked from editing. |
Once Twinkle is enabled, you will be presented with a number of additional tabs, links, or menu options, depending on the page you are viewing and the permissions available to your account.
Installation[edit source]
Installing Twinkle is easy. Open your Preferences page, go to the Gadgets section, find Twinkle, enable it, and click Save.
Once enabled, Twinkle will load automatically when you use Bharatpedia.
Before you start using Twinkle, you should read this page to familiarize yourself with some of the possibilities and functions of Twinkle. There are numerous options that can be configured to change some of Twinkle's default behaviours.
Twinkle practice / sandbox[edit source]
Practice pages can be used to test some of Twinkle's functions before using them on real pages.
For testing page tagging and other editing functions, use the designated Bharatpedia sandbox or another page specifically intended for testing.
For testing user warnings, welcomes, and other user-talk functions, use a designated user-warning test page where available.
Do not use practice pages to test actions that create real deletion requests, protection requests, administrative reports, or other notifications on operational pages.
Similarly, do not use sandbox pages to test functions that would remove backlinks or otherwise make changes to pages outside the sandbox.
Troubleshooting installation[edit source]
Twinkle may fail to load or function correctly for several reasons:
- You must be using an account that is permitted to use the Twinkle gadget. Access to individual Twinkle functions may depend on your Bharatpedia user rights.
- You must use a supported modern web browser with JavaScript enabled.
- After enabling Twinkle, you may need to reload the page or clear your browser cache before changes become visible.
- Browser extensions that modify JavaScript, page content, or the MediaWiki interface may interfere with Twinkle.
- If you have recently changed skins, check whether the current skin is supported by the Bharatpedia implementation of Twinkle.
- If you are using a touchscreen device, you may need to tap or hold the Twinkle button or menu to display its options, depending on the skin.
If you have tried the above suggestions and still cannot use Twinkle, or if you notice another problem, report the issue on the appropriate Bharatpedia Twinkle discussion or technical-support page.
When reporting a problem, include:
- What behaviour are you seeing?
- What behaviour were you expecting?
- How can the incorrect behaviour be reproduced? Describe exactly what you are doing and seeing.
- Confirm that you have tried refreshing or bypassing your browser cache.
- Note your browser and browser version.
- Note your operating system and operating system version.
- Include relevant JavaScript errors reported by your browser.
- Identify the page or Twinkle function where the problem occurred.
To obtain JavaScript errors, open your browser's developer tools and select the Console tab. The exact procedure varies between browsers.
When reporting a technical problem, provide the complete relevant error message rather than only saying that "JavaScript does not work".
Installing individual Twinkle modules[edit source]
Twinkle is intended to be installed and updated as a single gadget.
Individual Twinkle modules should not normally be installed separately. The available modules are part of the Bharatpedia Twinkle implementation and may depend on shared Twinkle functionality.
Modules[edit source]
Twinkle is made up of many "modules", each providing a quicker way of carrying out a particular maintenance task.
Depending on the Bharatpedia skin and configuration, modules may be accessible through tabs, a TW menu, a drop-down menu, links beside revision controls, or other interface elements.
Some modules appear only on particular types of pages. For example, certain functions are available when viewing a diff, a user page, a user contribution page, a file, a redirect, or another specific page type.
The exact modules available on Bharatpedia depend on the current Twinkle implementation and the permissions associated with the user's account.
CSD (speedy deletion)[edit source]
CSD stands for Criteria for Speedy Deletion.
If a page meets one of Bharatpedia's applicable speedy deletion criteria, the Twinkle CSD module can be used to quickly tag the page for deletion.
Using this module[edit source]
Click the CSD option in Twinkle.
You will be presented with a list of available reasons. The available reasons may differ depending on the namespace of the page being viewed.
After selecting a criterion, review the information requested by Twinkle and confirm the action.
You may be prompted for additional information, such as a rationale, URL, copyright information, or another explanation required by the selected criterion.
Twinkle will then add the appropriate deletion template to the page.
- If the Notify if possible option is enabled and the relevant notification template is available, the user who created the page may be notified.
- The Tag with multiple criteria option allows several applicable deletion criteria to be selected where supported by the Bharatpedia configuration.
- Twinkle may provide a userspace log for deletion nominations. This can be useful for tracking pages that were nominated and later deleted or declined.
- Depending on the configuration and the selected criterion, the page may be added to your watchlist.
- Some actions may automatically mark a page as patrolled where the user's permissions and Bharatpedia's configuration allow this.
Take note[edit source]
Twinkle provides a quick way to nominate pages for speedy deletion, but users remain responsible for the actions they perform.
Think carefully before applying a speedy-deletion tag, particularly in borderline cases.
If the issue is not clearly covered by a speedy deletion criterion, another maintenance or deletion process may be more appropriate.
Extra functionality for administrators[edit source]
Administrators may have additional CSD functionality through Twinkle, including tools to delete pages that have been appropriately tagged.
The exact administrative functions depend on the Bharatpedia configuration and the permissions assigned to the administrator.
RPP/PP (page protection)[edit source]
RPP/PP is used for page-protection-related actions.
Depending on the Bharatpedia configuration, it may be used to request protection or unprotection, apply protection-related templates, or, for users with the appropriate permissions, directly protect or unprotect pages.
Using this module[edit source]
Click the RPP or PP option on the relevant page.
Depending on the available functions, you may be prompted to select the type of action.
Possible actions may include:
- Request page protection: Used to request protection of a page. You may need to specify the type of protection, reason, and duration.
- Tag page with protection template: Used where the relevant protection template should be placed on a page.
- Apply page protection: Available only to users with the appropriate administrative permissions.
The exact options displayed depend on the Bharatpedia implementation.
Take note[edit source]
If you open the protection module on a page that does not exist, some protection-related options may not be available.
Extra functionality for administrators[edit source]
Administrators may have access to additional tools for directly applying or removing page protection.
PROD (proposed deletion)[edit source]
PROD is short for Proposed deletion.
Where Bharatpedia uses a proposed-deletion process, Twinkle can be used to apply the appropriate proposed-deletion tag.
The availability and operation of PROD depend on Bharatpedia's deletion policies and templates.
Using this module[edit source]
Click the PROD tab or option on the applicable page.
You will be prompted to select the appropriate type of proposed deletion and, where required, enter a reason.
- If the Notify if possible option is enabled, the creator may be notified using the appropriate notification template.
- If a page already contains a proposed-deletion tag, Twinkle may provide an option to endorse or otherwise process the existing nomination where supported.
- A userspace log may be available for tracking proposed-deletion nominations.
- The page may be added to your watchlist according to your Twinkle preferences.
Take note[edit source]
Proposed deletion should be used only where the applicable Bharatpedia process permits it and the deletion is appropriate for that process.
If deletion is likely to be controversial, use the appropriate deletion-discussion process instead.
If the page clearly meets a speedy-deletion criterion, the CSD module may be more appropriate.
Extra functionality for administrators[edit source]
Administrators may have additional functionality for processing or removing proposed-deletion tags where supported.
XfD (deletion discussions)[edit source]
XfD is a collective term for deletion-discussion processes.
Where Bharatpedia provides deletion discussion venues, Twinkle can be used to start the appropriate discussion for a page.
The available deletion venues depend on Bharatpedia's namespace structure and deletion procedures.
Before using XfD, make sure that you understand which deletion venue applies to the page.
Using this module[edit source]
Click the XfD option.
Twinkle will present the deletion-discussion venues supported by the current configuration.
Select the appropriate venue and provide the requested information.
Depending on the venue, Twinkle may:
- add a deletion notice to the page;
- create the deletion discussion;
- add the discussion to the appropriate listing;
- notify the page creator or other relevant users;
- add relevant pages to your watchlist; and
- record the nomination in a userspace log if enabled.
You must provide a reason explaining why the page should be considered for deletion.
Full wiki formatting may be used in the reason where appropriate.
The exact options displayed by the XfD module depend on Bharatpedia's deletion workflows and templates.
Take note[edit source]
Deletion discussions can involve significant editorial consequences. Check that you have selected the correct page and deletion venue before submitting the nomination.
Twinkle may take several seconds to complete a deletion nomination if multiple pages or server-side operations are involved. Do not repeatedly submit the same request simply because the interface appears to pause.
Extra tools for administrators[edit source]
Administrative tools for closing or processing deletion discussions may exist separately from Twinkle. Their availability depends on the Bharatpedia installation.
Last[edit source]
The Last option shows a diff between the current revision of a page and a previous revision.
When viewing a diff, Twinkle may provide additional options such as:
- since;
- since mine; and
- current.
These options make it easier to compare revisions and identify changes that require attention.
Unlink[edit source]
The Unlink option removes backlinks to a page.
Backlinks are links from other pages to a particular page.
Unlinking backlinks can be useful after a page has been deleted or moved when links to the former page should no longer remain.
The availability of this function depends on the user's permissions.
Editors should use this function carefully. Not every backlink should necessarily be removed merely because the target page has been deleted or changed.
Tag[edit source]
The Tag tab allows you to add one or more maintenance templates to an article, redirect, file, or other supported page.
All selected templates will be added to the appropriate location where supported by Twinkle.
For article maintenance templates, Twinkle may automatically populate a date parameter with the current month and year.
When multiple supported maintenance templates are applied to an article, Twinkle may group them inside a multiple-issues template where the relevant template configuration supports this.
Templates that are not supported by the multiple-issues system are added separately.
Twinkle may also allow existing maintenance tags to be removed from supported pages.
On redirect pages, the Tag module may provide redirect-categorization templates where supported.
The exact list of available templates depends on Bharatpedia's configuration.
DI (delayed speedy deletion for files)[edit source]
DI refers to Twinkle's file-related deletion tagging functionality.
Where supported, this module can tag files that lack required information such as copyright information, source information, or other information required by Bharatpedia's file policies.
The exact criteria and templates available depend on Bharatpedia's file-management policies.
ARV[edit source]
ARV provides tools for reporting problematic user activity to the appropriate administrative venue.
When viewing a supported user page or contribution page, the ARV module may provide several reporting options.
Depending on the Bharatpedia configuration, these may include:
- vandalism;
- problematic usernames;
- suspected sockpuppetry;
- edit warring;
- spam or promotional activity; and
- other conduct requiring administrative attention.
The exact reporting venues and criteria depend on Bharatpedia's policies.
Before submitting a report, check that the conduct meets the applicable policy or reporting criterion.
Reports should contain sufficient information and evidence for the reviewing administrator or other authorized user to understand the issue.
Warn (user talk warnings)[edit source]
On user talk pages, the Warn tab allows you to leave one of a variety of warning or notification messages.
To use it, click the Warn option.
Depending on the Bharatpedia configuration, the interface may provide:
- a warning level;
- a warning type;
- the article or page associated with the warning; and
- additional comments.
The article or page field may be automatically populated when the warning follows a Twinkle revert or another supported action.
Clicking Submit posts the selected warning to the user's talk page and may refresh the page.
Twinkle may support a custom list of warning templates. Where available, these can be configured through the Twinkle preferences.
The warning templates available on Bharatpedia depend on the site's user-warning system.
TB (talkback)[edit source]
The TB or Talkback function allows you to leave notification messages on another user's talk page.
It can provide a convenient interface for templates used to direct a user to another discussion or notification.
The templates supported depend on Bharatpedia's configuration.
Additional supported templates may be added as the implementation develops.
Wel (welcome)[edit source]
The Wel tab allows you to welcome a user with a selected template.
If an article or page is specified and the selected welcome template supports an article link, Twinkle may automatically include the specified page in the message.
Twinkle may also support custom welcome templates through the Twinkle preferences.
Editors should select an appropriate welcome template and should avoid sending automated welcome messages where doing so would be inappropriate.
Restore and rollback[edit source]
When viewing a diff between revisions of a page, Twinkle may provide additional links above the diff.
Restore this version[edit source]
The Restore this version option can appear above an older revision.
Using it restores the selected revision by creating a new edit that effectively undoes subsequent changes.
An edit-summary field may be provided so that the reason for restoring the earlier version can be explained.
Rollback[edit source]
When viewing the latest revision of a page, Twinkle may provide rollback links.
Rollback reverts consecutive edits by the same editor immediately preceding the current revision, subject to the permissions and rollback functionality available to the account.
Depending on the implementation, Twinkle may provide several rollback options.
For example:
- rollback (AGF) performs the rollback and provides an edit-summary field with a good-faith-related summary.
- rollback performs the rollback and provides an edit-summary field.
- vandalism performs the rollback and opens the user's talk page so an appropriate warning can be issued.
The exact options may differ on Bharatpedia.
Editors should use rollback only for edits that are appropriate for rapid reversion. It should not be used merely because an edit is undesirable or because an editorial disagreement exists.
A welcome link may also appear next to a user in a diff view where the relevant conditions are met. Depending on preferences, this may automatically welcome the user or open the welcome dialogue.
Modules for administrators[edit source]
As well as having access to additional functionality within some of the main modules, administrators may have access to modules intended specifically for administrative tasks.
The availability of these functions depends on Bharatpedia's user-right configuration.
- Batch deletion ("D-batch")
- This module can allow administrators to delete multiple pages according to a selected list, category, links, or other supported source. Depending on the implementation, it may also provide options to delete associated talk pages, subpages, redirects, or unlink pages.
Batch deletion can be useful when processing large groups of pages, but it can also cause extensive unintended changes if used incorrectly.
Administrators should review the selected pages and options carefully before submitting a batch operation.
- Batch undeletion ("Und-batch")
- Similar to batch deletion, this module can allow administrators to undelete multiple pages according to a supplied list or other supported source.
- Batch protection ("P-batch")
- Similar to batch deletion, this module can allow administrators to protect multiple pages. It can be useful when several pages require protection at the same time.
- De-prod
- See the PROD section above.
Administrative batch tools should be used with particular care because an incorrect configuration can affect many pages at once.
Configuration[edit source]
The easiest way to configure Twinkle is through its preferences panel.
The available configuration options depend on the version of Twinkle installed on Bharatpedia.
The preferences panel allows users to change various default behaviours, including options related to reverting, tagging, warnings, welcoming, notifications, watchlists, and other modules.
Technical details[edit source]
Twinkle stores user-specific configuration in a personal JavaScript options page.
Where supported by the Bharatpedia implementation, this may be:
Special:MyPage/twinkleoptions.js
The preferences panel saves configuration information in a JavaScript object that Twinkle reads when the gadget loads.
For example:
window.Twinkle.prefs = {
"optionsVersion": 2,
"revertMaxRevisions": 13,
"proddeleteChunks": 20,
"watchTaggedPages": true,
"talkbackHeading": "Talkback just for you..."
};Users should not manually edit this file unless they understand JavaScript and the configuration options being changed.
If the preferences panel is available, it should normally be preferred over manual editing.
Advanced parameters[edit source]
Some advanced parameters can be useful when the browser or network connection has difficulty completing Twinkle operations.
These parameters may not be exposed in the normal preferences panel and may need to be changed manually in the user's Twinkle configuration.
Users should avoid changing advanced parameters unless they understand their purpose.
Regular users may be able to use parameters such as:
revertMaxRevisions- Defines the maximum number of revisions queried when Twinkle looks for a suitable earlier revision for rollback or restoration.
Administrators may have additional parameters for controlling batch operations.
batchdeleteChunks- Defines how many pages are processed at a time during batch deletion.
batchMax- Defines the maximum number of pages processed by a batch function.
batchProtectChunks- Defines how many pages are processed at a time during batch protection.
batchundeleteChunks- Defines how many pages are processed at a time during batch undeletion.
proddeleteChunks- Defines how many pages are processed at a time when processing proposed-deletion actions.
The appropriate limits depend on Bharatpedia's MediaWiki configuration and server capabilities.
Users should normally retain the default values unless there is a documented reason to change them.
Hiding individual Twinkle tabs[edit source]
Depending on the Bharatpedia skin, Twinkle modules may appear as individual tabs or menu items.
If too many modules are visible, the Twinkle preferences may provide an option to hide selected modules.
This can be useful for users who regularly use only a subset of Twinkle's functionality.
Default watchlist options[edit source]
Twinkle provides watchlist options for many of its actions.
Depending on the module and the Bharatpedia configuration, an action may:
- add a page to the watchlist indefinitely;
- avoid adding the page to the watchlist;
- follow the site's default watchlist settings; or
- add the page for a specified period where temporary watchlisting is supported.
The available watchlist options depend on Bharatpedia's MediaWiki configuration and the version of Twinkle installed.
Users can configure the default watchlist behaviour through the Twinkle preferences where supported.