Template:Code/doc: Difference between revisions
(categorized to 'Semantic markup templates') |
(Avoid lua error by not using test template) |
||
Line 10: | Line 10: | ||
: {{code|some '''wiki''' text}} | : {{code|some '''wiki''' text}} | ||
However, <code><nowiki>{{code|a {{ | However, <code><nowiki>{{code|a {{Tl}} call}}</nowiki></code> will still invoke the template: | ||
: {{code|a {{ | : {{code|a {{Tl}} call}} | ||
Use {{tag|nowiki}} around the template name to avoid this problem: | Use {{tag|nowiki}} around the template name to avoid this problem: |
Latest revision as of 15:03, 26 May 2018
This is a documentation subpage for Template:Code . |
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 {{Tl}} 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
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, use <code>...</code>
as a wrapper instead of this template.