Template:Template link/doc

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}}

which generates

{{Example}}

Other longer examples:

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

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.

· <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>

General-purpose formatting

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

Text style ↓	options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
options to achieve link style	—	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tl}} {{Template:tlu}}	<template link>	{{subst:Template:tlsu}}	{{subst:tlsf}} <template link>
code	code=yes	{{tl2}} {{Template:tlxu}}	<template link> <template link>		{{subst:tlsc}} <template link>	—
monospace	plaincode=yes	—		{{subst:tltss}}	—
kbd	kbd=yes
bold	bold=yes		—
bold+code	bold=yes|code=yes
italic+code	italic=yes|code=yes

Other formatting templates

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

Code example	Effect	Notes
	{{Hatnote }}	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
	{{Hatnote}}	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
	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
		Shows code and example
	Template:Hatnote	Produces a normal link to the template
	[[Template:Hatnote]] [[Template:Hatnote|Hatnote]]	Formats wikilink, with optional piped link text and blended suffix
	{{}}	Counterpart to {{tl}} for linking to Lua modules
	{{}}	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
	{{}}	Counterpart to {{tlx}} for linking to Lua modules
	require('Module:Example')	Link to Lua modules and built-in libraries, showing Lua code.
	title=book title	Formats template parameters for display, with or without values
	[[[[LASTING]]]]	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
	<ref>...</ref> <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
	{{d:Ping project}}	Wikidata counterpart to {{tl}}
	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}
	{{[[MW:Help:Magic words#|uc:]]}}	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
	Template:Hatnote (edit | talk | history | links | watch | logs)
	Template:Hatnote(edit talk links history)
	Template:T links/sandbox links
	{{Hatnote}} links talk edit
	{{subst:Hatnote}}  links talk edit
	Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
	Template:Hatnote (talk links edit)
	m:Template:Hatnote (backlinks edit)
	Template:Hatnote (backlinks edit)
	{{Hatnote}} (talk)
	{{Hatnote}} (t/l)
	Template:Hatnote (links, talk)