Template:Var serif/doc

From BibleStrength

Template:Documentation subpage

This template is to help facilitate the displaying of variable names (in mathematics, computer source code, etc.) with the semantically correct <var>...</var>, which also renders the variable in italics, as is customary, and to do so in a serif font. This is specifically for the use of the characters "I" (upper-case i) and "l" (lower-case L), which in many sans-serif fonts can be difficult to distinguish. The template also very slightly adjusts the font size of the enclosed variable, to account for typical difference in x-height between non-fancy serif (e.g., Times and Times New Roman) and sans-serif (e.g. Arial and Helvetica) typefaces. The template should not be used generally, but only for "I" and "l", and perhaps other cases where a known visual ambiguity can be shown to exist in common sans-serif fonts for readers without acute vision. It is recommended to use Template:Tlx rather than Template:Tlx for "1" (numeral one), as it is usually more clearly distinguishable from "I" and "l" in sans-serif than serif fonts.

Template:Tlx need not be used for variables that simply contain "I" or "l", only for cases in which readers are likely to be unable to distinguish them visually.

The Template:Tlx method is preferred to simply italicizing and using inline style to specify the font, for accessibility, content/presentation separation, semantic Web, and metadata reasons; XHTML's <var> element has semantic meaning, while simple font changes like italicizing does not.

Because the font styling in the template is done entirely with CSS, it has no effect at all upon content semantics, nor does it change the output for users of screen reader software.


{{var serif|I}}


<var style="font-size:118%;font-family:serif;">I</var>

which renders as:

{{var|I}} = I
{{var|l}} = l
{{var|1}} = 1
{{var serif|I}} = I
{{var serif|l}} = l
{{var serif|1}} = 1

Please note that Template:Tnull is not a panacea; its treatment of the numeral "1" is easily mistaken for the letter "l" (lower-case "L") in many serif fonts.

Recommended usage
{{var serif|I}} = I
{{var serif|l}} = l
{{var|1}} = 1
{{var|variable}} for any other variable