Difference between revisions of "Template:Code"

From Xen
(Created page with "<onlyinclude><code>{{#tag:syntaxhighlight|​{{{code|{{{1}}}}}}​|lang={{{lang|{{{2|text}}}}}}|enclose=none}}</code></onlyinclude> {{documentation}}Category:Templates")
m (1 revision: Testing import of templates)
(No difference)

Latest revision as of 23:29, 4 December 2011


[edit] [purge] Template documentation


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>. See Help:Wiki markup for an explanation of what the various tags do.Template:Ifsubst

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 &nbsp;{{code|bar baz}}&nbsp; quux.​

is well spaced:

foo  ​bar baz​  quux.


​foo {{code|bar baz}} quux.​

which is going to be visually confusing for many:

foo ​bar baz​ quux.

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 such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.


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 int foo(const std::string& bar, const std::vector<long double*>& baz); 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 var img = document.getElementsByTagName("img");, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also bugzilla:5138.

See also

  • {{nowiki}} - for preventing the parsing of wiki markup and HTML in the content, e.g. in source code examples
  • {{pre}} - for larger blocks of source code and other pre-formatted text
  • {{tag}} - for using HTML elements ("tags") in prose, e.g. source code examples
  • {{var}} - for computer and mathematics variables
  • {{varserif}} - same as {{var}} but differentiates better between "I" (upper-case "i") and "l" (lower-case "L")
  • {{kbd}} - for indicating user input
  • {{samp}} - for example output
  • {{key press}} - for indicating the input of specific keystrokes, e.g. Ctrl+X
  • Help:Wiki markup
The above documentation is transcluded from Template:Code/doc. (edit | history)
Editors can experiment in this template's sandbox (create) and testcases (edit) pages.
Please add categories and interwikis to the /doc subpage. Subpages of this template.