Template:Cquote/doc: Difference between revisions

Latest revision as of 04:23, 3 September 2020

This is a documentation subpage for Template:Cquote.
It may contain usage information, categories and other content that is not part of the original template page.

The Manual of Style guidelines for block quotations recommend formatting block quotations using the {{Quote}} 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, {{Cquote}} (for use outside of article space only) provides a borderless quote with decorative quotation marks, and {{Quote frame}} provides a bordered quote. Both span the page width.
For very short quotes, {{Rquote}} (with decorative quotation marks, for use outside of article space only) or {{Quote box}} (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 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

{{Cquote|quote=text of the quotation|author=person quoted|source=source of the quotation}}

Parameters

Parameter 1, quote: text of the quote; use <p>...</p> around second or subsequent paragraphs.; Required; File:Pictogram voting info.svg Note: if the quote text contains a = (equal sign), then the template must be called with a named parameter for the content. For example: {{Cquote|quote=quote text=more quoted text}}
(see Help:Template § Usage hints and workarounds).
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 |author= (e.g. for a scripture, law, or other source without an author per se)
bgcolor: The color of the background.
float: Defaults to center, but can also be right or left. Usually used with |width=30% or so (otherwise for quotes longer than one line on the rendered page, the float will have no useful effect).
width: for example |width=30%
qcolor: color of quotemarks, for example |qcolor=#FF0000 for a red color (only for use in WP:Signpost, and personal pages; do not use in articles, guidelines, etc.)
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.
quotealign: set to center to center align the quote text.

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 |width= constraint).

Simple example

{{Cquote|quote text}}

“

To be, or not to be ...

”

Sourced example

“

Life is like riding a bicycle. To keep your balance you must keep moving.

”

— Albert Einstein, in a letter to his son^[1]

</syntaxhighlight>

“

Life is like riding a bicycle. To keep your balance you must keep moving.

”

— Albert Einstein, in a letter to his son^[2]

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

Other examples

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

(the 1= is necessary as quote text contains an equal sign)

“

F=ma

”

— Isaac Newton

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

(quote text contains an equal sign and math syntax)

“

Thus:

Script error: No such module "in5".<math>E=mc^2</math>

”

— Albert Einstein

