Template:Cquote/doc: Difference between revisions

Nothing to hide, but nothing to show you either.
Jump to navigation Jump to search
Content added Content deleted
No edit summary
m (175 revisions imported from wikipedia:Template:Cquote/doc)
 
(80 intermediate revisions by 34 users not shown)
Line 2: Line 2:
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->


{{Blockquote/doc/boilerplate}}
==Usage==
'''{{tl|Cquote}}''' (for '''Centered pull-quote''') is a template meant for [[pull-quote]]s, the visually distinctive text that is ''already present'' in the same article.


== Usage ==
* <font color="red">'''NOTE''': This template should '''not be used''' for quotations</font> if they are not repeated elsewhere in the main text. The [[Wikipedia:Manual of Style#Quotations|Manual of Style]] recommendation is:
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 visually distinctive quotation, use {{tl|Quotation}} template.
** For long quotations, use the HTML &lt;[[blockquote]]&gt; element, such as through the use of the {{tl|Quote}} template.
* 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 shorter pull-quotes of 50 words or fewer in a similar style, consider using {{tl|Rquote}} 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===
===Syntax===
* {{tlx|{{BASEPAGENAME}}|2=quote={{var|text of the quotation}}|3=author={{var|person quoted}}|4=source={{var|source of the quotation}}}}
# <code><nowiki>{{cquote|quote text}}</nowiki></code>
# <code><nowiki>{{cquote|quote text|author=author or speaker}}</nowiki></code>
# <code><nowiki>{{cquote|quote text|author=author or speaker|source=title of article, speech, book, etc.}}</nowiki></code>


===Parameters===
===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'''''
: '''''Required'''''
: '''Note''': if the quote text contains one or more "=" (equal signs), then the template must be called as <nowiki>{{cquote|</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> (equals 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}})}}.
; <code>author</code>: Name of the person that wrote or spoke the text being quoted. Can include wiki syntax.
;Deprecated positional parameter 2: "size", "quotewidth", or "width" can also be used. Desired size of the quotation marks. Currently this value is ignored and the size is always 35px, except for the values 10px, 20px, 30px, 40px, 50px, and 60px retained for historical reasons. This was used to scale the graphical [[quotation mark]]s up and down to suit larger or smaller quotes.
; <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'')
;Deprecated positional parameter 3:"quoteheight"&nbsp;– it was used for desired height of the quotation marks, but is now ignored.
; <code>bgcolor</code>: The color of the background. This parameter is disabled in article space.
; author: Name of the person that wrote or spoke the text being quoted. Can include wiki syntax.
; <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). This parameter is disabled in article space.
; source: Source of the quote (publication title, speech, etc.). Can include wiki syntax.
; <code>width</code>: for example {{para|width|30%}}. This parameter is disabled in article space.
; bgcolor: The color of the background.
; <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.). This parameter is disabled in article space.
; 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>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. This parameter is disabled in article space.
; <code>quotealign</code>: set to center to center align the quote text. This parameter is disabled in article space.
'''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). This parameter is disabled in article space.


===Simple example===
===Simple example===
<pre>{{cquote|quote text}}</pre>
<pre>{{Cquote|quote text}}</pre>
{{cquote|To be, or not to be.}}
{{Cquote|To be, or not to be ...}}


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


{{cquote|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]]
|author=[[Albert Einstein]]
|source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref>
|source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref>
}}
}}


{{Reflist}}
{{reflist}}


