Template:Template link/doc

"Template:TI" redirects here. Not to be confused with Template:Ti.

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 as they 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

{{Example}}

Other longer examples:

Code	Result	Notes
{{tl|Void}}	{{Void}}	Standard usage
{{tls|Example}}	This template, often abbreviated as {{}}, is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline. For a multi-line output, see {{tj}}. Parameters With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options. Parameter Action Use with {{example}} Default active Default (without accessory parameters) {{example}} brace Include braces as part of the template link {{example}} {{tlw}}/{{tn}} braceinside Include innermost braces as part of the template link {{example}} bold Renders the template link/name in bold {{example}} {{tlb}}, {{tlxb}} code Display output using HTML ‎<code>...‎</code> tags (monospaced font) {{example}} {{tlc}}, {{Template link expanded}}, etc. italic Display any parameters accompanying the template link/name in italics {{example|param}} {{tlxi}} kbd Display output using HTML ‎<kbd>...‎</kbd> tags (monospaced font) {{example}} nolink Don't render the template name as a link {{example}} {{tlf}}, {{tnull}} nowrap Prevent the insertion of line breaks (word wrap) in the output {{example}} nowrapname Prevent word wrapping in the output of template name/link (parameters will wrap if needed) {{example}} plaincode Uses ‎<code style="border:none; background:transparent;">...‎</code> {{example}} {{tltss}} subst Include a subst: prefix before the template link/name {{subst:example}} {{tls}}, {{tlxs}}, etc alttext=[text] Replace [text] with the actual label to be displayed for the template link {{Other}} {{tla}} _show_result Will also display the result of the template {{Min|7|-5}} → -5 _expand Will add a link to the expanded template page {{Min|7|-5}} [1] Unnamed (Positional) This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below. Examples Code Output Remarks {{Example|Banner}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Template:Banner does not exist. (Non-existent template is redlinked.) {{Example|Abc}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Template:Abc exists. {{Example|abC}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Template names are case-sensitive {{Example|abc}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. (but the first letter is case-insensitive). {{Example|x0}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. no parameters {{Example|x1|one}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. one parameter {{Example|x2|one|two}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. two parameters {{Example|x3|1|2|3|4|5|6|7|8|9|10}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. ten parameters {{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Unlimited parameters, as one ‎<nowiki>...‎</nowiki> string. {{Example|x2||two||}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Empty parameters are discarded. {{Example|x0|code=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. <code> style {{Example|x0|plaincode=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. plaincode style {{Example|x0|kbd=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. <kbd> style {{Example|x0|bold=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. bold link/name {{Example|x1|one|italic=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. parameter(s) in italics {{Example|x0|nolink=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. {{Example|x0|subst=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. {{Example|x0|brace=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. all braces in link {{Example|x0|braceinside=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. inside braces in link {{Example|x0|alttext=x0 link}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. {{Example|x0|bold=on|code=on|brace=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Combine multiple parameter settings. {{tlg|x1|{{spaces}}one{{spaces}}}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Using {{spaces}} before and after a parameter. {{Example|x2|bold=on|code=on|one|two}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Can combine named and anonymous parameters ... {{Example|x2|one|two|bold=on|code=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. ... in any order ... {{Example|x2|one|code=on|two|bold=on|three}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. ... even intermixed ... {{Example|x2|one|code=on|two|bold=on|three|italic=on}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. ... with many configurations. {{tlg|x1|x=u}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. = won't work {{tlg|x1|x&#61;u}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. &#61; is okay {{tlg|x1|x{{=}}u}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. {{=}} is okay (see Template:=) {{tlg|x1|x<nowiki>=</nowiki>u}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Sticky nowiki is okay. {{Example|x2|3=two|2=one}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Right-to-left is okay {{Example}} Example With no arguments, it emits the current page name without braces. {{Example|x2|3=one|4=two}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Null parameter stops parsing. Wrapping of long names (default) Code Output {{Example|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Wrapping of long names (nowrap=on) Code Output {{Example|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. Wrapping of long names (nowrapname=on) Code Output {{Example|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} File:Cube.svgThis is an example of a template. For help with templates, see Help:Template. See also 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 Linked with alternative text {{tlg}} options to achieve link style — DEFAULT nolink=yes subst=yes nolink=yes|subst=yes braceinside=yes alttext=Foo 2=Foo normal DEFAULT {{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}} {{tlf}} <template link> {{subst:Template:tlsu}} {{subst:tlsf}} <template link> {{tn}} {{tla}} code code=yes {{tl2}} {{tlx}} {{Template:tlxu}} {{tlc}} <template link> {{tnull}}<template link> {{subst:tlxs}} {{subst:tlsc}} <template link> — monospace plaincode=yes — {{subst:tltss}} — kbd kbd=yes bold bold=yes {{tlb}} — bold+code bold=yes|code=yes {{tlxb}} italic+code italic=yes|code=yes {{tlxi}} Other formatting templates Templates producing specialised formatting effects for given templates, modules or parameters Code example Effect Notes {{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}} {{Hatnote | Some text | selfref = yes | category = no | lang = fr }} Supports colors, placeholder texts, named and unnamed parameters <syntaxhighlight lang="wikitext"> {{Hatnote | Some text | selfref = yes | category = no | lang = fr }} </syntaxhighlight> {{Hatnote | Some text | selfref = yes | category = no | lang = fr }} Same as above {{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}} {{Hatnote|Some text|selfref=yes|category=no|lang=fr}} Supports colors, placeholder texts, named and unnamed parameters <syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight> {{Hatnote|Some text|selfref=yes|category=no|lang=fr}} Same as above {{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 {{mfl|Example|hello}} {{#invoke:Example|hello}} Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section {{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules {{ml-lua|Module:Example|hello}} require('Module:Example') Link to Lua modules and built-in libraries, showing Lua code. {{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:]]  {{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) {{tetl|Hatnote}} {{Hatnote}} links talk edit {{tsetl|Hatnote}} {{subst:Hatnote}}  links talk edit {{ti|Hatnote}} {{Hatnote}} {{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)	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 in articles 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

This template prefers inline formatting of parameters.

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

See also

• Template:tl2 (backlinks edit)
• Template:tl (backlinks edit)
• Template:tlp (backlinks edit) to produce a [t]emplate [l]ink with a single [p]arameter.
• Template:tlx (backlinks edit) to produce a [t]emplate [l]ink with an 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: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 to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
{{tlg}} options to achieve link style	—	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}}	{{tlf}} <template link>	This template, often abbreviated as {{}}, is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline. For a multi-line output, see {{tj}}. Parameters With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options. Parameter Action Use with {{example}} Default active Default (without accessory parameters) {{example}} brace Include braces as part of the template link {{example}} {{tlw}}/{{tn}} braceinside Include innermost braces as part of the template link {{example}} bold Renders the template link/name in bold {{example}} {{tlb}}, {{tlxb}} code Display output using HTML ‎<code>...‎</code> tags (monospaced font) {{example}} {{tlc}}, {{Template link expanded}}, etc. italic Display any parameters accompanying the template link/name in italics {{example|param}} {{tlxi}} kbd Display output using HTML ‎<kbd>...‎</kbd> tags (monospaced font) {{example}} nolink Don't render the template name as a link {{example}} {{tlf}}, {{tnull}} nowrap Prevent the insertion of line breaks (word wrap) in the output {{example}} nowrapname Prevent word wrapping in the output of template name/link (parameters will wrap if needed) {{example}} plaincode Uses ‎<code style="border:none; background:transparent;">...‎</code> {{example}} {{tltss}} subst Include a subst: prefix before the template link/name {{subst:example}} {{tls}}, {{tlxs}}, etc alttext=[text] Replace [text] with the actual label to be displayed for the template link {{Other}} {{tla}} _show_result Will also display the result of the template {{Min|7|-5}} → -5 _expand Will add a link to the expanded template page {{Min|7|-5}} [2] Unnamed (Positional) This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below. Examples Code Output Remarks {{tls|Banner}} Template:Banner does not exist. (Non-existent template is redlinked.) {{tls|Abc}} Template:Abc exists. {{tls|abC}} Template names are case-sensitive {{tls|abc}} (but the first letter is case-insensitive). {{tls|x0}} no parameters {{tls|x1|one}} one parameter {{tls|x2|one|two}} two parameters {{tls|x3|1|2|3|4|5|6|7|8|9|10}} ten parameters {{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} Unlimited parameters, as one ‎<nowiki>...‎</nowiki> string. {{tls|x2||two||}} Empty parameters are discarded. {{tls|x0|code=on}} <code> style {{tls|x0|plaincode=on}} plaincode style {{tls|x0|kbd=on}} <kbd> style {{tls|x0|bold=on}} bold link/name {{tls|x1|one|italic=on}} parameter(s) in italics {{tls|x0|nolink=on}} {{tls|x0|subst=on}} {{tls|x0|brace=on}} all braces in link {{tls|x0|braceinside=on}} inside braces in link {{tls|x0|alttext=x0 link}} {{tls|x0|bold=on|code=on|brace=on}} Combine multiple parameter settings. {{tlg|x1|{{spaces}}one{{spaces}}}} Using {{spaces}} before and after a parameter. {{tls|x2|bold=on|code=on|one|two}} Can combine named and anonymous parameters ... {{tls|x2|one|two|bold=on|code=on}} ... in any order ... {{tls|x2|one|code=on|two|bold=on|three}} ... even intermixed ... {{tls|x2|one|code=on|two|bold=on|three|italic=on}} ... with many configurations. {{tlg|x1|x=u}} = won't work {{tlg|x1|x&#61;u}} &#61; is okay {{tlg|x1|x{{=}}u}} {{=}} is okay (see Template:=) {{tlg|x1|x<nowiki>=</nowiki>u}} Sticky nowiki is okay. {{tls|x2|3=two|2=one}} Right-to-left is okay {{tls}} tls With no arguments, it emits the current page name without braces. {{tls|x2|3=one|4=two}} Null parameter stops parsing. Wrapping of long names (default) Code Output {{tls|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} Wrapping of long names (nowrap=on) Code Output {{tls|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} Wrapping of long names (nowrapname=on) Code Output {{tls|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} See also {{subst:Template:tlsu}}	{{subst:tlsf}} <template link>	{{tn}}	{{tla}}
code	code=yes	{{tl2}} {{tlx}} {{Template:tlxu}}	{{tlc}} <template link> {{tnull}}<template link>	{{subst:tlxs}}	{{subst:tlsc}} <template link>	—
monospace	plaincode=yes	—		{{subst:tltss}}	—
kbd	kbd=yes
bold	bold=yes	{{tlb}}	—
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	{{tlxi}}

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}}	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote | Some text | selfref = yes | category = no | lang = fr }} </syntaxhighlight>	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Same as above
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}}	{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight>	{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}	Same as above
{{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
{{mfl|Example|hello}}	{{#invoke:Example|hello}}	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
{{mlx|Example|hello}}	{{#invoke:Example|hello}}	Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example|hello}}	require('Module:Example')	Link to Lua modules and built-in libraries, showing Lua code.
{{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:]]
{{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)
{{tetl|Hatnote}}	{{Hatnote}} links talk edit
{{tsetl|Hatnote}}	{{subst:Hatnote}}  links talk edit
{{ti|Hatnote}}	{{Hatnote}}
{{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)