Template:Var/doc

This is a documentation subpage for Template:Var.
It contains usage information, categories and other content that is not part of the original template page.

Redirects

{{VAR}}
{{variable}}

This template is used on approximately 6,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

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: {{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.

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: Page Template:Var serif/styles.css has no content.I, Page Template:Var serif/styles.css has no content.l.

More examples

Markup	Renders as
The HTML code: : {{tag\|var\|content=username}} renders as: : {{var\|username}}	The HTML code: `<var>username</var>` renders as: `username`
The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press {{key press\|Enter}}.	The commandline should read: `%` `ssh hostname` (where `hostname` is the IP address or ...) If it is correct, press `↵ Enter`.
in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120 ...	in this equation, let `x`=1 and `y`=120 ...
{{para\|accessdate\|{{var\|todays_date}}}}	`\|accessdate=todays_date`

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Var

Marks text as an HTML variable

Template parameters
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 Example c++	String	optional
HTML title (hovertext)	`title`	no description	String	optional

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

Important!

To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

"Never use ..."

Same as {{strong}} but in red

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

"Only use ..."

Same as {{strong}} but in green

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

"An emphatic phrase"

To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

strPrefix

To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

Page Template:Var serif/styles.css has no content.strIllustratePrefix

(see {{var}} above)

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

{{DEFAULTSORT:Y, X}}

To display wikicode variables and magic words as they would appear in code

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

|year=2008

To display template parameters with or without values

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

{{{title|alt}}}

To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

Template:Pvalue

To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

etc.

{{Template|1|2|...|10}}

To display a template call (with or without parameters and values) as code

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

"The <img>...</img> tags ..."

To render HTML elements ("tags") in prose

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

"Ensure the alt= parameter ..."

To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: someMethod becomes someMethod

{{subst:codenowiki}} {{small|small text}} To wrap example code in <code><nowiki>...</nowiki></code>

{{subst:kbdnowiki}} {{big|big text}} To wrap example code in <kbd><nowiki>...</nowiki></kbd>

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

_{[this is a block template]}

( or {{sxhl}} ) Wrapper for <syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

"Do not use <Template:Deprecated code>."

( or {{dc}} ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2}} variant uses strike-through (<Template:Dc2>) while {{dcr}} uses red (<Template:Dcr>).

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

_{[this is a block template]}

For larger blocks of source code and other pre-formatted text

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

_{[this is a block template]}

For block quotations (only – never for non-quotations)

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

_{[this is a block template]}

For indented blocks of material; visually identical to {{quote}} but without quote markup

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

user input

To indicate user input

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

Ctrl+x

To indicate specific-keystroke input, including combinations

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

Left shift

Similar; includes more symbols, but does not directly support combinations

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

Template:Lower

To indicate PlayStation-style gamepad key presses

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

Don't save

To indicate a button in a user interface

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

When appropriate, protection levels are automatically sensed, described and categorized.

example output

To indicate sample or example output

This template is based (in parts) on the Template:Var/doc from the free encyclopedia wikipedia and is licensed under GNU license for free documentation and the Creative Commons Attribution/Share Alike. On wikipedia there is a List of authors accessible. More about importing from wikipedia on page Imedwiki:Importing from wikipedia.

Accuracy	Spot checked
Depth	Basic
Readability	Acceptable

Contents

Usage

Examples

TemplateData

See also

Navigation menu

Search