Template:xt

From TechInfoDepot
Jump to navigationJump to search

Example text

Documentation icon Template documentation[view] [edit] [history] [purge]
Not to be confused with Category:Text color templates.

{{xt}} and related templates produce an inline typeface change suitable to render example text on TechInfoDepot's 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 TechInfoDepot:Manual of Style (MOS) when inline typeface changes are needed.

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

For cases where the serif typeface is not desirable (e.g. in blocks of computer code), use {{bxt}}, which substitutes Template:Bxt, or {{mxt}}, which substitutes a Template:Mxt. 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 Template:!xts.

The {{xtd}} template exists for Template:Xtd examples. Its alias {{xtg}} (for "grey") can be used to indicate Template:Xtg, examples without implying deprecation. The Template:Bxtd equivalent is {{bxtd}} (and {{bxtg}} alias). The Template:Mxtd equivalent is {{mxtd}}.

The {{xtn}} template is for Template:Xtn examples, and has no color change, but is otherwise identical to {{xt}} in that it changes to serif typeface. It can be used with {{xt}} and {{!xt}} to indicate usage that is neither advised nor advised against or deprecated. The Template:Bxtn equivalent is {{bxtn}}. The Template:Mxtn equivalent is {{mxtn}}.

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 m=5.4kg.
Template class Output typeface
{{xt}} inline typeface change
{{!xt}} inline typeface change
{{xtn}} Template:Xtn
{{xtd}} Template:Xtd
{{mxt}} Template:Mxt
{{!mxt}} Template:!mxt
{{mxtn}} Template:Mxtn
{{mxtd}} Template:Mxtd
{{bxt}} Template:Bxt
{{!bxt}} Template:!bxt
{{bxtn}} Template:Bxtn
{{bxtd}} Template:Bxtd

User CSS for a monospaced coding font

Change system-default monospace font:

Template:Mxt/User CSS for a monospaced coding font

See also

Template:Xt/see also