Template:Blockquote/doc: Difference between revisions

m
198 revisions imported from wikipedia:Template:Blockquote/doc
(no such parameter)
m (198 revisions imported from wikipedia:Template:Blockquote/doc)
 
(18 intermediate revisions by 7 users not shown)
Line 1:
{{Documentation subpage}}
{{Uses TemplateStyles|Template:Quote{{BASEPAGENAME}}/styles.css}}
{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}
{{High-risk|120,000+}}
 
{{Quote{{BASEPAGENAME}}/doc/boilerplate|mos-recommended=yes}}
 
== Usage ==
{{tlxtlc|Quote{{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}}).
Line 15 ⟶ 16:
 
=== Examples ===
;Basic use{{colon}}:
{{markup|
<nowiki>{{QuoteBlockquote
|text=Quoted material.
}} </nowiki>|{{QuoteBlockquote
|text=Quoted material.
}}}}
}}}}<!-- Template:Mra -->
 
;With attribution displayed{{colon}}:
{{markup|
<nowiki>{{QuoteBlockquote
|text=Quoted material.
|author=First M. Last
}} </nowiki>|{{QuoteBlockquote
|text=Quoted material.
|author=First M. Last
}}}}
}}}}<!-- Template:Mra -->
 
;With more attribution{{colon}}:
{{markup|
<nowiki>
{{Blockquote
{{Quote
|text=Quoted material.
|author=First M. Last
|title="Article Title"
|source=''Book Title'' (date)
}} </nowiki>|
{{Blockquote
{{Quote
|text=Quoted material.
|author=First M. Last
|title="Article Title"
|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 ==
=== 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.
 
Line 73 ⟶ 132:
 
=== 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 =
}}
</pre>
 
== Reference citations ==
Line 91 ⟶ 143:
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> {{quoteblockquote |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: {{quoteblockquote |text=Doe's Quoted material.<ref>...</ref>}} {{quoteblockquote |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: {{quoteblockquote |text=Quoted material. |author=Pat Doe |source="Underwater Basketweaving Tips" (2015)<ref>...</ref>}}</syntaxhighlight>
|{{crossxmark}} {{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): {{quoteblockquote |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 {{tltlf|Quoteblockquote}} 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 ==
Line 123 ⟶ 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 {{template link with parameterstlf|Quoteblockquote|this is quoted}} More text here<br />spans a blank line, unless a {{template link with parameterstlf|Quoteblockquote|...}} 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. To fix this issue, add the parameter {{para|style|{{code|lang=css|font-size:inherit;}}}} on any inner {{tltlf|Quoteblockquote}} templates.
 
=== Technical issues with block templates ===
Line 136 ⟶ 182:
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}}.
 
Line 167 ⟶ 214:
"suggested": true
},
"title": {
"label": "title",
"description": "The sourcework being quoted from",
"type": "content",
"required": false,
Line 189 ⟶ 236:
"suggested": true
},
"character": {
"label": "character",
"description": "The speaker within the work who is being quoted",
Line 200 ⟶ 247:
"suggested": false
},
"stylemultiline": {
"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
}
Line 215 ⟶ 279:
[[Category:Quotation templates]]
[[Category:Wikipedia XHTML tag-replacing templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>