Template:Tl/doc

The template link template is a simple macro template used to display a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation. A short example is:

{{tl|Example}}

which generates

{{Example}}

<templatedata>{ "description": "This template displays a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation.", "params": {

 "1": {
   "label": "template name",
   "description": "the template name without the namespace prefix “Template:”, which is added automatically",
   "type": "line",
   "required": true
 }

}}</templatedata>

More complex variations are described below.

Example

Code	Result	Notes
{{tl|Void}}	{{Void}}	Standard usage
{{tls|Void}}	{{subst:Example}}	For templates that should be substituted
{{tl2|X1}}	{{X1}}	This formats the link to show how it would look in code
{{tl2|SISTER=M:|3x}}	{{3x}}	Same as above, for templates on another Wikimedia project (such as meta)
{{tl2|SISTER=wikibooks|LANG=de:|WP}}	{{WP}}	For templates on another language project
{{tl|1==)}}	{{=)}}	Use the format {{tl|1=templatename}} if the template contains template coding characters such as {{=)}} or {{!}}

See also

General-purpose formatting

• ¹ {{tlg}} is the most general, allowing any combination of text style and/or link style options.
• ² Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
• ³ Uses monospace font but not <code>...</code>.
• ⁴ Allows links to templates in any namespace.

Other formatting templates

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	{{User:Ahunt/SSHFS}}	Supports linking to any namespace
{{xpd|Hatnote|Some hatnote text}}	"{{hatnote|Some hatnote text}}" gives " Some hatnote text " [1]	Shows code, example and a link to expand the template code
{{para|title|<var>book title</var>}}	|title=book title	Formats template parameters for display, with or without values

With utility links

Code example	Effect
{{lts|Hatnote}}	Template:Hatnote(edit talk links history)
{{t links|Hatnote}}	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) · Module:hatnote
{{tfd links|Hatnote}}	Template:Hatnote (edit⧼dot-separator⧽talk⧼dot-separator⧽history⧼dot-separator⧽links⧼dot-separator⧽logs⧼dot-separator⧽subpages⧼dot-separator⧽delete)
{{tiw|Hatnote}}	Template:hatnote (backlinks edit)
{{tltt|Hatnote}}	{{Hatnote}}
{{tetl|Hatnote}}	{{ Hatnote }} links talk view
{{tsetl|Hatnote}}	{{ subst:Hatnote }}  links talk view
{{ti|Hatnote}}	Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
{{tic|Hatnote}}	Template:Hatnote (talk links edit)
{{tiw|Hatnote}}	Template:Hatnote (backlinks edit)
{{tlt|Hatnote}}	{{Hatnote}} (talk)
{{ttl|Hatnote}}	{{Hatnote}} (t/l)
{{twlh|Hatnote}}	Template:Hatnote (links, talk)