Template:Code

{{{1}}}

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

This template is used on ༥༨,༠༠༠+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Template:Expensive

Usage

Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use Template:Tag or Template:Tag. See Help: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=int i = 0;}}.

The template uses the Template:Tag tag with the attribute inline=1. This works like the combination of the Template:Tag and Template:Tag 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

If the above example is declared as wikitext (via {{code|some '''wiki''' text|lang=wikitext}}, the output is rendered as follows:

some '''wiki''' text

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

a <span class="nowrap">{{</span>[[Template:{{{1}}}|{{{1}}}]]<span class="nowrap">}}</span> call

Use Template:Tag around the template name to avoid this problem:

a {{template}} call

When used inline with regular text, Template:Tnull 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 less visually clear:

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 |lang=text, i.e. no highlighting. Valid values include |lang=wikitext for wikitext, |lang=html for HTML, along with many other languages including php, perl, css, javascript, mysql. Attempting to use an invalid value for lang will cause the page to be added to Category:Pages with syntax highlighting errors, and no syntax highlighting will be present in the output. html4strict and html5 used to be valid values - however, |lang=html should be used instead.

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, which can contain templates such as {{var}} and {{samp}}, use Template:Tag as a wrapper instead of this template.

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

Template:Markup

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

Expensive Parser Function warning

This template internally uses mw:Extension:SyntaxHighlight, which is considered an 'expensive parser function' (see WP:EXPENSIVE). If used on a page which uses more than 500 expensive parser functions, the output of subsequent uses of this template will be presented using Template:Tag formatting (without any syntax highlighting) instead.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Code in articles based on its TemplateData.

TemplateData for Code

An inline source code string.

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: mw:Extension:SyntaxHighlight#Supported_languages Default text	String	suggested
Class	`class`		String	optional
ID	`id`		String	optional
CSS Style	`style`		String	optional

Usage

Examples

Included templates

Expensive Parser Function warning

TemplateData

See also