Template:Xt/doc

Using example-formatting templates in general
The category of example-formatting templates is used frequently in non-mainspace general help pages such as Wikipedia:Manual of Style (MOS) when inline typeface changes are needed.


 * use instead.

For cases where the serif typeface is not desirable (e.g. in blocks of computer code), use, which substitutes boldfacing, or , which substitutes a mono-spaced font. For style examples that break to their own line (e.g. paragraphs), use.

For examples of bad/wrong style, in red, use, , , or , respectively.

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

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

Parameters

 * text here or text here – The text to which to apply the markup. As with all templates, when the text has any equals characters ("="), explicitly prefix the text with 1 or the template will break.
 * tooltip text here – 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
The accompanying change in typeface to a serif or mono-spaced type style (as in example text) is to make it fully accessible for those with color blindness.

Keep accessibility more broadly in mind, and never construct examples such that a blind person, who may not be able to 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 material is deprecated.

Examples of syntax and result

 * What you write:




 * What you get:


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