Vorlage:Code snippet/doc

Usage

Wraps a short span of text in <syntaxhighlight> tags (see 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 inline. 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:

sample text

However, {{code snippet|a {{tl|Classgeneretor}} call}} will still invoke the template:

sample text

Use <nowiki>...</nowiki> around the template name to avoid this problem:

sample text

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:

sample text

is well spaced:

foo  sample text  quux.

versus:

sample text

which is going to be visually confusing for many:

foo sample text quux.

because "foo" and "sample text" will seem more closely associated than "sample text" and "sample text"; 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 sample text and sample text are valid values, as are sample text, sample text, sample text, sample text, sample text 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 snippet|ipsum '''dolor'''}} sit amet	Lorem sample text 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 sample text 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");}}, 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 var img = document.getElementsByTagName("img");, 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}} }}	sample text

The above example shows the HTML rendered by the mediawiki collapse mechanism.

See also

• {{pre}}
• {{pre2}}
• {{code}}
• Help:Wiki markup