Template:Cquote/doc: Difference between revisions
From Zoophilia Wiki
Jump to navigationJump to search
meta>TheDJ |
m 173 revisions imported |
||
| (15 intermediate revisions by 11 users not shown) | |||
| Line 2: | Line 2: | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | ||
{{ | {{Quote/doc/boilerplate}} | ||
== Usage == | == Usage == | ||
For | 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=== | ===Syntax=== | ||
* | * {{tlx|{{BASEPAGENAME}}|2=quote={{var|text of the quotation}}|3=author={{var|person quoted}}|4=source={{var|source of the quotation}}}} | ||
===Parameters=== | ===Parameters=== | ||
; Parameter <code>1</code>, | ; Parameter <code>1</code>, <code>quote</code>: text of the quote; use {{tag|p}} around second or subsequent paragraphs. | ||
: '''''Required''''' | : '''''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>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>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'') | ||
| Line 20: | Line 20: | ||
; <code>width</code>: for example {{para|width|30%}} | ; <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>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''': | '''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). | ; <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). | ||
===Simple example=== | ===Simple example=== | ||
<pre>{{ | <pre>{{Cquote|quote text}}</pre> | ||
{{ | {{Cquote|To be, or not to be ...}} | ||
===Sourced example=== | ===Sourced example=== | ||
< | <syntaxhighlight lang="moin">{{Cquote|Life is like riding a bicycle. To keep your balance you must keep moving. | ||
|author=[[Albert Einstein]] | |author=[[Albert Einstein]] | ||
|source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref> | |source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref> | ||
}}</ | }}</syntaxhighlight> | ||
{{ | {{Cquote|Life is like riding a bicycle. To keep your balance you must keep moving. | ||
|author=[[Albert Einstein]] | |author=[[Albert Einstein]] | ||
|source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref> | |source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref> | ||
| Line 42: | Line 43: | ||
===Other examples=== | ===Other examples=== | ||
<pre>{{ | <pre>{{Cquote|1=F=ma|author=[[Isaac Newton]]}}</pre> | ||
(the ''1='' is necessary as quote text contains an equal sign) | (the ''1='' is necessary as quote text contains an equal sign) | ||
{{ | {{Cquote|1=F=ma|author=[[Isaac Newton]]}} | ||
<pre>{{ | <pre>{{Cquote|1=Thus: | ||
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre> | {{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre> | ||
(quote text contains an equal sign and math syntax) | (quote text contains an equal sign and math syntax) | ||
{{ | {{Cquote|1=Thus: | ||
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}} | {{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}} | ||
<pre>{{ | <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) | (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. {{ | Note that it will wrap around article text like this.{{Lorem ipsum}}{{clear|both}} | ||
<pre>{{ | <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) | (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>{{ | <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.) | (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=== | ||
{{ | {{TemplateData header}} | ||
<templatedata> | <templatedata> | ||
{ | { | ||
| Line 164: | Line 165: | ||
"quotesource": { | "quotesource": { | ||
"deprecated": "This is an option of a template that was merged into this one. You can replace it with 'source'." | "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 | "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": [ | "paramOrder": [ | ||
"quote", | "quote", | ||
| Line 183: | Line 189: | ||
"2", | "2", | ||
"3", | "3", | ||
"4", | |||
"5", | |||
"rtl" | |||
], | ], | ||
"format": "block" | "format": "block" | ||
| Line 192: | Line 199: | ||
{{Quotation templates}} | {{Quotation templates}} | ||
<includeonly>{{ | <includeonly>{{sandbox other|| | ||
| | [[Category:Enhanced quote templates]] | ||
[[Category: | |||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 04:23, 3 September 2020
 | This is a documentation subpage for Template:Cquote. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template should not be used for block quotations in article text. |
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
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}}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=#FF0000for 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}}
| “ | To be, or not to be ... | ” |
Sourced example
<syntaxhighlight lang="moin">
| “ | Life is like riding a bicycle. To keep your balance you must keep moving. | ” |
| — Albert Einstein, in a letter to his son[1] | ||
</syntaxhighlight>
| “ | Life is like riding a bicycle. To keep your balance you must keep moving. | ” |
| — Albert Einstein, in a letter to his son[2] | ||
- ↑ Walter Isaacson, Einstein: His Life and Universe (2007), p. 367.
- ↑ 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)
| “ | F=ma | ” |
| — Isaac Newton | ||
{{Cquote|1=Thus:
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}
(quote text contains an equal sign and math syntax)
| “ | Thus:
Script error: No such module "in5".<math>E=mc^2</math> |
” |
| — Albert Einstein | ||
{{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)
| “ | 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. | ” |
| — First Amendment to the Constitution of the United States | ||
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)
| “ | 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. | ” |
| — First Amendment to the Constitution of the United States | ||
{{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.)
| “ | 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. | ” |
| — First Amendment to the Constitution of the United States | ||
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Quote | quote 1 quotetext text content | The quote to be visually repeated | Content | required |
| Author | author personquoted | Name of the person that wrote or spoke the text being quoted
| Content | suggested |
| Source | source 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)
| Content | suggested |
| Width | width | The width of the quote
| String | optional |
| Float | float | Position the quote to float on the right or left side of the content
| String | optional |
| Background color | bgcolor | The background color for the quote
| String | optional |
| Quotation mark color | qcolor | Color of quotemarks (only for use in WP:Signpost, and personal pages; do not use in articles, guidelines, etc.)
| Unknown | optional |
| Full width | 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). | Boolean | deprecated |
| small | small | no description | Unknown | deprecated |
| personquoted | personquoted | no description | Unknown | deprecated |
| publication | publication | no description | Unknown | deprecated |
| title | title | no description | Unknown | deprecated |
| quotesource | quotesource | no description | Unknown | deprecated |
| 2 | 2 | no description | Unknown | optional |
| 3 | 3 | no description | Unknown | deprecated |
| 4 | 4 | no description | Unknown | deprecated |
| 5 | 5 | no description | Unknown | deprecated |
| Direction | rtl | Sets scrript direction right-to-left (Arabic, Hebrew)
| Unknown | optional |
