Template:Xt/doc

From LNF Wiki
Jump to navigation Jump to search

Usage

Use template {{xt}} (the name of which stands for "example text") in order to format examples of style, especially when using quotation marks or italics could be confusing. This changes the given text to the serif typeface and green color. This template is used frequently in the Manual of Style when inline typeface changes are needed. 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 mono-spaced font. For style examples that break to their own line (e.g. paragraphs), use {{xt2}}. This template is not for use as quotation markup in talk pages; use {{tq}} instead.

For examples of bad/wrong style, in red, use {{!xt}}, {{!bxt}}), {{!mxt}}), or {{!xt2}}, respectively.

The {{xtd}} template exists for deprecated 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 neutral 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}}.

As with all templates, when the text, given as the template parameter, has any equals characters ("="), prefix the text with |1= in order to ensure any equals signs in the given text are correctly interpreted as being part of the normal text.

The accompanying change in typeface to a serif or mono-spaced type style, (example text) is to make it fully accessible for those with color blindness.

The parameter |title= 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.

Examples

What you write
...for example, {{xt|1=''T'' = 293.15 K}}, {{xt|1=''m'' = 5.4 kg}}.
What you get
...for example, T = 293.15 K, m = 5.4 kg.

See also

  • {{xt}} inline positive example text, in green, with serif font
  • {{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)
  • {{xt2}} same as {{xt}} but for blocks of text
  • {{!xt}} inline negative example text, in red, with serif font
  • {{!bxt}} same as {{!xt}} but uses boldface
  • {{!mxt}} same as {{!xt}} but uses mono-spaced font
  • {{!xt2}} same as {{!xt}} but for blocks
  • {{xtd}} inline deprecated (or uncertain, unavailable, lorem, etc.) example text, in grey
  • {{bxtd}} same as {{xtd}} but uses boldface
  • {{mxtd}} same as {{xtd}} but uses mono-spaced font
  • {{xtn}} inline neutral example text, with no color change, when none of the above applies
  • {{bxtn}} same as {{xtn}} but uses boldface; it still applies a CSS class, so it's not simply boldfacing
  • {{dc}} inline deprecated or deleted code or text; {{dc2}} variant has strikethrough (both explicitly use the <del> element)