Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

Template:Xt/doc: Difference between revisions

Content deleted Content added
No edit summary
Tags: Reverted Mobile edit Mobile web edit
Using example-formatting templates in general: Added an introductory description of what is displayed with the basic {{xt}} template.
 
(15 intermediate revisions by 9 users not shown)
Line 1:
<!-- 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 prefitheprefix cursorthe hoverstext overwith {{para|1}} or the spanktemplate 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==
Line 19 ⟶ 46:
 
{| class=wikitable
!Template class
!What you type
!Output typeface
!What you get
|-
|{{tlx|xt}}
|<kbd><nowiki>this is an {{</nowiki>'''xt'''<nowiki>|inline typeface change}} for comparison</nowiki></kbd>
|this is an {{xt|inline typeface change}} for comparison
|-
|{{tlx|!xt}}
|<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>{{tlx|xtn}}</kbd>
|<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>{{tlx|xtd}}</kbd>
|<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>{{tlx|mxt}}</kbd>
|<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>{{tlx|!mxt}}</kbd>
|<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>{{tlx|mxtn}}</kbd>
|<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>{{tlx|mxtd}}</kbd>
|<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>{{tlx|bxt}}</kbd>
|<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>{{tlx|!bxt}}</kbd>
|<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>{{tlx|bxtn}}</kbd>
|<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>{{tlx|bxtd}}</kbd>
|<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=HaveChange monospacedsystem-default templates in this group – and your editing window – use your preferred monospacedmonospace font:}}
{{Mxt/User CSS for a monospaced coding font}}
{{collapse bottom}}
Line 68 ⟶ 95:
 
<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
<!--CATEGORIES AND INTERWIKIS BELOW THIS LINE PLEASE-->
[[Category:Example-formatting templates]]
[[Category:Text color templates]]