mw>Oetterer am 3. Februar 2015 um 13:13 Uhr

2015-02-03T13:13:27Z

Neue Seite

{{Documentation subpage}}


==Usage==
Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight GeSHi]]). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. See [[wpen:Help:Wiki markup|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><nowiki>{{code snippet|1=date=30 Feb 2010}}</nowiki></code>.

The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code>enclose="none"</code>. This works like the combination of the <code><nowiki><code></nowiki></code> and <code><nowiki><nowiki></nowiki></code> tags, applied to the expanded wikitext. For example, <code><nowiki>{{code snippet|some '''wiki''' text}}</nowiki></code> will '''''not''''' render the word "wiki" in bold, and will render the tripled-single-quotes:

:{{code snippet|some '''wiki''' text}}

However, <code><nowiki>{{code snippet|a {{tl}} call}}</nowiki></code> will still invoke the template:

:{{code snippet|a {{tl}} call}}

Use {{tag|nowiki}} around the template name to avoid this problem:

:{{code snippet|a <nowiki>{{tl}}</nowiki> call}}

When used inline with regular text, {{tnull|code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
:{{code snippet|foo  <nowiki>{{code|bar baz}}</nowiki>  quux.}}
is well spaced:
:foo  {{code snippet|bar baz}}  quux.
versus:
:{{code snippet|foo <nowiki>{{code snippet|bar baz}}</nowiki> quux.}}
which is going to be visually confusing for many:
:foo {{code snippet|bar baz}} quux.
because "foo" and "{{code snippet|bar}}" will seem more closely associated than "{{code snippet|bar}}" and "{{code snippet|baz}}"; the width of the space character in a monospaced font is almost always larger than in a proportional font.

Use parameter {{{2}}} (unnamed, as {{para|2}}, or more explicitly as {{para|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 {{code snippet|html4strict}} and {{code snippet|html5}} are valid values, as are {{code snippet|php}}, {{code snippet|perl}}, {{code snippet|css}}, {{code snippet|javascript}}, {{code snippet|mysql}} 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.

if {{{3}}} is set to yes, the template will append a "copy-to-clipboard"-link.

This template does not need to be [[Wikipedia:Template substitution|substituted]].

===Examples===

{{markup
|<nowiki>Lorem {{code snippet|ipsum '''dolor'''}} sit amet</nowiki>
|Lorem {{code snippet|ipsum '''dolor'''}} sit amet

|<nowiki>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.</nowiki>
|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.

|<nowiki>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]].</nowiki>
|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]].
}}

===Included templates===
Embedded templates do not function as expected inside {{tl|code snippet}}; for longer, free-form blocks of code, which can contain templates such as {{tl|var}}, use {{tag|code snippet}} as a wrapper instead of this template.

Templates used inside {{tl|code snippet}} expose the rendered HTML— this can be useful. For example:

{{markup
|1=<nowiki>{{code snippet|
{{hidden |title=Title |content=http://example.org}}
}}</nowiki>
|2={{code snippet|
{{hidden |title=Title |content=http://example.org}}
}}
}}

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

== See also ==
* {{tl|pre}}
* {{tl|pre2}}
* {{tl|code}}
* [[wpen:Help:Wiki markup|Help:Wiki markup]]

<includeonly>
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
[[Category:Text manipulation templates]]
}}
</includeonly>

Vorlage:Code snippet/doc - Versionsgeschichte

mw>Oetterer am 3. Februar 2015 um 13:13 Uhr