Template:Shortcut/doc: Difference between revisions
More actions
m Reverted edits by Be..anyone (talk) to last revision by FDMS4 |
use {{TemplateBox}}, add documentation for three remaining parameters |
||
| Line 1: | Line 1: | ||
{{ | {{TemplateBox | ||
|1 = 1 | |||
|1label-en= shortcut 1 | |||
|1d-en = Name of the first shortcut | |||
|1type = wiki-page-name | |||
|1def = <!-- default value for the parameter --> | |||
|1stat = required | |||
|2 = 2 | |||
|2label-en= shortcut 2 | |||
|2d-en = Name of the second shortcut | |||
|2type = wiki-page-name | |||
|2def = | |||
|2stat = optional- | |||
|3 = 3 | |||
|3label-en= shortcut 3 | |||
|3d-en = Name of the third shortcut | |||
|3type = wiki-page-name | |||
|3def = | |||
|3stat = optional- | |||
|4 = 4 | |||
|4label-en= shortcut 4 | |||
|4d-en = Name of the fourth shortcut | |||
|4type = wiki-page-name | |||
|4def = | |||
|4stat = optional- | |||
|5 = lang | |||
|5label-en= language | |||
|5d-en = Language of the language-dependent output of the template (e.g. “de”). Useful in other templates and translated Commons pages to provide consistent language throughout the template/page | |||
|5type = line | |||
|5def = | |||
|5stat = optional- | |||
|name = shortcut | |||
|desc-en = This template shows the shortcuts of the current page. | |||
|namespace = | |||
|usergroup = | |||
|placement = top | |||
|example-value = | |||
|mustbesubst = | |||
|relieson = | |||
|usage-notes = | |||
|shorthand = | |||
|setscats = | |||
|seealso = | |||
* {{tl|Shortcut2}} to produce a box floating right suited for shortcuts to sections | |||
* {{tl|Redirects}} for redirects to templates | |||
|type = | |||
|i18n-method = switch | |||
|i18n-desc = Localization by {{tl|Shortcut text}}. | |||
|i18n-subpage = | |||
|i18n-mediawiki-msg = | |||
|example = | |||
|print = | |||
|useTemplateData = only | |||
}} | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ Usage | |+ Usage | ||
| Line 13: | Line 71: | ||
|} | |} | ||
The output is shown with <code>class="coordinates"</code>, see [[mediawikiwiki:Help:Page status indicators]] for details. | The output is shown with <code>class="coordinates"</code>, see [[mediawikiwiki:Help:Page status indicators]] for details.<includeonly> | ||
[[Category:Header templates]] | [[Category:Header templates]] | ||
[[Category:Internationalised header templates]] | [[Category:Internationalised header templates]] | ||
</includeonly> | </includeonly> | ||
Revision as of 19:50, 11 July 2019
This template shows the shortcuts of the current page.
Usage
{{shortcut |1= }}
Template parameters
- TemplateData
TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.
Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1 or useTemplateData=only on the /doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.
Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.
Wikipedia's help about TemplateData • Commons-specific information
This template shows the shortcuts of the current page.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| shortcut 1 | 1 | Name of the first shortcut | Page name | required |
| shortcut 2 | 2 | Name of the second shortcut | Page name | optional |
| shortcut 3 | 3 | Name of the third shortcut | Page name | optional |
| shortcut 4 | 4 | Name of the fourth shortcut | Page name | optional |
| language | lang | Language of the language-dependent output of the template (e.g. “de”). Useful in other templates and translated Commons pages to provide consistent language throughout the template/page | Line | optional |
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
Placement: At the top of the page
See also
- {{Shortcut2}} to produce a box floating right suited for shortcuts to sections
- {{Redirects}} for redirects to templates
Localization
To add your language to the list of languages supported by this template, please edit the template and add a row to the "{{LangSwitch|}}" construct. It takes the form "|xx= Your translation " (xx being the code of your language)
Localization by {{Shortcut text}}.
| input | result |
|---|---|
{{shortcut|COM:COM}}
|
Shortcut: COM:COM |
{{shortcut|COM:COM|CAT:CAT}}
|
Shortcut: COM:COM · CAT:CAT |
The output is shown with class="coordinates", see mediawikiwiki:Help:Page status indicators for details.