Template:Bxtn

Example text

Documentation

This documentation is transcluded from Template:Xt/doc. (view | edit | history)

This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

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

Using example-formatting templates in general[edit]

File:Ambox important.svg

Not for use in article space: This family of templates cannot be used in mainspace (the article namespace).

File:Lua-Logo.svg

This template uses Lua:

Module:TEMPLATENAME

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.

{{xt}} changes the typeface to serif and the text color to green.

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 bad/wrong style, in red, use {{!xt}}, {{!bxt}}, {{!mxt}}, or {{!xt2}}, respectively to the previous paragraph (the addition of the ! indicates the opposite effect). Use {{!xts}} for bad/wrong style ~~with strikethrough formatting~~.

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[edit]

|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[edit]

The accompanying change in typeface to a serif or monospaced type style (as in Template:Xt) 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[edit]

What you write

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

What you get

...for example, Template:Xt, but not m=5.4kg.

Template class	Output typeface
`{{xt}}`	Template:Xt
`{{!xt}}`	inline typeface change
`{{xtn}}`	Template:Xtn
`{{xtd}}`	Template:Xtd
`{{mxt}}`	Template:Mxt
`{{!mxt}}`	inline typeface change
`{{mxtn}}`	Template:Mxtn
`{{mxtd}}`	Template:Mxtd
`{{bxt}}`	inline typeface change
`{{!bxt}}`	inline typeface change
`{{bxtn}}`	inline typeface change
`{{bxtd}}`	inline typeface change

User CSS for a monospaced coding font[edit]

Change system-default monospace font:
Template:Mxt/User CSS for a monospaced coding font