Movatterモバイル変換

[0]ホーム
URL:

Jump to content
WikipediaThe Free Encyclopedia
Search

Template:xt

Permanently protected template
From Wikipedia, the free encyclopedia

Example text

Template documentation[view] [edit] [history] [purge]
Not to be confused withCategory:Text color templates.
WarningThis template is used onapproximately 38,000 pages and changes may be widely noticed. Test changes in the template's/sandbox or/testcases subpages, or in your ownuser subpage. Consider discussing changes on thetalk page before implementing them.

{{xt}} and related templates produce an inline typeface change suitable to renderexampletext onWikipedia's help pages.

Using example-formatting templates in general

Not for use in article space: This family of templates cannot be used inmainspace (the articlenamespace).
This template usesLua:

Thecategory of example-formatting templates is used frequently in non-mainspace generalhelp pages such asWikipedia:Manual of Style (MOS) wheninline typeface changes are needed.

{{xt}} changes the typeface to serif and the text color to green.Example

For cases where the serif typeface is not desirable (e.g. in blocks of computer code), use{{bxt}}, which substitutesboldfacing, or{{mxt}}, which substitutes amonospaced font. For style examples that break to their own line (e.g. paragraphs), use{{xt2}}.

For examples ofbad/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 stylewith strikethrough formatting.

The{{xtd}} template exists fordeprecated examples. Its alias{{xtg}} (for "grey") can be used to indicateuncertain, unavailable, disabled, lorem, etc., examples without implyingdeprecation. Thebold, sans-serif equivalent is{{bxtd}} (and{{bxtg}} alias). Themono-spaced equivalent is{{mxtd}}.

The{{xtn}} template is forneutral examples, and has no color change, but is otherwise identical to{{xt}} in that it changes to serif typeface. It can be used with{{xt}} and{{!xt}} to indicate usage that is neither advised nor advised against or deprecated. Thebold, sans-serif equivalent is{{bxtn}}. Themono-spaced equivalent is{{mxtn}}.

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 inexample text) is to make it fully accessible for those withcolor blindness.

Keepaccessibility 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 notm=5.4kg.
Template classOutput typeface
{{xt}}inline typeface change
{{!xt}}inline typeface change
{{xtn}}inline typeface change
{{xtd}}inline typeface change
{{mxt}}inline typeface change
{{!mxt}}inline typeface change
{{mxtn}}inline typeface change
{{mxtd}}inline typeface change
{{bxt}}inline typeface change
{{!bxt}}inline typeface change
{{bxtn}}inline typeface change
{{bxtd}}inline typeface change

User CSS for a monospaced coding font

Change system-default monospace font:

To consistently use amonospaced font with well-designed characters for coding so as to clearly distinguish betweenl,1, andI, and betweenO and0, and between-,−,–, and—, the system-default monospaced font can be changed:

If you like it as-is, you can simply@import (transclude) it: seemeta:User:SMcCandlish/codefont.css for quick instructions.

Otherwise, copy one of the code snippets below to yourSpecial:MyPage/common.css ormeta:Special:MyPage/global.css page, replacing"Roboto Mono" in the code with your preferred coding font. (Roboto Mono was used in this example as it is good, free coding font, for user-editable material on the wiki).

This code will:

  • Apply a consistent monospace font of choice to all the normally monospaced HTML elements like<code>,<pre>, etc.
  • Fallback to system-defaultmonospace font, should the chosen font be unavailable or lack the necessary characters.
  • Do the same for the output of allExample-formatting templates, such as{{mxt}} and{{xt}}.
  • Apply to additional site-wide classes identified so far (e.g.,.monospaced) that output as monospace.
  • Make the three most frequently encountered editing fields also use this font stack: the main editing window, the edit summary line, and the search entry box.
  • If any additionalclasses are known that should be added, please update this page or mention it onthe talk page.

Horizontal style

