Template:Code
{{{1}}}
Usage
[edit]Wraps a short span of text in <syntaxhighlight> tags (see mediawikiwiki: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:
some '''wiki''' text
However, {{code|a {{template}} call}} will still invoke the template:
a {{[[Template:{{{1}}}|{{{1}}}]]}} 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 baz
versus:
foo {{code|bar baz}} quux.
which is going to be visually confusing for many:
- foo
bar baz
because "foo" and "barbarbaz
Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mediawikiwiki: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 html4stricthtml5phpperlcssjavascriptmysql
This template does not need to be substituted.
Examples
[edit]| 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}}}.
|
If the code contains an equals sign, such as |
Included templates
[edit]Embedded templates do not function as expected inside {{code}}.
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.