Template:Tlp/doc

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 teletype 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|one}}	{{name|one}}
{{tlp|name|one|two}}	{{name|one|two}}
{{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 in the end.
{{tlp|name|one=a|two=b}}	{{name}}	Equal signs is a problem, but there is a fix.
{{tlp|name|2=one=a|3=two=b}}	{{name|one=a|two=b}}	Use numbered parameters to fix it. Remember to start from 2, since the "name" is number 1.

If you have equal signs in your template parameters then some find it simpler to code it using <nowiki> tags, or the = or = character references. Here's how to do that. Code to the left and actual rendering to the right:

{{tlp|name|<nowiki>one=a|two=b</nowiki>}} = {{name|one=a|two=b}}

{{tlp|name|one=a|two=b}} = {{name|one=a|two=b}}

See also

Template linking templates

	Link Style	Linked	Unlinked	Linked with subst:	Linked including braces	Linked with alternative text
Text Style	{{tlg}} option	--	nolink=yes	subst=yes	braceinside=yes	alttext=FOO
Normal	--	{{tl}}, {{tlp}}; {{tlg}}	{{tlf}}	{{tls}}, {{tlsp}}	{{tn}}	{{tla}}
Teletype	tt=yes	{{tlx}}	{{tld}}, {{tnull}}	{{tlxs}}
Bold	bold=yes	{{tlb}}
Bold Teletype	bold=yes|tt=yes	{{tlxb}}
Italic Teletype	italic=yes|tt=yes	{{tlxi}}
Code	code=yes		{{tlc}}

NOTE: {{tlg}} is the most general, allowing any combination of the above options.

Style comparison:

• {{tlf|Milford Haven Line|弘安源氏論議}} produces: {{Milford Haven Line|弘安源氏論議}}
• {{tld|Milford Haven Line|弘安源氏論議}} produces: {{Milford Haven Line|弘安源氏論議}}
• {{tlc|Milford Haven Line|弘安源氏論議}} produces: {{Milford Haven Line|弘安源氏論議}}

For parameter description,

• {{para|<var>name</var>|value}} renders: |name=value