Difference between revisions of "Template:Var/doc"

From Summertime Saga Wiki
Jump to: navigation, search
(Created page with "This template is to help facilitate the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc....")
 
m
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
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.
+
The template {{tlg|var}} 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.
  
−
; Example:
+
== Usage ==
−
: {{tlx|var|username}}
+
 
−
outputs the following HTML:
+
: {{tlg|code=yes|nolink=yes|var|username}}
 +
Outputs the following HTML:
 
: {{tag|var|content=username}}
 
: {{tag|var|content=username}}
−
which renders as:
+
Which renders as:
 
: {{var|username}}
 
: {{var|username}}
  
 
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.
  
−
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 {{tlx|varserif}} template instead of {{tl|var}}, to make them more distinguishable, like these serif examples: {{varserif|I}}, {{varserif|l}}.
+
== Examples ==
−
 
 
−
; More examples:
 
−
 
 
−
<div style="background:#FFFFFF;">
 
−
{{Markup
 
−
| <nowiki>The HTML code:
 
−
: {{tag|var|content=username}}
 
−
renders as:
 
−
: {{var|username}}</nowiki>
 
−
| The HTML code:
 
−
: {{tag|var|content=username}}
 
−
renders as:
 
−
: {{var|username}}
 
−
 
 
−
| <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 {{key press|Enter}}.</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 {{key press|Enter}}.
 
−
 
 
−
| <nowiki>in this equation, let {{var|x}}{{=}}1 and {{var|y}}{{=}}120 ...</nowiki>
 
−
| in this equation, let {{var|x}}{{=}}1 and {{var|y}}{{=}}120 ...
 
  
 +
{|class=wikitable
 +
! Markup
 +
! Renders as
 +
|-
 +
| <nowiki>The HTML code {{tag|var|content=username}} renders as {{var|username}}</nowiki>
 +
| The HTML code {{tag|var|content=username}} renders as {{var|username}}
 +
|-
 +
| <nowiki>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}}.</nowiki>
 +
| 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}}.
 +
|-
 +
| <nowiki>In this equation, let {{var|x}} = 1 and {{var|y}} = 120.</nowiki>
 +
| In this equation, let {{var|x}} = 1 and {{var|y}} = 120.
 +
|-
 
| <nowiki>{{para|accessdate|{{var|todays_date}}}}</nowiki>
 
| <nowiki>{{para|accessdate|{{var|todays_date}}}}</nowiki>
 
| {{para|accessdate|{{var|todays_date}}}}
 
| {{para|accessdate|{{var|todays_date}}}}
−
}}
+
|}
−
</div>
 
−
 
 
  
−
[[Category:Documentation subpages]]
+
[[Category:Templates]][[Category:Semantic markup templates]][[Category:Templates documentation]]

Latest revision as of 17:05, 21 July 2020

The template {{var}} 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

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

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
Retrieved from "https://wiki.summertimesaga.com/index.php?title=Template:Var/doc&oldid=24579"