ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tlp/doc
Appearance
| This is a documentation subpage for ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tlp. It contains usage information, categories and other content that is not part of the original ππ°πΏππ°πΌπ΄π»π΄πΉπ½π page. |
This is the {{Tlp}} (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. (
{{Tlx}}, for instance, 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Β β i.e. on the first occurrence of a template name, use {{tl}}, {{tlp}} or {{Tlx}} and thereafter use {{tlf}}, {{βtlcβ}} or ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tlg.
Examples
[πΉπ½πΌπ°πΉπ³πΎπ°π½]| Code | Output | Comments |
|---|---|---|
{{β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
[πΉπ½πΌπ°πΉπ³πΎπ°π½]ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Navbar
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=Foo2=Foo |
| Normal | N/A | {{Tlg}}1, 2{{Tl}}{{Tlp}}2{{Tlu}}4 |
{{Tlf}}2 |
{{Tls}}{{Tlsp}} |
{{Tn}} |
{{Tla}} |
Code |
code=yes ortt=yes |
{{Tlx}}{{Tltt}}{{Tltt2}} |
{{Tlc}}2{{Tld}}2{{Tnull}} |
{{Tlxs}}{{Tltts}}{{Tltts3}}{{Tltss}}3 |
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 Uses monospace font but not
<code>...</code>. - 4 Allows links to templates in any namespace.
Other formatting templates
[πΉπ½πΌπ°πΉπ³πΎπ°π½]| Code example | Effect | Notes |
|---|---|---|
{{Tl2|Hatnote|lang=fr}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tl2 | Supports linking to sister projects (e.g., fr:Hatnote) |
{{Tlu|User:Ahunt/SSHFS}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tlu | Supports linking to any namespace |
{{Xpd|Hatnote|Some hatnote text}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Xpd | 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 |
With utility links
[πΉπ½πΌπ°πΉπ³πΎπ°π½]| Code example | Effect |
|---|---|
{{Lts|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Lts |
{{T links|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:T links |
{{Tfd links|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tfd links |
{{Tiw|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tiw |
{{Tltt|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tltt |
{{Tetl|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tetl |
{{Tsetl|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tsetl |
{{Ti|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Ti |
{{Tic|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tic |
{{Tiw|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tiw |
{{Tlt|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Tlt |
{{Ttl|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Ttl |
{{Twlh|Hatnote}} | ππ°πΏππ°πΌπ΄π»π΄πΉπ½π:Twlh |