Difference between revisions of "Template:QuoteBox/doc"

From WikiCorporates
Jump to navigation Jump to search
m (Full syntax)
m (Fat-quotes)
Line 174: Line 174:
 
  |quoted = 1
 
  |quoted = 1
 
}}
 
}}
 
{{-}}
 
  
 
==== Alignment of text in box====
 
==== Alignment of text in box====

Revision as of 22:22, 23 March 2018

This template can be used for block quotations (long quotes set off from the main text). However, this use is not advised in articles. The Manual of Style guidelines for block quotations recommend formatting block quotations using the Template:tlx template or the HTML <blockquote> element, for which that template provides a wrapper.

  • Quotes work best when used with short sentences, and at the start or end of a section, as a hint of or to help emphasize the section's content.
  • For typical quotes, especially those longer than the rest of the paragraph in which they are quoted, Template:tlx provides a borderless quote with decorative quotation marks, and Template:tlx provided a bordered quote. Both span the article width. (However, do not use Template:tlx for block quotations in articles.)
  • For very short quotes, Template:tlx (with decorative quotation marks) or Template:tlx (framed) can be used to set the quote off to either the right or left as in a magazine sidebar. This can be effective on essay pages and WikiProject homepages.

Usage

For actual quotes, and poems, this template (a variant of Template:tlx) can be used to present a title, quote, author, and source in a box such as that shown opposite, with options to customise its bordering, background, alignment and other aspects. The box itself is floating div, which, like images, can appear on the right or left or across the entire page. Article text will wrap around the div in the first two cases. This is useful in articles that are short on images and need some graphic-like element, or where an important or interesting quote wants to be presented in a way that sets it off from the surrounding text.

Caution: This is a div-based template, so it may malfunction if indented using wikitext syntax. This is a current limitation of the Wikipedia HTML parsing software.

When used with a poem, it is convenient to wrap the poem's content in Template:tag tags; these preserve line breaks without having to manually insert Template:tag markup.

To be or not to be ...

Parameters

Basic parameters

  • title = Optional title to appear at the top of the quote box.
  • quote = The quote or other text to be displayed in the box.
  • author = Optional name of the author. A Template:tag reference citation can be added at the end.
  • source = Optional source of the quote ("Quoted" or Italic work title, and other publication data). A Template:tag reference citation can be added at the end.

Main box styling

  • align: Alignment of the quote box on the page—left / right / center / none. Defaults to right alignment. Using align=none will remove word wrapping.
  • width: The width of the quote box. Defaults to the width of the quote included, unless Template:para where the width will default to 100%.
  • border: The width of the quote box border. Defaults to 1px. Remember to include 'px' or 'em' to specify the correct width.
  • fontsize: The fontsize of the quote box text. Defaults to 88%.
  • bgcolor: The RGB background color of the box. Defaults to #F9F9F9 (light gray).
  • style: A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding parameters.

Title styling

  • title_bg: The RGB background color of the title. Defaults to #F9F9F9 (light gray).
  • title_fnt: The title font color. Defaults to black.
  • tstyle: A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding title parameters.

Quote styling

  • qalign: Alignment of the quote element—left / right / center. Defaults to left.
  • qstyle: A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding quote parameters.
  • quoted: If this parameter evaluates to true (is not 0, false, or empty) the quote box will enclose the quote in fat-quotes. Use judiciously, per MOS:QUOTEWikipedia-W.svg.

Source styling These affect the entire Template:para and Template:para block, below the quotation.

  • salign: Alignment of the source element—left / right / center. Defaults to the value of qalign.
  • sstyle: A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding source parameters.

Full syntax

{{QuoteBox
 |class = <!-- Advanced users only.  See the "Custom classes" section below. -->
 |title = 
 |quote = 
 |author = 
 |source = 
 |align = 
 |width = 
 |border = 
 |fontsize = 
 |bgcolor = 
 |style = 
 |title_bg = 
 |title_fnt = 
 |tstyle = 
 |qalign = 
 |qstyle = 
 |quoted = 
 |salign = 
 |sstyle = 
}}

Examples

Various example codes and their results. For more intricate examples see Template:Quote box/examplesWikipedia-W.svg. In the examples the Template:tl template merely generates several lines of sample text without meaning, and is not part of the quote syntax.

Floating and wrapping

Minimal code, defaults to floating right and minimal width:

{{QuoteBox
 |quote  = Cry "Havoc", and let slip the dogs of war.
 |author = [[William Shakespeare]]
 |source = ''[[Julius Caesar (play)|Julius Caesar]]'', Act III, Scene I.
}}
{{Lorem ipsum}}
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Floating right:

{{QuoteBox
 |quote  = Cry "Havoc", and let slip the dogs of war.
 |author = [[William Shakespeare]]
 |source = ''[[Julius Caesar (play)|Julius Caesar]]'', Act III, Scene I.
 |width  = 50%
 |align  = right
}}
{{Lorem ipsum}}
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Floating left:

{{QuoteBox
 |quote  = Cry "Havoc", and let slip the dogs of war.
 |author = [[William Shakespeare]]
 |source = ''[[Julius Caesar (play)|Julius Caesar]]'', Act III, Scene I.
 |width  = 50%
 |align  = left
}}
{{Lorem ipsum}}
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Centered, not floating:

{{QuoteBox
 |quote  = Cry "Havoc", and let slip the dogs of war.
 |author = [[William Shakespeare]]
 |source = ''[[Julius Caesar (play)|Julius Caesar]]'', Act III, Scene I.
 |width  = 50%
 |align  = center
}}
{{Lorem ipsum}}
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Template:-

Fat-quotes

{{QuoteBox
 |quote  = Cry "Havoc", and let slip the dogs of war.
 |author = [[William Shakespeare]]
 |source = ''[[Julius Caesar (play)|Julius Caesar]]'', Act III, Scene I.
 |quoted = 1
}}
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

Alignment of text in box

<source lang="moin">

Centered quote
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

</source>

Centered quote
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

Template:-

<source lang="moin">

Left title, right quote
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

</source>

Left title, right quote
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

Template:-

Custom classes

This parameter should only be used by editors who fully understand how this template works.

The "class=" parameter can be used add a generic CSS class to this template. Some classes are not compatible with other options or require specific options be set to be useful or look good.

Letterhead custom class

The "letterhead" class should be used with Template:para, Template:para, and Template:para either not used or set to "none". Since the upper-left-corner will have a white background, it should only be used on pages with a white background.

Care should be taken that neither the title nor the text extends into the "left corner" portion of the box. To use a blank line for a title, use Template:para. To provide a blank line at the bottom of the letterhead, add <br /><br /> to the end of the Template:para parameter (or Template:para, if Template:para was not used).

<source lang="moin">

 
{{#invoke:Error|error|Error: No text given for quotation (or equals sign used in the actual argument to an unnamed parameter)|tag=}}
William Shakespeare, Julius Caesar, Act III, Scene I.

</source>

 
Cry "Havoc", and let slip the dogs of war.
William Shakespeare, Julius Caesar, Act III, Scene I.

Template:clear

Collapsing text

Sections of text can be collapsed by use of Template:tl and Template:tl. Template:markup

Note that, although Template:para, the centering is reset after the Template:tl, since that template applies its own styling. This can be resolved by using Template:para in Template:tl with appropriate markup; in this case:

Template:tlx

Template:markup