模板:Code

維基文庫,自由的圖書館
跳到导航 跳到搜索
03wiki-zn-frontpage-icon.pngCode正在翻译。欢迎您积极翻译与修订
原文在en:template:code

{{{1}}}

模板文档


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 or syntaxhighlight. See Help:Wiki markup for an explanation of what the various tags do.Template: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:{{{1}}}|{{{1}}}]]}} call

Use 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.

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 |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 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[编辑]

Template:Markup

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 as a wrapper instead of this template.

Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:

Template:Markup

The above example shows the HTML rendered by the citation template, including the hidden metadata.

See also[编辑]

Template:Var/seealso