Template:Tlp/doc

From wikiNonStop
Revision as of 06:14, 16 August 2024 by Majestix (talk | contribs) (1 revision imported: initial Setup)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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}}.

Examples

Code Output Comments
{{tlp}} {{[[Template:{{{1}}}|{{{1}}}]]}} Shows its own syntax.
name}} {{name}}
{{tlp|name|first}} {{name|first}}
name|first|last}} {{name|first|last}}
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.
name four}} {{name four}} Also shows empty parameters.
name }} {{name }} 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.
name|first{{= }}a|last{{= }}b}} {{name|first=a|last=b}} Or, simply use, "{{=}}", the equal-sign template, to "escape" the symbol.
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...
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.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Tlp

Template link with parameters

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Template1

Linked template name

Templaterequired
Parameter 12

First parameter value

Stringoptional
Parameter 23

Second parameter value

Stringoptional
Parameter 34

Third parameter value

Stringoptional
Parameter 45

Fourth parameter value

Stringoptional
Parameter 56

Fifth parameter value

Stringoptional
Parameter 67

Sixth parameter value

Stringoptional
Parameter 78

Seventh parameter value

Stringoptional
Parameter 89

Eight parameter value

Stringoptional

See also

These tables: view · talk · edit

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} options[note 1]
to achieve text style
Link style
Linked Unlinked Linked with subst
{{tlg}} options[note 1]
to achieve link style
N/A DEFAULT nolink=1 subst=1
normal DEFAULT
code code=1
monospace mono=1[note 4] N/A
plaincode plaincode=1[note 5]
kbd kbd=1[note 6]
  1. 1.0 1.1 1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. 2.0 2.1 2.2 Prevents wrapping of text by placing it inside <span style="white-space:nowrap">...</span> tags.
  3. Allows links to templates in any namespace.
  4. 4.0 4.1 4.2 Displays monospaced font using <span style="font-family:monospace">...</span>.
  5. {{Template:Tlp/doc}} uses <code style="background:transparent;border:none">...</code> .
  6. {{Template:Tlp/doc}} uses ‎<kbd> tags.