Template:Code: Difference between revisions
(Add <code> per edit request. Ping if there are problems.) |
(<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
{{{1}}}
Usage
Wraps a short span of text in <syntaxhighlight>
tags (see mw:Extension:SyntaxHighlight GeSHi). This template should be used for short samples; longer content should use <pre>...</pre>
or <syntaxhighlight>...</syntaxhighlight>
.
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 enclose="none"
. 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:
</noinclude>some '''wiki''' text
Template loop detected: Template:Documentation </noinclude>
However, {{code|a {{template}} call}}
will still invoke the template:
</noinclude>a {{[[Template:{{{1}}}|{{{1}}}]]}} call
Template loop detected: Template:Documentation </noinclude>
Use <nowiki>...</nowiki>
around the template name to avoid this problem:
</noinclude>a {{template}} call
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:
</noinclude>foo {{code|bar baz}} quux.
Template loop detected: Template:Documentation </noinclude> is well spaced:
- foo
</noinclude>bar baz
Template loop detected: Template:Documentation </noinclude> quux. versus:
</noinclude>foo {{code|bar baz}} quux.
Template loop detected: Template:Documentation </noinclude> which is going to be visually confusing for many:
- foo
</noinclude>bar baz
Template loop detected: Template:Documentation </noinclude> quux.
because "foo" and "bar
</noinclude>
Template loop detected: Template:Documentation
</noinclude>" will seem more closely associated than "bar
</noinclude>
Template loop detected: Template:Documentation
</noinclude>" and "baz
</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 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 html4strict
</noinclude>
Template loop detected: Template:Documentation
</noinclude> andhtml5
</noinclude>
Template loop detected: Template:Documentation
</noinclude> are valid values, as arephp
</noinclude>
Template loop detected: Template:Documentation
</noinclude>,perl
</noinclude>
Template loop detected: Template:Documentation
</noinclude>,css
</noinclude>
Template loop detected: Template:Documentation
</noinclude>,javascript
</noinclude>
Template loop detected: Template:Documentation
</noinclude>,mysql
</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.
Finally, embedded templates do not function inside {{code}}; for longer, free-form blocks of code, which can contain templates, use <code>...</code>
as a wrapper instead of this template.
Examples
input | output |
---|---|
Lorem {{code|ipsum '''dolor'''}} sit amet |
Lorem </noinclude>
Template loop detected: Template:Documentation </noinclude> sit amet |
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 </noinclude>
Template loop detected: Template:Documentation </noinclude> is the prototype for a function defined later. |
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 </noinclude>
Template loop detected: Template:Documentation </noinclude>, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}. |