Template:Template link with parameters

From Gratispaideia, the free and educational encyclopedia
Template documentation[view] [edit] [history] [purge]

This template, often abbreviated as {{tlp}}, is used to provide stylized formatting to template displays without actually using the template itself.

Parameters[edit source]

With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options.

Parameter Action Use with
{{example}}
Default active
brace Include braces as part of the template link {{example}} {{tlw}}/{{tn}}
braceinside Include innermost braces as part of the template link {{example}}
bold Renders the template link/name in bold {{example}} {{tlb}}, {{tlxb}}
code Display output using HTML <code>...</code> tags (monospaced font) {{example}} {{tlc}}, {{Template link expanded}}, etc.
italic Display any parameters accompanying the template link/name in italics {{example|param}} {{tlxi}}
kbd Display output using HTML <kbd>...</kbd> tags (monospaced font) {{example}}
nolink Don't render the template name as a link {{example}} {{tlf}}, {{tlc}}, {{tnull}}
nowrap Prevent the insertion of line breaks (word wrap) in the output {{example}}
nowrapname Prevent word wrapping in the output of template name/link (parameters will wrap if needed) {{example}}
plaincode Uses <code style="border:none; background:transparent;">...</code> {{example}} {{tltss}}
subst Include a subst: prefix before the template link/name {{subst:example}} {{tls}}, {{tlxs}}, etc
|alttext=[text] Use [text] as the label for the template link {{Other}} {{tla}}

Unnamed (Positional)[edit source]

This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.

Examples[edit source]

Code Output Remarks
{{tlp|Banner}} {{Banner}} Banner template does not exist. Be aware with linking to non-existing templates, although desired.
{{tlp|ok}} {{ok}} ok template does exist
{{tlp|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} {{convert|14|m|ftin|abbr=out|sp=us}} Unlimited parameters as one <nowiki>...</nowiki> string
{{tlp|Abc}} {{Abc}}
{{tlp|abC}} {{abC}} template names are case-sensitive
{{tlp|abc}} {{abc}} first letter is case-insensitive though
{{tlp|abc|{{spaces}}tlp{{spaces}}}} {{abc| tlp }} Using {{spaces}} before and after {{{1}}} parameter.
{{tlp|x0}} {{x0}}
{{tlp|x0|code=on}} {{x0}} <code> style
{{tlp|x0|plaincode=on}} {{x0}} plaincode style
{{tlp|x0|kbd=on}} {{x0}} <kbd> style
{{tlp|x0|bold=on}} {{x0}} bold link/name
{{tlp|x1|one|italic=on}} {{x1|one}} parameter/s in italics
{{tlp|x0|nolink=on}} {{x0}}
{{tlp|x0|subst=on}} {{subst:x0}}
{{tlp|x0|brace=on}} {{x0}} all braces in link
{{tlp|x0|braceinside=on}} {{x0}} inside braces in link
{{tlp|x0|alttext=x0 link}} {{x0 link}}
{{tlp|x0|bold=on|code=on|brace=on}} {{x0}} No reason you can't combine multiple parameter settings
{{tlp|x1|one}} {{x1|one}}
{{tlp|x2|one|two}} {{x2|one|two}}
{{tlp|x2|bold=on|code=on|one|two}} {{x2|one|two}} Can combine named and anonymous parameters …
{{tlp|x2|one|two|bold=on|code=on}} {{x2|one|two}} … in any order …
{{tlp|x2|one|code=on|two|bold=on|three}} {{x2|one|two|three}} … even intermixed …
{{tlp|x2|one|code=on|two|bold=on|three|italic=on}} {{x2|one|two|three}} … with many different configurations.
{{tlp|x3|1|2|3|4|5|6|7|8|9|10}} {{x3|1|2|3|4|5|6|7|8|9|10}}
{{tlp}} tlp with no arguments, the current page name is substituted
{{tlp|x1|x=u}} {{x1}} = won't work
{{tlp|x1|x&#61;u}} {{x1|x=u}}
&#61; is okay
{{tlp|x1|x{{=}}u}} {{x1|x=u}}
{{=}} is okay (see template equal sign)
{{tlp|x1|x<nowiki>=</nowiki>u}} {{x1|x=u}}
sticky nowiki is okay
{{tlp|x2||two||}} {{x2||two}} empty parameters work too, even at the end
{{tlp|x2|3=two|2=one}} {{x2|one|two}}
right to left okay
Wrapping of long names (default)
Code Output
{{tlp|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} {{long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}}
Wrapping of long names (nowrap=on)
Code Output
{{tlp|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} {{long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
Wrapping of long names (nowrapname=on)
Code Output
{{tlp|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} {{long template name that would wrap to new line|long value for the 1st parameter that would wrap}}

See also[edit source]

General-purpose formatting[edit source]

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 Unlinked with subst Linked including braces Linked with alternative text
{{tlg}} options[note 1]
to achieve link style
N/A DEFAULT nolink=yes subst=yes nolink=yes|subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{tlg}}[note 1]
{{tl}}
{{tlp|1|2|...}}[note 2]
{{Template:tlu}}[note 3]
{{tlf}}[note 2]
<template link>
{{subst:tls}}
{{subst:Template:tlsu}}[note 3]
{{tlsf}}[note 2]
<template link>
Template:Tn Template:Tla
code code=yes {{tl2}}
{{tlx}}
{{Template:tlxu}}[note 3]
{{tlc}}[note 2]
<template link>
{{tnull}}<template link>
{{subst:tlxs}} {{subst:tlsc}}[note 2]
<template link>
N/A
monospace plaincode=yes[note 4] N/A {{subst:tltss}}[note 5] N/A
kbd kbd=yes[note 5]
bold bold=yes {{tlb}} N/A
bold+code bold=yes|code=yes Template:Tlxb
italic+code italic=yes|code=yes {{tlxi}}
  1. ^ a b c {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. ^ a b c d e Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. ^ a b c Allows links to templates in any namespace.
  4. ^ {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  5. ^ a b Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates[edit source]

Templates producing specialised formatting effects for given templates, modules or parameters
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
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}
{{hatnote|lang=fr|Some text}}

Shows code and example
{{xpd|Hatnote|Some hatnote text}} Template:Xpd Shows code, example and a link to expand the template code
{{tln|Hatnote}} Template:Tln Produces a normal link to the template
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}
Template:Elc
Template:Elc
Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values
{{sclx|LASTING}} Template:Sclx Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
{{tag|ref}}
{{xtag|templatedata}}
<ref>...</ref>
Template:Xtag
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}} Template:Dtl Gratisdata counterpart to {{tl}}
{{pf|if}}
{{pf|if|{{{1}}}|true|false}}
{{#if}}
{{#if:{{{1}}}|true|false}}
Parser function equivalent to {{tl}}
{{magic word|uc:}} {{uc:}} Magic word links

With utility links[edit source]

Templates producing utility links for a given template (Hatnote used here as example)
Code example Effect
{{lt|Hatnote}} Template:Lt
{{lts|Hatnote}} Template:Lts
{{t links|Hatnote}} Template:T links
{{tfd links|Hatnote}} Template:Tfd links
{{tetl|Hatnote}} Template:Tetl
{{tsetl|Hatnote}} Template:Tsetl
{{ti|Hatnote}} Template:Ti
{{tic|Hatnote}} Template:Tic
{{tim|Hatnote}} Template:Tim
{{tiw|Hatnote}} Template:Tiw
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} Template:Ttl
{{twlh|Hatnote}} Template:Twlh