Template:Code: Difference between revisions
meta>Edokter (Add <code> per edit request. Ping if there are problems.) |
meta>Edokter (<noinclude>) |
||
| Line 1: | Line 1: | ||
<code>{{#tag:syntaxhighlight|{{{code|{{{1}}}}}}|lang={{{lang|{{{2|text}}}}}}|enclose=none}}</code></noinclude> | |||
{{documentation}} | {{documentation}} | ||
</noinclude> | |||
Revision as of 12:31, 18 February 2012
<syntaxhighlight lang="text" enclose="none">{{{1}}}</syntaxhighlight>
 | This template is used on 35,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. |
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:
<syntaxhighlight lang="text" enclose="none">some wiki text</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation </noinclude>
However, {{code|a {{template}} call}} will still invoke the template:
<syntaxhighlight lang="text" enclose="none">a {{[[Template:{{{1}}}|{{{1}}}]]}} call</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation </noinclude>
Use <nowiki>...</nowiki> around the template name to avoid this problem:
<syntaxhighlight lang="text" enclose="none">a {{template}} call</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation </noinclude>
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:
<syntaxhighlight lang="text" enclose="none">foo {{code|bar baz}} quux.</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation </noinclude> is well spaced:
- foo
<syntaxhighlight lang="text" enclose="none">bar baz</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation </noinclude> quux. versus:
<syntaxhighlight lang="text" enclose="none">foo {{code|bar baz}} quux.</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation </noinclude> which is going to be visually confusing for many:
- foo
<syntaxhighlight lang="text" enclose="none">bar baz</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude> quux.
because "foo" and "<syntaxhighlight lang="text" enclose="none">bar</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude>" will seem more closely associated than "<syntaxhighlight lang="text" enclose="none">bar</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude>" and "<syntaxhighlight lang="text" enclose="none">baz</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude>"; 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 GeSHi. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though <syntaxhighlight lang="text" enclose="none">html4strict</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude> and <syntaxhighlight lang="text" enclose="none">html5</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude> are valid values, as are <syntaxhighlight lang="text" enclose="none">php</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude>, <syntaxhighlight lang="text" enclose="none">perl</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude>, <syntaxhighlight lang="text" enclose="none">css</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude>, <syntaxhighlight lang="text" enclose="none">javascript</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude>, <syntaxhighlight lang="text" enclose="none">mysql</syntaxhighlight></noinclude>
Template loop detected: Template:Documentation
</noinclude> 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 as |
|---|---|
Lorem {{code|ipsum '''dolor'''}} sit amet
|
Lorem |
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 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 |
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 as |
|---|---|
{{code|
{{cite web |title=Title |url=http://example.org}}
}}
|
|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
See also
- {{codett}}, wrapper for this template that removes background and border styling
- {{mono}}, monospaced font only
- {{Syntaxhighlight}}
- Help:Wiki markup
