Sjabloon:Tlp/doc

Uit informatiestandaarden
Naar navigatie springen Naar zoeken springen

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

Template linking templates
Link style → Linked Unlinked Linked with subst Linked including braces Linked with alternative text
Text style ↓ {{tlg}} option1 nolink=yes subst=yes braceinside=yes alttext=FOO
Normal {{tl}} · {{tlp}}2 · {{tlg}}1, 2 {{tlf}}2 {{tls}} · {{tlsp}} {{tn}} {{tla}}
Code code=yes or
tt=yes
{{tlx}} {{tlc}}2 · {{tld}} · {{tnull}} {{tlxs}}  
Bold bold=yes {{tlb}}  
Bold code bold=yes|code=yes {{tlxb}}
Italic code italic=yes|code=yes {{tlxi}}
NOTES:  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 of <span class="nowrap">...</span> tags.


Style comparison
  • {{tlf|Milford Haven Line|弘安源氏論議}} …renders… {{Milford Haven Line|弘安源氏論議}}
  • {{tld|Milford Haven Line|弘安源氏論議}} …renders… {{Milford Haven Line|弘安源氏論議}}
  • {{tlc|Milford Haven Line|弘安源氏論議}} …renders… {{Milford Haven Line|弘安源氏論議}}


For parameter description
  • {{para|name|{{var|value}}}} …renders… |name=value
  • {{para|name|{{varserif|value}}}} …renders… |name=value
  • {{tlx|Milford Haven Line|first parameter{{=}}first value}} …renders… {{Milford Haven Line|first parameter=first value}}