Template:Code/doc: Difference between revisions
(note on embedded templates) |
No edit summary |
||
| (10 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
==Usage== | ==Usage== | ||
Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight GeSHi]]). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. | Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight GeSHi]]). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. | ||
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>. | ||
| Line 33: | Line 30: | ||
This template does not need to be [[Wikipedia:Template substitution|substituted]]. | This template does not need to be [[Wikipedia:Template substitution|substituted]]. | ||
Finally, embedded templates do not function inside {{tnull|code}}; for longer, free-form blocks of code, which can contain templates | Finally, embedded templates do not function inside {{tnull|code}}; for longer, free-form blocks of code, which can contain templates, use {{tag|code}} as a wrapper instead of this template. | ||
===Examples=== | ===Examples=== | ||
| Line 47: | Line 44: | ||
|- | |- | ||
| <pre style="margin:0px; white-space:normal;">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]].</pre> | | <pre style="margin:0px; white-space:normal;">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]].</pre> | ||
| 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 [[w:equals sign|equals sign]], such as {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}. | ||
|} | |} | ||
<includeonly> | |||
[[Category:Formatting templates]] | |||
<includeonly> | |||
</includeonly> | </includeonly> | ||
Latest revision as of 02:31, 22 May 2013
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight GeSHi). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>.
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 enclose="none". 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:
some '''wiki''' text
However, {{code|a {{template}} call}} will still invoke the template:
a {{[[Template:{{{1}}}|{{{1}}}]]}} call
Use <nowiki>...</nowiki> around the template name to avoid this problem:
a {{template}} call
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:
foo {{code|bar baz}} quux.
is well spaced:
- foo
bar baz
versus:
foo {{code|bar baz}} quux.
which is going to be visually confusing for many:
- foo
bar baz
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 |2=, or more explicitly as |lang=) to specify a language for 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
html4strict
and
html5
are valid values, as are
php
,
perl
,
css
,
javascript
,
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 substituted.
Finally, embedded templates do not function inside {{code}}; for longer, free-form blocks of code, which can contain templates, use <code>...</code> as a wrapper instead of this template.
Examples
| input | output |
|---|---|
Lorem {{code|ipsum '''dolor'''}} 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 |