Vorlage:Var/doc

Usage

This template is to help facilitate the displaying of variable names (in mathematics, computer source code, wikimarkup, 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, wpen:separation of presentation and content, wpen:semantic Web, and metadata; In wpen:XHTML and wpen:HTML, the <var> element has semantic meaning, while simple italicization does not. "Variable" in this sense may include arbitrary or unknown names or terms, example 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.

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 sample text (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).

More examples

Markup	Renders as
The HTML code: :<code>{{tag|var|content=username}}</code> renders as: :{{var|username}}	The HTML code: <var>username</var> renders as: username
The commandline should read: {{code snippet|code=ssh hostname}}<br />(where {{var|hostname}} is the IP address or ...)<br />If it is correct, press <code>Enter</code>.	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 }}

See also

Template	Example output	Use
{{var}}	strIllustratePrefix	To indicate text is a variable name
{{para}}	|title=  |year=2008	To display template parameters with or without values.
{{param}}	{{{title}}}  {{{title|alt}}}  etc.	To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them.
{{tlx}} etc.	{{tlx|first parameter|...}}	To display a template call (with or without parameters and values) as code.
{{tag}}	"With HTML <img>...</img> tags..."	To render wpen:HTML elements ("tags") as prose.
{{code}}	local p = {} function p.main(frame) ... end	To indicate text is source code.
{{code snippet}}	"Always include the sample text parameter..."	To indicate text is source code. To nest other templates within {{code snippet}}, use <code>...</code>.
<syntaxhighlight>...</syntaxhighlight>		Parser function
{{pre}}		For larger blocks of source code and other pre-formatted text.
{{pre2}}		For larger blocks of source code and other pre-formatted text. Same as {{pre}} but ads slider for overflowing text