Template:Cquote/doc

From testwiki
Jump to navigation Jump to search

Template:Documentation subpageTemplate:TOC right Template:High use Template:Blockquote/doc/boilerplate

Usage

Centered quote – For quotes, this template provides a centered, borderless quote, with scalable decorative quotation marks, and optional attribution of the source of the quote. It can be used with or without the names of the parameters.

Syntax

Parameters

Parameter 1, quote
text of the quote; use Template:Tag around second or subsequent paragraphs.
Required
Template:A note if the quote text contains a = (equals sign), then the template must be called with a named parameter for the content. For example: Template:Tlx Template:Crossreference.
author
Name of the person that wrote or spoke the text being quoted. Can include wiki syntax.
source
Source of the quote (publication title, speech, etc.). Can include wiki syntax. Can be used without Template:Para (e.g. for a scripture, law, or other source without an author per se)
bgcolor
The color of the background. This parameter is disabled in article space.
float
Defaults to center, but can also be right or left. Usually used with Template:Para or so (otherwise for quotes longer than one line on the rendered page, the float will have no useful effect). This parameter is disabled in article space.
width
for example Template:Para. This parameter is disabled in article space.
qcolor
color of quotemarks, for example Template:Para for a red color (only for use in WP:Signpost, and personal pages; do not use in articles, guidelines, etc.). This parameter is disabled in article space.
rtl
set to any non-blank value for quotes that should be rendered from right to left (e.g., Arabic). Adds the necessary dir attribute and reverses the quotes. This parameter is disabled in article space.
quotealign
set to center to center align the quote text. This parameter is disabled in article space.

Deprecated:

wide
In older versions of the template, when this was set to "yes", the quote expanded to the entire width of the page, which was useful for long quotes. However, it clashed with other floating objects, such as infoboxes, and the template now auto expands and line wraps as needed (full page, or within a Template:Para constraint). This parameter is disabled in article space.

Simple example

{{Cquote|quote text}}

Template:Cquote

Sourced example

{{Cquote|Life is like riding a bicycle. To keep your balance you must keep moving.
|author=[[Albert Einstein]]
|source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref>
}}

Template:Cquote

Template:Reflist

Other examples

{{Cquote|1=F=ma|author=[[Isaac Newton]]}}

(the 1= is necessary as quote text contains an equals sign) Template:Cquote


{{Cquote|1=Thus:
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}

(quote text contains an equals sign and math syntax) Template:Cquote


{{Cquote|Congress shall make no law respecting an establishment of religion, or prohibiting the free exercise thereof; or abridging the freedom of speech, or of the press; or the right of the people peaceably to assemble, and to petition the Government for a redress of grievances.|source=First Amendment to the Constitution of the United States |float=right |width=30%}}

(source with no author; floated right and width-constrained) Template:Cquote Note that it will wrap around article text like this.Template:Lorem ipsumTemplate:Clear


{{Cquote|Congress shall make no law respecting an establishment of religion, or prohibiting the free exercise thereof; or abridging the freedom of speech, or of the press; or the right of the people peaceably to assemble, and to petition the Government for a redress of grievances.|source=First Amendment to the Constitution of the United States |width=50%}}

(same quote, no float, width constraint) Template:Cquote


{{Cquote|Congress shall make no law respecting an establishment of religion, or prohibiting the free exercise thereof; or abridging the freedom of speech, or of the press; or the right of the people peaceably to assemble, and to petition the Government for a redress of grievances.|source=First Amendment to the Constitution of the United States}}

(same quote, no float, no width setting – for short quote, would use as much of line as necessary, and for longer quotes, full width of page, wrapping for multiple lines.) Template:Cquote

TemplateData

Template:TemplateData header <templatedata> { "params": { "2": {}, "3": { "deprecated": true }, "4": { "deprecated": true }, "5": { "deprecated": true }, "float": { "label": "Float", "description": "Position the quote to float on the right or left side of the content", "example": "left", "type": "string" }, "bgcolor": { "label": "Background color", "description": "The background color for the quote", "type": "string", "default": "transparent" }, "wide": { "label": "Full width", "description": "In older versions of the template, when this was set to \"yes\", the quote expanded to the entire width of the page, which was useful for long quotes. However, it clashed with other floating objects, such as infoboxes, and the template now auto expands and line wraps as needed (full page, or within a |width= constraint).", "type": "boolean", "deprecated": "Replace it with width=100%" }, "width": { "label": "Width", "description": "The width of the quote", "example": "30%", "type": "string", "default": "Sized to fit content (auto)", "autovalue": "" }, "qcolor": { "label": "Quotation mark color", "description": "Color of quotemarks (only for use in WP:Signpost, and personal pages; do not use in articles, guidelines, etc.)", "example": "#FF0000 for a red color", "default": "#B2B7F2" }, "small": { "deprecated": "This is an option of a template that was merged into this one. You can remove it." }, "quote": { "aliases": [ "1", "quotetext", "text", "content" ], "label": "Quote", "description": "The quote to be visually repeated", "type": "content", "required": true }, "author": { "aliases": [ "personquoted" ], "label": "Author", "description": "Name of the person that wrote or spoke the text being quoted", "example": "Albert Einstein", "type": "content", "suggested": true }, "personquoted": { "deprecated": "This is an option of a template that was merged into this one. You can replace it with 'author'." }, "source": { "aliases": [ "publication", "title", "quotesource" ], "label": "Source", "description": "Source of the quote (publication title, speech, etc.). Can include wiki syntax. Can be used without |author= (e.g. for a scripture, law, or other source without an author per se)", "example": "in a letter to his son[1]", "type": "content", "suggested": true }, "publication": { "deprecated": "This is an option of a template that was merged into this one. You can replace it with 'source'" }, "title": { "deprecated": true }, "quotesource": { "deprecated": "This is an option of a template that was merged into this one. You can replace it with 'source'." }, "rtl": { "label": "Direction", "description": "Sets scrript direction right-to-left (Arabic, Hebrew)", "example": "rtl=yes" } },

"description": "This template is intended for quotes. Usually this is not appropriate for encyclopedia articles. The Manual of Style guidelines for block quotations recommend formatting block quotations using the Template:Quote template or the HTML

element.",

"paramOrder": [ "quote", "author", "source", "width", "float", "bgcolor", "qcolor", "wide", "small", "personquoted", "publication", "title", "quotesource", "2", "3", "4", "5", "rtl" ], "format": "block" } </templatedata>

Template:Quotation templates


  1. Walter Isaacson, Einstein: His Life and Universe (2007), p. 367.