Template:Quote box/doc

This template can be used for block quotations (long quotes set off from the main text). However, this use is not advised. The Manual of Style guidelines for block quotations recommend formatting block quotations using the template or the HTML &lt;blockquote&gt; 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, provides a borderless quote with decorative quotation marks, and  provided a bordered quote. Both span the article width. (However, do not use  for block quotations in articles.)
 * For very short quotes, (with decorative quotation marks) or  (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 ) 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  tags; these preserve line breaks without having to manually insert markup.

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  reference citation can be added at the end.
 * source — Optional source of the quote ("Quoted" or Italic work title, and other publication data). A  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 center 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; 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.

Examples
Various example codes and their results. For more intricate examples see Template:Quote_box/examples. In the examples the lorem ipsum 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:

Floating right:

Floating left:

Centered, not floating:

Custom classes
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.
 * This parameter should only be used by editors who fully understand how this template works.

Letterhead custom class
The "letterhead" class should be used with none, 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 &amp;nbsp;. To provide a blank line at the bottom of the letterhead, add

to the end of the source parameter (or author, if source was not used).

Collapsing text
Sections of text can be collapsed by use of hidden begin and hidden end.

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

TemplateData
{	"description": "Put a quote, and its source, inside a box, with flexible control over bordering, background color, alignment, and other features", "params": { "class": { "label": "CSS class", "description": "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.", "type": "string", "required": false },		"title": { "label": "Title", "description": "Optional title to appear at the top of the quote box.", "type": "string", "required": false },		"quote": { "label": "Quote", "description": "The quote or text to be displayed in the box.", "type": "string", "required": true, "aliases": [ "1",				"content", "quotetext", "text" ]		},		"source": { "label": "Source", "description": "Optional source of the quote (author, publication, etc.). Set off from author with a comma.", "type": "string", "required": false, "aliases": [ "3"			]		},		"align": { "label": "Alignment", "description": "Alignment of the quote box on the page—left / right / center / none. Defaults to right alignment. Using align=none will remove word wrapping.", "type": "string", "required": false },		"width": { "label": "Width", "description": "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", "type": "string", "required": false },		"border": { "label": "Border width", "description": "The width of the quote box border. Defaults to 1px. Remember to include 'px' or 'em' to specify the correct width.", "type": "string", "required": false },		"fontsize": { "label": "Font size", "description": "The fontsize of the quote box text. Defaults to 88%.", "type": "string", "required": false },		"bgcolor": { "label": "Background color", "description": "The RGB background color of the box. Defaults to #F9F9F9 (light gray).", "type": "string", "required": false },		"style": { "label": "CSS style", "description": "A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding parameters.", "type": "string", "required": false },		"title_bg": { "label": "TItle background color", "description": "The RGB background color of the title. Defaults to #F9F9F9 (light gray).", "type": "string", "required": false },		"title_fnt": { "label": "Title font color", "description": "The title font color. Defaults to black.", "type": "string", "required": false },		"tstyle": { "label": "Title CSS style", "description": "A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding title parameters.", "type": "string", "required": false },		"qalign": { "label": "Quote alignment", "description": "Alignment of the quote element—left / right / center. Defaults to left.", "type": "string", "required": false, "aliases": [ "halign" ]		},		"qstyle": { "label": "Quote CSS style", "description": "A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding quote parameters.", "type": "string", "required": false },		"quoted": { "label": "Add quotes?", "description": "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.", "type": "string", "required": false },		"salign": { "label": "Source alignment", "description": "Alignment of the source element—left / right / center. Defaults to the value of qalign.", "type": "string", "required": false },		"sstyle": { "label": "Source CSS style", "description": "A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding source parameters.", "type": "string", "required": false },		"tclass": { "label": "Title CSS class", "description": "Advanced: additional classes to apply to the title element", "type": "string" },		"qclass": { "label": "Quote CSS class", "description": "Advanced: additional classes to apply to the quote's element" },		"author": { "aliases": [ "2"			],			"label": "Author", "description": "The author to whom the quote is attributed", "type": "line" }	},	"format": "block", "paramOrder": [ "class", "title", "quote", "author", "source", "align", "width", "border", "fontsize", "bgcolor", "style", "title_bg", "title_fnt", "tstyle", "qalign", "qstyle", "quoted", "salign", "sstyle", "tclass", "qclass" ] }