Template:Blockquote/doc: Difference between revisions

m
198 revisions imported from wikipedia:Template:Blockquote/doc
m (→‎Usage: bypass redir)
m (198 revisions imported from wikipedia:Template:Blockquote/doc)
 
(5 intermediate revisions by 4 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 18:
;Basic use{{colon}}
{{markup|
<nowiki>{{QuoteBlockquote
|text=Quoted material.
}}</nowiki>|{{QuoteBlockquote
|text=Quoted material.
}}}}
Line 26:
;With attribution displayed{{colon}}
{{markup|
<nowiki>{{QuoteBlockquote
|text=Quoted material.
|author=First M. Last
}}</nowiki>|{{QuoteBlockquote
|text=Quoted material.
|author=First M. Last
Line 37:
{{markup|
<nowiki>
{{Blockquote
{{Quote
|text=Quoted material.
|author=First M. Last
Line 43:
|source=''Book Title'' (date)
}}</nowiki>|
{{Blockquote
{{Quote
|text=Quoted material.
|author=First M. Last
Line 55:
{{markup|
<nowiki>
{{quoteblockquote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
Line 62:
|title=[[The Treachery of Images]]
}}</nowiki>|
{{quoteblockquote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
Line 72:
{{markup|
<nowiki>
{{quoteblockquote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
Line 78:
|title=[[The Treachery of Images]]
}}</nowiki>|
{{quoteblockquote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
Line 87:
;An ample example<!-- no pun intended -->{{colon}}
{{markupv
|markup=<syntaxhighlight lang="moin">{{QuoteBlockquote|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={{QuoteBlockquote|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}}
}}
 
Line 94:
=== Parameter list ===
<pre>
{{Blockquote
{{Quote
| text =
| author =
Line 101:
| character =
| multiline =
| class =
| style =
}}
Line 136 ⟶ 137:
** 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 ==
Line 141 ⟶ 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.
 
== Limitations ==
Line 167 ⟶ 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 259 ⟶ 261:
"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
}