Editing Template:Quote/doc

{{Documentation subpage}}

{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}

== Usage ==
{{tlx|Quote}} adds a [[block quotation]] to an article page.

This is easier to type and is more wiki-like than the equivalent [[HTML]] {{tag|blockquote}} tags, and has additional pre-formatted attribution parameters for author and source (though these are not usually used in articles; {{crossref|see {{section link||Reference citations}}, below}}).

'''Note:''' Block quotes do {{em|not}} normally contain quotation marks {{crossref|(see [[MOS:BLOCKQUOTE]])}}.

{{warning|heading=This template is for actual quotations only.|text=Do not use it for block indentation of other material; see {{tlx|Block indent}} for that purpose.}}

=== Examples ===

;Basic use{{colon}}:
<pre>{{Quote
|text=Quoted material.
}}</pre>

;With attribution displayed{{colon}}: 
<pre>{{Quote
|text=Quoted material.
|author=First M. Last
}}</pre>

;With more attribution{{colon}}:
<pre>{{Quote
|text=Quoted material.
|author=First M. Last |title="Article Title"  |source=''Book Title'' (date)
}}</pre>

== Parameters ==

{{para|text}} a.k.a. {{para|1}}—The material being quoted, without quotation marks around it. It is always safest to name this parameter (rather than use an unnamed positional parameter), because, otherwise, any inclusion of a [[Template:=|non-escaped "=" character]] (e.g., in a URL in a source citation) will break the template.

=== Displayed attribution ===
These parameters for for {{em|displaying}} attribution information below the quote; this should not be confused with a citing a source {{crossref|(see {{section link||Reference citations}}, below)}}. These parameters are entirely optional, and are usually used with famous quotations, not routine block quotations, which are usually sourced at the end of the introductory line immediately before the quotation, with a normal {{tag|ref}} tag.

{{para|author}} a.k.a. {{para|2}}—Optional Author/speaker attribution information that will appear below the quotation, and preceded with an attribution dash. 

{{para|title}} a.k.a. {{para|3}}—Optional title of the work the quote appears in, to display below the quotation. This parameter immediately follows the output of {{para|author}} (and an auto-generated comma), if one is provided. It does not auto-italicize. Major works (books, plays, albums, feature films, etc.) should be italicized; minor works (articles, chapters, poems, songs, TV episodes, etc.) go in quotation marks {{crossref|(see [[MOS:TITLES]])}}. Additional citation information can be provided in a fourth parameter, {{para|source}}, below, which will appear after the title.

{{para|source}} a.k.a. {{para|4}}—Optionally used for additional source information to display, after {{para|title}}, like so: {{para|title|"The Aerodynamics of Shaved Weasels"}}{{para|source|{{code|2=moin|''Perspectives on Mammal Barbering'', 2016}}}}; a comma will be auto-generated between the two parameters.  If {{para|source}} is used without {{para|title}}, it simply acts as {{para|title}}. <small>(This parameter was added primarily to ease conversion from misuse of the [[pull quote]] template {{tlx|Quote frame}} for block quotation, but it may aid in cleaner meta-data implementation later.)</small>

{{para|character}} a.k.a. {{para|char}}—to attribute fictional speech to a fictional character, {{em|with}} other citation information. Can also be used to attribute real speech to a specific speaker among many, e.g. in a roundtable/panel transcript, a band interview, etc.  This parameter outputs "[{{Var|Character's name}}], in" after the attribution dash and before the output of the parameters above, thus one or more of those parameters must also be supplied. If you need to cite a fictional speaker in an article about a single work of fiction, where repeating the author and title information would be redundant, you can just use the {{para|author}} parameter instead of {{para|character}}.

Technically, all citation information can be given in a single parameter, as in:
:{{para|source|Anonymous interview subject, in Jane G. Arthur, "The Aerodynamics of Shaved Weasels", ''Perspectives on Mammal Barbering''(2016), Bram Xander Yojimbo (ed.)}}
But this is a bit messy, and will impede later efforts to generate metadata from quotation attribution the way we are already doing with source citations. This is much more usable:
:{{para|character|Anonymous interview subject}}
:{{para|author|Jane G. Arthur}}
:{{para|title|"The Aerodynamics of Shaved Weasels"}}
:{{para|source|{{code|2=moin|''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.)}}}}
Later development can assign a CSS <code>class</code> and so forth to these separate parameters, upon which scripts would be able to operate (e.g. to look up things in WikiQuote).

