Skabelon:Tlp/doc

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

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.

General-purpose formatting

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 →	N/A	nolink=yes	subst=yes	braceinside=yes	alttext=Foo 2=Foo
Normal	N/A	{{tlg}}1, 2 {{tl}} {{tlp}}2 {{tlu}}4	{{tlf}}2	{{tls}} {{tlsp}}	{{tn}}	{{tla}}
Code	code=yes or tt=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}}

• ¹ {{tlg}} is the most general, allowing any combination of text style and/or link style options.
• ² Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
• ³ Uses monospace font but not <code>...</code>.
• ⁴ Allows links to templates in any namespace.

Other formatting templates

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
{{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

With utility links

Code example	Effect
{{lts|Hatnote}}	Skabelon:Hatnote(rediger diskussion links historik)
{{t links|Hatnote}}	Skabelon:T links
{{tfd links|Hatnote}}	Skabelon:Tfd links
{{tiw|Hatnote}}	Skabelon:hatnote (backlinks redigér)
{{tltt|Hatnote}}	{{Hatnote}}
{{tetl|Hatnote}}	Skabelon:Tetl
{{tsetl|Hatnote}}	Skabelon:Tsetl
{{ti|Hatnote}}	Skabelon:Ti
{{tic|Hatnote}}	Skabelon:Tic
{{tiw|Hatnote}}	Skabelon:Hatnote (backlinks redigér)
{{tlt|Hatnote}}	Skabelon:Tlt
{{ttl|Hatnote}}	Skabelon:Ttl
{{twlh|Hatnote}}	Skabelon:Twlh