틀:Code/doc
This is a documentation subpage for 틀:Code. It contains usage information, categories and other content that is not part of the original 틀 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 틀:Tag or 틀:Tag. See Help:Wiki markup for an explanation of what the various tags do.틀:Clarify
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]] call
Use 틀:Tag around the template name to avoid this problem:
a {{template}} call
When used inline with regular text, 틀:Tnull 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
quux.
versus:
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 틀:Para, or more explicitly as 틀:Para) 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.
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 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 틀:Tnull 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. 틀:Key press
- Help:Wiki markup