Template:Wp/nod/Code/doc

ᨿᩢ᩠ᨦᨷ᩵ᨸᩖᩯ

Usage

Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See th:Help:Wiki markup for an explanation of what the various tags do.

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 inline=1. 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, {{Wp/nod/code|a {{Wp/nod/template}} call}} will still invoke the template:

a [[:Template:Wp/nod/template]] call

Use <nowiki>...</nowiki> around the template name to avoid this problem:

a {{Wp/nod/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  {{Wp/nod/code|bar baz}}  quux.

is well spaced:

foo  bar baz  quux.

versus:

foo {{Wp/nod/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

Markup [[:Template:	Renders asTemplate:For loop

/* _____________________________________________________________________________

* |                                                                             |
* |                    === WARNING: GLOBAL GADGET FILE ===                      |
* |                  Changes to this page affect many users.                    |
* | Please discuss changes on the talk page or on WT:Gadget before editing. |
* |_____________________________________________________________________________|
*
* Imported from version XXXX as of DATE from SCRIPT_SOURCE
* SHORT_DESCRIPTION, see SCRIPT_HOME_PAGE
*/

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 [[:Template:	Renders asTemplate:For loop

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

See also

• {{Syntaxhighlight}}
• Help:Wiki markup