Template:Var/doc

From MicroWiki, the free micronational encyclopædia
Jump to navigation Jump to search

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. This template (and the underlying XHTML) are generally not used if MediaWiki's <math>...</math> tags (or any other stand-alone mathematical markup) are being used.

Examples

Example
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.

At times, you may wish to use a serif font. This is especially true when attempting to render single-letter variables like "I" (upper-case "i") and "l" (lower-case "L"), since they are nearly indistinguishable (if at all). In such situations, use the {{varserif}} template instead of {{var}}, to make them more distinguishable, like these serif examples: Template:Varserif, Template:Varserif.

More examples
Markup Renders as
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:9px 5px 5px; vertical-align:top;"|
[markup]
style= "background:#f8f9fa ; border:1px solid #eaecf0 ; padding:5px; vertical-align:top;"|

[rendering]

TemplateData

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

Var

Marks text as an HTML variable

Template parameters

ParameterDescriptionTypeStatus
variable1

no description

Linerequired
classclass

no description

Stringoptional
IDid

no description

Stringoptional
CSS stylestyle

no description

Stringoptional
languagelang

no description

Example
c++
Stringoptional
HTML title (hovertext)title

no description

Stringoptional

See also

  • {{mvar}} which makes the argument italic and formats as mathematics
  • {{math}} which formats its argument as mathematics
  • {{bigmath}}, the same as {{math}} but makes it bigger

Template:Semantic markup templates