Open main menu

Header for the documentation pages of gadgets. ? use 'gadget' parameter to allow use on non-gadget scripts

The template automatically sets the following categories: Category:User scripts needing internationalisation, if il8n is 'missing' or empty. Sets Category:Gadget scripts, unless category is set.

Usage

{{Gadget-talk/doc |name= |script= |doc= |talk= |gadgeturl= |il8n= |il8ndetails= |category= }}

Template parameters

ParameterDescriptionDefaultStatus
namename of the Gadget - to help users recognise it in their Preferences{{BASEPAGENAME}} (the name of the page, without the namespace)optional
scriptlocation of the Javascript page of the Gadget. Exclude the namespace (MediaWiki:) and extension (.js).MediaWiki:{{BASEPAGENAME}}.js (the name of the documentation page, without the namespace and MediaWiki: prefixed and .js suffixed)required
doclocation of the documentation page of the Gadget. Use the full pagename.emptyoptional
talklocation of the documentation page of the Gadget. Use the full pagename.emptyoptional
gadgeturllocation of the gadget description page of the Gadget. This is normally the same as script, but if it isn't, use this parameter to distinguish. Use the full pagename.emptyoptional
il8nrecord il8n type/status/requirement. Values: missing/notneeded/internal/subpage-internal/subpage-entire/mediawiki-msg.emptyoptional
il8ndetailsrecord il8n details relevant to il8n typeemptyoptional
categoryprevents autocategorising in Category:Gadget scripts, and instead categorises in 'category'. 'Category' should be given without wikilinks or the 'Category:' namespace, i.e. Category:User scripts should be given as User scriptsemptyoptional

Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: no user group specified

Relies on:
{{Lang links}}