Template:Code/doc
This is a documentation subpage for Template:Code. It contains 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 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.[clarification needed]
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
quux.bar baz
versus:
foo {{code|bar baz}} quux.
which is going to be visually confusing for many:
- foo
quux.bar baz
because "foo" and "
" will seem more closely associated than "bar
" and "bar
"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
baz
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
and html4strict
are valid values, as are html5
, php
, perl
, css
, javascript
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.
mysql
This template does not need to be substituted.
Examples
Markup | Renders as |
---|---|
Lorem {{code|ipsum '''dolor'''}} sit amet |
Lorem 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 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 , 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}} }} |
|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
See also
Template | Example output | Use |
{{strong}} | strong semantic emphasis | To indicate <strong> emphasis instead of (or as well as) simple typographical boldfacing. |
{{strongbad}} | "Never use..." | Same as {{strong}} but in red. |
{{stronggood}} | "Only use..." | Same as {{strong}} but in green. |
{{em}} | mild semantic emphasis | As per {{strong}} but for the milder <em> emphasis (instead of / as well as typographical italicization). |
{{var}} | strIllustratePrefix | To indicate text is a variable name. Use for any variables except those whose names include "I" (uppercase i) and/or "l" (lowercase L), where {{varserif}} below should be used instead to ensure a distinction between these letters is noticeable. |
{{varserif}} | strIllustratePrefix | (see {{var}} above). |
{{wikivar}} | {{PAGENAME}} {{DEFAULTSORT:Y, X}}
| To display wikicode variables and magic words as they would appear in code. |
{{para}} | |title= |year=2008
| To display template parameters with or without values. |
{{param}} | {{{title}}} {{{title|alt}}} etc.
| To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above. |
{{tlx}} etc. | {{Template|first parameter|...}}
| To display a template call (with or without parameters and values) as code. |
{{tag}} | "With HTML <img>...</img> tags..."
| To render HTML elements ("tags") as prose. |
{{code}} | "Always include the parameter..."
| To indicate text is source code. To nest other templates within {{code}}, use <code>...</code> .
|
{{syntaxhighlight}} | ( or {{sxhl}} ) Wrapper for <syntaxhighlight>...</syntaxhighlight> , but will wrap overflowing text.
| |
{{deprecated code}} | "Do not use <blink>...</blink> | ( or {{dc2}} ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. |
{{pre}} | For larger blocks of source code and other pre-formatted text. | |
{{bq}} | For indented blocks of content, such as block quotations, examples, poems, etc. | |
{{kbd}} | user input | To indicate user input. |
{{key press}} | CtrlX | To indicate specific keystroke/s input. |
{{pskeypress}} | × | To indicate PlayStation-style gamepad key presses. |
{{samp}} | example output | To indicate sample or example output. |