Template:Code/doc

Revision as of 01:26, 21 October 2011

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.Template:Category handler/numbered^{[clarification needed]}

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:

Unknown extension tag "syntaxhighlight"

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

Unknown extension tag "syntaxhighlight"

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

Unknown extension tag "syntaxhighlight"

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:

Unknown extension tag "syntaxhighlight"

is well spaced:

foo  Unknown extension tag "syntaxhighlight"  quux.

versus:

Unknown extension tag "syntaxhighlight"

which is going to be visually confusing for many:

foo Unknown extension tag "syntaxhighlight" quux.

because "foo" and "Unknown extension tag "syntaxhighlight"" will seem more closely associated than "Unknown extension tag "syntaxhighlight"" and "Unknown extension tag "syntaxhighlight""; 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 Unknown extension tag "syntaxhighlight" and Unknown extension tag "syntaxhighlight" are valid values, as are Unknown extension tag "syntaxhighlight", Unknown extension tag "syntaxhighlight", Unknown extension tag "syntaxhighlight", Unknown extension tag "syntaxhighlight", Unknown extension tag "syntaxhighlight" 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.

Finally, embedded templates do not function 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.

Examples

Lorem {{code|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.

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]].