View source for Template:Wp/nys/Quote/documentation

''<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->



== 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===
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|text={{var|text of the quotation}}|author={{var|person quoted}}|source={{var|source of the quotation}}<nowiki>}}</nowiki></code>

===Parameters===
; Parameter <code>1</code>, a.k.a. <code>quote</code>: text of the quote; use {{Wp/nys/Tag|p}} around second or subsequent paragraphs.
: '''''Required'''''
: '''Note''': if the quote text contains a <code>=</code> (equal sign), then the template must be called with a named parameter for the content, e.g. <code><nowiki>{{Wp/nys/Cquote|</nowiki>'''<span style="color:red;">quote=</span>'''<nowiki>quote text}}</nowiki></code> {{Wp/nys/Crossref|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 {{Wp/nys/Para|author}} (e.g. for a scripture, law, or other source without an author ''per se'')
; <code>bgcolor</code>: The color of the background.
; <code>float</code>: Defaults to center, but can also be right or left. Usually used with {{Wp/nys/Para|width|30%}} or so (otherwise for quotes longer than one line on the rendered page, the float will have no useful effect).
; <code>width</code>: for example {{Wp/nys/Para|width|30%}}
; <code>qcolor</code>: color of quotemarks, for example {{Wp/nys/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.
'''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 {{Wp/nys/Para|width}} constraint).

===Simple example===
<pre>{{Wp/nys/Cquote|quote text}}</pre>
{{Wp/nys/Cquote|To be, or not to be ...}}

===Sourced example===
<source lang="moin">{{Wp/nys/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>
}}</source>

{{Wp/nys/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>
}}

{{Wp/nys/Reflist}}

===Other examples===
<pre>{{Wp/nys/Cquote|1=F=ma|author=[[Isaac Newton]]}}</pre>
(the ''1='' is necessary as quote text contains an equal sign)
{{Wp/nys/Cquote|1=F=ma|author=[[Isaac Newton]]}}


<pre>{{Wp/nys/Cquote|1=Thus:
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre>
(quote text contains an equal sign and math syntax)
{{Wp/nys/Cquote|1=Thus:
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}


<pre>{{Wp/nys/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)
{{Wp/nys/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. {{Wp/nys/Lorem}}{{Wp/nys/Clear|both}}


<pre>{{Wp/nys/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)
{{Wp/nys/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>{{Wp/nys/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.)
{{Wp/nys/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===
{{Wp/nys/TemplateDataHeader}}
<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'."
		}
	},
	"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 {{Wp/nys/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"
	],
	"format": "block"
}
</templatedata>

{{Wp/nys/Quotation templates}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Enhanced quote templates]]
}}</includeonly>
''