Template:Tl7/doc
Appearance
![]() | This is a documentation subpage for Template:Tl7. It may contain usage information, categories and other content that is not part of the original template page. |
This is the 45th internal template-link template.
It can be used in documentation and talk page discussions to show how a template name would be used in code but also with links.
Here is how this template looks. Code to the left and actual rendering to the right:
{{tl7|name|parameters}}
= {{name|parameters}}
Features of {{tl7}}:
- It shows a template name with a link to that template.
- It shows up to three parameters.
- It also shows empty parameters. (See examples below.)
- It uses normal text style. (
{{tlx}}
, for instance, uses<code>...</code>
text style.) - It links the parameter shown back to the template.
This template belongs to a whole family of similar templates. See the see also section below for some of the ones that are more popular than {{tl7}}.
Examples
[edit]Code | Output | Comments |
---|---|---|
{{tl7}} | {{[[Template:{{{1}}}|{{{1}}}]]}} | Shows its own syntax. |
{{tl7|name}} | {{name}} | |
{{tl7|name|first}} | {{name|first}} | |
{{tl7|name|first|last}} | {{name|first|last}} | |
{{tl7|name|a|b|c|d|e|f|g|h|i|j}} | {{name|a|b|c|...}} | Shows up to three parameters. The rest are replaced with ... instead. |
{{tl7|name|too|many}} | {{name|too|many}} | Empty parameters are still treated as if there is something there. There are only two ways to fix this: |
{{tl7|name|{{!}}too|many}} | {{name||too|many}} | Use {{!}} instead |
{{tl7|name||too|many}} | {{name||too|many}} | Use "|" |
{{tl7|name|first=a|last=b}} | {{name}} | Equal signs are also a problem, but there are a couple ways to fix this: |
{{tl7|name|2=first=a|3=last=b}} | {{name|first=a|last=b}} | Use numbered parameters to fix it. Here, parameter "|2= " is assigned the string "first=a". Start with #2, since "name" is already in the "|1= " slot. Note that all subsequent parameters after a numbered parameter must also be numbered. |
{{tl7|name|first{{=}}a|last{{=}}b}} | {{name|first=a|last=b}} | Or, simply use, "{{=}}", the equal-sign template, to "escape" the symbol. |
{{tl7|name|2=1=a|3=2=b}} | {{name|1=a|2=b}} | Both techniques also work with numbered positional parameters (e.g.: "|1= ", "|2= "). |
{{tl7|name|2=1=a|last{{=}}b}} | {{name|last=b}} | The named parameter ("|last= ") clobbered the prior one ("|2= "). Again, all subsequent parameters after a numbered parameter must also be numbered... |
{{tl7|name|2=1=a|3=last=b}} | {{name|1=a|last=b}} | ... but that's easy to fix, by adding the position number ("|3= ") to the last parameter. |
See also
[edit]- {{Template link 2}} - the {{tlx}}-version of this template
- {{Template link with parameters}} - solves the same problem
General-purpose formatting
[edit]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
[edit]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
[edit]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}}
|
{{Hatnote}} (t/l) |
{{twlh|Hatnote}}
|
Template:Hatnote (links, talk) |