Template:Code/doc: Difference between revisions
meta>DragonHawk explain nowiki effects |
m 89 revisions imported |
||
(83 intermediate revisions by 48 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | ||
Wraps a short span of text in | {{#ifeq: {{PAGENAME}}|{{ROOTPAGENAME}}|{{High-risk|24,000+}}}} | ||
==Usage== | |||
Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight]]). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|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><nowiki>{{code|1=date=30 Feb 2010}}</nowiki></code>. | If the content includes an equals sign (=), you must specify the parameter explicitly: <code><nowiki>{{code|1=date=30 Feb 2010}}</nowiki></code>. | ||
The template uses the | The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code>inline=1</code>. This works like the combination of the <code><nowiki><code></nowiki></code> and <code><nowiki><nowiki></nowiki></code> tags, applied to the expanded wikitext. For example, <code><nowiki>{{code|some '''wiki''' text}}</nowiki></code> will '''''not''''' render the word "wiki" in bold, and will render the tripled-single-quotes: | ||
:{{code|some '''wiki''' text}} | :{{code|some '''wiki''' text}} | ||
Line 12: | Line 15: | ||
:{{code|a {{template}} call}} | :{{code|a {{template}} call}} | ||
Use {{tag|nowiki}} around the template name to avoid this problem: | |||
:{{code|a <nowiki>{{template}}</nowiki> call}} | |||
When used inline with regular text, {{tnull|code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text: | |||
:{{code|foo <nowiki>{{code|bar baz}}</nowiki> quux.}} | |||
is well spaced: | |||
:foo {{code|bar baz}} quux. | |||
versus: | |||
:{{code|foo <nowiki>{{code|bar baz}}</nowiki> quux.}} | |||
which is going to be visually confusing for many: | |||
:foo {{code|bar baz}} quux. | |||
because "foo" and "{{code|bar}}" will seem more closely associated than "{{code|bar}}" and "{{code|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 {{para|2}}, or more explicitly as {{para|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 {{code|html4strict}} and {{code|html5}} are valid values, as are {{code|php}}, {{code|perl}}, {{code|css}}, {{code|javascript}}, {{code|mysql}} 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 [[Wikipedia:Template substitution|substituted]]. | This template does not need to be [[Wikipedia:Template substitution|substituted]]. | ||
=== See also | ===Examples=== | ||
* {{tl| | |||
* {{tl| | {{markup | ||
* {{tl| | |<nowiki>Lorem {{code|ipsum '''dolor'''}} sit amet</nowiki> | ||
|Lorem {{code|ipsum '''dolor'''}} sit amet | |||
|<nowiki>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.</nowiki> | |||
|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. | |||
|<nowiki>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]].</nowiki> | |||
|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]]. | |||
}} | |||
===Included templates=== | |||
Embedded templates do not function as expected inside {{tl|code}}; for longer, free-form blocks of code, which can contain templates such as {{tl|var}} and {{tl|samp}}, use {{tag|code}} as a wrapper instead of this template. | |||
Templates used inside {{tl|code}} expose the rendered HTML— this can be useful. For example: | |||
<div style="overflow:auto;"> | |||
{{markup | |||
|1=<nowiki>{{code| | |||
{{cite web |title=Title |url=http://example.org}} | |||
}}</nowiki> | |||
|2={{code| | |||
{{cite web |title=Title |url=http://example.org}} | |||
}} | |||
}} | |||
</div> | |||
The above example shows the HTML rendered by the citation template, including the hidden metadata. | |||
== See also == | |||
* {{tl|codett}}, wrapper for this template that removes background and border styling | |||
* {{tl|mono}}, monospaced font only | |||
* {{tl|Syntaxhighlight}} | |||
* [[Help:Wiki markup]] | * [[Help:Wiki markup]] | ||
<includeonly><!-- | {{Semantic markup templates}} | ||
[[Category: | <includeonly>{{Sandbox other|| | ||
</includeonly> | <!-- Categories below this line; interwikis at Wikidata --> | ||
[[Category:Programming typing-aid templates]] | |||
[[Category:Semantic markup templates]] | |||
[[Category:Wikipedia XHTML tag-replacing templates]] | |||
}}</includeonly> |
Latest revision as of 00:58, 3 September 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.
See also
- {{codett}}, wrapper for this template that removes background and border styling
- {{mono}}, monospaced font only
- {{Syntaxhighlight}}
- Help:Wiki markup