Template:Var/doc
It contains usage information, categories and other content that is not part of the original template page.
|
Usage
This template is to help facilitate the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the semantically correct <var>...</var>
tags, which also renders the variable in italics, as is customary. This method is preferred to simply italicizing for many reasons, including accessibility, separation of presentation and content, semantic Web, and metadata; In XHTML and HTML, the <var>
element has semantic meaning, while simple italicization does not. This template provides a tiny hint of kerning to compensate for the italicization and enhance readability.
"Variable" in this sense may include arbitrary or unknown names or terms, examples of human input, arithmetical variables in equations, etc.
Examples
- {{var
|username}} - outputs the following HTML:
<var>username</var>
- which renders as:
- username
Note that on the screen or in print, this renders as simple italicization, as does ''username''
(using pairs of apostrophes) or <i>username</i>
(using HTML), yet it carries more semantic meaning than either of these methods.
TemplateData
Marks text as an HTML variable
Parameter | Description | Type | Status | |
---|---|---|---|---|
variable | 1 | no description | Line | required |
class | class | no description | String | optional |
ID | id | no description | String | optional |
CSS style | style | no description | String | optional |
language | lang | no description
| String | optional |
HTML title (hovertext) | title | no description | String | optional |