Template:Tmpl/doc: Difference between revisions
More actions
Add `desc` parameter to {{TemplateBox}} |
Use main {{TemplateBox}} |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Shared Template Warning|Template:Tmpl}} | |||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | ||
{{TemplateBox | |||
| mbox = | |||
{{Lua|Module:Tmpl}} | {{Lua|Module:Tmpl}} | ||
| name = tmpl | | name = tmpl | ||
| desc-en = This template replaces numeric variables (similar to those used in MediaWiki messages and translatable pages) in a string. In contrast to translatable pages, it supports only numeric variables {{mono|$1}} to {{mono|$9}}. One variable can appear several times, so in case of translatable pages, there’s no need to translate the same text more than once. | | desc-en = This template replaces numeric variables (similar to those used in MediaWiki messages and translatable pages) in a string. In contrast to translatable pages, it supports only numeric variables {{mono|$1}} to {{mono|$9}}. One variable can appear several times, so in case of translatable pages, there’s no need to translate the same text more than once. | ||
| namespace = all | | namespace = all | ||
| usergroup = all | | usergroup = all | ||
| example = < | | example-source = <syntaxhighlight lang="html">{{tmpl|0= <$1 name=$3>$2</$1> |tag|content|value}}</syntaxhighlight> | ||
| example-value = {{tmpl|0= <$1 name=$3>$2</$1> |tag|content|value}} | | example-value = {{tmpl|0= <$1 name=$3>$2</$1> |tag|content|value}} | ||
| relieson = [[Module:Tmpl]] | | relieson = | ||
* [[Module:Tmpl]] | |||
| i18n-method = - | | i18n-method = - | ||
| Line 27: | Line 30: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| useTemplateData = | | useTemplateData = TNT:tmpl | ||
| 1 = 0 | | 1 = 0 | ||
| 1stat = required | | 1stat = required | ||
}} | }} | ||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other|| | ||
<!-- Categories below this line; interwikis at Wikidata --> | <!-- Categories below this line; interwikis at Wikidata --> | ||
[[Category: | [[Category:Commons utility templates]] | ||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 20:26, 24 November 2024
 | Warning: Do not edit. This page is maintained by an automated tool. All edits should be done at mediawiki.org. (translate this warning) |
| Uses Lua: |
This template replaces numeric variables (similar to those used in MediaWiki messages and translatable pages) in a string. In contrast to translatable pages, it supports only numeric variables $1 to $9. One variable can appear several times, so in case of translatable pages, there’s no need to translate the same text more than once.
Usage
{{tmpl |0= }}
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 replaces numeric variables (similar to those used in MediaWiki messages and translatable pages) in a string. In contrast to translatable pages, it supports only numeric variables $1 to $9. One variable can appear several times, so in case of translatable pages, there’s no need to translate the same text more than once.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Template Content | 0 | Text with replacements, which are specified using “$n”, where “n” is a positive integer matching the parameter names. | Content | required |
| Replacement 1 | 1 | The replacement string for “$1”. | Content | optional |
| Replacement 2 | 2 | The replacement string for “$2”. | Content | optional |
| Replacement 3 | 3 | The replacement string for “$3”. | Content | optional |
| Replacement 4 | 4 | The replacement string for “$4”. | Content | optional |
| Replacement 5 | 5 | The replacement string for “$5”. | Content | optional |
| Replacement 6 | 6 | The replacement string for “$6”. | Content | optional |
| Replacement 7 | 7 | The replacement string for “$7”. | Content | optional |
| Replacement 8 | 8 | The replacement string for “$8”. | Content | optional |
| Replacement 9 | 9 | The replacement string for “$9”. | Content | optional |
Edit parameter translations
Additional information
The template is intended to be used in the following namespaces: all namespaces
The template is intended to be used by the following user groups: all users
Relies on:
Examples
{{tmpl|0= <$1 name=$3>$2</$1> |tag|content|value}}
renders as:
<tag name=value>content</tag>
Localization
This template is not intended to be localized.
This template is intended to be used on pages using the Translate extension to allow partial translation of the content of <tvar>...</tvar> tags.
Example
{{tmpl|0= <$1 name=$3>$2</$1> |tag|content|value}}
which translators will see as:
{{$1|tag|content|value}}