Template:Code2

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search

{{{1}}}

Template documentation


Usage[edit]

Wraps a short span of text in <syntaxhighlight> tags (see Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See w:en:Help:Wiki markup for an explanation of what the various tags do.[unclear]

If the content includes an equals sign (=), you must specify the parameter explicitly: {{code2|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, {{code2|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:

some '''wiki''' text

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

a &#123;&#123;[[Template:{{{1}}}|{{{1}}}]]&#125;&#125; call

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

a {{template}} call

When used inline with regular text, {{code2}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:

foo &nbsp;{{code2|bar baz}}&nbsp; quux.

is well spaced:

foo  bar baz  quux.

versus:

foo {{code2|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 Extension:SyntaxHighlight. 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.

Finally, embedded templates do not function inside {{code2}}; 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[edit]

input output
Lorem {{code2|ipsum '''dolor'''}} sit amet
Lorem ipsum '''dolor''' sit amet
The declaration {{code2|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 {{code2|lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{para|1}} or {{para|code}}; see also [[:bugzilla:5138]].
If the code contains an equals sign, such as var img = document.getElementsByTagName("img");, you must identify the first parameter explicitly as |1= or |code=; see also bugzilla:5138.

TemplateData[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Code2

An inline source code string.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Code1 code

The code to display.

Stringrequired
Language2 lang

The programming language of the source code. List of valid values is at: Extension:SyntaxHighlight#Supported_languages

Default
php
Example
sql
Stringsuggested

See also[edit]

Template:Var/seealso