Template:Tmpl

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Tmpl/doc.

Warning:

Do not edit. This page is maintained by an automated tool. All edits should be done at mediawiki.org. (translate this warning)

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

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

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.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

---

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.

Template parameters

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:

• Module:Tmpl

Example

{{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

{{<tvar name=1>tmpl|0= &lt;$1 name=$3&gt;$2&lt;/$1&gt; </tvar>|tag|content|value}}

which translators will see as:

{{$1|tag|content|value}}