/* Use my font, when available, for code */code,pre,samp,kbd,tt,.example-mono,.userlinks-username,.monospaced,.keyboard-key,.button,.plaincode{font-family:"Roboto Mono",monospace!important;}/*  Make some of the editable stuff monospaced */#wpTextbox1,#wpSummary,#searchInput,#searchText{font-family:"Roboto Mono",monospace!important;}

Vertical style

/* Use my font, when available, for code */code,pre,samp,kbd,tt,.example-mono,.userlinks-username,.monospaced,.keyboard-key,.button.plaincode{font-family:"Roboto Mono",monospace!important;}/*  Make some of the editable stuff monospaced */#wpTextbox1,#wpSummary,#searchInput,#searchText{font-family:"Roboto Mono",monospace!important;}

Cleanup efforts

If you'd like to help clean up instances of the<tt>...</tt> element – which has been discouraged since the 1990s, and should usually be replaced with<code>...</code> (this may vary by context) – you can add something like the following to yourcommon.css to make<tt> stick out like a sore thumb:

/* Flag bad code for cleanup */tt{color:DarkRed;background:Pink;}

You can also do this with<font>,<center>,<strike>, and otherdeprecated elements. For CSS you can just import for this, seemeta:User:SMcCandlish/lint.css.

See also

  • {{xt}} inlinepositive example text, in green, with serif font
  • {{xt2}} same as{{xt}} but for blocks of text
  • {{bxt}} same as{{xt}} but usesbold instead of serif font
  • {{mxt}} same as{{xt}} but usesmono-spaced font (especially useful in source code)
     
  • {{!xt}} inlinenegative example text, in red, with serif font
  • {{!xt2}} same as{{!xt}} but for blocks (i.e., same as{{xt2}} but red)
  • {{!bxt}} same as{{!xt}} but usesboldface
  • {{!mxt}} same as{{!xt}} but usesmono-spaced font; used for incorrect or strongly deprecated code/output/input examples and should usually be wrapped in<code>,<samp>, or<kbd> as appropriate; see also{{dc}} and its variants below
  • {{!xts}} same as{{!xt}} but alsostrikes through the text
  • {{dcr}} inlinestrongly deprecated or deleted material;{{dc2}} variant hasstrikethrough (they both use the<del> element, and do not add monospace font on their own; can be used in mainspace (articles), and where necessary wrapped in<code>,<samp>, or<kbd>); see also{{dc}} below
     
  • {{xtd}} inlinedeprecated (or uncertain, unavailable, lorem, etc.) example text, in grey
  • {{bxtd}} same as{{xtd}} but usesboldface
  • {{mxtd}} same as{{xtd}} but usesmono-spaced font
  • {{dc}} inlinedeprecated or deleted material; (uses the<del> element, and does not add monospace font on it own; can be used in mainspace (articles), and where necessary wrapped in<code>,<samp>, or<kbd>); see also{{dcr}} above
     
  • {{xtn}} inlineneutral example text, with no color change, when none of the above applies; used for "permissible" examples neither favored nor deprecated
  • {{xtn2}} same as{{xtn}} but for blocks of text
  • {{bxtn}} same as{{xtn}} but usesboldface; it still applies a CSS class, so it's not simply boldfacing
  • {{mxtn}} same as{{xtn}} but usesmono-spaced font; this is a good template to use when the shaded box formatting of<code>...</code> might be undesirable, or thesemantics of it is incorrect in the context
     
  • {{strongbad}} – for introducing something as deprecated or issuing some other warning in documentation, e.g.:Not for use in mainspace.
The abovedocumentation istranscluded fromTemplate:Xt/doc.(edit |history)
Editors can experiment in this template'ssandbox(edit |diff) andtestcases(edit) pages.
Add categories to the/doc subpage.Subpages of this template.
Retrieved from "https://en.wikipedia.org/w/index.php?title=Template:Xt&oldid=1318919411"
Categories:
Hidden categories:
[8]ページ先頭
©2009-2026 Movatter.jp