模板:xt/doc

来自决策链云智库
< 模板:xt模板:Xt/doc /
Zeroclanzhang讨论 | 贡献2024年1月16日 (二) 22:59的版本 (创建页面,内容为“<!--PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE--> {{lowercase title}} {{Documentation subpage|Template:xt, Template:bxt, Template:mxt, Template:xtd, Template:bxtd, Template:!xt, Template:!xts, Template:!bxt, and Template:!mxt}} {{High-use}} {{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…”)
(差异) ←上一版本 | 最后版本 (差异) | 下一版本→ (差异)


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

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).


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 bad/wrong style, in red, use {{!xt}}, {{!bxt}}, {{!mxt}}, or {{!xt2}}, respectively to the previous paragraph (the addition of the ! indicates the opposite effect). Use {{!xts}} for bad/wrong style 模板:!xts.

The {{xtd}} template exists for deprecated 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 neutral 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 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 {{!xt|1=''m''=5.4kg}}.
What you get
...for example, T = 293.15 K, but not m=5.4kg.
What you type What you get
this is an {{xt|inline typeface change}} for comparison this is an inline typeface change for comparison
this is an {{!xt|inline typeface change}} for comparison this is an inline typeface change for comparison
this is an {{xtn|inline typeface change}} for comparison this is an inline typeface change for comparison
this is an {{xtd|inline typeface change}} for comparison this is an inline typeface change for comparison
this is an {{mxt|inline typeface change}} for comparison this is an 模板:Mxt for comparison
this is an {{!mxt|inline typeface change}} for comparison this is an inline typeface change for comparison
this is an {{mxtn|inline typeface change}} for comparison this is an inline typeface change for comparison
this is an {{mxtd|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 inline typeface change for comparison
this is an {{!bxt|inline typeface change}} for comparison this is an inline typeface change for comparison
this is an {{bxtn|inline typeface change}} for comparison this is an inline typeface change for comparison
this is an {{bxtd|inline typeface change}} for comparison this is an inline typeface change for comparison

User CSS for a monospaced coding font

Have monospaced templates in this group – and your editing window – use your preferred monospaced font:

模板:Mxt/User CSS for a monospaced coding font

See also

模板:Xt/see also