Template:Template link/doc

This is a documentation subpage for Template:Template link.
It contains usage information, categories and other content that is not part of the original template page.

Shortcuts

{{tl}}
{{t}}

The template link template is a simple macro template used to display a template name as a link surrounded by braces, thus showing the template name as code rather than actually invoking it. Its primary use is in instruction and documentation where it is used to refer to a template by name without invoking it.

Note that this template may be used under the name "tee-el" (tl) as well as "tee-one" (t1)— both function the same way and produce the same results. This is not true for all such visually confusing templates containing a possible 1/l mix-up: and are not interchangeable.

{{Tla}} works exactly like {{tl}} with the addition of optionally displaying alternative label text (link label). {{tlg}} can include the use of parameters in the template (as {{{1}}}).

Examples

A short example of its use is:

{{tl|Example}}

which generates

Other longer examples:

Code	Result	Notes
`{{tl\|Void}}`	{{Void}}	Standard usage
`{{tls\|Example}}`	{{subst:Example}}	For templates that should be substituted
`{{tl2\|X1}}`	`{{X1}}`	This formats the link to show how it would look in code (i.e., monospace font)
`{{tl2\|sister=M:\|3x}}`	`{{3x}}`	Same as above, for templates on another Wikimedia project (in this example, Meta, using `m:`). See Interwiki codes.
`{{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 {{!}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Template link

<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": "positional parameter: the template name without the namespace prefix “Template:”, which is added automatically",
   "type": "line",
   "required": true
 }

}}</templatedata>

Template:tl2 (talk, backlinks, edit)
Template:tl (talk, backlinks, edit)
Template:tlp (talk, backlinks, edit) to produce a [t]emplate [l]ink with single [p]arameter.
Template:tlx (talk, backlinks, edit) to produce a [t]emplate [l]ink with e[x]tended number of parameters.
Template:tlsp (talk, backlinks, edit) to produce a [t]emplate [l]ink that's [s]ubst:ituted, with a single [p]arameter.
Template:lts (talk, backlinks, edit)
Template:tlu (talk, backlinks, edit), tl or tlp in any namespace.
Category:Internal template-link templates (edit talk links history)
Template:xpd (talk, backlinks, edit) to e[xp]an[d] (i.e. demonstrate) a template in situ.

General-purpose formatting

Comparison of template-linking templates according to their style
	Link style →	Linked	Unlinked	Linked with subst	Linked including braces	Linked with alternative text
Text style ↓	↓ `{{tlg}}` options¹ →	DEFAULT	`<syntaxhighlight lang="text" enclose="none">nolink=yes</syntaxhighlight>`	`<syntaxhighlight lang="text" enclose="none">subst=yes</syntaxhighlight>`	`<syntaxhighlight lang="text" enclose="none">braceinside=yes</syntaxhighlight>`	`<syntaxhighlight lang="text" enclose="none">alttext=Foo</syntaxhighlight>` `<syntaxhighlight lang="text" enclose="none">2=Foo</syntaxhighlight>`
normal	DEFAULT	`{{tlg}}`¹ `{{tl}}` `{{tlp}}`² `{{tlu}}`³	`{{tlf}}`²	`{{tls}}` `{{tlsp}}` `{{tlsu}}`³	`{{tn}}`	`{{tla}}`
`code`	`<syntaxhighlight lang="text" enclose="none">code=yes</syntaxhighlight>`	`{{tl2}}` `{{tlx}}` `{{tlxu}}`³	`{{tlc}}`² `{{tld}}`² `{{tnull}}`	`{{tlxs}}`	N/A
monospace `kbd`	`<syntaxhighlight lang="text" enclose="none">plaincode=yes</syntaxhighlight>`⁴ `<syntaxhighlight lang="text" enclose="none">kbd=yes</syntaxhighlight>`⁵	`{{tltt}}`⁵ `{{tltt2}}`⁵	N/A	`{{tltss}}`⁶	N/A
bold	`<syntaxhighlight lang="text" enclose="none">bold=yes</syntaxhighlight>`	`{{tlb}}`	N/A
`bold+code`	code=yes</syntaxhighlight>	`{{tlxb}}`
`italic+code`	code=yes</syntaxhighlight>	`{{tlxi}}`
¹ `{{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. ³ Allows links to templates in any namespace. ⁴ REDIRECT Template:Template link code uses `<code style="border:none; background-color:transparent;"></code>`. ⁵ Displays monospaced font using `<kbd></kbd>` tags (changed from `<tt></tt>` for HTML 5 compliance). ⁶ Displays monospaced font using `<span style="font-family:monospace;"></span>`.

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
`{{demo\|<nowiki>{{Hatnote\|lang=fr\|Some text}}</nowiki>}}`	{{hatnote\|lang=fr\|Some text}} Some text	Shows code and example
`{{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
`{{tln\|Hatnote}}`	Template:Tln	Produces a normal link to the template
`{{elc\|Template:Hatnote}}` `{{elc\|Template:Hatnote\|Hatnote}}`	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
`{{ml\|Example\|hello}}`	{{#invoke:Example\|hello}}	Counterpart to {{tl}} for linking to Lua modules
`{{mlx\|Example\|hello}}`	`{{#invoke:Example\|hello}}`	Counterpart to {{tlx}} for linking to Lua modules
`{{para\|title\|<var>book title</var>}}`	`\|title=book title`	Formats template parameters for display, with or without values
`{{sclx\|LASTING}}`	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a `<code></code>` tag.
`{{tag\|ref}}` `{{xtag\|templatedata}}`	`<ref></ref>` `<templatedata>`	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
`{{dtl\|Ping project}}`	Template:Dtl	Wikidata counterpart to {{tl}}
`{{pf\|if}}` `{{pf\|if\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	Parser function equivalent to {{tl}}

With utility links

Code example	Effect
`{{lt\|Hatnote}}`	Template:Hatnote `(`edit`\|`talk`\|`history`\|`links`\|`watch`\|`logs`)`
`{{lts\|Hatnote}}`	Template:Hatnote `(`edit talk links history`)`
`{{t links\|Hatnote}}`	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
`{{tltt\|Hatnote}}`	{{Hatnote}}
`{{tetl\|Hatnote}}`	{{ Hatnote }} links talk view
`{{tsetl\|Hatnote}}`	Template:Tsetl
`{{ti\|Hatnote}}`	Template:Hatnote (talk, links, edit)
`{{tic\|Hatnote}}`	Template:Tic
`{{tim\|Hatnote}}`	m:Template:Hatnote (talk, backlinks, edit)
`{{tiw\|Hatnote}}`	Template:Hatnote (talk, backlinks, edit)
`{{tlt\|Hatnote}}`	{{Hatnote}} (talk)
`{{ttl\|Hatnote}}`	Template:Ttl
`{{twlh\|Hatnote}}`	Template:Hatnote (links, talk)