Template:Code
{{{1}}}
Template:High-risk 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: Template:Tji.
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, Template:Tji 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 Template:Tji, the output is rendered as follows:
some '''wiki''' text
However, Template:Tji will still invoke the template:
a [[:Template:Template]] 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 Template:Para, or more explicitly as Template:Para) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to Template:Para, i.e. no highlighting. Valid values include Template:Para for wikitext, Template:Para 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, Template:Para should be used instead.
This template does not need to be substituted.
Examples[ཞུན་དག།]
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:
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[ཞུན་དག།]
See also[ཞུན་དག།]
- {{PreCode}}, which forbids line breaks inside the code
- {{codett}}, wrapper for this template that removes background and border styling
- {{mono}}, monospaced font only
- {{param value}}, monospaced; friendly handling for blank space
- {{Syntaxhighlight}}
- {{kbd}}, for keyboard input
- Help:Wiki markup