Template:Code/doc

This documentation subpage contains instructions, categories, or other information for Template:Code. [<Edit> Template:Code]

[⧼Purge⧽ Template:Code/doc]

Note: the Extension:SyntaxHighlight GeSHi [MediaWiki server] extension tag is currently NOT installed in OEIS Wiki.

The {{code}} typing-aid template wraps a short span of text in <syntaxhighlight>...</syntaxhighlight> tags (see Extension:SyntaxHighlight GeSHi—MediaWiki.org.), unless the second parameter (or lang=) is set to text in which case it wraps the expanded wikitext in <nowiki> then <code> tags. 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 use template {{=}} instead of =.

Usage

The template uses the <syntaxhighlight> tag with the attribute enclose="none". This works like the combination of the <nowiki> then <code> 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:Template]] call​

Use <nowiki>...</nowiki> around the template name to avoid this problem, e.g. {{code|a <nowiki>{{template}}</nowiki> call}}:

​a {{template}} call​

Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for Extension:SyntaxHighlight GeSHi. This option defaults to text (e.g. plain-text), which gives 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 such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.

Examples

Input	Output
Lorem {{code|ipsum '''dolor'''}} sit amet	Lorem ​ipsum '''dolor'''​ 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" enclose="none">​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 [https://bugzilla.wikimedia.org/show_bug.cgi?id=5138 bugzilla:5138].	If the code contains an equals sign, such as <syntaxhighlight lang="javascript" enclose="none">​var img = document.getElementsByTagName("img");​</syntaxhighlight>, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also bugzilla:5138.

Code

<noinclude>{{documentation}}</noinclude><!--
-->{{#switch: {{{lang|{{{2|text}}}}}}
| text = <code>​{{#tag:nowiki|{{{code|{{{1}}}}}}​}}</code> 
| <code>{{#tag:syntaxhighlight|​{{{code|{{{1}}}}}}​|lang="{{{lang|{{{2|text}}}}}}"|enclose="none"}}</code>
}}

See also

• Help:Wiki markup—Wikipedia.org.