Jump to content

Teamplaid:Template link with parameters/documentation

Cuir ceanglaichean ris
O Wiktionary
Shortcut

This is the template link with parameters (or {{Tlp}}) 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 {{Tld}}.

Eisimpleirean - Examples

[deasaich]
Code Output Comments
{{Tlp}} {{[[Teamplaid:{{{1}}}|{{{1}}}]]}} 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.

Faic cuideachd - Also see

These tables: seall • deasbaireachd • deasaich

General-purpose formatting

[deasaich]
Comparison of template-linking templates according to their style
Link style → Linked Unlinked Linked with subst Linked including braces Linked with alternative text
Text style ↓ ↓ {{Tlg}} options1 → DEFAULT nolink=yes subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{Tlg}}1
{{Tl}}
{{Tlp}}2
{{Tlu}}3 		{{Tlf}}2 {{Tls}}
{{Tlsp}}
{{Tlsu}}3 		{{Tn}} {{Tla}}
code code=yes {{Tl2}}
{{Tlx}}
{{Tlxu}}3 		{{Tlc}}2
{{Tld}}2
{{Tnull}} 		{{Tlxs}} N/A
monospace
kbd 		plaincode=yes4
kbd=yes5 		{{Tltt}}5
{{Tltt2}}5 		N/A {{Tltss}}6
bold bold=yes {{Tlb}} N/A
bold+code code=yes {{Tlxb}}
italic+code code=yes {{Tlxi}}

Other formatting templates

[deasaich]
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}}

Some text
 Shows code and example
{{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
{{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
{{Mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{Tlx}} for linking to Lua modules
{{Para|title|<var>book title</var>}} title=book title Formats template parameters for display, with or without values
{{Sclx|LASTING}} [[w:en: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}}
[deasaich]
Code example Effect
{{Lt|Hatnote}} Teamplaid:Hatnote (deasaich | deasbaireachd | eachdraidh | ceanglaichean | faire | logaichean)
{{Lts|Hatnote}} Teamplaid:Hatnote(deasaich deasbaireachd ceanglaichean-lìn eachdraidh)
{{T links|Hatnote}} Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{Tfd links|Hatnote}} Template:Hatnote (edit · talk · history · links · transclusions · logs · subpages · delete)
{{Tltt|Hatnote}} {{Hatnote}}
{{Tetl|Hatnote}} {{Hatnote}}
links talk view
{{Tsetl|Hatnote}} {{subst:Hatnote}}
 links talk view
{{Ti|Hatnote}} Teamplaid:Hatnote (deasbaireachd⧼dot-separator⧽ceanglaichean-lìn⧼dot-separator⧽deasaich)
{{Tic|Hatnote}} Template:Hatnote (talk links edit)
{{Tim|Hatnote}} m:Template:Hatnote (backlinks edit)
{{Tiw|Hatnote}} Teamplaid:Hatnote  (ceanglaichean deasaich) 
{{Tlt|Hatnote}} {{Hatnote}} (talk)
{{Ttl|Hatnote}} {{Hatnote}} (t/l)
{{Twlh|Hatnote}} Template:Hatnote (links, talk)
Air a tharraing à "https://gd.wiktionary.org/w/index.php?title=Teamplaid:Template_link_with_parameters/documentation&oldid=75553"