Template:Tld/doc

TemplateData

 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

Template link code with link

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Extra Class Names	class	Extra class names to add to the “class” attribute.	String	optional
doc	doc	Whether to display a linked “+/doc”	Boolean	optional
Nowrap?	nowrap	Whether to add “<span style="white-space: nowrap">” Auto value 1	Boolean	optional
Template	1	Linked template name	Template	required
Parameter 1	2	First parameter value	String	optional
Parameter 2	3	Second parameter value	String	optional
Parameter 3	4	Third parameter value	String	optional
Parameter 4	5	Fourth parameter value	String	optional
Parameter 5	6	Fifth parameter value	String	optional
Parameter 6	7	Sixth parameter value	String	optional
Parameter 7	8	Seventh parameter value	String	optional
Parameter 8	9	Eighth parameter value	String	optional

Template links

List of templates using {{T/main}}

Code	Result	Notes	lock
{{T|example}}	{{Example}}	makes brackets part of the link; see docu
{{T0|example}}	Example	just link, without the brackets; see docu
{{T1|example}}	{{Example}}	inner brackets are part of the link; see docu
{{T2|example}}	{{Example}}	brackets are not a part of the link; see docu
{{Tl|example}}	{{Example}}	makes brackets around the link; see docu
{{Tls|example}}	{{subst:example}}	no parameters, adds "subst:"
Templates showing parameters 0 Meta template {{Tle}} is easiest to parametrize.
{{Tle|T=F|p1=1|v1|p2=2|v2|p3=3|v3}}	{{ F | 1 = v1 | 2 = v2 | 3 = v3 }}	decribes template parameters by names and values
{{Tlx|example|1|2|3|4|5||7|8|9}}	{{example|1|2|3|4|5|7|8|...}}	up to 8 parameters
{{Tlf|example|1|2|3|...up to 8}}	{{example|1|2|3|...up to 8}}	up to 8 parameters, no link; see docu
{{Tlc|example|1|2|3|4|||7|up to 8|9}}	{{example|1|2|3|4|||7|up to 8}}	up to 8 parameters, no link, <code> style
{{Tld|example|1|2||3||}}	{{example|1||2|3||}}	up to 8 parameters, <code> style; see docu
{{Tlr|User:Example}}	{{User:Example}}	like {{tl}} but for any namespace
{{Tlsu|User:Example}}	{{subst:User:Example}}	like {{tlr}}, but also adds "subst:"
Alternative forms 0 These ignore empty parameters.
{{Tlp|example|1|2|3|4|5||7|8|9}}	{{example|1|2|3|4|5|7|8}}	up to 8 parameters; ignores empty parms
{{Tl2|example|p1|p2}}	{{example|p1|p2}}	up to 2 parameters, <code> style; see docu
{{Tlsp|example|1|2|3|4|5|6|7|8|9}}	{{subst:example|1|2|3|4|5|6|7|8|...}}	up to 8 parameters, adds linked "subst:"; see doc
{{Tlsx|example|1|2|3|4|5|6|7|8|9}}	{{subst:example|1|2|3|4|5|...}}	up to 5 parameters, adds linked "subst:", <code> style

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced

Text style ↓	{{tlg}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces
{{tlg}} options to achieve link style	N/A	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes
normal	DEFAULT	{{tlg}} {{T2}} {{tlx}} {{tlp|1|2|...}} {{Template:tlr}} {{Template:tlu}}	{{tlf}} <template link>	{{subst:tls}} {{subst:tlsp}} {{subst:Template:tlsu}}	N/A	{{T}}
code	code=yes	{{tl2}}	{{tlc}} <template link>	{{subst:tlsx}}	{{subst:tlsc}} <template link>	N/A
monospace	plaincode=yes	{{tld}}	N/A	{{subst:tltts}}	N/A	{{Tl}}
kbd	kbd=yes