|Warning: You take full responsibility for any action you perform using any gadget. You must understand Wikipedia policies and use this tool within these policies, or risk being blocked from editing.|
|Subject namespaces||Talk namespaces|
|2302||Gadget definition||Gadget definition talk||2303|
General criteria for gadgets
In order to be deployed on the English language Wikipedia, gadgets should generally pass the following conditions:
- Gadgets must work if just included with no further configuration. They can be configurable via personal common.js, but must work unconfigured.
- Gadgets must be compatible with all major browsers, i.e. they must not terminate with errors.
- Gadgets should be functional in most major browsers (cross-browser compatibility). Exceptions must be clearly stated.
- Duplication of gadgets should only be made if it is reasonable.
- Collections of scripts should be split if they have disparate functions.
- Gadgets requiring permissions must be marked and must fail gracefully if the permissions aren't present.
- Gadgets only working in some skins must be marked as such if that data is available.
New gadgets should be proposed at the technical Village Pump.
Historically, new gadgets were proposed at a subpage of this page, but that page was marked historical due to low participation. Also, existing WikiProject User scripts used to be evaluated for conversion to gadgets, but that process has also been marked historical.
- Add the header below and the script code to MediaWiki:Gadget-scriptname.js
- Optionally, add the header below and CSS code to MediaWiki:Gadget-scriptname.css
- Add a script description to MediaWiki:Gadget-scriptname. Please link to the script home and/or help page and state browser requirements if needed.
- Add to MediaWiki:Gadgets-definition under the appropriate heading
The gadget should now appear on Special:Gadgets.
Comments or warnings can be added to the gadget description templates in two ways:
- noinclude tag (visible on description page with links):
<noinclude> comment </noinclude>
- HTML comments (visible in source text only):
<!-- comment -->
Comments added in this way will be automatically discarded during the page creation process.
The following header is to be added to the gadget files:
/* _____________________________________________________________________________ * | | * | === WARNING: GLOBAL GADGET FILE === | * | Changes to this page affect many users. | * | Please discuss changes on the talk page or on [[WT:Gadget]] before editing. | * |_____________________________________________________________________________| * * Imported from version XXXX as of DATE from [[SCRIPT_SOURCE]] * SHORT_DESCRIPTION, see [[SCRIPT_HOME_PAGE]] */
A gadget with
default keyword is enabled for all Wikipedia visitors and only registered users can disable it.
A gadget with
[default|rights=minoredit] description would be automatically enabled only for registered users.
Currently installed gadgets
Users can browse a list of all available gadgets in the gadgets section of their preferences page:
See Special:Gadgets for a list of all active gadgets and links to their script files.
- MediaWiki talk:Gadgets-definition, discussing technical details of making and maintaining gadgets
- Special:GadgetUsage, provides statistics on gadget usage
- mw:Extension:Gadgets, the Mediawiki gadget extension page
- Template:Bug report, template message asking for detailed bug-related information
- mw:Gadget kitchen, tutorial on writing gadgets