Difference between revisions of "Template:Var/doc"
m |
|||
| Line 1: | Line 1: | ||
| + | == Purpose == | ||
| + | |||
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 [[wikipedia:Semantic HTML|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 [[wikipedia:XHTML]] and [[wikipedia:HTML]], the {{tag|var|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of [[wikipedia:kerning]] to compensate for the italicization and enhance readability. | 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 [[wikipedia:Semantic HTML|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 [[wikipedia:XHTML]] and [[wikipedia:HTML]], the {{tag|var|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of [[wikipedia: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. | ||
| − | + | == Usage == | |
| + | |||
: {{tlx|var|username}} | : {{tlx|var|username}} | ||
outputs the following HTML: | outputs the following HTML: | ||
| Line 12: | Line 15: | ||
Note that on the screen or in print, this renders as simple italicization, as does <code><nowiki>''username''</nowiki></code> (using pairs of apostrophes) or {{tag|i|content=username}} (using HTML), yet it carries more semantic meaning than either of these methods. | Note that on the screen or in print, this renders as simple italicization, as does <code><nowiki>''username''</nowiki></code> (using pairs of apostrophes) or {{tag|i|content=username}} (using HTML), yet it carries more semantic meaning than either of these methods. | ||
| − | + | == Examples == | |
| − | |||
{|class=wikitable | {|class=wikitable | ||
! Markup | ! Markup | ||
| Line 26: | Line 28: | ||
: {{var|username}} | : {{var|username}} | ||
|- | |- | ||
| − | | <nowiki>The commandline should read: % {{kbd|1=ssh {{var|hostname}}}}<br />(where {{var|hostname}} is the IP address or ...)<br />If it is correct, press <kbd>Enter</kbd>.</nowiki> | + | | <nowiki>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 <kbd>Enter</kbd>.</nowiki> |
| − | | The commandline should read: % {{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: {{samp|%}} {{kbd|1=ssh {{var|hostname}}}}<br />(where {{var|hostname}} is the IP address or ...)<br />If it is correct, press {{key press|Enter}}. |
|- | |- | ||
| <nowiki>in this equation, let {{var|x}}{{=}}1 and {{var|y}}{{=}}120 ...</nowiki> | | <nowiki>in this equation, let {{var|x}}{{=}}1 and {{var|y}}{{=}}120 ...</nowiki> | ||
Revision as of 00:15, 10 June 2019
Purpose
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 wikipedia:XHTML and wikipedia:HTML, the element has semantic meaning, while simple italicization does not. This template provides a tiny hint of wikipedia: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: |
The HTML code:
renders as:
|
| 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 <kbd>Enter</kbd>. | 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
|