Template:Xtn2/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

Usage

Use template {{xtn2}} to format a style example (for example, on the Manual of Style and its subpages) to be displayed on its own line, in black, in a serif font, and indented in block-quotation style. (Use 1= before the argument if it contains equals signs.) For examples to be displayed inline within running text, use {{xtn}}. For good examples, use {{xt2}} (or {{xt}} inline), and for bad/wrong examples, use {{!xt2}} (or {{!xt}} inline).

Examples
What you write
For nested quotations, use double quotes for the outermost level, single quotes for the next inner level, and continue alternating: {{xtn2|The Dalai Lama stated in his book ''The Universe in a Single Atom'': "I am told that one of the greatest of all quantum theorists, Richard Feynman, wrote 'I think I can safely say that nobody understands quantum mechanics', so at least I feel I am in good company."}}
What you get
For nested quotations, use double quotes for the outermost level, single quotes for the next inner level, and continue alternating:

The Dalai Lama stated in his book The Universe in a Single Atom: "I am told that one of the greatest of all quantum theorists, Richard Feynman, wrote 'I think I can safely say that nobody understands quantum mechanics', so at least I feel I am in good company."

For blocks of code, such as template code, use {{xtn2|1=<code>code here</code>}}.

The parameter |title= 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 block of text.

See also

  • {{xt}} inline positive example text, in green, with serif font
  • {{xt2}} same as {{xt}} but for blocks of text
  • {{bxt}} same as {{xt}} but uses bold instead of serif font
  • {{mxt}} same as {{xt}} but uses mono-spaced font (especially useful in source code)
     
  • {{!xt}} inline negative 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 uses boldface
  • {{!mxt}} same as {{!xt}} but uses mono-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 also strikes through the text
  • {{dcr}} inline strongly deprecated or deleted material; {{dc2}} variant has strikethrough (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}} inline deprecated (or uncertain, unavailable, lorem, etc.) example text, in grey
  • {{bxtd}} same as {{xtd}} but uses boldface
  • {{mxtd}} same as {{xtd}} but uses mono-spaced font
  • {{dc}} inline deprecated 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}} inline neutral 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 uses boldface; it still applies a CSS class, so it's not simply boldfacing
  • {{mxtn}} same as {{xtn}} but uses mono-spaced font; this is a good template to use when the shaded box formatting of <code>...</code> might be undesirable, or the semantics 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.