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 for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Template link

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.

Template parameters
Parameter		Description	Type	Status
template name	`1`	positional parameter: the template name without the namespace prefix “Template:”, which is added automatically	Template	required

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

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓	`{{tlg}}` options<ref group="note" name="TlTfn1"></ref> to achieve text style	Link style
Text style ↓		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
`{{tlg}}` options<ref group="note" name="TlTfn1"></ref> to achieve link style	N/A	DEFAULT	<syntaxhighlight lang="text" class="" id="" style="" inline="1">nolink=yes</syntaxhighlight>	<syntaxhighlight lang="text" class="" id="" style="" inline="1">subst=yes</syntaxhighlight>	`nolink=yes\|subst=yes`	<syntaxhighlight lang="text" class="" id="" style="" inline="1">braceinside=yes</syntaxhighlight>	<syntaxhighlight lang="text" class="" id="" style="" inline="1">alttext=Foo</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">2=Foo</syntaxhighlight>
normal	DEFAULT	{{tlg}}<ref group="note" name="TlTfn1"></ref> {{tl}} {{tlp\|1\|2\|...}}<ref group="note" name="TlTfn2"></ref> {{Template:tlu}}<ref group="note" name="TlTfn3"></ref>	{{tlf}}<ref group="note" name="TlTfn2"></ref> ^{<template link>}	{{subst:tls}} {{subst:Template:tlsu}}<ref group="note" name="TlTfn3"></ref>	{{tlsf}}<ref group="note" name="TlTfn2"></ref> ^{<template link>}	{{tn}}	{{tla}}
`code`	<syntaxhighlight lang="text" class="" id="" style="" inline="1">code=yes</syntaxhighlight>	`{{tl2}}` `{{tlx}}` `{{Template:tlxu}}`<ref group="note" name="TlTfn3"></ref>	`{{tlc}}`<ref group="note" name="TlTfn2"></ref> ^{<template link>} `{{tnull}}`^{<template link>}	`{{subst:tlxs}}`	`{{subst:tlsc}}`<ref group="note" name="TlTfn2"></ref> ^{<template link>}	N/A
monospace	<syntaxhighlight lang="text" class="" id="" style="" inline="1">plaincode=yes</syntaxhighlight><ref group="note" name="TlTfn4"></ref>	N/A		{{subst:tltss}}<ref group="note" name="TlTfn5"></ref>	N/A
`kbd`	<syntaxhighlight lang="text" class="" id="" style="" inline="1">kbd=yes</syntaxhighlight><ref group="note" name="TlTfn5"></ref>	N/A		{{subst:tltss}}<ref group="note" name="TlTfn5"></ref>	N/A
bold	<syntaxhighlight lang="text" class="" id="" style="" inline="1">bold=yes</syntaxhighlight>	{{tlb}}	N/A
`bold+code`	`bold=yes\|code=yes`	`{{tlxb}}`
`italic+code`	`italic=yes\|code=yes`	`{{tlxi}}`

<references group="note" responsive="1"><ref group="note" name="TlTfn1">{{tlg}} is the most general template, allowing any combination of text style and/or link style options.</ref> <ref group="note" name="TlTfn2">Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.</ref> <ref group="note" name="TlTfn3">Allows links to templates in any namespace.</ref> <ref group="note" name="TlTfn4">{{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.</ref>

<ref group="note" name="TlTfn5">Displays monospaced font using <span style="font-family:monospace;">...</span>.</ref></references>

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example	Effect	Notes
`{{tl2\|Hatnote\|lang=fr}}`	`{{hatnote}}`	Supports linking to sister projects (e.g., fr:Hatnote)
`{{demo\|<nowiki>{{Hatnote\|lang=fr\|Some text}}</nowiki>}}`	{{hatnote\|lang=fr\|Some text}} Some text	Shows code and example
`{{tln\|Hatnote}}`	Template:Hatnote	Produces a normal link to the template
`{{elc\|Template:Hatnote}}` `{{elc\|Template:Hatnote\|Hatnote}}`	`[[Template:Hatnote]]` `[[Template:Hatnote\|Hatnote]]`	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}}`	`[[WP:LASTING]]`	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}}`	{{d:Ping project}}	Wikidata counterpart to {{tl}}
`{{pf\|if}}` `{{pf\|if\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	Parser function equivalent to {{tl}}
`{{magic word\|uc:}}`	{{uc:}}	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)
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)
`{{tfd links\|Hatnote}}`	Template:Hatnote (talk · history · transclusions · logs · subpages · delete)
`{{tetl\|Hatnote}}`	{{Hatnote}} links talk edit
`{{tsetl\|Hatnote}}`	{{subst:Hatnote}} links talk edit
`{{ti\|Hatnote}}`	Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
`{{tic\|Hatnote}}`	Template:Hatnote (talk links edit)
`{{tim\|Hatnote}}`	m:Template:Hatnote (backlinks edit)
`{{tiw\|Hatnote}}`	Template:Hatnote (backlinks edit)
`{{tlt\|Hatnote}}`	{{Hatnote}} (talk)
`{{ttl\|Hatnote}}`	{{Hatnote}} (t/l)
`{{twlh\|Hatnote}}`	Template:Hatnote (links, talk)