Template:Cquote/doc: Difference between revisions

m
175 revisions imported from wikipedia:Template:Cquote/doc
(→‎Sourced example: ok to have multiple lines)
m (175 revisions imported from wikipedia:Template:Cquote/doc)
 
(82 intermediate revisions by 36 users not shown)
Line 2:
<!-- 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===
* {{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===
; Parameter <code>1</code>, <code>quote</code>: text of the quote; use <code><nowiki><br{{tag|p}} /></nowiki></code>around second or betweensubsequent paragraphs.
: '''''Required'''''
: '''Note''':{{A note}} if the quote text contains onea or more "<code>="</code> (equalequals signssign), then the template must be called aswith a named parameter for the content. For example: <nowiki>{{cquotetlx|</nowiki>'''<span styleCquote|{{stronggood|quote{{="color:red;">1=</span>'''<nowiki>}}}}{{var|quote text{{=}}</nowiki>more quoted text}}}} {{Crossreference|1=(see [[m:{{section link|Help:TemplatesTemplate#EqualsUsage signhints inand parameter value|"Equals sign in parameter value"]]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===
<pre>{{cquoteCquote|quote text}}</pre>
{{cquoteCquote|To be, or not to be ...}}
 
===Sourced example===
<presyntaxhighlight lang="moin">{{cquoteCquote|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>
}}</presyntaxhighlight>
 
{{cquoteCquote|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>
}}
 
{{Reflistreflist}}
 
===Other examples===
<pre>{{cquoteCquote|1=F=ma|author=[[Isaac Newton]]}}</pre>
(the ''1='' is necessary as quote text contains an equalequals sign)
{{cquoteCquote|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>
;Direct variants:
(quote text contains an equals sign and math syntax)
* {{tl|cquotetxt}}&nbsp;– a very similar template
{{Cquote|1=Thus:
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}
 
{{Quotation templates 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 |float=right |width=30%}}</pre>
<includeonly>
(source with no author; floated right and width-constrained)
<!-- ADD CATEGORIES BELOW THIS LINE -->
{{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%}}
[[Category:Quotation templates|{{PAGENAME}}]]
Note that it will wrap around article text like this.{{Lorem ipsum}}{{clear|both}}
 
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
<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>
[[bg:Шаблон:Цитат]]
(same quote, no float, width constraint)
[[cs:Šablona:Citát]]
{{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%}}
[[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}}</pre>
[[eu:Txantiloi:Aipu]]
(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.)
[[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}}
[[fr:Modèle:Citation bloc]]
 
[[hy:Կաղապար:Քաղվածք]]
===TemplateData===
[[la:Formula:Locus]]
{{TemplateData header}}
[[ms:Templat:Cquote]]
<templatedata>
[[mk:Шаблон:Цитатник]]
{
[[ja:Template:Cquote]]
"params": {
[[ko:틀:인용문2]]
"2": {},
[[ka:თარგი:Cquote]]
"3": {
[[os:Шаблон:Cquote]]
"deprecated": true
[[pt:Predefinição:Quote2]]
},
[[ro:Format:Cquote]]
"4": {
[[ru:Шаблон:Цитатник]]
"deprecated": true
[[sr:Шаблон:Цитат2]]
},
[[sv:Mall:Citat]]
"5": {
[[fa:الگو:نقل قول]]
"deprecated": true
[[uk:Шаблон:Цитата]]
},
[[uz:Andoza:Quote]]
"float": {
[[zh:Template:Cquote]]
"label": "Float",
</includeonly>
"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>