View source for Template:Xt/doc

<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{lowercase title}}
{{Documentation subpage|[[Template:xt]], [[Template:bxt]], [[Template:mxt]], [[Template:xtd]], [[Template:bxtd]], [[Template:!xt]], [[Template:!xts]], [[Template:!bxt]], and [[Template:!mxt]]}}
{{distinguish|Category:Text color templates}}
{{High-use}}

This and related templates produce an inline typeface change suitable to render e'''<u>X</u>'''ample '''<u>T</u>'''ext on [[Help:Contents|Wikipedia's help pages]].

==Using example-formatting templates in general==
{{mbox
| type  = content
| text  = '''Not for use in article space''': This family of templates cannot be used in [[Wikipedia:Mainspace|mainspace]] (the article [[Wikipedia:Namespace|namespace]]).
}}
{{lua|Module:TEMPLATENAME|noprotcat=yes}}
The [[:Category:Example-formatting templates|category of example-formatting templates]] is used frequently in non-[[Wikipedia:Mainspace|mainspace]] general [[Help:Contents|help pages]] such as [[Wikipedia:Manual of Style|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 {{tlx|bxt}}, which substitutes boldfacing, or {{tlx|mxt}}, which substitutes a monospaced font. For style examples that break to their own line (e.g. paragraphs), use {{tlx|xt2}}.  

For examples of {{!xt|bad/wrong style, in red}}, use {{tlx|!xt}}, {{tlx|!bxt}}, {{tlx|!mxt}}, or {{tlx|!xt2}}, respectively to the previous paragraph (the addition of the <code>[[Negation#Programming language and ordinary language|!]]</code> indicates the opposite effect). Use {{tlx|!xts}} for bad/wrong style {{!xts|with strikethrough formatting}}.

The {{tlx|xtd}} template exists for {{xtg|deprecated}} examples. Its alias {{tlx|xtg}} (for "grey") can be used to indicate uncertain, unavailable, disabled, lorem, etc., examples without implying [[deprecation]]. The bold, sans-serif equivalent is {{tlx|bxtd}} (and {{tlx|bxtg}} alias). The mono-spaced equivalent is {{tlx|mxtd}}.

The {{tlx|xtn}} template is for {{xtn|neutral}} examples, and has no color change, but is otherwise identical to {{tlx|xt}}. It can be used with {{tnull|xt}} and {{tnull|!xt}} to indicate usage that is neither advised nor advised against or deprecated. The bold, sans-serif equivalent is {{tlx|bxtn}}.

==Parameters==

* {{para||{{var|text here}}}} or {{para|1|{{var|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 {{para|1}} or the template will break.
* {{para|title|{{var|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 {{xt|example text}}) is to make it fully accessible for those with [[color blindness]].

Keep [[WP:Accessibility|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 &#123;&#123;[[Template:xt|xt]]&#125;&#125; syntax and result==

;What you write:

:<code><nowiki>...for example, {{xt|1=''T''&nbsp;=&nbsp;293.15&nbsp;K}}, but not {{!xt|1=''m''=5.4kg}}.</nowiki></code>

;What you get:

:...for example, {{xt|1=''T''&nbsp;=&nbsp;293.15&nbsp;K}}, but not {{!xt|1=''m''=5.4kg}}.

{| class=wikitable
!Template class
!Output typeface
|-
|{{tlx|xt}}
|{{xt|inline typeface change}}
|-
|{{tlx|!xt}}
|{{!xt|inline typeface change}}
|-
|<kbd>{{tlx|xtn}}</kbd>
|{{xtn|inline typeface change}}
|-
|<kbd>{{tlx|xtd}}</kbd>
|{{xtd|inline typeface change}}
|-
|<kbd>{{tlx|mxt}}</kbd>
|{{mxt|inline typeface change}}
|-
|<kbd>{{tlx|!mxt}}</kbd>
|{{!mxt|inline typeface change}}
|-
|<kbd>{{tlx|mxtn}}</kbd>
|{{mxtn|inline typeface change}}
|-
|<kbd>{{tlx|mxtd}}</kbd>
|{{mxtd|inline typeface change}}
|-
|<kbd>{{tlx|bxt}}</kbd>
|{{bxt|inline typeface change}}
|-
|<kbd>{{tlx|!bxt}}</kbd>
|{{!bxt|inline typeface change}}
|-
|<kbd>{{tlx|bxtn}}</kbd>
|{{bxtn|inline typeface change}}
|-
|<kbd>{{tlx|bxtd}}</kbd>
|{{bxtd|inline typeface change}}
|}

== User CSS for a monospaced coding font ==
{{collapse top|left=y|title=Change system-default monospace font:}}
{{Mxt/User CSS for a monospaced coding font}}
{{collapse bottom}}

==See also==
{{Xt/see also}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Example-formatting templates]]
[[Category:Text color templates]]

}}</includeonly>