Template:Xt/doc: Difference between revisions
meta>SMcCandlish →Usage: parameter doc |
meta>SMcCandlish typo |
||
Line 7: | Line 7: | ||
For examples of {{!xt|bad/wrong style, in red}}, use {{tlx|!xt}} (or {{tlx|!bxt}}) and {{tlx|!xt2}}, respectively. | For examples of {{!xt|bad/wrong style, in red}}, use {{tlx|!xt}} (or {{tlx|!bxt}}) and {{tlx|!xt2}}, respectively. | ||
The {{tlx|xtd}} template exists for {{xtg|deprecated}} | The {{tlx|xtd}} template exists for {{xtg|deprecated}} examples. It's alias {{tlx|xtg}} (for "grey") can be used to indicate uncertain, unavailable, disabled, lorem, etc., examples without imply [[deprecation]]. The bold, sans-serif equivalent is {{tlx|bxtd}} (and {{tlx|bxtg}} alias). | ||
As with all templates, when the text, given as the template parameter, has any equals characters ("="), | As with all templates, when the text, given as the template parameter, has any equals characters ("="), |
Revision as of 09:07, 6 February 2012
This is a documentation subpage for Template:xt, Template:bxt, Template:xtd, Template:bxtd, Template:!xt and Template:!bxt. 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") to change the given text to the serif typeface, and green text, in order to format examples of style, especially when using quotation marks or italics could be confusing. 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. For style examples that break to their own line (e.g. paragraphs), use {{xt2}}
.
For examples of bad/wrong style, in red, use {{!xt}}
(or {{!bxt}}
) and {{!xt2}}
, respectively.
The {{xtd}}
template exists for deprecated examples. It's alias {{xtg}}
(for "grey") can be used to indicate uncertain, unavailable, disabled, lorem, etc., examples without imply deprecation. The bold, sans-serif equivalent is {{bxtd}}
(and {{bxtg}}
alias).
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 typestyle, (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