Template:Xt/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>SMcCandlish
insure and ensure are not synonymous
meta>SMcCandlish
dox overhaul, especially 1) Don't use tables for layout and other non-tabular purposes; 2) don't add activistic accessibility screeds to template documentation (especially here since font changes are ignored by screen readers!)
Line 1: Line 1:
{{Documentation subpage}}<!--PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE-->
{{Documentation subpage}}<!--PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE-->


===Usage===
==Usage==
Use this template to change the given text to the serif typeface, in order to format examples of style, especially when using quotation marks or italics could be confusing. This template is used frequently in the [[Wikipedia:Manual of Style|Manual of Style]] when ''inline'' typeface changes are needed. (For style examples that break to their own line, use {{tl|xt2}}).)  
Use this template (the name of which stands for "e<strong>x</strong>ample <strong>t</strong>ext") to change the given text to the serif typeface, in order to format examples of style, especially when using quotation marks or italics could be confusing. This template is used frequently in the [[Wikipedia:Manual of Style|Manual of Style]] when ''inline'' typeface changes are needed. (For style examples that break to their own line, use {{tl|xt2}}).)  


As with all templates, when the text, given as the template parameter, has any equals characters,  
As with all templates, when the text, given as the template parameter, has any equals characters,  
prefix the text with <code>1=</code> in order to ensure any equals signs in the given text
prefix the text with {{para|1}} in order to ensure any equals signs in the given text
are correctly interpreted as being part of the normal text.
are correctly interpreted as being part of the normal text.


{|class="wikitable"
===Examples===
|+Examples
;What you write:
|-
!What you write
|-
|<code><nowiki>Symbols for variables are normally italicized, and symbols for units of measurement are usually upright: for example, {{xt|1=''T''&nbsp;=&nbsp;293.15 K}}, {{xt|1=''m''&nbsp;=&nbsp;5.4&nbsp;kg}}.</nowiki></code>
|-
!What you get
|-
|Symbols for variables are normally italicized, and symbols for units of measurement are usually upright: for example, {{xt|1=''T''&nbsp;=&nbsp;293.15 K}}, {{xt|1=''m''&nbsp;=&nbsp;5.4&nbsp;kg}}.
|-
!About color and color blindness
|-
|The accompanying change in typeface to a serif typestyle, ({{xt|example text}}) is to make it fully accessible for those with red/green color blindness. Actually, the change in typeface works for those with ''total'' color blindness, which makes it more accessible than the <span style="color:#002BB8;">blue text</span> that Wikipedia uses as the only clue that something is a link. The important point to remember about color blindness and accessibility is that editors must not use color ''alone''—especially red and/or green—to convey an important distinction, like <span style="color:Green;">“this is good”</span> but <span style="color:Red;">“this is bad”</span> or “<span style="color:Maroon;">GOOD</span>/BAD”. This is prohibited under Wikipedia policy.


Color simply provides yet another way to distinguish example text for normal-sighted individuals. This is similar to the [http://www.sks-science.com/plastic-laboratory-bottles-p-967.html chemistry wash bottles] found in wet labs: the isopropanol wash bottle has a <span style="color:#002BB8;">blue top</span>, ethanol&nbsp;=&nbsp;<span style="color:orange;">orange top</span>, methanol&nbsp;=&nbsp;<span style="color:green;">green top</span>, acetone&nbsp;=&nbsp;<span style="color:Red;">red top</span>. There is a big difference between acetone and methanol (red/green). If one is color blind, you read the wording on the bottle. If you have normal color vision, you have both indicators, where color is the quicker one. It’s the same for cylinders of compressed hydrogen; they come in red cylinders. Oxygen ('''big''' difference) cylinders are green. Of course, both are labeled with their contents too. Color is simply assistive; same here.
*<code><nowiki>Symbols for variables are normally italicized, and symbols for units of measurement are usually upright: for example, {{xt|1=''T''&nbsp;=&nbsp;293.15 K}}, {{xt|1=''m''&nbsp;=&nbsp;5.4&nbsp;kg}}.</nowiki></code>
|}


===See also===
;What you get:
 
*Symbols for variables are normally italicized, and symbols for units of measurement are usually upright: for example, {{xt|1=''T''&nbsp;=&nbsp;293.15 K}}, {{xt|1=''m''&nbsp;=&nbsp;5.4&nbsp;kg}}.
 
The accompanying change in typeface to a serif typestyle, ({{xt|example text}}) is to make it fully accessible for those with color blindness.
 
==See also==
*{{tl|xt2}}
*{{tl|xt2}}



Revision as of 11:01, 7 January 2010

Usage

Use this template (the name of which stands for "example text") to change the given text to the serif typeface, in order to format examples of style, especially when using quotation marks or italics could be confusing. This template is used frequently in the Manual of Style when inline typeface changes are needed. (For style examples that break to their own line, use {{xt2}}).)

As with all templates, when the text, given as the template parameter, has any equals characters, prefix the text with |1= in order to ensure any equals signs in the given text are correctly interpreted as being part of the normal text.

Examples

What you write
  • Symbols for variables are normally italicized, and symbols for units of measurement are usually upright: for example, {{xt|1=''T'' = 293.15 K}}, {{xt|1=''m'' = 5.4 kg}}.
What you get
  • Symbols for variables are normally italicized, and symbols for units of measurement are usually upright: for example, T = 293.15 K, m = 5.4 kg.

The accompanying change in typeface to a serif typestyle, (example text) is to make it fully accessible for those with color blindness.

See also