More actions
Created page with "{{#ifeq:{{NAMESPACE}}|{{ns:0}}|{{FormattingError|[[:{{safesubst:<noinclude/>#invoke:TEMPLATENAME|main}}]] is only for examples of style and formatting. Do not use it in actual articles.}}|<span class="example deprecated-content example-bad" style="font-family: Georgia, 'DejaVu Serif', serif; color: var(--color-content-removed, #8B0000);" {{#if:{{{title|}}}|title="{{{title}}}"}}>{{{1|Example text}}}</span>}}<noinclude> {{Documentation}} </noinclude>" |
m Protected "Template:!xt": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) |
(No difference)
| |
Latest revision as of 17:48, 3 March 2025
Example text
| This page uses Creative Commons Licensed content from Wikipedia (view authors). |
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
 | Not for use in article space: This family of templates cannot be used in mainspace (the article namespace). |
 | This template uses Lua: |
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.
{{code|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 , which substitutes boldfacing, or , which substitutes a monospaced font. For style examples that break to their own line (e.g. paragraphs), use .
For examples of , use , , , or , respectively to the previous paragraph (the addition of the ! indicates the opposite effect). Use for bad/wrong style .
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 {{mxtd}}.
The template is for examples, and has no color change, but is otherwise identical to {{xt}}. It can be used with {{xt}} and to indicate usage that is neither advised nor advised against or deprecated. The bold, sans-serif equivalent is .
Parameters
|text hereor|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 .
- What you get
- ...for example, T = 293.15 K, but not .
| Template class | Output typeface |
|---|---|
{{xt}}
|
inline typeface change |
{{mxtd}}
|
Template:Mxtd |
User CSS for a monospaced coding font
Change system-default monospace font:
|
|---|