Template:Var/doc

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  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|HTML, the 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 used in MediaWiki's  tags (or any other stand-alone mathematical markup) are being used.


 * Example:

outputs the following HTML:
 * username

which renders as:
 * username

Note that on the screen or in print, this renders as simple italicization, as does  (using pairs of apostrophes) or username (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 template instead of, to make them more distinguishable, like these serif examples: ,.


 * More examples:

TemplateData
{	"description": { "en": "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 ... tags." },	"format": "inline", "params": { "1": {			"label": { "en": "Content" },			"description": { "en": "The content of the ... tags." },			"required": true, "type": "line" },		"id": { "label": { "en": "ID" },			"description": { "en": "Adds the ID attribute to the tag." },			"type": "string" },		"class": { "label": { "en": "Class" },			"description": { "en": "Adds extra classes to the tag." },			"type": "string" },		"style": { "label": { "en": "CSS Style" },			"description": { "en": "Adds extra CSS properties to the tag." },			"type": "string" },		"title": { "label": { "en": "Tooltip" },			"type": "string" },		"lang": { "label": { "en": "Language" },			"description": { "en": "Adds the ISO 639 language code to the tag." },			"suggestedvalues": [ "en" ],			"type": "string" }	},	"paramOrder": [ "id", "class", "style", "title", "lang", "1"	] }