From finiki, the Canadian financial wiki
This template uses Lua :
This template, often abbreviated as {{tlp}} , is used to provide stylized formatting to template displays without actually using the template itself.
Parameters
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
Default (without accessory parameters)
{{example }}
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 }}, {{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 }}
_show_result
Will also display the result of the template.
Lua error: expandTemplate: template "Template:Min" does not exist.
_expand
Will add a link to the expanded template page.
{{Min |7|-5}}
[1]
Unnamed (Positional)
This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples
Note
On the source sister projects, en.wikipedia and Meta, X0, X1, X2, …, X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other Sister projects.
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=u}}
{{x1 |x=u}} =
is okay
{{tlp |x1|x{{=}}u}}
{{x1 |x=u}} {{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
Template:Template-linking templates
Template Example output Use {{strong }} Important! To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing {{strongbad }} "Never use ..." Same as {{strong}} but in red {{stronggood }} "Only use ..." Same as {{strong}} but in green {{em }} "An emphatic phrase " To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms) {{var }} strPrefix To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction {{var serif }} Template:Var serif (see {{var}} above) {{tld }} {{DEFAULTSORT:Y, X}}
To display wikicode variables and magic words as they would appear in code {{para }} |year=2008
To display template parameters with or without values {{param }} {{{title|alt}}}
To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above {{param value }} Template:Pvalue To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character. {{tlx }} etc. {{Template |1 |2 |...|10 }}
To display a template call (with or without parameters and values) as code {{tag }} "The <img>...</img>
tags ..." To render HTML elements ("tags") in prose {{code }}/{{codett }} "Ensure the alt=
parameter ..." To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>
. {{codett }} differs only in styling: someMethod
becomes Template:Codett {{subst:codenowiki }} {{small|small text}}
To wrap example code in <code><nowiki>...</nowiki></code>
{{subst:kbdnowiki }} {{big|big text}} To wrap example code in <kbd><nowiki>...</nowiki></kbd>
{{syntaxhighlight }} [this is a block template] (Template:Thin space ) Wrapper for <syntaxhighlight>...</syntaxhighlight>
, but will wrap overflowing text {{deprecated code }} "Do not use <blink>
." (Template:Thin space ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2 }}
variant uses strike-through (<blink >
) while {{dcr }}
uses red (<Template:Dcr >
). {{pre }} [this is a block template] For larger blocks of source code and other pre-formatted text {{quote }} [this is a block template] For block quotations (only – never for non-quotations) {{block indent }} [this is a block template] For indented blocks of material; visually identical to {{quote }}
but without quote markup {{kbd }} user input To indicate user input {{key press }} Template:Key press To indicate specific-keystroke input, including combinations {{key top }} Template:Key top Similar; includes more symbols, but does not directly support combinations {{button }} Template:Button To indicate a button in a user interface {{samp }} Template:Samp To indicate sample or example output