{{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)

“

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.

”

— First Amendment to the Constitution of the United States

Note that it will wrap around article text like this.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.

{{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)

“

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.

”

— First Amendment to the Constitution of the United States

{{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.)

“

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.

”

— First Amendment to the Constitution of the United States

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Cquote

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 {{Quote}} template or the HTML <blockquote> element.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Quote	`quote` `1` `quotetext` `text` `content`	The quote to be visually repeated	Content	required
Author	`author` `personquoted`	Name of the person that wrote or spoke the text being quoted Example [[Albert Einstein]]	Content	suggested
Source	`source` `publication` `title` `quotesource`	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<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref>	Content	suggested
Width	`width`	The width of the quote Default Sized to fit content (auto) Example 30% Auto value	String	optional
Float	`float`	Position the quote to float on the right or left side of the content Example left	String	optional
Background color	`bgcolor`	The background color for the quote Default transparent	String	optional
Quotation mark color	`qcolor`	Color of quotemarks (only for use in WP:Signpost, and personal pages; do not use in articles, guidelines, etc.) Default #B2B7F2 Example #FF0000 for a red color	Unknown	optional
Full width	`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 \|width= constraint).	Boolean	deprecated
small	`small`	no description	Unknown	deprecated
personquoted	`personquoted`	no description	Unknown	deprecated
publication	`publication`	no description	Unknown	deprecated
title	`title`	no description	Unknown	deprecated
quotesource	`quotesource`	no description	Unknown	deprecated
2	`2`	no description	Unknown	optional
3	`3`	no description	Unknown	deprecated
4	`4`	no description	Unknown	deprecated
5	`5`	no description	Unknown	deprecated
Direction	`rtl`	Sets scrript direction right-to-left (Arabic, Hebrew) Example rtl=yes	Unknown	optional

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

[2] Walter Isaacson, Einstein: His Life and Universe (2007), p. 367.

[1]

[2]

Template:Cquote/doc: Difference between revisions

Latest revision as of 04:23, 3 September 2020

Contents

Usage

Syntax

Parameters

Simple example

Sourced example

Other examples

TemplateData

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

In other languages

@@ Line 2: / Line 2: @@
 <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
-==Usage==
+{{Quote/doc/boilerplate}}
-'''{{tl|Centered pull quote}}''' is a template meant for [[pull quote]]s, the visually distinctive ''repetition'' of text that is ''already present'' in the same article.  In most cases, this is not appropriate for use in encyclopedia articles.
-* '''{{red|NOTE: This template should ''not'' be used for quotations}}''' if they are not repeated elsewhere in the main text. The [[Wikipedia:Manual of Style#Block quotations|Manual of Style guidelines for block quotations]] recommend formatting block quotations using the HTML &lt;[[blockquote]]&gt; element (which can be done with the {{tl|bq}} template), or the {{tl|quote}} or {{tl|quote box}} quotation templates.
+== Usage ==
-* Pull quotes work best when used with short sentences, and at the start or end of a section, as a hint of the section's content.
+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.
-* For shorter pull quotes of 50 words or fewer in a similar style, consider using {{tl|Reduced pull quote}} which sets the quote off to either the right or left as in a magazine [[Sidebar (publishing)|sidebar]].  This can be effective on [[WP:ESSAY|essay]] pages and [[WP:WIKIPROJECT|WikiProject]] homepages.
 ===Syntax===
-# <code><nowiki>{{centered pull quote|quote text}}</nowiki></code>
+* {{tlx|{{BASEPAGENAME}}|2=quote={{var|text of the quotation}}|3=author={{var|person quoted}}|4=source={{var|source of the quotation}}}}
-# <code><nowiki>{{centered pull quote|quote text|author=author or speaker}}</nowiki></code>
-# <code><nowiki>{{centered pull quote|quote text|author=author or speaker|source=title of article, speech, book, etc.}}</nowiki></code>
 ===Parameters===
-; Parameter 1: text of the quote; use <code><nowiki><br /></nowiki></code> between paragraphs.
+; Parameter <code>1</code>, <code>quote</code>: text of the quote; use {{tag|p}} around second or subsequent paragraphs.
 : '''''Required'''''
-: '''Note''': if the quote text contains one or more "=" (equal signs), then the template must be called as <nowiki>{{centered pull quote|</nowiki>'''<span style="color:red;">1=</span>'''<nowiki>quote text}}</nowiki> (see [[m:Help:Templates#Equals sign in parameter value|"Equals sign in parameter value"]])
+: {{A note}} if the quote text contains a <code>=</code> (equal sign), then the template must be called with a named parameter for the content. For example: {{tlx|Cquote|{{stronggood|quote{{=}}}}{{var|quote text{{=}}more quoted text}}}} {{Crossreference|1=(see {{section link|Help:Template#Usage hints and workarounds}})}}.
-; author: Name of the person that wrote or spoke the text being quoted. Can include wiki syntax.
+; <code>author</code>: 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.
+; <code>source</code>: Source of the quote (publication title, speech, etc.). Can include wiki syntax. Can be used without {{para|author}} (e.g. for a scripture, law, or other source without an author ''per se'')
-; bgcolor: The color of the background.
+; <code>bgcolor</code>: The color of the background.
-; wide: When set to "yes", the quote expands to the entire width of the page. Useful for small quotes, but may clash with other floating objects, such as infoboxes.
+; <code>float</code>: Defaults to center, but can also be right or left. Usually used with {{para|width|30%}} or so (otherwise for quotes longer than one line on the rendered page, the float will have no useful effect).
+; <code>width</code>: for example {{para|width|30%}}
+; <code>qcolor</code>: color of quotemarks, for example {{para|qcolor|#FF0000}} for a red color (only for use in [[WP:Signpost]], and personal pages; do not use in articles, guidelines, etc.)
+; <code>rtl</code>: 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.
+; <code>quotealign</code>: set to center to center align the quote text.
+'''Deprecated''':
+; <code style="color: DarkRed;">wide</code>: 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 {{para|width}} constraint).
 ===Simple example===
-<pre>{{centered pull quote|quote text}}</pre>
+<pre>{{Cquote|quote text}}</pre>
-{{centered pull quote|To be, or not to be.}}
+{{Cquote|To be, or not to be ...}}
 ===Sourced example===
-<pre>{{
+<syntaxhighlight lang="moin">{{Cquote|Life is like riding a bicycle. To keep your balance you must keep moving.
-centered pull quote|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>
-}}</pre>
+}}</syntaxhighlight>
-{{centered pull quote|Life is like riding a bicycle. To keep your balance you must keep moving.
+{{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>
 }}
-{{Reflist}}
+{{reflist}}
 ===Other examples===
-<pre>{{centered pull quote|1=F=ma|author=[[Isaac Newton]]}}</pre>
+<pre>{{Cquote|1=F=ma|author=[[Isaac Newton]]}}</pre>
 (the ''1='' is necessary as quote text contains an equal sign)
-{{cquote|1=F=ma|author=[[Isaac Newton]]}}
+{{Cquote|1=F=ma|author=[[Isaac Newton]]}}
-<pre>{{centered pull quote|1=Thus:
-:<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre>
+<pre>{{Cquote|1=Thus:
+{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre>
 (quote text contains an equal sign and math syntax)
-{{centered pull quote|1=Thus:
+{{Cquote|1=Thus:
-:<math>E=mc^2</math>|author=[[Albert Einstein]]}}
+{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}
-==See also==
-{{Quotation templates see also}}
-<includeonly>
+<pre>{{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%}}</pre>
-{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+(source with no author; floated right and width-constrained)
-<!-- ADD CATEGORIES BELOW THIS LINE -->
+{{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%}}
-[[Category:Quotation templates]]
+Note that it will wrap around article text like this.{{Lorem ipsum}}{{clear|both}}
-}}
-</includeonly>
+<pre>{{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%}}</pre>
+(same quote, no float, width constraint)
+{{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%}}
+<pre>{{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}}</pre>
+(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.)
+{{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}}
+===TemplateData===
+{{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<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref>",
+			"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 {{Quote}} template or the HTML <blockquote> element.",
+	"paramOrder": [
+		"quote",
+		"author",
+		"source",
+		"width",
+		"float",
+		"bgcolor",
+		"qcolor",
+		"wide",
+		"small",
+		"personquoted",
+		"publication",
+		"title",
+		"quotesource",
+		"2",
+		"3",
+		"4",
+		"5",
+		"rtl"
+	],
+	"format": "block"
+}
+</templatedata>
+{{Quotation templates}}
+<includeonly>{{sandbox other||
+[[Category:Enhanced quote templates]]
+}}</includeonly>