| 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
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
- Template loop detected: Template:Code
However, {{code|a {{template}} call}} will still invoke the template:
- Template loop detected: Template:Code
Use <nowiki>...</nowiki> around the template name to avoid this problem:
- Template loop detected: Template:Code
When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
- Template loop detected: Template:Code
is well spaced:
- foo Template loop detected: Template:Code quux.
versus:
- Template loop detected: Template:Code
which is going to be visually confusing for many:
- foo Template loop detected: Template:Code quux.
because "foo" and "Template loop detected: Template:Code" will seem more closely associated than "Template loop detected: Template:Code" and "Template loop detected: Template:Code"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though Template loop detected: Template:Code and Template loop detected: Template:Code are valid values, as are Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.
This template does not need to be substituted.
Examples
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
TemplateData
Script error: No such module "Format TemplateData".
See also
|
|---|
| 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 Template loop detected: Template:Code parameter ..." | To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: Template loop detected: Template:Code becomes Template loop detected: Template:Code | | {{subst:codenowiki}} | {{small|small text}} | To wrap example code in Template loop detected: Template:Code | | {{subst:kbdnowiki}} | {{large|large text}} | To wrap example code in Template loop detected: Template:Code | | {{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}} | {{ hatnote | Hello | selfref = yes | category = no}} | 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}} | Script error: No such module "key". | 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 |
|
| To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling:
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
- Template loop detected: Template:Code
However, {{code|a {{template}} call}} will still invoke the template:
- Template loop detected: Template:Code
Use <nowiki>...</nowiki> around the template name to avoid this problem:
- Template loop detected: Template:Code
When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
- Template loop detected: Template:Code
is well spaced:
- foo Template loop detected: Template:Code quux.
versus:
- Template loop detected: Template:Code
which is going to be visually confusing for many:
- foo Template loop detected: Template:Code quux.
because "foo" and "Template loop detected: Template:Code" will seem more closely associated than "Template loop detected: Template:Code" and "Template loop detected: Template:Code"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though Template loop detected: Template:Code and Template loop detected: Template:Code are valid values, as are Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.
This template does not need to be substituted.
Examples
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
TemplateData
Script error: No such module "Format TemplateData".
See also
|
|---|
| 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 Template loop detected: Template:Code parameter ..." | To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: Template loop detected: Template:Code becomes Template loop detected: Template:Code | | {{subst:codenowiki}} | {{small|small text}} | To wrap example code in Template loop detected: Template:Code | | {{subst:kbdnowiki}} | {{large|large text}} | To wrap example code in Template loop detected: Template:Code | | {{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}} | {{ hatnote | Hello | selfref = yes | category = no}} | 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}} | Script error: No such module "key". | 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 |
|
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
- Template loop detected: Template:Code
However, {{code|a {{template}} call}} will still invoke the template:
- Template loop detected: Template:Code
Use <nowiki>...</nowiki> around the template name to avoid this problem:
- Template loop detected: Template:Code
When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
- Template loop detected: Template:Code
is well spaced:
- foo Template loop detected: Template:Code quux.
versus:
- Template loop detected: Template:Code
which is going to be visually confusing for many:
- foo Template loop detected: Template:Code quux.
because "foo" and "Template loop detected: Template:Code" will seem more closely associated than "Template loop detected: Template:Code" and "Template loop detected: Template:Code"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though Template loop detected: Template:Code and Template loop detected: Template:Code are valid values, as are Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.
This template does not need to be substituted.
Examples
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
TemplateData
Script error: No such module "Format TemplateData".
See also
|
|---|
| 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 Template loop detected: Template:Code parameter ..." | To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: Template loop detected: Template:Code becomes Template loop detected: Template:Codett | | {{subst:codenowiki}} | {{small|small text}} | To wrap example code in Template loop detected: Template:Code | | {{subst:kbdnowiki}} | {{large|large text}} | To wrap example code in Template loop detected: Template:Code | | {{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}} | {{ hatnote | Hello | selfref = yes | category = no}} | 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}} | Script error: No such module "key". | 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 |
|
| | {{subst:codenowiki}} | {{small|small text}} | To wrap example code in
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
- Template loop detected: Template:Code
However, {{code|a {{template}} call}} will still invoke the template:
- Template loop detected: Template:Code
Use <nowiki>...</nowiki> around the template name to avoid this problem:
- Template loop detected: Template:Code
When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
- Template loop detected: Template:Code
is well spaced:
- foo Template loop detected: Template:Code quux.
versus:
- Template loop detected: Template:Code
which is going to be visually confusing for many:
- foo Template loop detected: Template:Code quux.
because "foo" and "Template loop detected: Template:Code" will seem more closely associated than "Template loop detected: Template:Code" and "Template loop detected: Template:Code"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though Template loop detected: Template:Code and Template loop detected: Template:Code are valid values, as are Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.
This template does not need to be substituted.
Examples
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
TemplateData
Script error: No such module "Format TemplateData".
See also
|
|---|
| 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 Template loop detected: Template:Code parameter ..." | To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: Template loop detected: Template:Code becomes Template loop detected: Template:Code | | {{subst:codenowiki}} | {{small|small text}} | To wrap example code in Template loop detected: Template:Code | | {{subst:kbdnowiki}} | {{large|large text}} | To wrap example code in Template loop detected: Template:Code | | {{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}} | {{ hatnote | Hello | selfref = yes | category = no}} | 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}} | Script error: No such module "key". | 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 |
|
| | {{subst:kbdnowiki}} | {{large|large text}} | To wrap example code in
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
- Template loop detected: Template:Code
However, {{code|a {{template}} call}} will still invoke the template:
- Template loop detected: Template:Code
Use <nowiki>...</nowiki> around the template name to avoid this problem:
- Template loop detected: Template:Code
When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
- Template loop detected: Template:Code
is well spaced:
- foo Template loop detected: Template:Code quux.
versus:
- Template loop detected: Template:Code
which is going to be visually confusing for many:
- foo Template loop detected: Template:Code quux.
because "foo" and "Template loop detected: Template:Code" will seem more closely associated than "Template loop detected: Template:Code" and "Template loop detected: Template:Code"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though Template loop detected: Template:Code and Template loop detected: Template:Code are valid values, as are Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.
This template does not need to be substituted.
Examples
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
| Markup |
Renders asScript error: No such module "For loop".
|
|
|
|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
TemplateData
Script error: No such module "Format TemplateData".
See also
|
|---|
| 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 Template loop detected: Template:Code parameter ..." | To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: Template loop detected: Template:Code becomes Template loop detected: Template:Code | | {{subst:codenowiki}} | {{small|small text}} | To wrap example code in Template loop detected: Template:Code | | {{subst:kbdnowiki}} | {{large|large text}} | To wrap example code in Template loop detected: Template:Code | | {{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}} | {{ hatnote | Hello | selfref = yes | category = no}} | 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}} | Script error: No such module "key". | 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 |
|
| | {{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}} | {{ hatnote | Hello | selfref = yes | category = no}} | 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}} | Script error: No such module "key". | 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 |
|
Template documentation