Template:Tlp/doc
![]() |
This is a documentation subpage for Template:Tlp (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
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{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}}
= {{name{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}}
Features of {{tlp{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}}:
- 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{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}} uses teletype 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{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} or {{tlx{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}{{{10}}}{{{11}}}...}}, and then use {{tlf{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}}, {{tld{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} or {{tlc{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}}
.
Examples[edit source]
Code | Result | Comment |
---|---|---|
{{tlp{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | {{tlp{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | Shows its own syntax. |
{{tlp{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | {{name{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | |
{{tlp{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | {{name{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | |
{{tlp{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | {{name{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | |
{{tlp|name|a|b|c|d|e|f|g|h|i|j}} | {{name}} | Shows up to eight parameters. The rest are dropped. |
{{tlp{{{7}}}{{{8}}}{{{9}}}}} | {{name{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | Also shows empty parameters. |
{{tlp{{{8}}}{{{9}}}}} | {{name{{{7}}}{{{8}}}{{{9}}}}} | Even shows empty parameters that come in the end. |
{{tlp{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | {{name{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | Equal signs is a problem, but there is a fix. |
{{tlp{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | {{name{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}} | Use numbered parameters to fix it. Remember to start from 2, since the "name" is number 1. |
If you have equal signs in your template parameters then some find it simpler to code it using <nowiki>
tags. Here's how to do that. Code to the left and actual rendering to the right:
{{tlp|name|<nowiki>one=a|two=b</nowiki>}}
= {{name{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}}
See also[edit source]
- {{tlc}} – Not linked, several parameters and text in
<code></code>
style. - {{tld}} – Not linked, several parameters and teletype text style.
- {{tlf}} – Not linked, several parameters and normal text style.
- {{tl}} – Template link, no parameters and normal text style.
- {{tlp}} – Template link, several parameters and normal text style.
- {{tlx}} – Template link, several parameters and interwiki links, teletype text style.
- {{tn}} – Same as {{tl{{{2}}}{{{3}}}{{{4}}}{{{5}}}{{{6}}}{{{7}}}{{{8}}}{{{9}}}}}, but shows the braces as part of the link.