Vorlage:Code snippet
{{{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>
. 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 snippet|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 snippet|some '''wiki''' text}}
will not render the word "wiki" in bold, and will render the tripled-single-quotes:
some '''wiki''' text
However, {{code snippet|a {{tl}} call}}
will still invoke the template:
a {{[[Template:{{{1}}}|{{{1}}}]]}} call
Use <nowiki>...</nowiki>
around the template name to avoid this problem:
a {{tl}} 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
quux.bar baz
versus:
foo {{code snippet|bar baz}} quux.
which is going to be visually confusing for many:
- foo
quux.bar baz
because "foo" and "
" will seem more closely associated than "bar
" and "bar
"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
baz
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
and html4strict
are valid values, as are html5
, php
, perl
, css
, javascript
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.
mysql
if {{{3}}} is set to yes, the template will append a "copy-to-clipboard"-link.
This template does not need to be substituted.
Examples
Markup | Renders as |
---|---|
Lorem {{code snippet|ipsum '''dolor'''}} sit amet |
Lorem sit amet |
The declaration {{code snippet|lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later. |
The declaration is the prototype for a function defined later. |
If the code contains an [[wpen:equals sign]], such as {{code snippet|lang=javascript |code=var img = document.getElementsByTagName("img");|3=yes}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also [[:mediazilla:5138]]. |
If the code contains an wpen:equals sign, such as <clippy>var img = document.getElementsByTagName("img");</clippy>, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also mediazilla:5138.
|
Included templates
Embedded templates do not function as expected inside {{code snippet}}; for longer, free-form blocks of code, which can contain templates such as {{var}}, use <code snippet>...</code snippet>
as a wrapper instead of this template.
Templates used inside {{code snippet}} expose the rendered HTML— this can be useful. For example:
Markup | Renders as |
---|---|
{{code snippet| {{hidden |title=Title |content=http://example.org}} }} |
|
The above example shows the HTML rendered by the mediawiki collapse mechanism.
See also
- {{pre}}
- {{pre2}}
- {{code}}
- Help:Wiki markup
The above documentation is transcluded from Vorlage:Code snippet/doc. (edit | history) Please add categories to the /doc subpage. Subpages of this template. |