Template:Tlp: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
(No difference)
|
Latest revision as of 15:58, 9 February 2014
{{tlp|...}}
This template is used on 30,000+ pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in a user subpage, and consider discussing changes at the talk page before implementing them. |
This is the {{Tlp}} or template link with parameters template.
It can be used in documentation and talk page discussions to show how a template name would be used in code.
Here is how this template looks. Code to the left and actual rendering to the right:
{{Tlp|name|parameters}}
= {{name|parameters}}
Features of {{Tlp}}:
- It shows a template name with a link to that template.
- It shows up to eight parameters.
- It also shows empty parameters. (See examples below.)
- It prevents line wraps in its output.
- It uses normal text style. (While for instance
{{Tlx}}
uses<code>...</code>
text style.)
This template belongs to a whole family of similar templates. See the see also section below for some of them. For instance, when writing documentation you might want to avoid a lot of unnecessary links, since it decreases readability. Then on the first occurrence of a template name use {{Tl}}, {{Tlp}} or {{Tlx}}
, and then use {{Tlf}}, {{Tld}}
or {{Tlc}}
.
Examples
Code | Result | Comment |
---|---|---|
{{tlp}} |
{{tlp|...}} | Shows its own syntax. |
{{tlp|name}} |
{{name}} | |
{{tlp|name|first}} |
{{name|first}} | |
{{tlp|name|first|last}} |
{{name|first|last}} | |
{{tlp|name|a|b|c|d|e|f|g|h|i|j}} |
{{name|a|b|c|d|e|f|g|h}} | Shows up to eight parameters. The rest are dropped. |
{{tlp|name|||three|four}} |
{{name|||three|four}} | Also shows empty parameters. |
{{tlp|name|||three||}} |
{{name|||three||}} | Even shows empty parameters that come at the end. |
{{tlp|name|first=a|last=b}} |
{{name}} | Equal signs are a problem, but there are a couple ways to fix: |
{{tlp|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.
|
{{tlp|name|first{{=}}a|last{{=}}b}} |
{{name|first=a|last=b}} | Or, simply use, "{{=}}", the equal-sign template, to "escape" the symbol. |
{{tlp|name|2=1=a|3=2=b}} |
{{name|1=a|2=b}} | Both techniques also work with numbered positional parameters (e.g.: "|1= ", "|2= ").
|
{{tlp|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...
|
{{tlp|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
General-purpose formatting
Link style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
---|---|---|---|---|---|---|
Text style ↓ | ↓ {{tlg}} options1 →
|
N/A |
|
|
|
|
Normal | N/A | {{tlg}} 1, 2{{tl}} {{tlp}} 2
|
{{tlf}} 2
|
{{tls}} {{tlsp}}
|
{{tn}}
|
{{tla}}
|
Code
|
or
|
{{tlx}} {{tltt}} {{tltt2}}
|
{{tlc}} 2{{tld}} 2{{tnull}}
|
{{tlxs}} {{tltts}} {{Tltts3}} {{Tltss}} 3
|
N/A | |
Bold |
|
{{tlb}}
|
N/A | |||
Bold code
|
|
{{tlxb}}
| ||||
Italic code
|
|
{{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 Uses monospace font but not
<code>...</code>
.
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 |
{{xpd|Hatnote|Some hatnote text}} |
"{{hatnote|Some hatnote text}}" gives "Some hatnote text " [1] |
Shows code, example and a link to expand the template code |
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}} |
|
{{tiw|Hatnote}} |
|
{{tltt|Hatnote}} |
{{Hatnote}} |
{{tetl|Hatnote}} |
{{ Hatnote }} |
{{Tlsetl|Hatnote}} |
{{ subst:Hatnote }} |
{{ti|Hatnote}} |
Template:Hatnote (talk, links, edit) |
{{tic|Hatnote}} |
Template:Hatnote (talk, links, edit) |
{{tiw|Hatnote}} |
|
{{tlt|Hatnote}} |
{{Hatnote}} (talk) |
{{ttl|Hatnote}} |
{{Hatnote}} (t/l) |
{{Twlh|Hatnote}} |
Template:Hatnote (links, talk) |
The above documentation is transcluded from Template:Tlp/doc. (edit | history) Editors can experiment in this template's sandbox (edit | diff) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |