440
edits
(quote -> text for consistency) |
m (198 revisions imported from wikipedia:Template:Blockquote/doc) |
||
(30 intermediate revisions by 14 users not shown) | |||
Line 1:
{{Documentation subpage}}
{{Uses TemplateStyles|Template:
{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}
{{High-risk|120,000+}}
{{{{BASEPAGENAME}}/doc/boilerplate|mos-recommended=yes}}
== Usage ==
{{
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; {{
'''Note:''' Block quotes do {{em|not}} normally contain quotation marks {{
{{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}}
{{markup|
<nowiki>{{
|text=Quoted material.
}}
|text=Quoted material.
}}}}
;With attribution displayed{{colon}}
{{markup|
<nowiki>{{
|text=Quoted material.
|author=First M. Last
}}
|text=Quoted material.
|author=First M. Last
}}}}
;With more attribution{{colon}}
{{markup|
<nowiki>
{{Blockquote
|text=Quoted material.
|author=First M. Last
|title="Article Title"
|source=''Book Title'' (date)
}}
{{Blockquote
|text=Quoted material.
|author=First M. Last
|title="Article Title"
|source=''Book Title'' (date)
}}}}
;Example with "multiline"{{colon}}
Especially useful for translated quotes; ''see [[#multiline|notes about this parameter]]''.
* with "multiline" {{tick}}
{{markup|
<nowiki>
{{blockquote|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>|
{{blockquote|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" {{xmark}}
{{markup|
<nowiki>
{{blockquote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
|author=[[René Magritte]]
|title=[[The Treachery of Images]]
}}</nowiki>|
{{blockquote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
|author=[[René Magritte]]
|title=[[The Treachery of Images]]
}}}}
;An ample example<!-- no pun intended -->{{colon}}
{{markupv
|markup=<syntaxhighlight lang="moin">{{Blockquote|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}}</syntaxhighlight>
|renders={{Blockquote|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}}
}}
== Parameters ==
=== Parameter list ===
<pre>
{{Blockquote
| text =
| author =
| title =
| source =
| character =
| multiline =
| class =
| style =
}}
</pre>
See also section [[#TemplateData]].
=== 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.
=== Displayed attribution ===
These parameters
{{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 {{
{{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.
{{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.
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:
Line 72 ⟶ 131:
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 ===
* {{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.)}}
* {{para|class}} – allows specifying additional HTML classes to apply to the same element.
== 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 {{para|source}} parameter:
{{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> {{
|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: {{
|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: {{
|{{
}}
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}}— {{
== Limitations ==
Line 112 ⟶ 155:
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 {{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.
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.
=== Next to right-floated boxes ===
{{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.
# 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|{{code|lang=css|code=overflow:inherit;}}}} in the quotation template.
Line 126 ⟶ 169:
=== 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 {{tlf|blockquote|this is quoted}} More text here<br />spans a blank line, unless a {{tlf|blockquote|...}} is ended with a line break, then the next blank line might be ignored and two paragraphs joined.
{{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
=== Technical issues with block templates ===
Line 138 ⟶ 181:
== 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 header}}<templatedata>
{
"description": "Adds a block quotation.",
Line 156 ⟶ 201:
"example": "Cry \"Havoc\" and let slip the dogs of war."
},
"
"label": "
"description": "The
"type": "content",
"required": false,
Line 164 ⟶ 209:
"2",
"cite",
"
],
"example": "
"suggested": true
},
"title": {
"label": "title",
"description": "The work being quoted from",
"type": "content",
"required": false,
"aliases": [
"3"
],
"example": "Julius Caesar",
"suggested": true
},
Line 175 ⟶ 231:
"required": false,
"aliases": [
"
],
"example": "
"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
},
"class": {
"label": "class",
"description": "Additional HTML classes to apply",
"type": "string",
"required": false,
"example": "pullquote",
"suggested": false
}
}
}</templatedata>
{{Quotation templates}}<includeonly>
{{Sandbox other||
<!-- ADD CATEGORIES AFTER THIS LINE, PLEASE: -->
[[Category:Quotation templates]]
[[Category:Wikipedia XHTML tag-replacing templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>
|