Template:Xt/doc

This and related templates produce an inline typeface change suitable to render eXample Text on Wikipedia's general help pages.

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.

This family of templates cannot be used in mainspace (the article namespace).

Also, this family of templates is not for use as wikitext markup for quotations on talk pages; use {{tq}} instead.

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 monospaced font. For style examples that break to their own line (e.g. paragraphs), use {{xt2}}.

For examples of Template:!xt, use {{!xt}}, {{!bxt}}, {{!mxt}}, or {{!xt2}}, respectively.

The {{xtd}} template exists for Template:Xtg 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 Template:Xtn 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}}.

Parameters

• |= text here or |1 = 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.
• |title = 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 monospaced 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 {{xt}} syntax and result

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 Template:!xt.

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 Template:!xt for comparison
this is an {{xtn|inline typeface change}} for comparison	this is an Template:Xtn for comparison
this is an {{xtd|inline typeface change}} for comparison	this is an Template:Xtd 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 Template:!mxt for comparison
this is an {{mxtn|inline typeface change}} for comparison	this is an Template:Mxtn for comparison
this is an {{mxtd|inline typeface change}} for comparison	this is an Template:Mxtd 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 Template:!bxt for comparison
this is an {{bxtn|inline typeface change}} for comparison	this is an Template:Bxtn for comparison
this is an {{bxtd|inline typeface change}} for comparison	this is an Template:Bxtd for comparison

User CSS for a monospaced coding font

Have monospaced templates in this group – and your editing window – use your preferred monospaced font:

See also

• {{xt}} inline positive example text, in green, with serif font
• {{xt2}} same as {{xt}} but for blocks of text
• {{bxt}} same as {{xt}} but uses bold instead of serif font
• {{mxt}} same as {{xt}} but uses mono-spaced font (especially useful in source code)
   
• {{!xt}} inline Template:!xt, in red, with serif font
• {{!xt2}} same as {{!xt}} but for blocks (i.e., same as {{xt2}}but red)
• {{!bxt}} same as {{!xt}} but uses Template:!bxt
• {{!mxt}} same as {{!xt}} but uses Template:!mxt; used for incorrect or strongly deprecated code/output/input examples and should usually be wrapped in <code>, <samp>, or <kbd> as appropriate; see also {{dc}} and its variants below
• {{!xts}} same as {{xt}} but also Template:!xts
• {{dcr}} inline Template:Dcr; {{dc2}} variant has Template:Dc2 (they both use the <del> element, and do not add monospace font on their own; can be used in mainspace (articles), and where necessary wrapped in <code>, <samp>, or <kbd>); see also {{dc}} below
   
• {{xtd}} inline Template:Xtd, in grey
• {{bxtd}} same as {{xtd}} but uses Template:Bxtg
• {{mxtd}} same as {{xtd}} but uses Template:Mxtd
• {{dc}} inline Template:Dc; (uses the <del> element, and does not add monospace font on it own; can be used in mainspace (articles), and where necessary wrapped in <code>, <samp>, or <kbd>); see also {{dcr}} above
   
• {{xtn}} inline Template:Xtn, with no color change, when none of the above applies; used for "permissible" examples neither favored nor deprecated
• {{xtn2}} same as {{xtn}} but for blocks of text
• {{bxtn}} same as {{xtn}} but uses Template:Bxtn; it still applies a CSS class, so it's not simply boldfacing
• {{mxtn}} same as {{xtn}} but uses Template:Mxtn; this is a good template to use when the shaded box formatting of <code>...</code> might be undesirable, or the semantics of it is incorrect in the context
   
• {{strongbad}} – for introducing something as deprecated or issuing some other warning in documentation, e.g.: Not for use in mainspace.