Template:Code

From Miranda NG
Jump to: navigation, search

<syntaxhighlight lang="text" enclose="none">{{{1}}}</syntaxhighlight>

Template documentation[view] [edit] [history] [purge]

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

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:

<syntaxhighlight lang="text" enclose="none">some wiki text</syntaxhighlight>

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

<syntaxhighlight lang="text" enclose="none">a {{[[Template:{{{1}}}|{{{1}}}]]}} call</syntaxhighlight>

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

<syntaxhighlight lang="text" enclose="none">a {{template}} call</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:

<syntaxhighlight lang="text" enclose="none">foo  {{code|bar baz}}  quux.</syntaxhighlight>

is well spaced:

foo  <syntaxhighlight lang="text" enclose="none">bar baz</syntaxhighlight>  quux.

versus:

<syntaxhighlight lang="text" enclose="none">foo {{code|bar baz}} quux.</syntaxhighlight>

which is going to be visually confusing for many:

foo <syntaxhighlight lang="text" enclose="none">bar baz</syntaxhighlight> quux.

because "foo" and "<syntaxhighlight lang="text" enclose="none">bar</syntaxhighlight>" will seem more closely associated than "<syntaxhighlight lang="text" enclose="none">bar</syntaxhighlight>" and "<syntaxhighlight lang="text" enclose="none">baz</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 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 <syntaxhighlight lang="text" enclose="none">html4strict</syntaxhighlight> and <syntaxhighlight lang="text" enclose="none">html5</syntaxhighlight> are valid values, as are <syntaxhighlight lang="text" enclose="none">php</syntaxhighlight>, <syntaxhighlight lang="text" enclose="none">perl</syntaxhighlight>, <syntaxhighlight lang="text" enclose="none">css</syntaxhighlight>, <syntaxhighlight lang="text" enclose="none">javascript</syntaxhighlight>, <syntaxhighlight lang="text" enclose="none">mysql</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.

Examples

Template:Markup

Included templates

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