Template:Code

From mediawiki.org
Jump to navigation Jump to search
{{{1}}}
Template documentation

Usage[edit]

This is a semantic markup wrapper template for the HTML element <code>...</code>. It can be used without a parameter to wrap code in a formatted block, with syntax highlighting, or with |inline= for a leaner presentation.

Example:

{{code|lang=css|font-family: 'Times New Roman', serif;}}

produces:

font-family: 'Times New Roman', serif;

Inline:

{{code|inline=y|lang=css|font-family: 'Times New Roman', serif;}}

produces:

font-family: 'Times New Roman', serif;

and is equivalent to:

<syntaxhighlight inline lang="css">font-family: 'Times New Roman', serif;</syntaxhighlight>

TemplateData[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Code

A block or inline source code string.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Code1 code

The code to display.

Stringrequired
Language2 lang

The programming language of the source code. List of valid values is at: Extension:SyntaxHighlight#Supported_languages

Default

text (if `inline=true`)

bash (if `inline` is not set)

Stringsuggested
Inline?inline

Whether to use inline formatting

Booleanoptional
Classclass

Applies only if `inline=true`

Stringoptional
IDid

Applies only if `inline=true`

Stringoptional
CSS Stylestyle

Applies only if `inline=true`

Stringoptional
Headerheader

Applies only if `inline` is not set

Lineoptional

See also[edit]