Difference between revisions of "Template:Var/doc"
m (→Examples) |
m |
||
| Line 1: | Line 1: | ||
| − | + | The {{tl|var}} template facilitates the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the semantically correct {{tag|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 {{tag|var|o}} 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 {{tag|math}} tags (or any other stand‐alone mathematical markup) are being used. | “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 {{tag|math}} tags (or any other stand‐alone mathematical markup) are being used. | ||
| Line 34: | Line 32: | ||
|} | |} | ||
| − | [[Category:Templates]] | + | [[Category:Templates]][[Category:Semantic markup templates]][[Category:Templates documentation]] |
| − | [[Category:Templates documentation]] | ||
Revision as of 14:47, 11 July 2020
The Template:Tl template facilitates 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 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.
Usage
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.
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}}}} where {{var|hostname}} is the IP address. If it is correct, press {{key press|Enter}}. | The commandline should read % ssh hostname where hostname is the IP address. 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
|