Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:!xt/doc: Difference between revisions

Template page
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{wikipedia|page name}}
{{wikipedia|page name}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
<!-- 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}}
{{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]].
This and related templates produce an inline typeface change suitable to render e'''<u>X</u>'''ample '''<u>T</u>'''ext on Wikipedia's help pages.


==Using example-formatting templates in general==
==Using example-formatting templates in general==
{{mbox
{{mbox
| type  = content
| 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]]).
| text  = '''Not for use in article space''': This family of templates cannot be used in mainspace (the article namespace).
}}
}}
{{lua|Module:TEMPLATENAME|noprotcat=yes}}
{{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.  
The category of example-formatting templates is used frequently in non-mainspace general help pages such as Wikipedia:Manual of Style (MOS) when ''inline'' typeface changes are needed.  


{{code|{{((}}xt{{))}}}} changes the typeface to serif and the text color to green.
{{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 cases where the serif typeface is not desirable (e.g. in blocks of computer code), use , which substitutes boldfacing, or , which substitutes a monospaced font. For style examples that break to their own line (e.g. paragraphs), use .   


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}}.
For examples of , use , , , or , respectively to the previous paragraph (the addition of the <code>!</code> indicates the opposite effect). Use for bad/wrong style .


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 template exists for examples. Its alias (for "grey") can be used to indicate uncertain, unavailable, disabled, lorem, etc., examples without implying deprecation. The bold, sans-serif equivalent is (and 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}}.
The template is for examples, and has no color change, but is otherwise identical to {{tlx|xt}}. It can be used with {{tnull|xt}} and to indicate usage that is neither advised nor advised against or deprecated. The bold, sans-serif equivalent is .


==Parameters==
==Parameters==
Line 32: Line 29:


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


;What you write:
;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>
:<code><nowiki>...for example, {{xt|1=''T''&nbsp;=&nbsp;293.15&nbsp;K}}, but not .</nowiki></code>


;What you get:
;What you get:


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


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


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


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


<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||

Latest revision as of 17:28, 9 April 2025

This page uses Creative Commons Licensed content from Wikipedia (view authors).

This and related templates produce an inline typeface change suitable to render eXample Text on Wikipedia'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 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 , which substitutes boldfacing, or , which substitutes a monospaced font. For style examples that break to their own line (e.g. paragraphs), use .

For examples of , use , , , or , respectively to the previous paragraph (the addition of the ! indicates the opposite effect). Use for bad/wrong style .

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

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

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 .
What you get
...for example, T = 293.15 K, but not .
Template class Output typeface
{{xt}} inline typeface change
{{mxtd}} Template:Mxtd

User CSS for a monospaced coding font

Change system-default monospace font: