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 |
| 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 | {{codenowiki|Banner}} | {{subst:Nowiki|Banner}} | Template:Banner does not exist. (Non-existent template is redlinked.) | {{codenowiki|Abc}} | {{subst:Nowiki|Abc}} | Template:Abc exists. | {{codenowiki|abC}} | {{subst:Nowiki|abC}} | Template names are case-sensitive | {{codenowiki|abc}} | {{subst:Nowiki|abc}} | (but the first letter is case-insensitive). | {{codenowiki|x0}} | {{subst:Nowiki|x0}} | no parameters | {{codenowiki|x1|one}} | {{subst:Nowiki|x1}} | one parameter | {{codenowiki|x2|one|two}} | {{subst:Nowiki|x2}} | two parameters | {{codenowiki|x3|1|2|3|4|5|6|7|8|9|10}} | {{subst:Nowiki|x3}} | ten parameters | {{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | {{subst:Nowiki|convert}} | Unlimited parameters, as one <nowiki>...</nowiki> string. | {{codenowiki|x2||two||}} | {{subst:Nowiki|x2}} | Empty parameters are discarded. | {{codenowiki|x0|code=on}} | {{subst:Nowiki|x0}} | <code> style | {{codenowiki|x0|plaincode=on}} | {{subst:Nowiki|x0}} | plaincode style | {{codenowiki|x0|kbd=on}} | {{subst:Nowiki|x0}} | <kbd> style | {{codenowiki|x0|bold=on}} | {{subst:Nowiki|x0}} | bold link/name | {{codenowiki|x1|one|italic=on}} | {{subst:Nowiki|x1}} | parameter(s) in italics | {{codenowiki|x0|nolink=on}} | {{subst:Nowiki|x0}} | | {{codenowiki|x0|subst=on}} | {{subst:Nowiki|x0}} | | {{codenowiki|x0|brace=on}} | {{subst:Nowiki|x0}} | all braces in link | {{codenowiki|x0|braceinside=on}} | {{subst:Nowiki|x0}} | inside braces in link | {{codenowiki|x0|alttext=x0 link}} | {{subst:Nowiki|x0}} | | {{codenowiki|x0|bold=on|code=on|brace=on}} | {{subst:Nowiki|x0}} | Combine multiple parameter settings. | {{tlg|x1|{{spaces}}one{{spaces}}}} | {{subst:Nowiki|abc}} | Using {{spaces}} before and after a parameter. | {{codenowiki|x2|bold=on|code=on|one|two}} | {{subst:Nowiki|x2}} | Can combine named and anonymous parameters ... | {{codenowiki|x2|one|two|bold=on|code=on}} | {{subst:Nowiki|x2}} | ... in any order ... | {{codenowiki|x2|one|code=on|two|bold=on|three}} | {{subst:Nowiki|x2}} | ... even intermixed ... | {{codenowiki|x2|one|code=on|two|bold=on|three|italic=on}} | {{subst:Nowiki|x2}} | ... with many configurations. | {{tlg|x1|x=u}} | {{subst:Nowiki|x1}} | = won't work | {{tlg|x1|x=u}} | {{subst:Nowiki|x1}} | = is okay | {{tlg|x1|x{{=}}u}} | {{subst:Nowiki|x1}} | {{=}} is okay (see Template:=) | {{tlg|x1|x<nowiki>=</nowiki>u}} | {{subst:Nowiki|x1}} | Sticky nowiki is okay. | {{codenowiki|x2|3=two|2=one}} | {{subst:Nowiki|x2}} | Right-to-left is okay | {{codenowiki}} | codenowiki | With no arguments, it emits the current page name without braces. | {{codenowiki|x2|3=one|4=two}} | {{subst:Nowiki|x2}} | Null parameter stops parsing. |
Wrapping of long names (default)
Code
|
Output
|
{{codenowiki|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}}
|
Wrapping of long names (nowrap=on)
Code
|
Output
|
{{codenowiki|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}}
|
Wrapping of long names (nowrapname=on)
Code
|
Output
|
{{codenowiki|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}}
|
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 |
|
| {{small|small text}} | To wrap example code in <code><nowiki>...</nowiki></code> |
| 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}} [2] |
|
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 | {{kbdnowiki|Banner}} | {{subst:nowiki|Banner}} | Template:Banner does not exist. (Non-existent template is redlinked.) | {{kbdnowiki|Abc}} | {{subst:nowiki|Abc}} | Template:Abc exists. | {{kbdnowiki|abC}} | {{subst:nowiki|abC}} | Template names are case-sensitive | {{kbdnowiki|abc}} | {{subst:nowiki|abc}} | (but the first letter is case-insensitive). | {{kbdnowiki|x0}} | {{subst:nowiki|x0}} | no parameters | {{kbdnowiki|x1|one}} | {{subst:nowiki|x1}} | one parameter | {{kbdnowiki|x2|one|two}} | {{subst:nowiki|x2}} | two parameters | {{kbdnowiki|x3|1|2|3|4|5|6|7|8|9|10}} | {{subst:nowiki|x3}} | ten parameters | {{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | {{subst:nowiki|convert}} | Unlimited parameters, as one <nowiki>...</nowiki> string. | {{kbdnowiki|x2||two||}} | {{subst:nowiki|x2}} | Empty parameters are discarded. | {{kbdnowiki|x0|code=on}} | {{subst:nowiki|x0}} | <code> style | {{kbdnowiki|x0|plaincode=on}} | {{subst:nowiki|x0}} | plaincode style | {{kbdnowiki|x0|kbd=on}} | {{subst:nowiki|x0}} | <kbd> style | {{kbdnowiki|x0|bold=on}} | {{subst:nowiki|x0}} | bold link/name | {{kbdnowiki|x1|one|italic=on}} | {{subst:nowiki|x1}} | parameter(s) in italics | {{kbdnowiki|x0|nolink=on}} | {{subst:nowiki|x0}} | | {{kbdnowiki|x0|subst=on}} | {{subst:nowiki|x0}} | | {{kbdnowiki|x0|brace=on}} | {{subst:nowiki|x0}} | all braces in link | {{kbdnowiki|x0|braceinside=on}} | {{subst:nowiki|x0}} | inside braces in link | {{kbdnowiki|x0|alttext=x0 link}} | {{subst:nowiki|x0}} | | {{kbdnowiki|x0|bold=on|code=on|brace=on}} | {{subst:nowiki|x0}} | Combine multiple parameter settings. | {{tlg|x1|{{spaces}}one{{spaces}}}} | {{subst:nowiki|abc}} | Using {{spaces}} before and after a parameter. | {{kbdnowiki|x2|bold=on|code=on|one|two}} | {{subst:nowiki|x2}} | Can combine named and anonymous parameters ... | {{kbdnowiki|x2|one|two|bold=on|code=on}} | {{subst:nowiki|x2}} | ... in any order ... | {{kbdnowiki|x2|one|code=on|two|bold=on|three}} | {{subst:nowiki|x2}} | ... even intermixed ... | {{kbdnowiki|x2|one|code=on|two|bold=on|three|italic=on}} | {{subst:nowiki|x2}} | ... with many configurations. | {{tlg|x1|x=u}} | {{subst:nowiki|x1}} | = won't work | {{tlg|x1|x=u}} | {{subst:nowiki|x1}} | = is okay | {{tlg|x1|x{{=}}u}} | {{subst:nowiki|x1}} | {{=}} is okay (see Template:=) | {{tlg|x1|x<nowiki>=</nowiki>u}} | {{subst:nowiki|x1}} | Sticky nowiki is okay. | {{kbdnowiki|x2|3=two|2=one}} | {{subst:nowiki|x2}} | Right-to-left is okay | {{kbdnowiki}} | kbdnowiki | With no arguments, it emits the current page name without braces. | {{kbdnowiki|x2|3=one|4=two}} | {{subst:nowiki|x2}} | Null parameter stops parsing. |
Wrapping of long names (default)
Code
|
Output
|
{{kbdnowiki|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}}
|
Wrapping of long names (nowrap=on)
Code
|
Output
|
{{kbdnowiki|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}}
|
Wrapping of long names (nowrapname=on)
Code
|
Output
|
{{kbdnowiki|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}}
|
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 |
|
| {{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 |