Vorlage:Code/Doku

Aus Wikivoyage

Usage[Bearbeiten]

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 Hilfe: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|1=date=30 Feb 2010}}.

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 &nbsp;{{code|bar baz}}&nbsp; quux.

is well spaced:

foo  bar baz  quux.

versus:

foo {{code|bar baz}} quux.

which is going to be visually confusing for many:

foo bar baz quux.

because "foo" and "bar" will seem more closely associated than "bar" and "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 |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 html4strict and html5 are valid values, as are php, perl, css, javascript, 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.

This template does not need to be substituted.

Examples[Bearbeiten]

Markup Renders as
Lorem {{code|ipsum '''dolor'''}} sit amet
Lorem ipsum '''dolor''' 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 int foo(const std::string& bar, const std::vector<long double*>& baz); 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 w:en:equals sign, such as var img = document.getElementsByTagName("img");, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also bugzilla:5138.

Included templates[Bearbeiten]

Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.

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

Markup Renders as
{{code|
{{Th|กรุงเทพมหานคร}}
}}
<span class="wv-foreign-lang wv-foreign-lang-th wv-foreign-dir-ltr"><span class="wv-lang wv-lang-th " lang="th" xml:lang="th" dir="ltr" title="Text auf thailändisch">กรุงเทพมหานคร</span></span>

The above example shows the HTML rendered by the citation template, including the hidden metadata.

See also[Bearbeiten]

  • {{strong}} – For semantically indicating strong emphasis instead of simple typographical boldfacing.
  • {{strongbad}} – Same as {{strong}} but red like this: "Never use {{strongbad}} in articles."
  • {{stronggood}} – Same as {{strongbad}} but green like this: "Only use {{stronggood}} on non-article pages."
  • {{em}} – Similar template for semantically indicating mild emphasis instead of simple typographical italicization.
  • {{var}} – Same as {{varserif}} use for all variables (e.g. strIllustratePrefix), except for "I" (upper-case i) and "l" (lower-case L), for which use {{varserif}}.
  • {{varserif}} – Same as {{var}} but uses serif font (e.g. strIllustratePrefix), especially for distinguishing between "I" (upper-case i) and "l" (lower-case L) as variables.
  • {{wikivar}} – For displaying wikicode variables and magicwords as they would appear in source code, e.g. {{PAGENAME}}, {{DEFAULTSORT:Lastname, Firstname}}.
  • {{para}} – For displaying wiki template parameters (|title=) or parameters and values (|year=2008).
  • {{tlx}} and related – For displaying entire templates (with or without parameters and values) as code.
  • {{tag}} – For using HTML elements ("tags") in prose (e.g. "When coding HTML <img>...</img> tags, always include …").
  • {{code}} – For computer source code (e.g. "always include the alt= parameter"). (Note: to nest other templates like {{var}} inside, use <code>...</code> instead of {{code}}.)
  • {{syntaxhighlight}} or {{sxhl}} – Wrapper for <syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text.
  • {{pre}} – For larger blocks of source code and other pre-formatted text.
  • {{pre2}}, a template with similar functionality but induces optional line wrap and optional scroll bars.
  • {{bq}} – For indented blocks of content, such as block quotations, examples, poems, etc.
  • {{kbd}} – For indicating user input.
  • {{key press}} – For indicating the input of specific keystrokes, e.g. CtrlX.
  • {{samp}} – For example output.
  • <syntaxhighlight>
  • Hilfe:Wiki Markup