Template:Xt/doc: Difference between revisions
meta>SMcCandlish (moving these to new Category:Example-formatting templates; they are not really quotation templates at all) |
meta>Cpiral (→Examples: + table of main xt-family concepts, with "this is an inline typeface change for comparison") |
||
| Line 20: | Line 20: | ||
===Examples=== | ===Examples=== | ||
;What you write: | ;What you write: | ||
| Line 27: | Line 28: | ||
:...for example, {{xt|1=''T'' = 293.15 K}}, {{xt|1=''m'' = 5.4 kg}}. | :...for example, {{xt|1=''T'' = 293.15 K}}, {{xt|1=''m'' = 5.4 kg}}. | ||
{| class=wikitable | |||
!What you type | |||
!What you get | |||
|- | |||
|<kbd><nowiki>this is an <kbd> inline typeface change </kbd> for comparison</kbd></nowiki> | |||
|this is an<kbd> inline typeface change </kbd>for comparison | |||
|- | |||
|<kbd><nowiki>this is an {{m</nowiki>'''xt'''<nowiki>|inline typeface change}} for comparison</kbd></nowiki> | |||
|this is an {{mxt|inline typeface change}} for comparison | |||
|- | |||
|<kbd><nowiki>this is an {{</nowiki>'''xt'''<nowiki>|inline typeface change}} for comparison</kbd></nowiki> | |||
|this is an {{xt|inline typeface change}} for comparison | |||
|- | |||
|<kbd><nowiki>this is an {{b</nowiki>'''xt'''<nowiki>|inline typeface change}} for comparison</kbd></nowiki> | |||
|this is an {{bxt|inline typeface change}} for comparison | |||
|- | |||
|<kbd><nowiki>this is an {{</nowiki>'''xt'''<nowiki>d|inline typeface change}} for comparison</kbd></nowiki> | |||
|this is an {{xtd|inline typeface change}} for comparison | |||
|- | |||
|<kbd><nowiki>this is an {{</nowiki>'''xt'''<nowiki>n|inline typeface change}} for comparison</kbd></nowiki> | |||
|this is an {{xtn|inline typeface change}} for comparison | |||
|} | |||
==See also== | ==See also== | ||
Revision as of 18:41, 22 January 2016
 | This is a documentation subpage for Template:xt, Template:bxt, Template:mxt, Template:xtd, Template:bxtd, Template:!xt, Template:!bxt, and Template:!mxt. It may contain usage information, categories and other content that is not part of the original template page. |
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.
| What you type | What you get |
|---|---|
| this is an <kbd> inline typeface change </kbd> for comparison</kbd> | this is an inline typeface change for comparison |
| this is an {{mxt|inline typeface change}} for comparison</kbd> | this is an inline typeface change for comparison |
| this is an {{xt|inline typeface change}} for comparison</kbd> | this is an inline typeface change for comparison |
| this is an {{bxt|inline typeface change}} for comparison</kbd> | this is an inline typeface change for comparison |
| this is an {{xtd|inline typeface change}} for comparison</kbd> | this is an inline typeface change for comparison |
| this is an {{xtn|inline typeface change}} for comparison</kbd> | this is an inline typeface change for comparison |
See also
