Note: The template above might be broken without the parameters; while not ideal and often not necessary, this is common.
View, edit, or check the history of this documentation. (How does this work?)
Editors can experiment with this template's sandbox and testcases.

Usage

Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). See Help:Wikitext on Wikipedia 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}}.

The template uses the <syntaxhighlight> tag with the attribute inline=1. 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:

some '''wiki''' text

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

a template call

Use <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  {{code|bar baz}}  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. 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

Code	Output
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}}}.	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}}}.

TemplateData

An inline source code string.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Code	1 code	The code to display.	String	required
Language	2 lang	The programming language of the source code. List of valid values is at: https://mediawiki.org/wiki/Extension:SyntaxHighlight#Supported_languages Default text	String	suggested
Class	class	no description	String	optional
ID	id	no description	String	optional
CSS Style	style	no description	String	optional

See also

• {{mono}}, monospaced font only
• Help:Wikitext on Wikipedia
  

There is no additional installation instructions for this template. If there is any, you may create it at Template:Code/install.