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
(fix link)
Line 5: Line 5:


== Usage ==
== Usage ==
For actual [[pull quote]]s, this template provides a centered, borderless pull 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 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===
===Syntax===
Line 13: Line 13:
; Parameter <code>1</code>, a.k.a. <code>quote</code>: text of the quote; use {{tag|p}} around second or subsequent paragraphs.
; Parameter <code>1</code>, a.k.a. <code>quote</code>: text of the quote; use {{tag|p}} around second or subsequent paragraphs.
: '''''Required'''''
: '''''Required'''''
: '''Note''': if the quote text contains a <code>=</code> (equal sign), then the template must be called with a named parameter for the content, e.g. <code><nowiki>{{pull quote|</nowiki>'''<span style="color:red;">quote=</span>'''<nowiki>quote text}}</nowiki></code> {{crossref|1=(see {{section link|Help:Template#Usage hints and workarounds}})}}.
: '''Note''': if the quote text contains a <code>=</code> (equal sign), then the template must be called with a named parameter for the content, e.g. <code><nowiki>{{Cquote|</nowiki>'''<span style="color:red;">quote=</span>'''<nowiki>quote text}}</nowiki></code> {{crossref|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.
; <code>author</code>: Name of the person that wrote or spoke the text being quoted. 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'')
; <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'')
Line 25: Line 25:


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


===Sourced example===
===Sourced example===
<source lang="moin">{{pull quote|Life is like riding a bicycle. To keep your balance you must keep moving.
<source lang="moin">{{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>
}}</source>
}}</source>


{{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]]
|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>
Line 42: Line 42:


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




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




<pre>{{pull quote|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>
<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>
(source with no author; floated right and width-constrained)
(source with no author; floated right and width-constrained)
{{pull quote|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%}}
{{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%}}
Note that it will wrap around article text like this. {{lorem}}{{clear|both}}
Note that it will wrap around article text like this. {{lorem}}{{clear|both}}




<pre>{{pull quote|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>
<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)
(same quote, no float, width constraint)
{{pull quote|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%}}
{{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>{{pull quote|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>
<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.)
(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.)
{{pull quote|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}}
{{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===
Line 166: Line 166:
}
}
},
},
"description": "This template is intended for pull quotes, a visually distinctive repetition of text that is already present on the same page. 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.",
"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": [
"paramOrder": [
"quote",
"quote",
Line 194: Line 194:
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->
| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Pull quote templates]]
[[Category:Enhanced quote templates]]
}}</includeonly>
}}</includeonly>

Revision as of 21:40, 17 January 2017

Template:Cquote/boilerplate

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|text=text of the quotation|author=person quoted|source=source of the quotation}}

Parameters

Parameter 1, a.k.a. quote
text of the quote; use <p>...</p> around second or subsequent paragraphs.
Required
Note: if the quote text contains a = (equal sign), then the template must be called with a named parameter for the content, e.g. {{Cquote|quote=quote 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.
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.

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

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


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


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

(quote text contains an equal 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. Template:Lorem


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

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