Template:Code: Difference between revisions
rm completely unused id parameter to avoid duplicate blank ids on pages with multiple transclusions |
(No difference)
|
Revision as of 15:48, 26 September 2024
{{{1}}}
{{#ifeq:code |doc
|
{{#ifeq:show |show
| | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original {{#if: |{{{text2}}} |{{#if: |{{{text1}}} |{{#ifeq:Template |User |template template page |{{#if:Template |template page|article}}}}}}}}. |
}}{{#if: |
| {{#ifexist:Template:Code
| [[Category:{{#switch:Template |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
|
}}
}}
|
}}
{{#ifeq: Code|Code| | This template is used on 63,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
| Due to a server limit of 500 "expensive parser function" calls (e.g. #ifexist:, PAGESIZE:, and PAGESINCATEGORY:), this {{#ifeq: Module | Template | module | template}} will only work properly if the page using it has not already exceeded the limit. When the limit is exceeded, the page using this template or module is categorised in Category:Pages with too many expensive parser function calls. (further information) |
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 {{#switch:pair
|c|close = |e|empty|s|single|v|void |o|open |p|pair = <{{#if:|pre|pre}}{{#if:| {{{attribs}}}}} }}{{#switch:pair |c|close = |e|empty|s|single|v|void = /> |o|open = > |p|pair = {{#ifeq:pre|!--||>}}... }}{{#switch:pair |e|empty|s|single|v|void |o|open = |c|close |p|pair = {{#ifeq:pre|!--|-->|</pre>}} }}or{{#switch:pair |c|close = |e|empty|s|single|v|void |o|open |p|pair = <{{#if:|syntaxhighlight|syntaxhighlight}}{{#if:| {{{attribs}}}}} }}{{#switch:pair |c|close = |e|empty|s|single|v|void = /> |o|open = > |p|pair = {{#ifeq:syntaxhighlight|!--||>}}... }}{{#switch:pair |e|empty|s|single|v|void |o|open = |c|close |p|pair = {{#ifeq: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: {{#if:code
|{{[[Template:{{#if:x|code}}|{{#if:x|code}}]]
The template uses the {{#switch:o
|c|close = |e|empty|s|single|v|void |o|open |p|pair = <{{#if:|syntaxhighlight|syntaxhighlight}}{{#if:| {{{attribs}}}}} }}{{#switch:o |c|close = |e|empty|s|single|v|void = /> |o|open = > |p|pair = {{#ifeq:syntaxhighlight|!--||>}}... }}{{#switch:o |e|empty|s|single|v|void |o|open = |c|close |p|pair = {{#ifeq:syntaxhighlight|!--|-->|</syntaxhighlight>}} }}tag with the attributeinline=1. This works like the combination of the{{#switch:o |c|close = |e|empty|s|single|v|void |o|open |p|pair = <{{#if:|code|code}}{{#if:| {{{attribs}}}}} }}{{#switch:o |c|close = |e|empty|s|single|v|void = /> |o|open = > |p|pair = {{#ifeq:code|!--||>}}... }}{{#switch:o |e|empty|s|single|v|void |o|open = |c|close |p|pair = {{#ifeq:code|!--|-->|</code>}} }}and{{#switch:o |c|close = |e|empty|s|single|v|void |o|open |p|pair = <{{#if:|nowiki|nowiki}}{{#if:| {{{attribs}}}}} }}{{#switch:o |c|close = |e|empty|s|single|v|void = /> |o|open = > |p|pair = {{#ifeq:nowiki|!--||>}}... }}{{#switch:o |e|empty|s|single|v|void |o|open = |c|close |p|pair = {{#ifeq:nowiki|!--|-->|</nowiki>}} }}tags, applied to the expanded wikitext. For example, {{#if:code
|{{[[Template:{{#if:x|code}}|{{#if:x|code}}]]
some '''wiki''' text
If the above example is declared as wikitext (via {{#if:code
|{{[[Template:{{#if:x|code}}|{{#if:x|code}}]]
some '''wiki''' text
However, {{#if:code
|{{[[Template:{{#if:x|code}}|{{#if:x|code}}]]
a <span class="nowrap">{{</span>[[Template:{{{1}}}|{{{1}}}]]<span class="nowrap">}}</span> call
Use {{#switch:pair
|c|close =
|e|empty|s|single|v|void
|o|open
|p|pair = <{{#if:|nowiki|nowiki}}{{#if:| {{{attribs}}}}}
}}{{#switch:pair
|c|close =
|e|empty|s|single|v|void = />
|o|open = >
|p|pair = {{#ifeq:nowiki|!--||>}}...
}}{{#switch:pair
|e|empty|s|single|v|void
|o|open =
|c|close
|p|pair = {{#ifeq:nowiki|!--|-->|</nowiki>}}
}} around the template name to avoid this problem:
a {{template}} call
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:
foo {{code|bar baz}} quux.
is well spaced:
- foo
bar bazquux.
versus:
foo {{code|bar baz}} quux.
which is less visually clear:
- foo
bar bazquux.
because "foo" and "bar" will seem more closely associated than "bar" and "baz"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter {{{2}}} (unnamed, as |{{SAFESUBST:#if:2|2=}}, or more explicitly as |{{SAFESUBST:#if:lang|lang=}}) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to |{{SAFESUBST:#if:lang|lang=}}text, i.e. no highlighting. Valid values include |{{SAFESUBST:#if:lang|lang=}}wikitext for wikitext, |{{SAFESUBST:#if:lang|lang=}}html for HTML, along with many other languages including php, perl, css, javascript, mysql. Attempting to use an invalid value for lang will cause the page to be added to Category:Pages with syntax highlighting errors, and no syntax highlighting will be present in the output. html4strict and html5 used to be valid values - however, |{{SAFESUBST:#if:lang|lang=}}html should be used instead.
This template does not need to be substituted.
Examples
{{#if: ||+ {{{title}}}}} {{#if: || Markup | Renders as
}}{{#if:Lorem {{code|ipsum '''dolor'''}} sit amet| | ||||
{{#switch:
|
none = Lorem {{code|ipsum '''dolor'''}} sit amet | syntaxhighlight = Lorem {{code|ipsum '''dolor'''}} sit amet
|
pre = Lorem {{code|ipsum '''dolor'''}} sit amet
|
#default = < style="">Lorem {{code|ipsum '''dolor'''}} sit amet</> }} | Lorem }}{{#if:Lorem {{code|ipsum '''dolor'''|wikitext}} sit amet| |
{{#switch:
|
none = Lorem {{code|ipsum '''dolor'''|wikitext}} sit amet | syntaxhighlight = Lorem {{code|ipsum '''dolor'''|wikitext}} sit amet
|
pre = Lorem {{code|ipsum '''dolor'''|wikitext}} sit amet
|
#default = < style="">Lorem {{code|ipsum '''dolor'''|wikitext}} sit amet</> }} | Lorem }}{{#if:The declaration {{code|lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.| |
{{#switch:
|
none = The declaration {{code|lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later. | syntaxhighlight = The declaration {{code|lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.
|
pre = The declaration {{code|lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.
|
#default = < style="">The declaration {{code|lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.</> }} | The declaration }}{{#if:If the code contains an [[equals sign]], such as {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also [[:bugzilla:5138]].| |
{{#switch:
|
none = If the code contains an [[equals sign]], such as {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also [[:bugzilla:5138]]. | syntaxhighlight = If the code contains an [[equals sign]], such as {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also [[:bugzilla:5138]].
|
pre = If the code contains an [[equals sign]], such as {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also [[:bugzilla:5138]].
|
#default = < style="">If the code contains an [[equals sign]], such as {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also [[:bugzilla:5138]].</> }} | If the code contains an equals sign, such as }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }} |
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 {{#switch:pair
|c|close =
|e|empty|s|single|v|void
|o|open
|p|pair = <{{#if:|code|code}}{{#if:| {{{attribs}}}}}
}}{{#switch:pair
|c|close =
|e|empty|s|single|v|void = />
|o|open = >
|p|pair = {{#ifeq:code|!--||>}}...
}}{{#switch:pair
|e|empty|s|single|v|void
|o|open =
|c|close
|p|pair = {{#ifeq: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 as
}}{{#if:{{code| {{cite web |title=Title |url=http://example.org}} |lang=html }}| | ||||
{{#switch:
|
none = {{code| {{cite web |title=Title |url=http://example.org}} |lang=html }} | syntaxhighlight = {{code| {{cite web |title=Title |url=http://example.org}} |lang=html }}
|
pre = {{code|
{{cite web |title=Title |url=http://example.org}}
|lang=html
}}
|
#default = < style="">{{code| {{cite web |title=Title |url=http://example.org}} |lang=html }}</> }} |
}}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }}{{#if:| |
{{#switch:
|
none = | syntaxhighlight = |
pre = | #default = < style=""></> }} | }} |
The above example shows the HTML rendered by the citation template, including the hidden metadata.
Expensive Parser Function warning
This template internally uses mw:Extension:SyntaxHighlight, which is considered an 'expensive parser function' (see WP:EXPENSIVE). If used on a page which uses more than 500 expensive parser functions, the output of subsequent uses of this template will be presented using {{#switch:pair
|c|close =
|e|empty|s|single|v|void
|o|open
|p|pair = <{{#if:|code|code}}{{#if:| {{{attribs}}}}}
}}{{#switch:pair
|c|close =
|e|empty|s|single|v|void = />
|o|open = >
|p|pair = {{#ifeq:code|!--||>}}...
}}{{#switch:pair
|e|empty|s|single|v|void
|o|open =
|c|close
|p|pair = {{#ifeq:code|!--|-->|</code>}}
}} formatting (without any syntax highlighting) instead.
TemplateData
{{#ifeq:{{safesubst:#switch: {{{header}}}
|no |n |f |false |off |0 = no | = yes |¬ = yes |yes |y |t |true |on |1 = yes |#default = yes}}|yes|
|=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACode%7CCode%7CCode%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}} |no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|no|S|s}}ee a monthly parameter usage report] for {{#if:Code|Template:Code|this template}} in articles{{#ifeq:{{safesubst:#switch: y
|no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|yes| based on {{#if:Code|its|this}} TemplateData}}.
|None|none=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACode%7CCode%7CCode%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}} |no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|no|P|p}}arameter usage report]{{#ifeq:{{safesubst:#switch: y
|no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|yes| based on {{#if:Code|its|this}} TemplateData}}
|for|For=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACode%7CCode%7CCode%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}} |no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|no|P|p}}arameter usage report] for {{#if:Code|Template:Code|Template:Code}}{{#ifeq:{{safesubst:#switch: y
|no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|yes| based on {{#if:Code|its|this}} TemplateData}}.
|#default=[1]{{#ifeq:{{safesubst:#switch: y |no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|yes| based on {{#if:Code|its|this}} TemplateData}} }}|This is the {{#if:|TemplateData|TemplateData}} for this template used by TemplateWizard, VisualEditor and other tools. {{#switch:
|=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACode%7CCode%7CCode%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}} |no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|no|S|s}}ee a monthly parameter usage report] for {{#if:Code|Template:Code|this template}} in articles{{#ifeq:{{safesubst:#switch: y
|no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|yes| based on {{#if:Code|its|this}} TemplateData}}.
|None|none=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACode%7CCode%7CCode%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}} |no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|no|P|p}}arameter usage report]{{#ifeq:{{safesubst:#switch: y
|no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|yes| based on {{#if:Code|its|this}} TemplateData}}
|for|For=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACode%7CCode%7CCode%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}} |no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|no|P|p}}arameter usage report] for {{#if:Code|Template:Code|Template:Code}}{{#ifeq:{{safesubst:#switch: y
|no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|yes| based on {{#if:Code|its|this}} TemplateData}}.
|#default=[2]{{#ifeq:{{safesubst:#switch: y |no |n |f |false |off |0 = no | = no |¬ = no |yes |y |t |true |on |1 = yes |#default = no
}}|yes| based on {{#if:Code|its|this}} TemplateData}} }}}}
TemplateData for Code
{{#if:
| {{{demospace}}}
| {{#ifeq:Template|Template
| template
| other
}}
}}
| template = {{#if:{{#ifeq:Code|sandbox|1}}{{#ifeq:Code|doc|1}}||
}} | other | #default = }}
}}| ⧼templatedata-doc-param-name⧽ | ⧼templatedata-doc-param-desc⧽ | ⧼templatedata-doc-param-type⧽ | ⧼templatedata-doc-param-status⧽ | |
|---|---|---|---|---|
| Code | 1code | The code to display. | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-required⧽ |
| Language | 2lang | The programming language of the source code. List of valid values is at: mw:Extension:SyntaxHighlight#Supported_languages
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-suggested⧽ |
| Class | class | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
| CSS Style | style | ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ | |
See also
- {{PreCode}}, which forbids line breaks inside the code
- {{codett}}, wrapper for this template that removes background and border styling
- {{mono}}, monospaced font only
- {{param value}}, monospaced; friendly handling for blank space
- {{Syntaxhighlight}}
- {{kbd}}, for keyboard input
- Help:Wiki markup
{{#if:{{#ifeq:Code|sandbox|1}}{{#ifeq:Code|doc|1}}||
}}