Template:Code/doc

From Second Life Wiki
< Template:Code
Revision as of 07:56, 12 September 2023 by Gwyneth Llewelyn (talk | contribs) (Shamelessly copied from wikipedia.org and adapted for SL Wiki)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


Usage

Wraps a short span of text in <syntaxhighlight> tags (see "Wikipedia logo"mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See "Wikipedia logo"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, {{code|a {{template}} call}} will still invoke the template:

a &#123;&#123;[[Template:{{{1}}}|{{{1}}}]]&#125;&#125; 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 &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 "Wikipedia logo"mw:Extension:SyntaxHighlight. 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 "Wikipedia logo"substituted.

Examples

Lorem {{code|ipsum '''dolor'''}} sit amet

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:

{{code| {{cite web |title=Title |url=http://example.org}} }}

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

TemplateData

{
	"description": "An inline source code string.",
	"format": "inline",
	"params": {
		"1": {
			"label": "Code",
			"aliases": ["code"],
			"description": "The code to display.",
			"required": true,
			"type": "string"
		},
		"2": {
			"label": "Language",
			"aliases": ["lang"],
			"description": "The programming language of the source code. List of valid values is at: [[mw:Extension:SyntaxHighlight#Supported_languages]]",
			"default": "text",
			"suggested": true,
			"type": "string"
		},
		"class": {
			"label": "Class",
			"type": "string"
		},
		"id": {
			"label": "ID",
			"type": "string"
		},
		"style": {
			"label": "CSS Style",
			"type": "string"
		}
	}
}

See also