Template:Quote/doc: Difference between revisions

Nothing to hide, but nothing to show you either.
Jump to navigation Jump to search
Content added Content deleted
m (missing word)
m (11 revisions imported from templatewiki:Template:Quote/doc)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}

{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}


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

This is easier to type and is more wiki-like than the equivalent [[HTML]] {{tag|blockquote}} tags, and has additional pre-formatted attribution parameters for author and source (though these are not usually used in articles; {{crossref|see {{section link||Reference citations}}, below}}).


This is easier to type and is more wiki-like than the equivalent [[w:HTML|HTML]] {{tag|blockquote}} tags, and has additional pre-formatted attribution parameters for author and source.
'''Note:''' Block quotes do {{em|not}} normally contain quotation marks {{crossref|(see [[MOS:BLOCKQUOTE]])}}.


{{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.}}
{{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.}}
Line 40: Line 36:
{{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|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 {{crossref|(see [[MOS:TITLES]])}}. Additional 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.


{{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|{{code|2=moin|''Perspectives on Mammal Barbering'', 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|{{code|2=moin|''Perspectives on Mammal Barbering'', 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 [[w:pull quote|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 75: 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 before the quote, after the quote, or in the <code>source</code> parameter:
A [[w:Wikipedia:Citing sources|reference citation]] can be placed before the quote, after the quote, or in the <code>source</code> parameter:
<ul>
<ul>
<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:<source lang="xml" inline>According to Pat Doe, in "Underwater Basketweaving Tips" (2015):<ref>...</ref> {{quote |text=Quoted material.}}</source></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:<source lang="xml" inline>According to Pat Doe, in "Underwater Basketweaving Tips" (2015):<ref>...</ref> {{quote |text=Quoted material.}}</source></li>
Line 121: Line 117:
If you do not provide text, the template generates a parser error message, which will appear in red text in the rendered page.
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 '''must''' use a named parameter (e.g. {{para|text|"E=MC<sup>2</sup>" is a formula everyone knows but few understand}}, 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. Named parameters are always safer, in this an other templates.
If any parameter's actual value contains an equals sign (<code>=</code>), you '''must''' use a named parameter (e.g. {{para|text|"E=MC<sup>2</sup>" is a formula everyone knows but few understand}}, 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. Named parameters are always safer, in this an other templates.


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 [[Template:!]] and friends.
If any parameter's actual value contains characters used for wiki markup syntax (such as pipe, brackets, single quotation marks, etc.), you may need to escape it. See [[Template:!]] and friends.


=== Next to right-floated boxes ===
=== Next to right-floated boxes ===

Latest revision as of 19:51, 31 May 2021

Usage[edit source]

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

Examples[edit source]

Basic use:
{{Quote
|text=Quoted material.
}}
With attribution displayed:
{{Quote
|text=Quoted material.
|author=First M. Last
}}
With more attribution:
{{Quote
|text=Quoted material.
|author=First M. Last |title="Article Title"  |source=''Book Title'' (date)
}}

Parameters[edit source]

|text= a.k.a. |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 non-escaped "=" character (e.g., in a URL in a source citation) will break the template.

Displayed attribution[edit source]

These parameters for for displaying attribution information below the quote; this should not be confused with a citing a source