Template:Quote box/doc

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search

Script error: No such module "Message box".

Script error: No such module "Shortcut". Template:High use Template:Uses TemplateStyles {{Quote boxTemplate:\sandbox |width=30em |title=Title |quote=Script error: No such module "lorem ipsum". |author=Author Name |source=source in "Quotes" or Italics as needed}}

This template can be used for block quotations (long quotes set off from the main text). However, this use is only rarely appropriate Template:Em. The Manual of Style guidelines for block quotations recommend formatting block quotations using the Template:Tlx template.

  • 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 provides 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 <poem>...</poem> tags; these preserve line breaks without having to manually insert <br /> markup.

<templatestyles src="Template:Quote_box/styles.css" />

To be or not to be ...

Script error: No such module "Check for unknown parameters".

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 <ref>...</ref> reference citation can be added at the end.
  • |source=: Optional source of the quote ("Quoted" or Italic work title, and other publication data). A <ref>...</ref> 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 |align=center or |align=none 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; specify a percentage, e.g. |fontsize=90%. Use font sizes of 85% or higher, per MOS:SMALLFONT.
  • |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; quote marks do not display in mainspace (articles) per MOS:BLOCKQUOTE.

Source styling These affect the entire |author= and |source= 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

{{Quote box
 |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/examples. 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:

Template:Demo

Floating right:

Template:Demo

Floating left:

Template:Demo

Centered, not floating:

Template:Demo

Fat-quotes

Template:Demo

Alignment of text in box

Template:Demo

Template:Demo

Custom classes

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

The "class=" parameter can be used to 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 |title_bg=none, |border=none, and |bgcolor= 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 |title=&nbsp;. To provide a blank line at the bottom of the letterhead, add <br /><br /> to the end of the |source= parameter (or |author=, if |source= was not used).

Template:Demo

Collapsing text

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

Template:Markup

Note that, although |halign=center, the centering is reset after the Template:Tl, since that template applies its own styling. This can be resolved by using |contentstyle= in Template:Tl with appropriate markup; in this case:

Template:Tlx

Template:Markup

TemplateData

Template:TemplateData header

Put a quote, and its source, inside a box, with flexible control over bordering, background color, alignment, and other features

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
CSS classclass

Optional CSS class to modify or override the default class ''quotebox''. Care should be used when using this parameter. Consider using other templates instead. See the ''Custom classes'' section of this document for more information.

Stringoptional
Titletitle

Optional title to appear at the top of the quote box.

Stringoptional
Quotequote 1 content quotetext text

The quote or text to be displayed in the box.

Contentrequired
Authorauthor 2

The author to whom the quote is attributed

Lineoptional
Sourcesource 3

Optional source of the quote (author, publication, etc.). Set off from author with a comma.

Stringoptional
Alignmentalign

Alignment of the quote box on the page—left / right / center / none. Defaults to right alignment. Using align=none will remove word wrapping.

Suggested values
left center right none
Stringoptional
Widthwidth

The width of the quote box. Defaults to the width of the quote included, unless align=center where the width will default to 100%. Use CSS lengths eg. 50% or 400px

Stringoptional
Border widthborder

The width of the quote box border. Defaults to 1px. Remember to include 'px' or 'em' to specify the correct width.

Stringoptional
Font sizefontsize

The fontsize of the quote box text. Defaults to 88%.

Stringoptional
Background colorbgcolor

The RGB background color of the box. Defaults to #F9F9F9 (light gray).

Stringoptional
CSS stylestyle

A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding parameters.

Stringoptional
Title background colortitle_bg

The RGB background color of the title. Defaults to #F9F9F9 (light gray).

Stringoptional
Title font colortitle_fnt

The title font color. Defaults to black.

Stringoptional
Title CSS styletstyle

A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding title parameters.

Stringoptional
Quote alignmentqalign halign

Alignment of the quote element—left / right / center. Defaults to left.

Suggested values
left center right
Stringoptional
Quote CSS styleqstyle

A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding quote parameters.

Stringoptional
Add quotes?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, and read the Manual of Style.

Stringoptional
Source alignmentsalign

Alignment of the source element—left / right / center. Defaults to the value of qalign.

Suggested values
left center right
Stringoptional
Source CSS stylesstyle

A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding source parameters.

Stringoptional
Title CSS classtclass

Advanced: additional classes to apply to the title element

Stringoptional
Quote CSS classqclass

Advanced: additional classes to apply to the quote's element

Unknownoptional

Tracking category

Script error: No such module "Navbox".