Template:Blockquote/doc: Difference between revisions

Nothing to hide, but nothing to show you either.
Jump to navigation Jump to search
Content added Content deleted
m (198 revisions imported from wikipedia:Template:Blockquote/doc)
 
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{Uses TemplateStyles|Template:Quote/styles.css}}
{{Uses TemplateStyles|Template:{{BASEPAGENAME}}/styles.css}}
{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}
{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}
{{High-risk|120,000+}}


{{Quote/doc/boilerplate|mos-recommended=yes}}
{{{{BASEPAGENAME}}/doc/boilerplate|mos-recommended=yes}}


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


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}}).
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}}).
Line 15: Line 16:


=== Examples ===
=== Examples ===
;Basic use{{colon}}:
;Basic use{{colon}}
{{markup|
{{markup|
<nowiki>{{Quote
<nowiki>{{Blockquote
|text=Quoted material.
|text=Quoted material.
}} </nowiki>|{{Quote
}}</nowiki>|{{Blockquote
|text=Quoted material.
|text=Quoted material.
}}}}
}}}}<!-- Template:Mra -->


;With attribution displayed{{colon}}:
;With attribution displayed{{colon}}
{{markup|
{{markup|
<nowiki>{{Quote
<nowiki>{{Blockquote
|text=Quoted material.
|text=Quoted material.
|author=First M. Last
|author=First M. Last
}} </nowiki>|{{Quote
}}</nowiki>|{{Blockquote
|text=Quoted material.
|text=Quoted material.
|author=First M. Last
|author=First M. Last
}}}}
}}}}<!-- Template:Mra -->


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

;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 ==
== 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.
{{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.


Line 73: Line 132:


=== Rarely used technical parameters ===
=== Rarely used technical parameters ===
* {{anchor|multiline}}{{para|multiline}} – keep forced linebreaks in output.<br>
{{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.)}}
''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}}.
=== Parameter list ===
** 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>).
<pre>
* {{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.)}}
{{Quote
* {{para|class}} – allows specifying additional HTML classes to apply to the same element.
| text =
| author =
| title =
| source =
| character =
| style =
| notrim =
}}
</pre>


== Reference citations ==
== Reference citations ==
Line 92: Line 143:
A [[WP:Citing sources|reference citation]] can be placed before the quote, after the quote, or in the {{para|source}} parameter:
A [[WP:Citing sources|reference citation]] can be placed before the quote, after the quote, or in the {{para|source}} parameter:
{{bulleted list
{{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>
|{{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> {{blockquote |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>
|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: {{blockquote |text=Doe's Quoted material.<ref>...</ref>}} {{blockquote |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>
|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: {{blockquote |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.
|{{xmark}} {{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): {{blockquote |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.
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 {{tlf|blockquote}} template, as this will cause a:<br />{{in5}}{{dummy reference}}<br />on a line by itself.

== Examples ==
{{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 |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 I}}</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}}
}}


== Limitations ==
== Limitations ==
Line 124: Line 169:


=== 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.
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}}
{{Blockquote paragraphs}}


=== Nested quotations ===
=== 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.
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 {{tlf|blockquote}} templates.


=== Mis-detection of wikimarkup ===
=== Technical issues with block templates ===
{{Block bug documentation}}
The template uses {{tlx|trim quotes}} to remove quotation marks from around quotations when put into block format (per [[MOS:BQ]]). However, if the quoted material happens to both begin and end with italics in {{kbd|<nowiki>''</nowiki>}} format or boldface in {{kbd|<nowiki>'''</nowiki>}} format, these will be partially mis-detected as regular quotation marks, which will result in unintended output. There are several workarounds for this problem:
* Insert <code>&lt;nowiki /&gt;</code> at the beginning of the quoted material, before any {{kbd|<nowiki>''</nowiki>}} or {{kbd|<nowiki>'''</nowiki>}} markup
* Change the {{kbd|<nowiki>''</nowiki>}} markup to explicit HTML {{tag|i}}, and {{kbd|<nowiki>'''</nowiki>}} to {{tag|b}}
* add the parameter {{para|notrim|y}} (or any other value, e.g. {{para|notrim|yes}}, {{para|notrim|1}}).
Use of any of these will have the effect of suppressing quotation-marks trimming entirely. A more robust solution at [[Template talk:Trim Quotes]] is being sought so that these work-arounds are not necessary.


== Errors ==
== 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}}.
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}}.
Articles that use unsupported parameters are placed in {{clc|Pages using quote template with unknown parameters}}.


Line 172: Line 214:
"suggested": true
"suggested": true
},
},
"title": {
"title": {
"label": "title",
"label": "title",
"description": "The source being quoted from",
"description": "The work being quoted from",
"type": "content",
"type": "content",
"required": false,
"required": false,
Line 194: Line 236:
"suggested": true
"suggested": true
},
},
"character": {
"character": {
"label": "character",
"label": "character",
"description": "The speaker within the work who is being quoted",
"description": "The speaker within the work who is being quoted",
Line 205: Line 247:
"suggested": false
"suggested": false
},
},
"style": {
"multiline": {
"label": "multiline",
"description": "Keeps forced linebreaks in output",
"type": "string",
"required": false,
"example": "true",
"suggested": false
},
"style": {
"label": "style",
"label": "style",
"description": "Additional CSS styles (not classes) to apply",
"description": "Additional CSS styles (not classes) to apply",
"type": "string",
"required": false,
"required": false,
"example": "font-size:inherit;",
"example": "font-size:inherit;",
"suggested": false
},
"class": {
"label": "class",
"description": "Additional HTML classes to apply",
"type": "string",
"required": false,
"example": "pullquote",
"suggested": false
"suggested": false
}
}
Line 220: Line 279:
[[Category:Quotation templates]]
[[Category:Quotation templates]]
[[Category:Wikipedia XHTML tag-replacing templates]]
[[Category:Wikipedia XHTML tag-replacing templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>
}}</includeonly>

Latest revision as of 19:47, 31 May 2021

Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab.

Lua error in package.lua at line 80: module 'Module:Transclusion_count/data/B' not found.


The Manual of Style guidelines for block quotations recommend formatting block quotations using the {{Blockquote}} 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[edit source]

{{Blockquote}} 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;