Template:Tl/doc
This is a documentation subpage for Template:Tl. It contains 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 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). A short example of its use is:
{{tl|Example}}
- which generates
TemplateData
TemplateData for Tl
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 | the template name without the namespace prefix “Template:”, which is added automatically | Line | required |
More complex variations are described below.
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) |
{{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
General-purpose formatting
Link style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
---|---|---|---|---|---|---|
Text style ↓ | ↓ {{tlg}} options1 →
|
N/A | nolink=yes
|
subst=yes
|
braceinside=yes
|
alttext=Foo 2=Foo
|
normal | DEFAULT | {{tlg}} 1{{tl}} {{tlp}} 2{{tlu}} 3
|
{{tlf}} 2
|
{{tls}} {{tlsp}}
|
{{tn}}
|
{{tla}}
|
code
|
code=yes
|
{{tl2}} {{tlx}} {{tlxu}} 3
|
{{tlc}} 2{{tld}} 2{{tnull}}
|
{{tlxs}}
|
N/A | |
monospace kbd |
plaincode=yes 4kbd=yes 5
|
{{tltt}} 5{{tltt2}} 5
|
N/A | {{tltts}} 5{{tltts3}} 5{{tltss}} 6
|
N/A | |
bold | bold=yes
|
{{tlb}}
|
N/A | |||
bold+code
|
bold=yes|code=yes
|
{{tlxb}}
| ||||
italic+code
|
italic=yes|code=yes
|
{{tlxi}}
|
- 1
{{tlg}}
is the most general, allowing any combination of text style and/or link style options. - 2 Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>
tags. - 3 Allows links to templates in any namespace.
- 4
{{tlg|plaincode=yes}}
uses<code style="border:none; background:transparent;">...</code>
. - 5 Displays monospaced font using
<kbd>...</kbd>
tags (changed from<tt>...</tt>
for HTML5 compliance). - 6 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}} |
Shows code and example |
{{xpd|Hatnote|Some hatnote text}} |
"{{hatnote|Some hatnote text}}" gives " " [1] |
Shows code, example and a link to expand the template code |
{{para|title|<var>book title</var>}} |
|title=book title |
Formats template parameters for display, with or without values |
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}} |
[[Template:Hatnote]] [[Template:Hatnote|Hatnote]] |
Formats wikilink, with optional piped link text and blended suffix |
{{tag|ref}} {{xtag|templatedata}} |
<ref>...</ref> <templatedata> |
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing |
{{mli|Bananas|hello}} {{mlix|BananasArgs|hello|Fred}} |
{{#invoke:Bananas|hello}}{{#invoke:BananasArgs|hello|Fred}} |
Counterparts to and for linking to Lua modules |
With utility links
Code example | Effect |
---|---|
{{lts|Hatnote}} |
Template:Hatnote(edit talk links history) |
{{t links|Hatnote}} |
Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) · Module:hatnote |
{{tfd links|Hatnote}} |
Template:Hatnote (edit · talk · history · links · logs · subpages · delete) |
{{tiw|Hatnote}} |
Template:hatnote (backlinks edit) |
{{tltt|Hatnote}} |
{{Hatnote}} |
{{tetl|Hatnote}} |
{{Hatnote}} |
{{tsetl|Hatnote}} |
{{subst:Hatnote}} |
{{ti|Hatnote}} |
Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit) |
{{tic|Hatnote}} |
Template:Hatnote (talk links edit) |
{{tiw|Hatnote}} |
Template:Hatnote (backlinks edit) |
{{tlt|Hatnote}} |
{{Hatnote}} (talk) |
{{ttl|Hatnote}} |
{{Hatnote}} (t/l) |
{{twlh|Hatnote}} |
Template:Hatnote (links, talk) |