Template:Bxt/doc: Difference between revisions
From The Kodiak Republic Wiki
Content added Content deleted
(Created page with "{{#ifeq:{{NAMESPACE}}|{{ns:0}}|{{FormattingError|[[:{{#invoke:TEMPLATENAME|main}}]] is only for examples of style and formatting. Do not use it in actual articles.}}|<span class="example example-bold" style="font-weight: bold; color: #006400;" {{#if:{{{title|}}}|title="{{{title}}}"}}>{{{1|Example text}}}</span>}}<noinclude> {{Documentation|Template:Xt/doc}} </noinclude>") |
No edit summary |
||
| Line 1: | Line 1: | ||
<!--PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE--> |
|||
{{#ifeq:{{NAMESPACE}}|{{ns:0}}|{{FormattingError|[[:{{#invoke:TEMPLATENAME|main}}]] is only for examples of style and formatting. Do not use it in actual articles.}}|<span class="example example-bold" style="font-weight: bold; color: #006400;" {{#if:{{{title|}}}|title="{{{title}}}"}}>{{{1|Example text}}}</span>}}<noinclude> |
|||
{{lowercase title}} |
|||
{{Documentation|Template:Xt/doc}} |
|||
{{Documentation subpage|[[Template:xt]], [[Template:bxt]], [[Template:mxt]], [[Template:xtd]], [[Template:bxtd]], [[Template:!xt]], [[Template:!bxt]], and [[Template:!mxt]]}} |
|||
</noinclude> |
|||
{{distinguish|Category:Text color templates}} |
|||
This and related templates produce an inline typeface change suitable to render e'''X'''ample '''T'''ext on Wikipedia's general help pages. |
|||
==Using example-formatting templates in general== |
|||
{{mbox |
|||
| type = content |
|||
| small = yes |
|||
| text = 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 pages such as [[Wikipedia:Manual of Style|Wikipedia:Manual of Style (MOS)]] when ''inline'' typeface changes are needed. |
|||
{{strong|This family of templates ''cannot'' be used in mainspace (the article [[Wikipedia:Namespace|namespace]]).}} |
|||
{{strong|Also, this family of templates is ''not'' for use as [[Help:Wikitext|wikitext markup]] for [[Wikipedia:Quotations|quotations]] on [[Wikipedia:Talk pages|talk pages]]}}; use {{tlx|tq}} instead. |
|||
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). |
|||
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 {{[[Template:xt|xt]]}} syntax and result== |
|||
;What you write: |
|||
:<code><nowiki>...for example, {{xt|1=''T'' = 293.15 K}}, but not {{!xt|1=''m''=5.4kg}}.</nowiki></code> |
|||
;What you get: |
|||
:...for example, {{xt|1=''T'' = 293.15 K}}, but not {{!xt|1=''m''=5.4kg}}. |
|||
{| class=wikitable |
|||
!What you type |
|||
!What you get |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''xt'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{xt|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''!xt'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{!xt|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''xtn'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{xtn|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''xtd'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{xtd|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''mxt'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{mxt|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''!mxt'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{!mxt|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''mxtn'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{mxtn|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''mxtd'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{mxtd|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''bxt'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{bxt|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''!bxt'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{!bxt|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''bxtn'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{bxtn|inline typeface change}} for comparison |
|||
|- |
|||
|<kbd><nowiki>this is an {{</nowiki>'''bxtd'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd> |
|||
|this is an {{bxtd|inline typeface change}} for comparison |
|||
|} |
|||
== User CSS for a monospaced coding font == |
|||
{{collapse top|left=y|title=Have monospaced templates in this group – and your editing window – use your preferred monospaced font:}} |
|||
{{Mxt/User CSS for a monospaced coding font}} |
|||
{{collapse bottom}} |
|||
==See also== |
|||
{{Xt/see also}} |
|||
<includeonly>{{Sandbox other|| |
|||
<!--CATEGORIES AND INTERWIKIS BELOW THIS LINE PLEASE--> |
|||
[[Category:Example-formatting templates]] |
|||
[[Category:Text color templates]] |
|||
}}</includeonly> |
|||
Latest revision as of 08:28, 12 January 2023
 | This is a documentation subpage for Template:xt, Template:bxt, Template:mxt, Template:xtd, Template:bxtd, Template:!xt, Template:!bxt, and Template:!mxt. It contains usage information, categories and other content that is not part of the original page. |
This and related templates produce an inline typeface change suitable to render eXample Text on Wikipedia's general help pages.
Using example-formatting templates in general
 | This family of templates cannot be used in mainspace (the article namespace). |
 | This template uses Lua: |
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.
This family of templates cannot be used in mainspace (the article namespace).
Also, this family of templates is not for use as wikitext markup for quotations on talk pages; use {{tq}} instead.
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 monospaced font. For style examples that break to their own line (e.g. paragraphs), use {{xt2}}.
For examples of Template:!xt, use {{!xt}}, {{!bxt}}, {{!mxt}}, or {{!xt2}}, respectively to the previous paragraph (the addition of the ! indicates the opposite effect).
The {{xtd}} template exists for Template:Xtg 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 Template:Xtn 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}}.
Parameters
|text hereor|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 Template:Xt) 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 {{!xt|1=''m''=5.4kg}}.
- What you get
- ...for example, Template:Xt, but not Template:!xt.
| What you type | What you get |
|---|---|
| this is an {{xt|inline typeface change}} for comparison | this is an Template:Xt for comparison |
| this is an {{!xt|inline typeface change}} for comparison | this is an Template:!xt for comparison |
| this is an {{xtn|inline typeface change}} for comparison | this is an Template:Xtn for comparison |
| this is an {{xtd|inline typeface change}} for comparison | this is an Template:Xtd for comparison |
| this is an {{mxt|inline typeface change}} for comparison | this is an Template:Mxt for comparison |
| this is an {{!mxt|inline typeface change}} for comparison | this is an Template:!mxt for comparison |
| this is an {{mxtn|inline typeface change}} for comparison | this is an Template:Mxtn for comparison |
| this is an {{mxtd|inline typeface change}} for comparison | this is an Template:Mxtd for comparison |
| this is an {{bxt|inline typeface change}} for comparison | this is an inline typeface change for comparison |
| this is an {{!bxt|inline typeface change}} for comparison | this is an Template:!bxt for comparison |
| this is an {{bxtn|inline typeface change}} for comparison | this is an Template:Bxtn for comparison |
| this is an {{bxtd|inline typeface change}} for comparison | this is an Template:Bxtd for comparison |
User CSS for a monospaced coding font
Have monospaced templates in this group – and your editing window – use your preferred monospaced font:
|
|---|
See also
