Template:Gadget-desc/doc
{{#ifeq:doc |doc
|
{{#ifeq:show |show
| {{ {{#switch: {{#if: | | {{#if: | {{#ifeq:| | talk | }} | {{#ifeq:template|template talk | talk | template }} }} }}
| main | = ambox | talk = tmbox | user = ombox | wikipedia = ombox | file | image = imbox | mediawiki = ombox | template = ombox | help = ombox | category = cmbox | portal = ombox | book = ombox | other | #default = ombox
}}
| type = notice
| image =
| imageright =
| style = margin-bottom:1.0em;
| textstyle =
| text = This is a documentation subpage for Template:Gadget-desc.
It contains usage information, categories and other content that is not part of the original {{#if: |{{{text2}}} |{{#if: |{{{text1}}} |{{#ifeq:Template |User |template template page |{{#if:Template |template page|article}}}}}}}}.
| small =
| smallimage =
| smallimageright =
| smalltext =
}}
}}{{#if: | | {{#ifexist:Template:Gadget-desc | [[Category:{{#switch:Template |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]] | }} }} | }}
This is for use on Special:Gadgets to provide consistently formatted descriptions of gadgets.
Parameter name | Description | Required or optional? |
---|---|---|
parameter #1 (1) | description of the gadget (start with a capital letter) | required |
self | the full name of the MediaWiki-gadget-description-page e.g. MediaWiki:Gadget-Gallerypreview/de | required |
name | name of the gadget | optional (some don't have one or is not important) |
talk | talk page where users can discuss the gadget | optional (but recommended) |
usergroup | indicate if a gadget is for a specific usergroup: admins, OTRS-members, etc. | optional |
skin | indicate if a gadget is for a specific skin: monobook, vector, etc. | optional |
status | indicate the status: beta, alpha, testing | optional (stable/working gadgets don't need this) |
doc | page name where the gadget is documented | optional |
example | page name where there's an example of the gadget | optional |
Relies on
- {{Gadget-translatelabel}} (for language logic), which in turn uses {{Gadget-translation}} (for the "please translate" link), which in turn uses {{Gadget-translation-editintro}} as an editintro
- {{Gadget-state}} and {{Gadget-state/default}}, using {{Default-tag}} for the “default gadget” mark; also {{Deprecated-tag}}.
See also
- {{Gadget-talk}}
- {{Gadget-help}}