Template:Code/doc
Template:Documentation subpage
Usage[edit source]
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:
- <syntaxhighlight lang="text" class="" id="" style="" inline="1">some wiki text</syntaxhighlight>
However, {{code|a {{template}} call}}
will still invoke the template:
- <syntaxhighlight lang="text" class="" id="" style="" inline="1">a template call</syntaxhighlight>
Use <nowiki>
around the template name to avoid this problem:
- <syntaxhighlight lang="text" class="" id="" style="" inline="1">a {{template}} call</syntaxhighlight>
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:
- <syntaxhighlight lang="text" class="" id="" style="" inline="1">foo {{code|bar baz}} quux.</syntaxhighlight>
is well spaced:
- foo <syntaxhighlight lang="text" class="" id="" style="" inline="1">bar baz</syntaxhighlight> quux.
versus:
- <syntaxhighlight lang="text" class="" id="" style="" inline="1">foo {{code|bar baz}} quux.</syntaxhighlight>
which is going to be visually confusing for many:
- foo <syntaxhighlight lang="text" class="" id="" style="" inline="1">bar baz</syntaxhighlight> quux.
because "foo" and "<syntaxhighlight lang="text" class="" id="" style="" inline="1">bar</syntaxhighlight>" will seem more closely associated than "<syntaxhighlight lang="text" class="" id="" style="" inline="1">bar</syntaxhighlight>" and "<syntaxhighlight lang="text" class="" id="" style="" inline="1">baz</syntaxhighlight>"; 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 <syntaxhighlight lang="text" class="" id="" style="" inline="1">html4strict</syntaxhighlight> and <syntaxhighlight lang="text" class="" id="" style="" inline="1">html5</syntaxhighlight> are valid values, as are <syntaxhighlight lang="text" class="" id="" style="" inline="1">php</syntaxhighlight>, <syntaxhighlight lang="text" class="" id="" style="" inline="1">perl</syntaxhighlight>, <syntaxhighlight lang="text" class="" id="" style="" inline="1">css</syntaxhighlight>, <syntaxhighlight lang="text" class="" id="" style="" inline="1">javascript</syntaxhighlight>, <syntaxhighlight lang="text" class="" id="" style="" inline="1">mysql</syntaxhighlight> 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[edit source]
Code | Output |
---|---|
Lorem {{code|ipsum '''dolor'''}} sit amet | Lorem <syntaxhighlight lang="text" class="" id="" style="" inline="1">ipsum dolor</syntaxhighlight> 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 <syntaxhighlight lang="cpp" class="" id="" style="" inline="1">int foo(const std::string& bar, const std::vector<long double*>& baz);</syntaxhighlight> 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 <syntaxhighlight lang="javascript" class="" id="" style="" inline="1">var img = document.getElementsByTagName("img");</syntaxhighlight>, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}. |
TemplateData[edit source]
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: https://mediawiki.org/wiki/Extension:SyntaxHighlight#Supported_languages
| String | suggested |
Class | class | no description | String | optional |
ID | id | no description | String | optional |
CSS Style | style | no description | String | optional |
See also[edit source]
{{mono}}
, monospaced font only- Help:Wikitext on Wikipedia