Template:Blockquote/doc: Difference between revisions

Jump to navigation Jump to search
Content added Content deleted
VisualWikitext
(→‎Parameters: add ===Parameter list===)
(Update; some of this stuff has changed, but the docs didn't get updated.)
Line 10: Line 10:
'''Note:''' Block quotes do {{em|not}} normally contain quotation marks {{crossref|(see [[MOS:Blockquote]])}}.
'''Note:''' Block quotes do {{em|not}} normally contain quotation marks {{crossref|(see [[MOS:Blockquote]])}}.


=== Synopsis ===
=== Examples ===


;Basic use{{colon}}:
;Basic use{{colon}}: <code><nowiki>{{Quote|text=Quoted material. |author=Attribution |title=Reference }}</nowiki></code>
<pre>{{Quote
|text=Quoted material.
}}</pre>


;With attribution displayed{{colon}}:
⚫
=== Parameters ===
<pre>{{Quote
|text=Quoted material.
|author=First M. Last
}}</pre>

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


⚫
== Parameters ==


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


=== Displayed attribution ===
⚫
{{para|author}} a.k.a. {{para|2}}—Author/speaker attribution information that will appear below the quotation, and preceded with an attribution dash.
These parameters for for {{em|displaying}} attribution information below the quote; this should not be confused with a citing a source {{crossref(see [[#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 introductory line immediately before the quotation, with a normal {{tag|ref}} tag.

⚫
{{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}}—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.
{{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 {{crossref|(see [[MOS:TITLES]])}}. Additional citation information can be provided in a fourth parameter, {{para|source}}, below, which will appear after the title.


{{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>
{{para|source}} a.k.a. {{para|4}}—Optionally used for additional source information to display, 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>


{{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}}.
{{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}}.
Line 28: Line 47:
Technically, all citation information can be given in a single parameter, as in:
Technically, all citation information can be given in a single parameter, as in:
<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>
<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:
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:
<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>
<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).
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===
{{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|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|style}}—allows specifying additional [[Help:Cascading Style Sheets|CSS]] styles (''not'' classes) to apply to the {{tag|blockquote}} element. For example, when putting a quotation inside a quotation, use <code>style=font-size:inherit</code> on the inner quotations so that the text doesn't get unreadably small or (on mobile) too large for the screen.
{{para|style}}—allows specifying additional [[Help:Cascading Style Sheets|CSS]] styles (''not'' classes) to apply to the {{tag|blockquote}} element. {{Crossref|(See [[#Nested quotations]], below, for the most common use case.)}}


====Parameter list====
===Parameter list===
<pre>
<pre>
{{Quote
{{Quote
Line 51: Line 71:
==Reference citations==
==Reference citations==
{{anchor|Attribution|reason=Old section name}}
{{anchor|Attribution|reason=Old section name}}
A [[WP:Citing sources|reference citation]] can be placed:
A [[WP:Citing sources|reference citation]] can be placed before the quote, after the quote, or in the <code>source</code> parameter:
<ul>
<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>'''Typical use''': In the regular-prose introduction to the quotation, when a quotation is given without the displayed <code>author</code>, <code>title</code>, or <code>source</code> parameters:<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>At the end of the quotation, when a quotation is given without the displayed <code>author</code>, <code>title</code>, or <code>source</code> 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:<br /><code><nowiki>Pat Doe and Chris Foo took opposing positions: {{quote |text=Doe's Quoted material.<ref>...</ref>}} {{quote |text=Foo's 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 <code>source</code> value (if a value is given for the <code>source</code> parameter other than the {{tag|ref}} itself):<br /><code><nowiki>One expert noted in 2015: {{quote |text=Quoted material. |author=Pat Doe |source="Underwater Basketweaving Tips" (2015)<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>
<li>{{strongbad|Deprecated}}: <s>After the quoted person's name in <code>author</code>, or after the work's title in <code>title</code>, when a <code>source</code> parameter 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></s><br />Please avoid that format, as it will pollute the author or title metadata with non-author or non-title information.</li>
</ul>
</ul>


Retrieved from ‘https://privacywiki.xyz/wiki/Template:Blockquote/doc’