Template:Cquote/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older edit
VisualWikitext
meta>EmilJ
m Undid revision 231411837 by DumZiBoT (talk)
Ookami (talk | contribs)
1,664 edits
m 173 revisions imported
 
(128 intermediate revisions by 59 users not shown)
Line 1: Line 1:
<includeonly>{{mergefrom|Cquotetxt}}{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
{{Documentation subpage}}{{TOC right}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->


'''{{tl|Cquote}}''' is a template meant for [[pull-quote]]s, which stand apart from the text of a page.  It generally should not be used in articles unless there is a good justification for doing so. Pull-quotes work best when used with short quotes, and at the start or end of a section, to help emphasize the content of the section. For shorter pull-quotes of 50 words or fewer in a similar style, consider using {{tl|Rquote}}.
{{Quote/doc/boilerplate}}


'''NOTE''': This template should '''not be used''' for [[block quote]]s in article text.  For long quotations in the text, the [[Wikipedia:Manual of Style#Quotations|Manual of Style]] recommends using the HTML &lt;[[blockquote]]&gt; element, such as through the use of the {{tl|Quote}} template.
== 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.


==Usage==
===Syntax===
# <code><nowiki>{{cquote|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>{{cquote|quote text|quotewidth=40px|quoteheight=40px}}</nowiki></code> or <code><nowiki>{{cquote|quote text|40px|40px}}</nowiki></code>
# <code><nowiki>{{cquote|quote text|quote width in pixels|quote height in pixels|Origin of quote|Cited source}}</nowiki></code>


Only the first parameter is required.
===Parameters===
; Parameter <code>1</code>, <code>quote</code>: text of the quote; use {{tag|p}} around second or subsequent paragraphs.
: '''''Required'''''
: {{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}})}}.
; <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>bgcolor</code>: The color of the background.
; <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).


==Parameters==
===Simple example===
* Parameter 1: text of the quote; use <code><nowiki><br /></nowiki></code> between paragraphs.
<pre>{{Cquote|quote text}}</pre>
:: '''''Required'''''
{{Cquote|To be, or not to be ...}}
:: '''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 [http://meta.wikimedia.org/wiki/Help:Templates#Equals_sign_in_parameter_value "Equals sign in parameter value"])


The next two parameters can be used to scale the graphical [[quotation mark]]s up and down to suit larger or smaller quotes.
===Sourced example===
* Parameter 2: "quotewidth" - desired width of the quote image; defaults to 20px. (anything larger than 48px is not recommended.)
<syntaxhighlight lang="moin">{{Cquote|Life is like riding a bicycle. To keep your balance you must keep moving.
* Parameter 3: "quoteheight" - desired height of the quote image; defaults to 20px.
|author=[[Albert Einstein]]
|source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref>
}}</syntaxhighlight>


The last two parameters can be used to provide attribution for the quote:
{{Cquote|Life is like riding a bicycle. To keep your balance you must keep moving.
* Parameter 4: Name of the person that wrote or spoke the text being quoted. Can include links.
|author=[[Albert Einstein]]
* Parameter 5: Source of the quote (publication title, speech, etc.). Can include links.
|source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref>
}}


==Examples==
{{reflist}}
;<code><nowiki>{{cquote|quote text}}</nowiki></code>
As [[Amy Tan]] once said
{{cquote|External success has to do with people who may see me as a model, or an example, or a representative. As much as I may dislike or want to reject that responsibility, this is something that comes with public success. It's important to give others a sense of hope that it is possible and you can come from really different places in the world and find your own place in the world that's unique for yourself.}}<!--This is a bad example, as it is illustrating use of the template in article text, not as a pull-quote!-->
;<code><nowiki>{{cquote|1=quote text}}</nowiki></code> (quote text contains an equal sign)
{{cquote|1=The essential point, established by Lorentz, is that the equations of the electromagnetic field are not altered by a certain transformation (which I will call by the name of Lorentz) of the form{{rf|2|LT1904}}:
::<math>x^\prime = k\ell\left(x + \varepsilon t\right),t^\prime = k\ell\left(t + \varepsilon x\right),y^\prime = \ell y,z^\prime = \ell z, k = 1/\sqrt{1-\varepsilon^2}.</math>}}


;<code><nowiki>{{cquote|quote text|40px|40px}}</nowiki></code>
===Other examples===
{{Cquote|You have the right to remain silent. If you give up that right, anything you say can and will be used against you in a court of law. You have the right to an attorney and to have an attorney present during questioning. If you cannot afford an attorney, one will be provided to you at no cost.  During any questioning, you may decide at any time to exercise these rights, not answer any questions, or make any statements.|40px|40px}}
<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]]}}


;<code><nowiki>{{cquote|quote text|30px|30px|Origin of quote|Cited source}}</nowiki></code>
For example,
;<code><nowiki>{{cquote|And when they've given you their all / Some stagger and fall, after all it's not easy / Banging your heart against some mad bugger's wall.|30px|30px|[[Pink Floyd]]|''[[The Wall]]''}}</nowiki></code>
is rendered as
{{cquote|And when they've given you their all / Some stagger and fall, after all it's not easy / Banging your heart against some mad bugger's wall.|30px|30px|[[Pink Floyd]]|''[[The Wall]]''}}


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


;<code><nowiki>{{cquote|You don't get everything you want. A dictatorship would be a lot easier.|200|50|George W. Bush<ref>http://www.governing.com/archive/1998/jul/bush.txt</ref>}}</nowiki></code>


{{cquote|You don't get everything you want. A dictatorship would be a lot easier.|200|50|George W. Bush<ref>http://www.governing.com/archive/1998/jul/bush.txt</ref>}}
<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)
{{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 ipsum}}{{clear|both}}


<references />


==See also==
<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%}}


Direct variants:


* {{Lts|Cquote}} – with graphic quotation mark<!--self-listing for quick access on edit history-->
<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>
* {{Lts|cquotetxt}} – with text-based quotation mark
(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}}


{{Quotation templates see also}}
===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>


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


<!-- ADD INTERWIKIS BELOW THIS LINE -->
<includeonly>{{sandbox other||
[[bg:Шаблон:Цитат]]
[[Category:Enhanced quote templates]]
[[es:Plantilla:Cita]]
}}</includeonly>
[[eu:Txantiloi:Aipu]]
[[id:Template:cquote]]
[[fr:Modèle:Citation bloc]]
[[ms:Templat:Cquote]]
[[mk:Шаблон:Цитатник]]
[[ja:Template:Cquote]]
[[pt:Predefinição:Quote2]]
[[ru:Шаблон:Цитатник]]
[[sr:Шаблон:Цитат2]]
[[sv:Mall:Citat]]
[[fa:الگو:نقل قول]]
 
</includeonly>

Latest revision as of 04:23, 3 September 2020

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

Sourced example

<syntaxhighlight lang="moin">

</syntaxhighlight>


  1. ↑ Walter Isaacson, Einstein: His Life and Universe (2007), p. 367.
  2. ↑ 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.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

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.

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


Retrieved from "https://zoophilia.wiki/index.php?title=Template:Cquote/doc&oldid=58377"