Template:Cquote/doc: Difference between revisions

update
(Clarify how to use and cite a source)
(update)
Line 1:
<includeonly>{{mergefrom|Cquotetxt}}</includeonly><noinclude>{{documentation subpage}}</noinclude>{{-}}{{interwikitmp-grp|wsp=|cms=}}{{TOCright}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
'''{{tl|Cquote}}''' (for ''''''Centered pull-quote'''''') is a template meant for [[pull-quote]]s, which stand apart from the text of a page.
 
'''{{tl|Cquote}}''' (for ''''''Centered pull-quote'''''') 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.
Line 12 ⟶ 11:
==Usage==
# <code><nowiki>{{cquote|quote text}}</nowiki></code>
# <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>{{i}}which is to say:
{{ibull}}title of article or book is same as Origin of quote{{ibull}}author is same as Cited source
 
;Only the first parameter is required.
:But since sizes are slotted into the second and third parameter placesplace 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 publication and author as 4= and 5= respectively (using them as named parameters&mdash;the preprocessor takes such fine):
 
 
Line 23 ⟶ 22:
|4=this is four
|5=this is five}}
 
;
which is generated by{{!:}}:&nbsp;
<pre>
Line 31 ⟶ 30:
</pre>
==Parameters==
*; Parameter 1: text of the quote; use <code><nowiki><br /></nowiki></code> between paragraphs.
:: '''''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 [http://meta.wikimedia.org/wiki/Help:Templates#Equals_sign_in_parameter_value "Equals sign in parameter value"])
;Parameter 2: "size", "quotewidth", or "width" can also be used. - desired size of the quotation marks; defaults to 20px (anything larger than 48px is not recommended). This can be used to scale the graphical [[quotation mark]]s up and down to suit larger or smaller quotes.
* ;<del>Parameter 3</del>: <del>"quoteheight"</del> - it was used for desired height of the quotequotation image;marks, defaultsbut tono 20pxlonger.
*; Parameter 4: Name of the person that wrote or spoke the text being quoted. 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;">4=</span>'''<nowiki>text}}</nowiki>
*; 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.
 
==Examples==
The next two parameters can be used to scale the graphical [[quotation mark]]s up and down to suit larger or smaller quotes.
;<code><nowikipre>{{cquote|quote text}}</nowiki></codepre>
* Parameter 2: "quotewidth" - desired width of the quote image; defaults to 20px. (anything larger than 48px is not recommended.)
{{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!-->
* Parameter 3: "quoteheight" - desired height of the quote image; defaults to 20px.
 
;<code><nowikipre>{{cquote|1=quote text}}</nowiki></codepre> (quote text contains an equal sign)
The last two parameters can be used to provide attribution for the quote:
* Parameter 4: Name of the person that wrote or spoke the text being quoted. 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;">4=</span>'''<nowiki>text}}</nowiki>
* 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>
 
==Examples==
;<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<sup id="refQLT1904"><small>[[#endnoteQLT1904|2]]</small></sup>:
::<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><nowikipre>{{cquote|quote text|40px|40px}}</nowiki></codepre>
{{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}}
 
;<code><nowikipre>{{cquote|quote text|30px|30px|Origin of quote|Cited source}}</nowiki></codepre>
For example,
;<code><nowikipre>{{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></codepre>
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:
 
;<code><nowikipre>{{cquote|You don't get everything you want. A dictatorship would be a lot easier.|200200px|50|George W. Bush<ref>http://www.governing.com/archive/1998/jul/bush.txt</ref>}}</nowiki></codepre>
 
{{cquote|You don't get everything you want. A dictatorship would be a lot easier.|200200px|50|George W. Bush<ref>http://www.governing.com/archive/1998/jul/bush.txt</ref>}}
 
<references />
Line 73 ⟶ 69:
 
Direct variants:
 
* {{Lts|Cquote}} – with graphic quotation mark<!--self-listing for quick access on edit history-->
* {{Lts|cquotetxt}} – with text-based quotation mark
Anonymous user