Template:Code/doc
This is a documentation subpage for Template:Code. It contains usage information, categories and other content that is not part of the original Template page. |
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Language | lang 2 | The programming language of the source code. List of valid values is at: Extension:SyntaxHighlight#Supported_languages
| String | suggested |
Inline? | inline | Whether to use inline formatting
| String | optional |
Class | class | Applies only if `inline=true` | String | optional |
ID | id | Applies only if `inline=true` | String | optional |
CSS Style | style | Applies only if `inline=true` | String | optional |
Header | header | Applies only if `inline` is not set | Line | optional |
Code | 1 code | The code to display. | String | required |
See also
[edit]- {{Inline-code }}
- {{MW file }}
- {{Git }}
- {{Codesample }}
- {{Terminal }}