PrivacyWiki

Template:Cquote/doc: Difference between revisions

Template Discussion

Template:Cquote/doc (edit)

Revision as of 09:22, 16 June 2021

5,779 bytes added ,  2 years ago
m
175 revisions imported from wikipedia:Template:Cquote/doc
VisualWikitext
(Using wording suggested on talk page (minus recommendation of the quote box template, which everyone seems to hate, as looking "very 1998".)
m (175 revisions imported from wikipedia:Template:Cquote/doc)
 
(42 intermediate revisions by 17 users not shown)
Line 1:
{{Documentation subpage}}{{TOC right}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{warning|'''NOTE''': This template should '''not be used''' for block quotations in article text.}}
 
{{Blockquote/doc/boilerplate}}
==Usage==
This template is meant for [[pull quote]]s, the visually distinctive ''repetition'' of text that is ''already present'' on the same page. In most cases, this is not appropriate for use in encyclopedia articles. The [[Wikipedia:Manual of Style#Block quotations|Manual of Style guidelines for block quotations]] recommend formatting block quotations using the {{tl|Quote}} template or the HTML &lt;[[blockquote]]&gt; element.
 
== Usage ==
For actual pull quotes, 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.
 
* {{strong|NOTE: This template should {{em|only}} be used for short pull quotes, which repeat quoted text already appearing in the article, and {{em|never}} for block quotations.}}.
* The [[Wikipedia:Manual of Style#Block quotations|Manual of Style guidelines for block quotations]] recommend formatting block quotations using the HTML &lt;[[blockquote]]&gt; element (which can be done with the {{tl|quote}} or {{tl|quote box}} quotation templates).
* Pull quotes work best when used with short sentences, and at the start or end of a section, as a hint of the following section's content.
* For very short pull quotes, consider using {{tl|Reduced pull quote}} 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===
* <code><nowiki>{{</nowiki>tlx|{{BASEPAGENAME}}|2=quote={{var|text of the quotation}}|3=author={{var|person quoted}}|4=source={{var|source of the quotation}}<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|{{var|text of quotation}}|{{var|person quoted}}|{{var|source of the quotation}}<nowiki>}}</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 a <code>=</code> (equalequals sign), then the template must be called with a named parameter for the content, e.g. <nowiki>For example: {{pull quotetlx|Cquote|{{stronggood|</nowiki>'''<span style="color:red;">quote{{=</span>'''<nowiki>}}}}{{var|quote text{{=}}more quoted text}}}}</nowiki> {{crossrefCrossreference|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. This parameter is disabled in article space.
; <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.
; <code>width</code>: for example {{para|width|30%}}. This parameter is disabled in article space.
; wide: When set to "yes", the quote expands to the entire width of the page. Useful for long quotes, but may clash with other floating objects, such as infoboxes.
; <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.
; <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>{{pull quoteCquote|quote text}}</pre>
{{pull quoteCquote|To be, or not to be ...}}
 
===Sourced example===
<presyntaxhighlight lang="moin">{{pull quoteCquote|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>
 
{{pull quoteCquote|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>
Line 46 ⟶ 43:
 
===Other examples===
<pre>{{pull quoteCquote|1=F=ma|author=[[Isaac Newton]]}}</pre>
(the ''1='' is necessary as quote text contains an equalequals sign)
{{pull quoteCquote|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>
(quote text contains an equalequals sign and math syntax)
{{pull quoteCquote|1=Thus:
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}
 
 
<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}}
 
 
<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%}}
 
 
<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.)
{{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 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>
 
{{Quotation templates}}
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox other||
[[Category:Enhanced quote templates]]
| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Quotation templates]]
}}</includeonly>
Retrieved from ‘https://privacywiki.xyz/wiki/Special:MobileDiff/14352...14395’