This template should always be substituted (i.e., use
This template uses Lua :
This template, often abbreviated as {{}} , is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline. For a multi-line output, see {{tj }}.
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]
Replace [text]
with the actual label to be displayed for the template link
{{Other }}
{{tla }}
_show_result
Will also display the result of the template
{{Min |7|-5}}
→ -5
_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
Code Output Remarks {{ HTML comment | Banner }} Template:Banner does not exist. (Non-existent template is redlinked.) {{ HTML comment | Abc }} Template:Abc exists. {{ HTML comment | abC }} Template names are case-sensitive {{ HTML comment | abc }} (but the first letter is case-insensitive). {{ HTML comment | x0 }} no parameters {{ HTML comment | x1 | one }} one parameter {{ HTML comment | x2 | one | two }} two parameters {{ HTML comment | x3 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 }} ten parameters {{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
Unlimited parameters, as one < nowiki > ...</ nowiki >
string . {{ HTML comment | x2 | | two | | }} Empty parameters are discarded. {{ HTML comment | x0 | code = on }} <code> style {{ HTML comment | x0 | plaincode = on }} plaincode style {{ HTML comment | x0 | kbd = on }} <kbd> style {{ HTML comment | x0 | bold = on }} bold link/name {{ HTML comment | x1 | one | italic = on }} parameter(s) in italics {{ HTML comment | x0 | nolink = on }} {{ HTML comment | x0 | subst = on }} {{ HTML comment | x0 | brace = on }} all braces in link {{ HTML comment | x0 | braceinside = on }} inside braces in link {{ HTML comment | x0 | alttext = x0 link }} {{ HTML comment | x0 | bold = on | code = on | brace = on }} Combine multiple parameter settings. {{tlg|x1|{{spaces}}one{{spaces}}}}
Using {{spaces }} before and after a parameter. {{ HTML comment | x2 | bold = on | code = on | one | two }} Can combine named and anonymous parameters ... {{ HTML comment | x2 | one | two | bold = on | code = on }} ... in any order ... {{ HTML comment | x2 | one | code = on | two | bold = on | three }} ... even intermixed ... {{ HTML comment | x2 | one | code = on | two | bold = on | three | italic = on }} ... with many configurations. {{tlg|x1|x=u}}
= won't work {{tlg|x1|x=u}}
=
is okay {{tlg|x1|x{{=}}u}}
{{=}}
is okay (see Template:= ) {{tlg|x1|x<nowiki>=</nowiki>u}}
Sticky nowiki is okay. {{ HTML comment | x2 | 3 = two | 2 = one }} Right-to-left is okay
{{ HTML comment }} HTML comment With no arguments, it emits the current page name without braces. {{ HTML comment | x2 | 3 = one | 4 = two }} Null parameter stops parsing.
Wrapping of long names (default)
Code
Output
{{ HTML comment | 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
{{ HTML comment | nowrap = on | 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
{{ HTML comment | nowrapname = on | long template name that would wrap to new line | long value for the 1st parameter that would wrap }}
See also
General-purpose formatting
Other formatting templates
With utility links
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 }} strIllustratePrefix (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 {{tjp }} | selfref = yes To display template parameters with colors (as they would appear in the {{tj }} and {{tji }} templates) {{param value }} ··2·blanks·fore·and·aft··
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 {{tji }} {{ hatnote | Hello | selfref = yes | category = no }} To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators {{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 someMethod
Template loop detected: Template:Tls {{small|small text}}
To wrap example code in <code><nowiki>...</nowiki></code>
Template loop detected: Template:Tls {{large|large text}} To wrap example code in <kbd><nowiki>...</nowiki></kbd>
{{syntaxhighlight }} [this is a block template] ( or {{sxhl }}
) Wrapper for < syntaxhighlight > ...</ syntaxhighlight >
, but will wrap overflowing text {{deprecated code }} "Do not use < blink>
." ( or {{dc }}
) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2 }}
variant uses strike-through (< blink >
) while {{dcr }}
uses red (< blink>
). {{pre }} [this is a block template] For larger blocks of source code and other pre-formatted text {{tj }} [this is a block template] To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators {{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 }} Ctrl +x To indicate specific-keystroke input, including combinations {{key top }} Left shift Similar; includes more symbols, but does not directly support combinations {{button }} Don't save To indicate a button in a user interface {{samp }} example output To indicate sample or example output
).
Use this substitution to insert HTML comments (<!-- ... -->
) – hidden to readers – into OODA WIKI pages.
Usage
{{subst:html comment|Lorem ipsum dolor sit amet}}
↳ <!-- Lorem ipsum dolor sit amet -->
By default a space will be added before and after the given text. Use | collapsed = yes to remove it (useful in vertical comments). For example,
{{subst:html comment|collapsed=yes|
Lorem ipsum dolor sit amet
}}
will generate
<!--
Lorem ipsum dolor sit amet
-->
In substitutable templates, use {{{{{|safesubst:}}}HTML comment|...}}
.
Notable cases
Using this substitution allows the expansion of MediaWiki commands inside HTML comments, where they would be preserved verbatim otherwise. Compare:
{{subst:html comment|Template:HTML comment/doc}}
↳ <!-- Template:HTML comment -->
and:
<!-- {{subst:FULLPAGENAME}} -->
↳ <!-- {{subst:FULLPAGENAME}} -->
See also