===Rarely used technical parameters===
{{para|multiline}}—some of the issues with the formatting of quotes with line breaks can be fixed by using {{para|multiline|y}} (see [[#Line breaks|the line breaks section]] for other options).

{{para|style}}—allows specifying additional [[Help:Cascading Style Sheets|CSS]] styles (''not'' classes) to apply to the {{tag|blockquote}} element. {{Crossref|(See [[#Nested quotations]], below, for the most common use case.)}}

===Parameter list===
<pre>
{{Quote
| quote     =
| author    =
| title     =
| source    =
| character =
| multiline =
| style     =
}}
</pre>

==Reference citations==
{{anchor|Attribution|reason=Old section name}}
A [[WP:Citing sources|reference citation]] can be placed before the quote, after the quote, or in the <code>source</code> parameter:
<ul>
<li>'''Typical use''': In the regular-prose introduction to the quotation, when a quotation is given without the displayed <code>author</code>, <code>title</code>, or <code>source</code> parameters:<source lang="xml" inline>According to Pat Doe, in "Underwater Basketweaving Tips" (2015):<ref>...</ref> {{quote |text=Quoted material.}}</source></li>
<li>At the end of the quotation, when a quotation is given without the displayed <code>author</code>, <code>title</code>, or <code>source</code> parameters, and placement before the quote isn't appropriate (e.g. because the material immediately before the quote isn't cited to the same source or introduces multiple quotes from different sources:<source lang="xml" inline>Pat Doe and Chris Foo took opposing positions: {{quote |text=Doe's Quoted material.<ref>...</ref>}} {{quote |text=Foo's Quoted material.<ref>...</ref>}}</source></li>
<li>After the <code>source</code> value (if a value is given for the <code>source</code> parameter other than the {{tag|ref}} itself):<source lang="xml" inline>One expert noted in 2015: {{quote |text=Quoted material. |author=Pat Doe |source="Underwater Basketweaving Tips" (2015)<ref>...</ref>}}</source></li>
<li>{{strongbad|Deprecated}}: <s>After the quoted person's name in <code>author</code>, or after the work's title in <code>title</code>, when a <code>source</code> parameter is not being added:<source lang="xml" inline>As noted in "Underwater Basketweaving Tips" (2015): {{quote |text=Quoted material. |author=Pat Doe<ref>...</ref>}}</source></s><br />Please avoid that format, as it will pollute the author or title metadata with non-author or non-title information.</li>
</ul>

Please do not place the citation in a {{para|author}} or {{para|source}} parameter by itself, as it will produce a nonsensical attribution line that looks like:<br />{{in5}}—&#8239;{{fake ref}}<br />Please also do not put it just outside the {{tnull|Quote}} template, as this will cause a:<br />{{in5}}{{fake ref}}<br />on a line by itself.

== Style ==
Styling is applied through CSS rules in [[MediaWiki:Common.css]].
<syntaxhighlight lang=css>
/* Styling for Template:Quote */
blockquote.templatequote {
     margin-top: 0;
}
blockquote.templatequote div.templatequotecite {
    line-height: 1.5em;
    /* @noflip */
    text-align: left;
    /* @noflip */
    padding-left: 1.6em;
    margin-top: 0;
}
</syntaxhighlight>
HTML:
<syntaxhighlight lang=html>
<blockquote class="templatequote">
<p>Quote text.</p>
<div class="templatequotecite"><cite>—Author, Source</cite></div>
</blockquote>
</syntaxhighlight>

== Examples ==

{{markupv
|markup=<source lang="moin">{{Quote|text=Cry "Havoc" and let slip the dogs of war.|character=Mark Antony|author=[[William Shakespeare]]|title=''[[Julius Caesar (play)|Julius Caesar]]''|source=act III, scene I}}</source>
|renders=
{{Quote|text=Cry "Havoc" and let slip the dogs of war.|character=Mark Antony|author=[[William Shakespeare]]|title=''[[Julius Caesar (play)|Julius Caesar]]''|source=act III, scene I}}
}}

== Limitations ==
{{anchor|Restrictions|reason=Old section name}}
If you do not provide text, the template generates a parser error message, which will appear in red text in the rendered page.

If any parameter's actual value contains an [[equals sign]] (<code>=</code>), you '''must''' use a named parameter (e.g. {{para|text|"E=MC<sup>2</sup>" is a formula everyone knows but few understand}}, not a blank-name positional parameter. The text before the equals sign gets misinterpreted as a named parameter otherwise. Be wary of URLs, which frequently contain this character.  Named parameters are always safer, in this an other templates.

If any parameter's actual value contains characters used for wiki markup syntax (such as [[vertical bar|pipe]], [[brackets]], single quotation marks, etc.), you may need to escape it. See [[Template:!]] and friends.

=== Next to right-floated boxes ===
{{As of|2015|09}}, the text of a block quotation may rarely overflow (in Firefox or other Gecko browsers) a right-floated item (e.g. a {{tlx|Listen}} box, when that item is below another right-floated item of a fixed size that is narrower. In Safari and other Webkit browsers (and even more rarely in Chrome/Chromium) the same condition can cause the block quotation to be pushed downward.  Both of these problems can be fixed by either:
# removing the sizing on the upper item and letting it use its default size (e.g. removing <code>{{var|###}}x{{var|###}}px</code> sizing or {{para|upright}} from a right-floated image above a wider right-floated object that is being overflowed by quotation text; or
# using {{para|style|overflow:inherit;}} in the quotation template.
There may be other solutions, and future browser upgrades may eliminate the issue. It arises at all because of the <code>blockquote { overflow: hidden; }</code> CSS declaration in [[Mediawiki:Common.css]], which itself works around other, more common display problems. A solution that fixes {{em|all}} of the issues is unknown at this time.

=== Vanishing quotes ===
In rare layout cases, e.g. when quotes are sandwiched between userboxes, a quotation may appear blanked out, in some browsers. The workaround for this problem is to add {{para|style|overflow:inherit;}} to such an instance of the template.

=== Line breaks ===
{{Blockquote paragraphs}}

This template sets a text style which might ignore one blank line, and so the template must be ended with a break (newline) or the next blank line might be ignored. Otherwise, beware inline, as:
::* text here <nowiki>{{quote|this is quoted}}</nowiki> More text here
spans a blank line, unless a <nowiki>{{quote|...}}</nowiki> is ended with a line break, then the next blank line might be ignored and two paragraphs joined.

=== Nested quotations ===
The {{tag|blockquote}} element has styles that change the font size: on desktop, text is smaller; on mobile, it is larger. This change is relative to the enclosing context, meaning that if you quote from a source that itself uses a block quotation, you'll find that the inner quotation is either really tiny and hard to read, or really large and barely fits on the screen. Additionally, you'll get an extra pair of decorative, oversize quotation marks. To fix both these issues, add the parameter <code>|style=font-size:inherit;quotes:none;</code> on any inner {{tl|quote}} templates.

=== Technical issues with block templates ===
{{Block bug documentation}}

== Errors ==
Pages where this template is not used correctly populate [[:Category:Pages incorrectly using the quote template]]. The category tracks tranclusions of [[:Template:Quote]] that have no text given for quotation or use an equals sign in the argument of an unnamed parameter. It also tracks usage of {{para|class}}, {{para|id}}, {{para|diff}}, {{para|4}}, or {{para|5}}.

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "Adds a block quotation.",
	"params": {
		"text": {
			"label": "text",
			"description": "The text to quote",
			"type": "content",
			"required": true,
			"aliases": [
				"1",
				"quote"
			],
			"example": "Cry \"Havoc\" and let slip the dogs of war."
		},
		"sign": {
			"label": "sign",
			"description": "The person being quoted",
			"type": "content",
			"required": false,
			"aliases": [
				"2",
				"cite",
				"author"
			],
			"example": "[[William Shakespeare]]",
			"suggested": true
		},
		"source": {
			"label": "source",
			"description": "A source for the quote",
			"type": "content",
			"required": false,
			"aliases": [
				"3"
			],
			"example": "''[[Julius Caesar (play)|Julius Caesar]]'', act III, scene I",
			"suggested": true
		}
	}
}
</templatedata>

{{Quotation templates}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|
| <!-- ADD CATEGORIES AFTER THIS LINE, PLEASE: -->
[[Category:Quotation templates]]
[[Category:Wikipedia XHTML tag-replacing templates]]
}}</includeonly>