Template:Code/doc: Difference between revisions
meta>Vanisaac m →See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other |
It’s all clear now saw how you truly feel. OVER IT |
||
Line 62: | Line 62: | ||
</div> | </div> | ||
The above example shows the HTML rendered by the citation template, including the hidden metadata. | The above example shows the HTML rendered by the citation template, including the hidden metadata. | ||
Revision as of 04:55, 3 May 2020
![]() | This is a documentation subpage for Template:Code. It may contain usage information, categories and other content that is not part of the original template page. |
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 <pre>...</pre>
or <syntaxhighlight>...</syntaxhighlight>
. 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=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:{{{1}}}|{{{1}}}]]}} call</syntaxhighlight>
Use <nowiki>...</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 GeSHi. 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
Markup | Renders as |
---|---|
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}}}; see also [[:bugzilla:5138]]. |
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}}}; see also bugzilla:5138. |
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 <code>...</code>
as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
Markup | Renders as |
---|---|
{{code| {{cite web |title=Title |url=http://example.org}} }} |
<syntaxhighlight lang="text" class="" id="" style="" inline="1"> "Title". </syntaxhighlight> |
The above example shows the HTML rendered by the citation template, including the hidden metadata.