Template:Code/sandbox
{{{1}}}
Page Module:Documentation/styles.css has no content.
Page Module:Message box/ombox.css has no content.
 | This is the template sandbox page for Template:Code (diff). See also the companion subpage for test cases. |
| File:Ambox warning yellow.svg | Due to a server limit of 500 "expensive parser function" calls (e.g. #ifexist:, PAGESIZE:, and PAGESINCATEGORY:), this template will only work properly if the page using it has not already exceeded the limit. When the limit is exceeded, the page using this template or module is categorised in Category:Pages with too many expensive parser function calls. (further information) |
Usage
Wraps a short span of text in <syntaxhighlight>...</syntaxhighlight> tags.
This template should only be used for short samples; longer content should use <syntaxhighlight> or Template:Tlx. See Help:Wiki markup for an explanation of what the various tags do, for example Template:Tlx will render:
some text
If the content includes an equals sign (=), you should escape it using Template:Tlx or, if doing so is unworkable, specify the parameter explicitly (such as with Template:Tlx).
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, Template:Tlx 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:Tlx), the output is rendered as follows:
some '''wiki''' text
However, Template:Tlx will still invoke the template:
a <span class="nowrap">{{</span>[[Template:{{{1}}}|{{{1}}}]]<span class="nowrap">}}</span> call
Use <nowiki>...</nowiki> 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 bazquux.
versus:
foo {{code|bar baz}} quux.
which is less visually clear:
- foo
bar bazquux.
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 unnamed parameter |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
Page Template:Markup/styles.css has no content.
| Markup | Renders as |
|---|---|
Lorem {{code|ipsum '''dolor'''}} sit amet |
Lorem |
Lorem {{code|ipsum '''dolor'''|wikitext}} sit amet |
Lorem |
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 |
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}}}; see also [[:bugzilla:5138]]. |
If the code contains an equals sign, such as |
Included templates
Embedded templates do not function as expected inside Template:Tl; for longer, free-form blocks of code, which can contain templates such as Template:Tl and Template:Tl, use <code>...</code> as a wrapper instead of this template.
Templates used inside Template:Tl expose the rendered HTML— this can be useful. For example:
Page Template:Markup/styles.css has no content.
| Markup | Renders as |
|---|---|
{{code|
{{cite web |title=Title |url=http://example.org}}
|lang=html
}} |
|
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 <code>...</code> formatting (without any syntax highlighting) instead.
TemplateData
TemplateData for Code
See also
- Template:Tl, monospaced font only
- Help:Wikitext
- Language-specific wrapper templates:
- Template:Tl, defaults to 'javascript'
- Template:Tl, defaults to 'wikitext' (for templates)
Lua error in package.lua at line 80: module 'Module:Navbox/configuration' not found.
