Template:Template link/doc
This is a documentation subpage for Template:Template link. It may contain usage information, categories and other content that is not part of the original template page. |
The template link template is a simple macro template used to display a template name as a link surrounded by braces, thus showing the 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}}}).
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
template name | 1 | positional parameter: the template name without the namespace prefix “Template:”, which is added automatically | Line | required |
More complex variations are described below.
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}}
|
{{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 {{!}}
|
See also
- 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]tended 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.
- (edit talk links history)
- Template:xpd (backlinks edit) to e[xp]an[d] (i.e. demonstrate) a template in situ.
General-purpose formatting
Text style ↓ | {{tlg}} options[note 1]to achieve text style |
Link style | |||||
---|---|---|---|---|---|---|---|
Linked | Unlinked | Linked with subst | Unlinked with subst | Linked including braces | Linked with alternative text | ||
{{tlg}} options[note 1]to achieve link style |
— | DEFAULT | nolink=yes
|
subst=yes
|
nolink=yes
|
braceinside=yes
|
alttext=Foo 2=Foo
|
normal | DEFAULT | {{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}} |
{{tlf}} <template link> |
{{subst:tls}} {{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
|
{{tlxb}}
| |||||
italic+code
|
italic=yes
|
{{tlxi}}
|
- ^ a b c
{{tlg}}
is the most general template, allowing any combination of text style and/or link style options. - ^ a b c d e Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>
tags. - ^ a b c Allows links to templates in any namespace.
- ^
{{tlg|plaincode=yes}}
uses<code style="border:none; background-color:transparent;">...</code>
. - ^ a b Displays monospaced font using
<span style="font-family:monospace;">...</span>
.
Other formatting templates
Code example | Effect | Notes |
---|---|---|
{{Tj|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 |
Supports colors, placeholder texts, named and unnamed parameters |
|
{{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}}
|
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}}
|
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
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) |
{{tetl|Hatnote}}
|
{{Hatnote}} |
{{tsetl|Hatnote}}
|
{{subst:Hatnote}} |
{{ti|Hatnote}}
|
Template:Hatnote (talk · links · 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}}
|
Template:Hatnote (links, talk) |
{{twlh|Hatnote}}
|
Template:Hatnote (links, talk) |