Template:Xt/doc

Usage

Use template {{xt}} (the name of which stands for "example text") in order to format examples of style, especially when using quotation marks or italics could be confusing. This changes the given text to the serif typeface and green color. This template is used frequently in the Manual of Style when inline typeface changes are needed. For cases where the serif typeface is not desirable (e.g. in blocks of computer code), use {{bxt}}, which substitutes boldfacing, or {{mxt}}, which substitutes a mono-spaced font. For style examples that break to their own line (e.g. paragraphs), use {{xt2}}. This template is not for use as quotation markup in talk pages; use {{tq}} instead.

For examples of bad/wrong style, in red, use {{!xt}}, {{!bxt}}), {{!mxt}}), or {{!xt2}}, respectively.

The {{xtd}} template exists for deprecated examples. Its alias {{xtg}} (for "grey") can be used to indicate uncertain, unavailable, disabled, lorem, etc., examples without implying deprecation. The bold, sans-serif equivalent is {{bxtd}} (and {{bxtg}} alias). The mono-spaced equivalent is {{mxtd}}.

The {{xtn}} template is for neutral examples, and has no color change, but is otherwise identical to {{xt}}. It can be used with {{xt}} and {{!xt}} to indicate usage that is neither advised nor advised against or deprecated. The bold, sans-serif equivalent is {{bxtn}}.

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.

The accompanying change in typeface to a serif or mono-spaced type style, (example text) is to make it fully accessible for those with color blindness.

The parameter |title= takes text, which cannot be marked up in any way, and displays it as a pop-up "tooltip" (in most browsers) when the cursor hovers over the span.

Accessibility

Keep accessibility in mind, and never construct examples such that a blind person, who cannot see the coloration, boldfacing, or monospace font change, cannot understand the examples. Especially indicate, with terms like "not", "don't", "wrong:", etc., that a negative example is a negative one, or with "deprecated", "avoid", etc., that deprecated matieral is deprecated.

Examples

What you write

...for example, {{xt|1=''T'' = 293.15 K}}, but not {{!xt|1=''m''=5.4kg}}.

What you get

...for example, T = 293.15 K, but not m=5.4kg.

What you type	What you get
this is an {{xt|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{!xt|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{xtn|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{xtd|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{mxt|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{!mxt|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{mxtn|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{mxtd|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{bxt|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{!bxt|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{bxtn|inline typeface change}} for comparison	this is an inline typeface change for comparison
this is an {{bxtd|inline typeface change}} for comparison	this is an inline typeface change for comparison