Template:Gadget/doc

Documentation

[purge]

This template is used on the description pages of gadgets to provide a standardized documentation.

Usage

{{ gadget | <name> | <description> | <internal name> | default = y/yes | nojs = y/yes | css = y/yes }}

First unnamed parameter

Name of the gadget.

Second unnamed parameter

Description of the gadget.

Third unnamed parameter

Internal name of the gadget. This corresponds to the title of the gadget's MediaWiki description page, without the MediaWiki:Gadget- part. For the Reference Tooltips gadget (description page: MediaWiki:Gadget-ReferenceTooltips), for instance, this would be ReferenceTooltips.

default

Indicates that the gadget is enabled by default.

nojs

Suppresses the "source" link that points to the gadget's JS page by default. This is useful for CSS-only gadgets.

css

Adds a link to the gadget's style page (MediaWiki:Gadget-$3.css).

Examples

Code	Result
{{gadget|Reference Tooltips|Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).|ReferenceTooltips}}	Reference Tooltips: Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).[source]
{{gadget|Reference Tooltips|Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).|ReferenceTooltips|default=yes}}	(Def) Reference Tooltips: Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).[source]
{{gadget|Reference Tooltips|Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).|ReferenceTooltips|css=yes}}	Reference Tooltips: Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).[source | css]
{{gadget|Reference Tooltips|Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).|ReferenceTooltips|nojs=yes|css=yes}}	Reference Tooltips: Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).[css]
{{gadget|Reference Tooltips|Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).|ReferenceTooltips|nojs=yes}}	Reference Tooltips: Hover over inline citations to see reference information without moving away from the article text (does not work if "Navigation popups" is enabled above).

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.