More actions
Created page with "{{wikipedia|page name}} {{Documentation subpage}} <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> {{#ifeq: {{PAGENAME}}|{{ROOTPAGENAME}}|{{High-risk}}}} {{Expensive}} ==Usage== Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. See Help:Wik..." |
No edit summary |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | ||
{{#ifeq: {{PAGENAME}}|{{ROOTPAGENAME}}| | {{#ifeq: {{PAGENAME}}|{{ROOTPAGENAME}}|}} | ||
==Usage== | ==Usage== | ||
Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see | Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|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 the content includes an equals sign (=), you must specify the parameter explicitly: . | ||
The template uses the {{tag|syntaxhighlight|o}} tag with the attribute <code>inline=1</code>. This works like the combination of the {{tag|code|o}} and {{tag|nowiki|o}} tags, applied to the expanded wikitext. For example, | The template uses the {{tag|syntaxhighlight|o}} tag with the attribute <code>inline=1</code>. This works like the combination of the {{tag|code|o}} and {{tag|nowiki|o}} tags, applied to the expanded wikitext. For example, will '''''not''''' render the word "wiki" in bold, and will render the tripled-single-quotes: | ||
:{{code|some '''wiki''' text}} | :{{code|some '''wiki''' text}} | ||
If the above example is declared as wikitext (via | If the above example is declared as wikitext (via , the output is rendered as follows: | ||
:{{code|some '''wiki''' text|lang=wikitext}} | :{{code|some '''wiki''' text|lang=wikitext}} | ||
However, | However, will still invoke the template: | ||
:{{code|a {{template}} call|lang=wikitext}} | :{{code|a {{template}} call|lang=wikitext}} | ||
| Line 36: | Line 35: | ||
because "foo" and "{{code|bar}}" will seem more closely associated than "{{code|bar}}" and "{{code|baz}}"; the width of the space character in a monospaced font is almost always larger than in a proportional font. | because "foo" and "{{code|bar}}" will seem more closely associated than "{{code|bar}}" and "{{code|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 {{para|2}}, or more explicitly as {{para|lang}}) to specify a language for | Use parameter {{{2}}} (unnamed, as {{para|2}}, or more explicitly as {{para|lang}}) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to {{para|lang|text}}, i.e. no highlighting. Valid values include {{para|lang|wikitext}} for wikitext, {{para|lang|html}} for HTML, along with many other languages including {{code|php}}, {{code|perl}}, {{code|css}}, {{code|javascript}}, {{code|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. {{code|html4strict}} and {{code|html5}} used to be valid values - however, {{para|lang|html}} should be used instead. | ||
This template does not need to be | This template does not need to be substituted. | ||
===Included templates=== | ===Included templates=== | ||
| Line 61: | Line 45: | ||
Templates used inside {{tl|code}} expose the rendered HTML— this can be useful. For example: | Templates used inside {{tl|code}} expose the rendered HTML— this can be useful. For example: | ||
<div style="overflow:auto;"> | <div style="overflow:auto;"> | ||
</div> | </div> | ||
The above example shows the HTML rendered by the citation template, including the hidden metadata. | The above example shows the HTML rendered by the citation template, including the hidden metadata. | ||
== Expensive Parser Function warning == | == Expensive Parser Function warning == | ||
This template internally uses | 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 {{tag|code}} formatting (without any syntax highlighting) instead. | ||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other|| | ||
Latest revision as of 18:33, 9 April 2025
| This page uses Creative Commons Licensed content from Wikipedia (view authors). |
 | This is a documentation subpage for Template:Code It may contain usage information, categories and other content that is not part of the original template page. |
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: .
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, will not render the word "wiki" in bold, and will render the tripled-single-quotes:
some '''wiki''' text
If the above example is declared as wikitext (via , the output is rendered as follows:
some '''wiki''' text
However, will still invoke the template:
a [[:Template:Template]] call
Use <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 |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to |lang=text, i.e. no highlighting. Valid values include |lang=wikitext for wikitext, |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, |lang=html should be used instead.
This template does not need to be substituted.
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:
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 <code>...</code> formatting (without any syntax highlighting) instead.