https://wiki.tachyony.co.uk/w/index.php?action=history&feed=atom&title=Wikipedia%3AGadgetWikipedia:Gadget - Revision history2026-05-16T00:34:51ZRevision history for this page on the wikiMediaWiki 1.35.5https://wiki.tachyony.co.uk/w/index.php?title=Wikipedia:Gadget&diff=1373&oldid=prevTachyony: Imported page2021-12-06T12:00:05Z<p>Imported page</p>
<p><b>New page</b></p><div>{{Wikipedia programs}}<br />
{{Information page|WP:GADGET|WP:GADGETS}}<br />
{{Tool warning|any gadget}}<br />
{{Namespaces}}<br />
A '''Wikipedia gadget''' is a [[JavaScript]] program and/or a [[CSS]] [[Snippet (programming)|snippet]] that can be enabled simply by checking an option in your [[Special:Preferences#mw-prefsection-gadgets|preferences]]. The gadget's function is provided by the [[MediaWiki]] extension [[mw:Extension:Gadgets|Gadgets]].<br />
<br />
Many gadgets started out as [[Wikipedia:User scripts|user scripts]]. Once a user script is approved as a gadget, it is removed from [[Wikipedia:User scripts/List]].<br />
<br />
== General criteria for gadgets ==<br />
In order to be deployed on the English language Wikipedia, gadgets should generally pass the following conditions:<br />
<br />
# Gadgets '''must''' work if just included with no further configuration. They can be configurable via [[Special:MyPage/common.js|personal common.js]], but must work unconfigured.<br />
# Gadgets '''must''' be compatible with all major browsers, i.e., they must not terminate with errors.<br />
# Gadgets '''should''' be functional in most major browsers (cross-browser compatibility). Exceptions must be clearly stated.<br />
# Duplication of gadgets '''should''' only be made if it is reasonable.<br />
# Collections of scripts '''should''' be split if they have disparate functions.<br />
# Gadgets requiring permissions '''must''' be marked and must fail gracefully if the permissions aren't present.<br />
# Gadgets only working in some skins '''must''' be marked as such if that data is available.<br />
<br />
== Proposals ==<br />
<br />
New gadgets should be proposed at [[WP:VPT|the technical Village Pump]].<br />
<br />
Historically, new gadgets were proposed at [[Wikipedia:Gadget/proposals|a subpage of this page]], but that page was marked historical due to low participation. Also, existing [[Wikipedia:WikiProject User scripts|WikiProject User scripts]] used to be [[Wikipedia:Gadget/evaluation|evaluated]] for conversion to gadgets, but that process has also been marked historical.<br />
<br />
== Installation ==<br />
<br />
Gadgets can be installed after discussion at the [[Wikipedia:Village pump (technical)|technical section of the village pump]] by [[Wikipedia:Interface administrators|interface administrator]]s in the following way:<br />
<br />
# Add the [[#Header|header]] below and the script code to MediaWiki:Gadget-''scriptname''.js<br />
# Optionally, add the [[#Header|header]] below and [[Cascading Style Sheets|CSS]] code to MediaWiki:Gadget-''scriptname''.css<br />
# Add a script description to MediaWiki:Gadget-''scriptname''. Please link to the script home and/or help page and state browser requirements if needed.<br />
# Add to [[MediaWiki:Gadgets-definition]] under the appropriate heading <br />
#: <syntaxhighlight lang="moin"> * scriptname|scriptname.js[|scriptname.css|otherscript.js|...]</syntaxhighlight><br />
<br />
The gadget should now appear on [[Special:Gadgets]].<br />
<br />
=== Comments ===<br />
<br />
Comments or warnings can be added to the gadget description templates in two ways:<br />
<br />
* noinclude tag (visible on description page with links): ''<code><nowiki><noinclude> comment </noinclude></nowiki></code>'' <br />
* HTML comments (visible in source text only): ''<code><nowiki><!-- comment --></nowiki></code>'' <br />
<br />
Comments added in this way will be automatically discarded during the page creation process.<br />
<br />
=== Header ===<br />
<br />
The following header is to be added to the gadget files:<br />
<syntaxhighlight lang="js"><br />
/* _____________________________________________________________________________<br />
* | |<br />
* | === WARNING: GLOBAL GADGET FILE === |<br />
* | Changes to this page affect many users. |<br />
* | Please discuss changes on the talk page or on [[WT:Gadget]] before editing. |<br />
* |_____________________________________________________________________________|<br />
* <br />
* Imported from version XXXX as of DATE from [[SCRIPT_SOURCE]]<br />
* SHORT_DESCRIPTION, see [[SCRIPT_HOME_PAGE]]<br />
*/<br />
</syntaxhighlight><br />
<br />
=== Default gadgets ===<br />
A gadget with [[mw:Extension:Gadgets#Options|<code>default</code>]] keyword is enabled for all Wikipedia visitors and only registered users can disable it. <br />
<br />
A gadget with <code>[default|rights=minoredit]</code> description would be automatically enabled only for registered users.<br />
<br />
== Currently installed gadgets ==<br />
Users can browse a list of all available gadgets in the gadgets section of their preferences page:<br />
<br />
{{myprefs|Gadgets}}<br />
<br />
See [[Special:Gadgets]] for a list of all active gadgets and links to their script files.<br />
<br />
== See also ==<br />
* [[MediaWiki talk:Gadgets-definition]], discussing technical details of making and maintaining gadgets<br />
* [[Special:GadgetUsage]], provides statistics on gadget usage<br />
* [[mw:Extension:Gadgets]], the Mediawiki gadget extension page<br />
* [[Template:Bug report]], template message asking for detailed bug-related information<br />
* [[mw:Gadget kitchen]], tutorial on writing gadgets<br />
* [[Wikipedia:Gadget/Repositories]], a list of version control repositories for gadgets and user scripts<br />
<br />
{{Wikipedia technical help|collapsed}}<br />
<br />
[[Category:Wikipedia scripts| ]]</div>Tachyony