Template:Cquote/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Kubanczyk
No edit summary
meta>Kubanczyk
since the quotewidth generally does not work anyhow, I'm marking it as deprecated and simplifying the documentation greatly
Line 13: Line 13:
===Syntax===
===Syntax===
# <code><nowiki>{{cquote|quote text}}</nowiki></code>
# <code><nowiki>{{cquote|quote text}}</nowiki></code>
# <code><nowiki>{{cquote|quote text|quotewidth=40px}}</nowiki></code> or <code><nowiki>{{cquote|quote text|40px|}}</nowiki></code>
# <code><nowiki>{{cquote|quote text|author=author or speaker}}</nowiki></code>
# <code><nowiki>{{cquote|quote text|quote width in pixels||author or speaker|title of article, speech, book, etc.}}</nowiki></code>
# <code><nowiki>{{cquote|quote text|author=author or speaker|source=title of article, speech, book, etc.}}</nowiki></code>
 
;Only the first parameter is required.
:But since sizes are slotted into the second parameter place by default, to cite a source one must deliberately define dummy parameters for those (abusing the template logic, which expects numbers), or explicitly define the source author and publication as 4= and 5= respectively (using them as named parameters—the preprocessor takes such fine):
 
{{cquote|This is one.
|4=Author
|5=Publication}}
 
 
which is generated by:
<pre>
{{cquote|This is one.
|4=Author
|5=Publication}}
</pre>
or
<pre>{{cquote|This is one.
|author=Author
|source=Publication}} </pre>


===Parameters===
===Parameters===
Line 39: Line 20:
: '''''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"]])
: '''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"]])
;Parameter 2: "size", "quotewidth", or "width" can also be used.&nbsp;– deprecated; 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.
;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.
;<del>Parameter 3</del>:<del>"quoteheight"</del>&nbsp;– it was used for desired height of the quotation marks, but no longer.
;Deprecated positional parameter 3:"quoteheight"&nbsp;– it was used for desired height of the quotation marks, but is now ignored.
; author / Parameter 4: Name of the person that wrote or spoke the text being quoted. Can include links.
; author: Name of the person that wrote or spoke the text being quoted. Can include wiki syntax.
: '''Note''': if the text contains one or more "=" (equal signs), then the template must be called as <nowiki>{{cquote|</nowiki>'''<span style="color:red;">4=</span>'''<nowiki>text}}</nowiki>
; source: Source of the quote (publication title, speech, etc.). Can include wiki syntax.
; source / publication / Parameter 5: Source of the quote (publication title, speech, etc.). Can include links.
: '''Note''': if the text contains one or more "=" (equal signs), then the template must be called as <nowiki>{{cquote|</nowiki>'''<span style="color:red;">5=</span>'''<nowiki>text}}</nowiki>
; bgcolor: The color of the background.
; bgcolor: The color of the background.
; wide: When set to "yes", the quote expands to the entire width of the page. Usefull for small quotes, but may clash with other floating objects, such as infoboxes.
; 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.


===Examples===
===Simple example===
<pre>{{cquote|quote text}}</pre>
<pre>{{cquote|quote text}}</pre>
{{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.|4=[[Amy Tan]]}}<!--This is a bad example, as it is illustrating use of the template in article text, not as a pull-quote!-->
{{cquote|To be, or not to be.}}


<pre>{{cquote|1=quote text}}</pre> (quote text contains an equal sign)
===Sourced example===
{{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<sup id="refQLT1904"><small>[[#endnoteQLT1904|2]]</small></sup>:
<pre style="overflow:scroll">{{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>}}</pre>
:<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>}}


<pre>{{cquote|quote text|40px}}</pre>
{{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>}}
{{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}}


<pre>{{cquote|quote text|30px||Origin of quote|Cited source}}</pre>
<references />


For example:
===Other examples===
<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]]}}


<pre style="overflow:scroll">{{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||[[Pink Floyd]]|''[[The Wall]]''}}</pre>
<pre>{{cquote|1=Thus:
is rendered as
:<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre>
 
(quote text contains an equal sign and math syntax)
{{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||[[Pink Floyd]]|''[[The Wall]]''}}
{{cquote|1=Thus:
 
:<math>E=mc^2</math>|author=[[Albert Einstein]]}}
Example with ref tags:
 
<pre style="overflow:scroll">{{cquote|You don't get everything you want. A dictatorship would be a lot easier.|200px||George W. Bush<ref>http://www.governing.com/archive/1998/jul/bush.txt</ref>}}</pre>
 
{{cquote|You don't get everything you want. A dictatorship would be a lot easier.|200px||George W. Bush<ref>http://www.governing.com/archive/1998/jul/bush.txt</ref>}}
 
<references />


==See also==
==See also==

Revision as of 15:14, 29 September 2011

Usage

{{Cquote}} (for Centered pull-quote) is a template meant for pull-quotes, the visually distinctive text that is already present in the same article.

  • NOTE: This template should not be used for quotations if they are not repeated elsewhere in the main text. The Manual of Style recommendation is:
    • For visually distinctive quotation, use {{Quotation}} template.
    • For long quotations, use the HTML <blockquote> element, such as through the use of the {{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 {{Rquote}} which sets the quote off to either the right or left as in a magazine sidebar. This can be effective on essay pages and WikiProject homepages.

Syntax

  1. {{cquote|quote text}}
  2. {{cquote|quote text|author=author or speaker}}
  3. {{cquote|quote text|author=author or speaker|source=title of article, speech, book, etc.}}

Parameters

Parameter 1
text of the quote; use <br /> between paragraphs.
Required
Note: if the quote text contains one or more "=" (equal signs), then the template must be called as {{cquote|1=quote text}} (see "Equals sign in parameter value")
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 marks up and down to suit larger or smaller quotes.
Deprecated positional parameter 3
"quoteheight" – it was used for desired height of the quotation marks, but is now ignored.
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.
bgcolor
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.

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:
:<math>E=mc^2</math>|author=[[Albert Einstein]]}}

(quote text contains an equal sign and math syntax)

See also

Direct variants

Template:Quotation templates see also