Difference between revisions of "Template:Quote/doc"

From blackwiki
Jump to navigation Jump to search
(better formatting)
m (192 revisions imported)
 
(64 intermediate revisions by 23 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
{{Uses TemplateStyles|Template:Quote/styles.css}}
 +
{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}
 +
{{High-risk|120,000+}}
  
{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}
+
{{Quote/doc/boilerplate|mos-recommended=yes}}
  
 
== Usage ==
 
== Usage ==
 
{{tlx|Quote}} adds a [[block quotation]] to an article page.
 
{{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.
+
This is easier to type and is more wiki-like than the equivalent [[HTML]] {{code|lang=html|code=<blockquote>...</blockquote>}} tags, and has additional pre-formatted attribution parameters for author and source (though these are not usually used in articles; {{crossreference|see {{section link||Reference citations}}, below}}).
 +
 
 +
'''Note:''' Block quotes do {{em|not}} normally contain quotation marks {{crossreference|(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.}}
  
'''Note:''' Block quotes do {{em|not}} normally contain quotation marks {{crossref|(see [[MOS:Blockquote]])}}.
+
=== Examples ===
 +
;Basic use{{colon}}
 +
{{markup|
 +
<nowiki>{{Quote
 +
|text=Quoted material.
 +
}}</nowiki>|{{Quote
 +
|text=Quoted material.
 +
}}}}
  
=== Synopsis ===
+
;With attribution displayed{{colon}}
 +
{{markup|
 +
<nowiki>{{Quote
 +
|text=Quoted material.
 +
|author=First M. Last
 +
}}</nowiki>|{{Quote
 +
|text=Quoted material.
 +
|author=First M. Last
 +
}}}}
  
;Basic use{{colon}}: <code><nowiki>{{Quote|text=Quoted material. |author=Attribution |source=Reference }}</nowiki></code>
+
;With more attribution{{colon}}
 +
{{markup|
 +
<nowiki>
 +
{{Quote
 +
|text=Quoted material.
 +
|author=First M. Last
 +
|title="Article Title"
 +
|source=''Book Title'' (date)
 +
}}</nowiki>|
 +
{{Quote
 +
|text=Quoted material.
 +
|author=First M. Last
 +
|title="Article Title"
 +
|source=''Book Title'' (date)
 +
}}}}
  
=== Parameters ===
+
;Example with "multiline"{{colon}}
 +
Especially useful for translated quotes; ''see [[#multiline|notes about this parameter]]''.
 +
* with "multiline" {{tick}}
 +
{{markup|
 +
<nowiki>
 +
{{quote|text=
 +
{{lang|fr|Ceci n’est pas une pipe.}}
 +
This is Not a Pipe.
 +
|multiline=yes
 +
|author=[[René Magritte]]
 +
|title=[[The Treachery of Images]]
 +
}}</nowiki>|
 +
{{quote|text=
 +
{{lang|fr|Ceci n’est pas une pipe.}}
 +
This is Not a Pipe.
 +
|multiline=yes
 +
|author=[[René Magritte]]
 +
|title=[[The Treachery of Images]]
 +
}}}}
 +
* for comparison without "multiline" {{cross}}
 +
{{markup|
 +
<nowiki>
 +
{{quote|text=
 +
{{lang|fr|Ceci n’est pas une pipe.}}
 +
This is Not a Pipe.
 +
|author=[[René Magritte]]
 +
|title=[[The Treachery of Images]]
 +
}}</nowiki>|
 +
{{quote|text=
 +
{{lang|fr|Ceci n’est pas une pipe.}}
 +
This is Not a Pipe.
 +
|author=[[René Magritte]]
 +
|title=[[The Treachery of Images]]
 +
}}}}
  
{{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.
+
;An ample example<!-- no pun intended -->{{colon}}
 +
{{markupv
 +
|markup=<syntaxhighlight 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</syntaxhighlight>
 +
|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}}
 +
}}
  
{{para|author}} a.k.a. {{para|2}}—Author/speaker attribution information that will appear below the quotation, and preceded with an attribution dash.
+
== Parameters ==
 +
=== Parameter list ===
 +
<pre>
 +
{{Quote
 +
| text      =
 +
| author   =
 +
| title    =
 +
| source    =
 +
| character =
 +
| multiline =
 +
| style    =
 +
}}
 +
</pre>
  
{{para|title}} a.k.a. {{para|3}}—Title of the work the quote appears in. 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]])}}. Secondary citation information can be provided in a fourth parameter, {{para|source}}, below, which will appear after the title.
+
See also section [[#TemplateData]].
  
{{para|source}} a.k.a. {{para|4}}—Can optionally be used for additional source information, after {{para|title}}, like so: {{para|title|"The Aerodynamics of Shaved Weasels"}}{{para|source|<nowiki>''Perspectives on Mammal Barbering''</nowiki>, 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>
+
=== Quoted text ===
 +
{{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.
  
{{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}}.
+
=== Displayed attribution ===
 +
These parameters are for {{em|displaying}} attribution information below the quote; this should not be confused with citing a source {{crossreference|(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 <syntaxhighlight lang="html" inline><ref>...</ref></syntaxhighlight> tag.
  
Technically, all citation information can be given in a single parameter, as in:
+
{{para|author}} a.k.a. {{para|2}} – optional author/speaker attribution information that will appear below the quotation, and preceded with an attribution dash.
<code><nowiki>|source=Anonymous interview subject, in Jane G. Arthur, "The Aerodynamics of Shaved Weasels", ''Perspectives on Mammal Barbering''(2016), Bram Xander Yojimbo (ed.)</nowiki></code>
 
But this is a bit messy, and will impede later efforts to generate metadata from quotation citations the way we are already doing with source citations. This is much more usable:
 
<code><nowiki>|character=Anonymous interview subject |author=Jane G. Arthur |title="The Aerodynamics of Shaved Weasels" |source=''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.)</nowiki></code>
 
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).
 
  
{{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|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 {{crossreference|(see [[MOS:TITLES]])}}. Additional citation information can be provided in a fourth parameter, {{para|source}}, below, which will appear after the title.
  
==Reference citations==
+
{{para|source}} a.k.a. {{para|4}} – optionally used for additional source information to display, after {{para|title}}, like so: {{code|lang=moin|code={{!}}title="The Aerodynamics of Shaved Weasels" {{!}}source=''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>
{{anchor|Attribution|reason=Old section name}}
 
A [[WP:Citing sources|reference citation]] can be placed:
 
<ul>
 
<li>In the regular-prose introduction to the quotation:<br /><code><nowiki>According to Pat Doe, in "Underwater Basketweaving Tips" (2015):<ref>...</ref> {{quote |text=Quoted material.}}</nowiki></code></li>
 
<li>At the end of the quotation, when a quotation is given without {{para|author}} or {{para|source}} (e.g. because the material before the quote makes it clear who is being quoted):<br /><code><nowiki>According to Pat Doe, in "Underwater Basketweaving Tips" (2015): {{quote |text=Quoted material.<ref>...</ref>}}</nowiki></code></li>
 
<li>After the quoted person's name, in {{para|author}}, when a {{para|source}} is not being added:<br /><code><nowiki>As noted in "Underwater Basketweaving Tips" (2015): {{quote |text=Quoted material. |author=Pat Doe<ref>...</ref>}}</nowiki></code></li>
 
<li>After the source title, in {{para|source}} (the preferred location when both attribution parameters are present):<br /><code><nowiki>One expert noted in 2015: {{quote |text=Quoted material. |author=Pat Doe |source="Underwater Basketweaving Tips"<ref>...</ref>}}</nowiki></code></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.
+
{{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}}.
  
== Style ==
+
Technically, all citation information can be given in a single parameter, as in: {{code|lang=moin|code={{!}}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:
Styling is applied through CSS rules in [[MediaWiki:Common.css]].
+
<syntaxhighlight lang="moin">
<syntaxhighlight lang=css>
+
|character=Anonymous interview subject
/* Styling for Template:Quote */
+
|author=Jane G. Arthur
blockquote.templatequote {
+
|title="The Aerodynamics of Shaved Weasels"
    margin-top: 0;
+
|source=''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.)
}
 
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>
 
<cite><div class="templatequotecite">—Author, Source</div></cite>
 
</blockquote>
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
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).
  
== Examples ==
+
=== Rarely used technical parameters ===
 +
* {{anchor|multiline}}{{para|multiline}} – keep forced linebreaks in output.<br>
 +
''Notes:''
 +
** Will only be applied if at least one of these other parameters or its aliases is not empty (including implicit, unnamed parameters):<br>{{para|author}}, {{para|title}}, {{para|source}}, or {{para|character}}.
 +
** The value does not matter, as long it is not empty. Using a so called speaking parameter (such as <code>true</code> or <code>yes</code>) is highly recommended. Avoid values that can surprise users (e.g. <code>false</code> or <code>no</code>).
 +
* {{para|style}} – allows specifying additional [[Help:Cascading Style Sheets|CSS]] styles ({{em|not}} classes) to apply to the {{code|lang=html|code=<blockquote>...</blockquote>}} element. {{Crossreference|(See [[#Nested quotations]], below, for the most common use case.)}}
  
{{markupv
+
== Reference citations ==
|markup=<nowiki>{{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}}</nowiki>
+
{{anchor|Attribution|reason=Old section name}}
|renders=
+
A [[WP:Citing sources|reference citation]] can be placed before the quote, after the quote, or in the {{para|source}} parameter:
{{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}}
+
{{bulleted list
 +
|{{tick}} {{stronggood|Typical use:}} In the regular-prose introduction to the quotation, when a quotation is given without the displayed {{para|author}}, {{para|title}}, or {{para|source}} parameters: <syntaxhighlight lang="html" inline>According to Pat Doe, in "Underwater Basketweaving Tips" (2015):<ref>...</ref> {{quote |text=Quoted material.}}</syntaxhighlight>
 +
|At the end of the quotation, when a quotation is given without the displayed {{para|author}}, {{para|title}}, or {{para|source}} 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: <syntaxhighlight lang="html" 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>}}</syntaxhighlight>
 +
|After the {{para|source}} value (if a value is given for the {{para|source}} parameter other than the <syntaxhighlight lang="html" inline><ref>...</ref></syntaxhighlight> itself):<syntaxhighlight lang="html" inline>One expert noted in 2015: {{quote |text=Quoted material. |author=Pat Doe |source="Underwater Basketweaving Tips" (2015)<ref>...</ref>}}</syntaxhighlight>
 +
|{{cross}} {{strongbad|Deprecated:}} <s>After the quoted person's name in {{para|author}}, or after the work's title in {{para|title}}, when a {{para|source}} parameter is not being added: <syntaxhighlight lang="html" inline>As noted in "Underwater Basketweaving Tips" (2015): {{quote |text=Quoted material. |author=Pat Doe<ref>...</ref>}}</syntaxhighlight></s><br />{{A note}} Please avoid this format, as it will pollute the author or title metadata with non-author or non-title information.
 
}}
 
}}
 +
 +
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;{{dummy reference}}<br />Please also do not put it just outside the {{tl|Quote}} template, as this will cause a:<br />{{in5}}{{dummy reference}}<br />on a line by itself.
  
 
== Limitations ==
 
== Limitations ==
Line 82: Line 153:
 
If you do not provide text, the template generates a parser error message, which will appear in red text in the rendered page.
 
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 named parameters or a blank-name parameter, as: <nowiki>{{{|text}}}</nowiki> (the text before the equals sign gets interpreted as a named parameter otherwise). Be wary of URLs, which frequently contain this character.
+
If any parameter's actual value contains an [[equals sign]] (<code>=</code>), you {{strong|must}} use a named parameter (e.g. <code>|text="E=MC<sup>2</sup>" is a formula everyone knows but few understand</code>, 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 and 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.
+
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 {{tlx|!}} and friends.
 
 
Put a break (newline) after the template, or the next blank line might be ignored.
 
 
 
=== Preserving line breaks and spacing from the original ===
 
Use {{tag|poem}} around material, such as poems and interlinear glosses, that require that whitespace formatting be preserve as in the original.  Due to limitations of how MediaWiki parses wikimarkup and HTML, attempts to do this by just inserting blank lines and extra spaces will not work.  This is true of all block elements, not just block quotations.
 
  
 
=== Next to right-floated boxes ===
 
=== 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:
+
{{As of|2015|09|post=,}} 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
 
# 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.
+
# using {{para|style|{{code|lang=css|code=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.
+
There may be other solutions, and future browser upgrades may eliminate the issue. It arises at all because of the <syntaxhighlight lang="css" inline>blockquote {overflow: hidden;}</syntaxhighlight> 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 ===
 
=== 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.
+
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|{{code|lang=css|code=overflow:inherit;}}}} to such an instance of the template.
  
 
=== Line breaks ===
 
=== Line breaks ===
 +
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:<br />{{in5}}text here {{template link with parameters|Quote|this is quoted}} More text here<br />spans a blank line, unless a {{template link with parameters|Quote|...}} is ended with a line break, then the next blank line might be ignored and two paragraphs joined.
 +
 
{{Blockquote paragraphs}}
 
{{Blockquote paragraphs}}
 +
 +
=== Nested quotations ===
 +
The {{code|lang=html|code=<blockquote>...</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. To fix this issue, add the parameter {{para|style|{{code|lang=css|font-size:inherit;}}}} 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}}.
 +
 +
=== Tracking category ===
 +
Articles that use unsupported parameters are placed in {{clc|Pages using quote template with unknown parameters}}.
  
 
== TemplateData ==
 
== TemplateData ==
{{TemplateDataHeader}}
+
{{TemplateData header}}<templatedata>
<templatedata>
 
 
{
 
{
 
"description": "Adds a block quotation.",
 
"description": "Adds a block quotation.",
Line 120: Line 199:
 
"example": "Cry \"Havoc\" and let slip the dogs of war."
 
"example": "Cry \"Havoc\" and let slip the dogs of war."
 
},
 
},
"sign": {
+
"author": {
"label": "sign",
+
"label": "author",
"description": "The person being quoted",
+
"description": "The writer of the source",
 
"type": "content",
 
"type": "content",
 
"required": false,
 
"required": false,
Line 128: Line 207:
 
"2",
 
"2",
 
"cite",
 
"cite",
"author"
+
"sign"
 
],
 
],
"example": "[[William Shakespeare]]",
+
"example": "William Shakespeare",
 +
"suggested": true
 +
},
 +
"title": {
 +
"label": "title",
 +
"description": "The work being quoted from",
 +
"type": "content",
 +
"required": false,
 +
"aliases": [
 +
"3"
 +
],
 +
"example": "Julius Caesar",
 
"suggested": true
 
"suggested": true
 
},
 
},
Line 139: Line 229:
 
"required": false,
 
"required": false,
 
"aliases": [
 
"aliases": [
"3"
+
"4"
 
],
 
],
"example": "''[[Julius Caesar (play)|Julius Caesar]]'', act III, scene I",
+
"example": "act III, scene I",
 
"suggested": true
 
"suggested": true
 +
},
 +
"character": {
 +
"label": "character",
 +
"description": "The speaker within the work who is being quoted",
 +
"type": "content",
 +
"required": false,
 +
"aliases": [
 +
"5"
 +
],
 +
"example": "Mark Antony",
 +
"suggested": false
 +
},
 +
        "multiline": {
 +
"label": "multiline",
 +
"description": "Keeps forced linebreaks in output",
 +
"type": "string",
 +
"required": false,
 +
"example": "true",
 +
"suggested":  false
 +
},
 +
"style": {
 +
"label": "style",
 +
"description": "Additional CSS styles (not classes) to apply",
 +
"type": "string",
 +
"required": false,
 +
"example": "font-size:inherit;",
 +
"suggested":  false
 
}
 
}
 
}
 
}
}
+
}</templatedata>
</templatedata>
 
 
 
== Errors ==
 
Pages where this template is not used correctly populate [[:Category:Pages incorrectly using the quote template]].
 
 
 
== Known problems ==
 
This template sets a text style which might ignore one blank line, and so the template must be ended with a break (newline). Otherwise, beware inline, as:
 
::* text here <nowiki>{{quote|this is quoted}}</nowiki> More text here spans a blank line
 
Unless a <nowiki>{{quote|xx}}</nowiki> is ended with a line break, then the next blank line might be ignored and two paragraphs joined.
 
 
 
== See also ==
 
{{Quotation templates}}
 
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|
+
{{Quotation templates}}<includeonly>
| <!-- ADD CATEGORIES AFTER THIS LINE, PLEASE: -->
+
{{Sandbox other||
 +
<!-- ADD CATEGORIES AFTER THIS LINE, PLEASE: -->
 
[[Category:Quotation templates]]
 
[[Category:Quotation templates]]
 +
[[Category:Wikipedia XHTML tag-replacing templates]]
 +
[[Category:Templates that add a tracking category]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 17:11, 5 September 2020

Script error: No such module "Uses TemplateStyles".


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

{{Quote}} adds a block quotation to an article page.

This is easier to type and is more wiki-like than the equivalent HTML <blockquote>...</blockquote> tags, and has additional pre-formatted attribution parameters for author and source (though these are not usually used in articles; see Script error: No such module "Section link"., below).

Note: Block quotes do not normally contain quotation marks (see MOS:BLOCKQUOTE).

Examples

Basic use:
Markup Renders as
{{Quote
|text=Quoted material.
}}

Quoted material.

With attribution displayed:
Markup Renders as
{{Quote
|text=Quoted material.
|author=First M. Last
}}

Quoted material.

— Script error: No such module "If empty"., Script error: No such module "If empty"., Script error: No such module "If empty".
With more attribution:
Markup Renders as
{{Quote
|text=Quoted material.
|author=First M. Last
|title="Article Title"
|source=''Book Title'' (date)
}}

Quoted material.

— Script error: No such module "If empty"., Script error: No such module "If empty"., Script error: No such module "If empty".
Example with "multiline":

Especially useful for translated quotes; see notes about this parameter.

  • with "multiline" ☑Y
Markup Renders as
{{quote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
|multiline=yes
|author=[[René Magritte]]
|title=[[The Treachery of Images]]
}}

Ceci n’est pas une pipe.

This is Not a Pipe.

— Script error: No such module "If empty"., Script error: No such module "If empty"., Script error: No such module "If empty".
  • for comparison without "multiline"
  1. REDIRECT Template:Xmark
Markup Renders as
{{quote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
|author=[[René Magritte]]
|title=[[The Treachery of Images]]
}}

Ceci n’est pas une pipe. This is Not a Pipe.

— Script error: No such module "If empty"., Script error: No such module "If empty"., Script error: No such module "If empty".
An ample example:
Markup
{{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
Renders as

Cry "Havoc" and let slip the dogs of war.

— Mark Antony, in Script error: No such module "If empty"., Script error: No such module "If empty"., Script error: No such module "If empty".

Parameters

Parameter list

{{Quote
| text      =
| author    =
| title     =
| source    =
| character =
| multiline =
| style     =
}}

See also section #TemplateData.

Quoted text

|text= a.k.a. |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 non-escaped "=" character (e.g., in a URL in a source citation) will break the template.

Displayed attribution

These parameters are for displaying attribution information below the quote; this should not be confused with citing a source (see Script error: No such module "Section link"., 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 <ref>...</ref> tag.

|author= a.k.a. |2= – optional author/speaker attribution information that will appear below the quotation, and preceded with an attribution dash.

|title= a.k.a. |3= – optional title of the work the quote appears in, to display below the quotation. This parameter immediately follows the output of |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 (see MOS:TITLES). Additional citation information can be provided in a fourth parameter, |source=, below, which will appear after the title.

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

|character= a.k.a. |char= – to attribute fictional speech to a fictional character, 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 "[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 |author= parameter instead of |character=.

Technically, all citation information can be given in a single parameter, as in: |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:

|character=Anonymous interview subject
|author=Jane G. Arthur
|title="The Aerodynamics of Shaved Weasels"
|source=''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.)

Later development can assign a CSS class 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

  • |multiline= – keep forced linebreaks in output.

Notes:

    • Will only be applied if at least one of these other parameters or its aliases is not empty (including implicit, unnamed parameters):
      |author=, |title=, |source=, or |character=.
    • The value does not matter, as long it is not empty. Using a so called speaking parameter (such as true or yes) is highly recommended. Avoid values that can surprise users (e.g. false or no).
  • |style= – allows specifying additional CSS styles (not classes) to apply to the <blockquote>...</blockquote> element. (See #Nested quotations, below, for the most common use case.)

Reference citations

A reference citation can be placed before the quote, after the quote, or in the |source= parameter:

  • ☑Y Typical use: In the regular-prose introduction to the quotation, when a quotation is given without the displayed |author=, |title=, or |source= parameters: According to Pat Doe, in "Underwater Basketweaving Tips" (2015):<ref>...</ref> {{quote |text=Quoted material.}}
  • At the end of the quotation, when a quotation is given without the displayed |author=, |title=, or |source= 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: Pat Doe and Chris Foo took opposing positions: {{quote |text=Doe's Quoted material.<ref>...</ref>}} {{quote |text=Foo's Quoted material.<ref>...</ref>}}
  • After the |source= value (if a value is given for the |source= parameter other than the <ref>...</ref> itself):One expert noted in 2015: {{quote |text=Quoted material. |author=Pat Doe |source="Underwater Basketweaving Tips" (2015)<ref>...</ref>}}
    1. REDIRECT Template:Xmark
    Deprecated: After the quoted person's name in |author=, or after the work's title in |title=, when a |source= parameter is not being added: As noted in "Underwater Basketweaving Tips" (2015): {{quote |text=Quoted material. |author=Pat Doe<ref>...</ref>}}
    Note: Please avoid this format, as it will pollute the author or title metadata with non-author or non-title information.

Please do not place the citation in a |author= or |source= parameter by itself, as it will produce a nonsensical attribution line that looks like:
     — [1]
Please also do not put it just outside the {{Quote}} template, as this will cause a:
     [1]
on a line by itself.

Limitations

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 (=), you must use a named parameter (e.g. |text="E=MC2" 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 and other templates.

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

Next to right-floated boxes

As of September 2015, the text of a block quotation may rarely overflow (in Firefox or other Gecko browsers) a right-floated item (e.g. a {{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:

  1. removing the sizing on the upper item and letting it use its default size (e.g. removing ###x###px sizing or |upright= from a right-floated image above a wider right-floated object that is being overflowed by quotation text; or
  2. using |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 blockquote {overflow: hidden;} CSS declaration in Mediawiki:Common.css, which itself works around other, more common display problems. A solution that fixes 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 |style=overflow:inherit; to such an instance of the template.

Line breaks

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 {{Quote|this is quoted}} More text here
spans a blank line, unless a {{Quote|...}} is ended with a line break, then the next blank line might be ignored and two paragraphs joined.


(This section is transcluded from Template:Blockquote paragraphs)

The <blockquote> element and any templates that use it do not honor newlines:

Markup Renders as
<blockquote>
Line 1
Line 2
Line 3
Line 4
</blockquote>

Line 1 Line 2 Line 3 Line 4

An easy solution is to use the {{poemquote}} template instead of <blockquote>...</blockquote>. This is effectively the same as using the <poem> tag inside <blockquote>, which converts line breaks to <br /> tags:

Markup Renders as
<blockquote><poem>
Line 1
Line 2
Line 3
Line 4
</poem></blockquote>

Line 1
Line 2
Line 3
Line 4

To markup actual paragraphs within block quotations, entire blank lines can be used between them, which will convert to <p>...</p> tags:

Markup Renders as
<blockquote>
Paragraph 1

Paragraph 2

Paragraph 3
</blockquote>

Paragraph 1

Paragraph 2

Paragraph 3

Note that it may be necessary to put a line break in the wikitext before <blockquote> and after </blockquote> in order for the paragraphs to render with the intended separation. (This also makes the wikitext easier to read.)

This paragraph style also works with {{quote}}, which is a replacement for <blockquote> that also has parameters to make formatting of the attribution more convenient and consistent.

Blockquote and templates that call it, and are indented with colon (:), bulleted with asterisk (*), or numbered with number (#), will generate errors and incorrectly display anything after a newline character.

Markup Renders as
:<blockquote>Paragraph 1
Paragraph 2</blockquote>

Paragraph 1

Paragraph 2
Markup Renders as
*<blockquote>Paragraph 1
Paragraph 2</blockquote>
  • Paragraph 1

Paragraph 2
Markup Renders as
#<blockquote>Paragraph 1
Paragraph 2</blockquote>
  1. Paragraph 1

Paragraph 2

Nested quotations

The <blockquote>...</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. To fix this issue, add the parameter |style=font-size:inherit; on any inner {{Quote}} templates.

Technical issues with block templates

If the block-formatted content begins with a list (or any other wikimarkup that is dependent upon a specific markup character being at the beginning of a line) then due to a bug in MediaWiki, a <nowiki /> must exist before the list (or whatever) starts. Compare:

  code result
FAIL
 {{Quote|1=
 *Firstly, ...
 *Secondly, ...
 *Thirdly, ...
 }}

*Firstly, ...

  • Secondly, ...
  • Thirdly, ...
Works as intended

{{Quote|1=<nowiki /> *Firstly, ... *Secondly, ... *Thirdly, ... }}

  • Firstly, ...
  • Secondly, ...
  • Thirdly, ...

To embed a table in block markup like this, the block template's content parameter must be named or numbered and include the self-closing noinclude – as in |1=<nowiki /> – then every | character in the table markup must be escaped with {{!}}. An alternative is to use explicit HTML <table>, <tr>, <th>, and <td> markup.

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 |class=, |id=, |diff=, |4=, or |5=.

Tracking category

Articles that use unsupported parameters are placed in Category:Pages using quote template with unknown parameters (0).

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Quote

Adds a block quotation.

Template parameters

ParameterDescriptionTypeStatus
texttext 1 quote

The text to quote

Example
Cry "Havoc" and let slip the dogs of war.
Contentrequired
authorauthor 2 cite sign

The writer of the source

Example
William Shakespeare
Contentsuggested
titletitle 3

The work being quoted from

Example
Julius Caesar
Contentsuggested
sourcesource 4

A source for the quote

Example
act III, scene I
Contentsuggested
charactercharacter 5

The speaker within the work who is being quoted

Example
Mark Antony
Contentoptional
multilinemultiline

Keeps forced linebreaks in output

Example
true
Stringoptional
stylestyle

Additional CSS styles (not classes) to apply

Example
font-size:inherit;
Stringoptional