Template:Tlp

{{tlp|...}}

Template documentation

[view] [edit] [history] [purge]

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}}	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}}	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}}	3=") to the last parameter.

TemplateData

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

Tlp

<templatedata> { "description": "Template link with parameters", "format": "inline", "params": { "1": { "label": "Template", "description": "Linked template name", "required": true, "type": "wiki-template-name" }, "2": { "label": "Parameter 1", "description": "First parameter value", "type": "string" }, "3": { "label": "Parameter 2", "description": "Second parameter value", "type": "string" }, "4": { "label": "Parameter 3", "description": "Third parameter value", "type": "string" }, "5": { "label": "Parameter 4", "description": "Fourth parameter value", "type": "string" }, "6": { "label": "Parameter 5", "description": "Fifth parameter value", "type": "string" }, "7": { "label": "Parameter 6", "description": "Sixth parameter value", "type": "string" }, "8": { "label": "Parameter 7", "description": "Seventh parameter value", "type": "string" }, "9": { "label": "Parameter 8", "description": "Eight parameter value", "type": "string" } } } </templatedata>

See also

· <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>

Comparison of template-linking templates according to the styles of generated text and link produced

Text style ↓	{{tlg}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst
{{tlg}} options to achieve link style	N/A	DEFAULT	nolink=1	subst=1
normal	DEFAULT	{{tlg}} {{Tl }} {{tlp|1|2|...}}	{{tlf}} <template link>	{{subst :tls}} {{subst :Template:tlsu}}
code	code=1	{{tl2}}	{{tlc}} <template link> {{tnull}} <template link>	{{subst :tlxs}}
monospace	mono=1	{{tlx}} {{tll}}	N/A
plaincode	plaincode=1
kbd	kbd=1

The above documentation is transcluded from Template:Tlp/doc. (edit | history)
Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.