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
(→‎Line breaks: put in a better order, to separate things for this template specifically vs. blockquote templates in general)
m (some source code clean-up)
Line 13: Line 13:


=== Examples ===
=== Examples ===

;Basic use{{colon}}:
;Basic use{{colon}}:
{{markup|
{{markup|
Line 22: Line 21:
}}}}<!-- Template:Mra -->
}}}}<!-- Template:Mra -->


;With attribution displayed{{colon}}:
;With attribution displayed{{colon}}:
{{markup|
{{markup|
<nowiki>{{Quote
<nowiki>{{Quote
Line 49: Line 48:


== Parameters ==
== 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.


Line 55: Line 53:
These parameters for for {{em|displaying}} attribution information below the quote; this should not be confused with a citing a source {{crossref|(see {{section link||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 the introductory line immediately before the quotation, with a normal <syntaxhighlight lang="html" inline><ref>...</ref></syntaxhighlight> tag.
These parameters for for {{em|displaying}} attribution information below the quote; this should not be confused with a citing a source {{crossref|(see {{section link||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 the introductory line immediately before the quotation, with a normal <syntaxhighlight lang="html" inline><ref>...</ref></syntaxhighlight> 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|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. 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}} – optionally used for additional source information to display, after {{para|title}}, like so: {{code|lang=moin|code={{!}}title="The Aerodynamics of Shaved Weasels" {{!}}source=''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: {{code|lang=moin|code={{!}}title="The Aerodynamics of Shaved Weasels" {{!}}source=''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|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}}.


Technically, all citation information can be given in a single parameter, as in: {{code|lang=moin|code={{!}}source=Anonymous interview subject, in Jane G. Arthur, "The Aerodynamics of Shaved Weasels", ''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.)}} 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:
Technically, all citation information can be given in a single parameter, as in: {{code|lang=moin|code={{!}}source=Anonymous interview subject, in Jane G. Arthur, "The Aerodynamics of Shaved Weasels", ''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.)}} 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:
Line 72: Line 70:
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===
=== Rarely used technical parameters ===
{{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. {{Crossref|(See [[#Nested quotations]], below, for the most common use case.)}}
{{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. {{Crossref|(See [[#Nested quotations]], below, for the most common use case.)}}


===Parameter list===
=== Parameter list ===
<pre>
<pre>
{{Quote
{{Quote
Line 88: Line 86:
</pre>
</pre>


==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 {{para|source}} parameter:
A [[WP:Citing sources|reference citation]] can be placed before the quote, after the quote, or in the {{para|source}} parameter:
Line 110: Line 108:
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 {{strong|must}} use a named parameter (e.g. <code>|text="E=MC<sup>2</sup>" is a formula everyone knows but few understand</code>, 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 and other templates.
If any parameter's actual value contains an [[equals sign]] (<code>=</code>), you {{strong|must}} use a named parameter (e.g. <code>|text="E=MC<sup>2</sup>" is a formula everyone knows but few understand</code>, 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 and 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 {{tlx|!}} and friends.
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 {{tlx|!}} and friends.


=== Next to right-floated boxes ===
=== Next to right-floated boxes ===
{{As of|2015|09|post=,}} the text of a block quotation may rarely overflow (in Firefox or other Gecko browsers) a right-floated item (e.g. a {{tlx|Listen}} box, when that item is below another right-floated item of a fixed size that is narrower. In Safari and other Webkit browsers (and even more rarely in Chrome/Chromium) the same condition can cause the block quotation to be pushed downward. Both of these problems can be fixed by either:
{{As of|2015|09|post=,}} the text of a block quotation may rarely overflow (in Firefox or other Gecko browsers) a right-floated item (e.g. a {{tlx|Listen}} box, when that item is below another right-floated item of a fixed size that is narrower. In Safari and other Webkit browsers (and even more rarely in Chrome/Chromium) the same condition can cause the block quotation to be pushed downward. Both of these problems can be fixed by either:
# removing the sizing on the upper item and letting it use its default size (e.g. removing <code>{{var|###}}x{{var|###}}px</code> sizing or {{para|upright}} from a right-floated image above a wider right-floated object that is being overflowed by quotation text; or
# removing the sizing on the upper item and letting it use its default size (e.g. removing <code>{{var|###}}x{{var|###}}px</code> sizing or {{para|upright}} from a right-floated image above a wider right-floated object that is being overflowed by quotation text; or
# using {{para|style|{{code|lang=css|code=overflow:inherit;}}}} in the quotation template.
# using {{para|style|{{code|lang=css|code=overflow:inherit;}}}} in the quotation template.
Line 124: Line 122:


=== 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 {{tlp|Quote|this is quoted}} More text here<br />spans a blank line, unless a {{tlp|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 {{tlp|Quote|this is quoted}} More text here<br />spans a blank line, unless a {{tlp|Quote|...}} is ended with a line break, then the next blank line might be ignored and two paragraphs joined.


Line 139: Line 136:


== TemplateData ==
== TemplateData ==
{{TemplateData header}}
{{TemplateData header}}<templatedata>
<templatedata>
{
{
"description": "Adds a block quotation.",
"description": "Adds a block quotation.",
Line 180: Line 176:
}
}
}
}
}</templatedata>
}
</templatedata>

{{Quotation templates}}


{{Quotation templates}}<includeonly>
<includeonly>{{Sandbox other||
{{Sandbox other||
<!-- ADD CATEGORIES AFTER THIS LINE, PLEASE: -->
<!-- ADD CATEGORIES AFTER THIS LINE, PLEASE: -->
[[Category:Quotation templates]]
[[Category:Quotation templates]]

Revision as of 16:19, 5 March 2019

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

Usage

{{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 (though these are not usually used in articles;