===Other examples===
===Other examples===
<pre>{{cquote|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)
(the ''1='' is necessary as quote text contains an equals sign)
{{cquote|1=F=ma|author=[[Isaac Newton]]}}
{{Cquote|1=F=ma|author=[[Isaac Newton]]}}


<pre>{{cquote|1=Thus:
:<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre>
(quote text contains an equal sign and math syntax)
{{cquote|1=Thus:
:<math>E=mc^2</math>|author=[[Albert Einstein]]}}


<pre>{{Cquote|1=Thus:
==See also==
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre>
{{Quotation templates see also}}
(quote text contains an equals sign and math syntax)
{{Cquote|1=Thus:
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}


<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Quotation templates|{{PAGENAME}}]]


<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>
<!-- ADD INTERWIKIS BELOW THIS LINE -->
(source with no author; floated right and width-constrained)
[[bg:Шаблон:Цитат]]
{{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%}}
[[cs:Šablona:Citát]]
Note that it will wrap around article text like this.{{Lorem ipsum}}{{clear|both}}
[[cy:Nodyn:Dyfyniad]]

[[eo:Ŝablono:Cquote]]

[[es:Plantilla:Cita]]
<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>
[[eu:Txantiloi:Aipu]]
(same quote, no float, width constraint)
[[id: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 |width=50%}}
[[fr:Modèle:Citation bloc]]

[[hy:Կաղապար:Քաղվածք]]

[[la:Formula:Locus]]
<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>
[[ms:Templat:Cquote]]
(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.)
[[mk:Шаблон:Цитатник]]
{{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}}
[[ja:Template:Cquote]]

[[ko:틀:인용문2]]
===TemplateData===
[[ka:თარგი:Cquote]]
{{TemplateData header}}
[[os:Шаблон:Cquote]]
<templatedata>
[[pt:Predefinição:Quote2]]
{
[[ro:Format:Cquote]]
"params": {
[[ru:Шаблон:Цитатник]]
"2": {},
[[sr:Шаблон:Цитат2]]
"3": {
[[sv:Mall:Citat]]
"deprecated": true
[[fa:الگو:نقل قول]]
},
[[uk:Шаблон:Цитата]]
"4": {
[[uz:Andoza:Quote]]
"deprecated": true
[[zh:Template:Cquote]]
},
</includeonly>
"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>

Latest revision as of 09:22, 16 June 2021

The Manual of Style guidelines for block quotations recommend formatting block quotations using the {{Blockquote}} 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[edit source]

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[edit source]

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

Parameters[edit source]

Parameter 1, quote
text of the quote; use <p>...</p> around second or subsequent paragraphs.
Required
 Note: if the quote text contains a = (equals sign), then the template must be called with a named parameter for the content. For example: {{Cquote|quote=quote text=more quoted text}}
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. This parameter is disabled in article space.
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). This parameter is disabled in article space.
width
for example |width=30%. This parameter is disabled in article space.
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.). 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 |width= constraint). This parameter is disabled in article space.

Simple example[edit source]

{{Cquote|quote text}}

Sourced example[edit source]

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


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

Other examples[edit source]

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

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


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

(quote text contains an equals sign and math syntax)


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

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)


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

TemplateData[edit source]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template 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.

ParameterDescriptionTypeStatus
Quotequote 1 quotetext text content

The quote to be visually repeated

Contentrequired
Authorauthor personquoted

Name of the person that wrote or spoke the text being quoted

Example
[[Albert Einstein]]
Contentsuggested
Sourcesource 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>
Contentsuggested
Widthwidth

The width of the quote

Default
Sized to fit content (auto)
Example
30%
Auto value
Stringoptional
Floatfloat

Position the quote to float on the right or left side of the content

Example
left
Stringoptional
Background colorbgcolor

The background color for the quote

Default
transparent
Stringoptional
Quotation mark colorqcolor

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
Unknownoptional
Full widthwide

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

Booleandeprecated
smallsmall

no description

Unknowndeprecated
personquotedpersonquoted

no description

Unknowndeprecated
publicationpublication

no description

Unknowndeprecated
titletitle

no description

Unknowndeprecated
quotesourcequotesource

no description

Unknowndeprecated
22

no description

Unknownoptional
33

no description

Unknowndeprecated
44

no description

Unknowndeprecated
55

no description

Unknowndeprecated
Directionrtl

Sets scrript direction right-to-left (Arabic, Hebrew)

Example
rtl=yes
Unknownoptional