Template:Quote/doc: Difference between revisions

From RabastorWiki
Jump to navigation Jump to search
m (→‎Displayed attribution: Typo fixing, replaced: for for → are for)
 
m (1 revision imported)
 

Latest revision as of 01:57, 21 August 2019

Lua error: Cannot create process: proc_open(/home4/iltornan/lua/error.log): Failed to open stream: No such file or directory Template:Uses TemplateStyles Lua error: Cannot create process: proc_open(/home4/iltornan/lua/error.log): Failed to open stream: No such file or directory

Template:Quote/doc/boilerplate

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; Template:Hatnote-inline).

Note: Block quotes do not normally contain quotation marks Template:Hatnote-inline.

Lua error: Cannot create process: proc_open(/home4/iltornan/lua/error.log): Failed to open stream: No such file or directory

Examples

Basic use:
Markup Renders as
{{Quote
|text=Quoted material.
}} 
<templatestyles src="Template:Quote/styles.css"/>

Template:Trim quotes

With attribution displayed:
Markup Renders as
{{Quote
|text=Quoted material.
|author=First M. Last
}} 
<templatestyles src="Template:Quote/styles.css"/>

Template:Trim quotes

— Lua error: Cannot create process: proc_open(/home4/iltornan/lua/error.log): Failed to open stream: No such file or directory
With more attribution:
Markup Renders as
{{Quote
|text=Quoted material.
|author=First M. Last
|title="Article Title"
|source=''Book Title'' (date)
}} 
<templatestyles src="Template:Quote/styles.css"/>

Template:Trim quotes

— Lua error: Cannot create process: proc_open(/home4/iltornan/lua/error.log): Failed to open stream: No such file or directory

Parameters

|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

These parameters are for displaying attribution information below the quote; this should not be confused with citing a source Template:Hatnote-inline. 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 <ref>...</ref> tag.

|author= a.k.a. |2= – optional author/speaker attribution information that will appear below the quotation, and preceded with an attribution dash.

|title= a.k.a. |3= – optional title of the work the quote appears in, to display below the quotation. This parameter immediately follows the output of |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 Template:Hatnote-inline. Additional citation information can be provided in a fourth parameter, |source=, below, which will appear after the title.

|source= a.k.a. |4= – optionally used for additional source information to display, after |title=, like so: |title="The Aerodynamics of Shaved Weasels" |source=''Perspectives on Mammal Barbering'', 2016; a comma will be auto-generated between the two parameters. If |source= is used without |title=, it simply acts as |title=. (This parameter was added primarily to ease conversion from misuse of the pull quote template {{Quote frame}} for block quotation, but it may aid in cleaner meta-data implementation later.)

|character= a.k.a. |char= – to attribute fictional speech to a fictional character, 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 "[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 |author= parameter instead of |character=.

Technically, all citation information can be given in a single parameter, as in: |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:

|character=Anonymous interview subject
|author=Jane G. Arthur
|title="The Aerodynamics of Shaved Weasels"
|source=''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.)

Later development can assign a CSS class 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

|style= – allows specifying additional CSS styles (not classes) to apply to the <blockquote>...</blockquote> element. Template:Hatnote-inline

Parameter list

{{Quote
| text      =
| author    =
| title     =
| source    =
| character =
| multiline =
| style     =
}}

Reference citations

Lua error: Cannot create process: proc_open(/home4/iltornan/lua/error.log): Failed to open stream: No such file or directory A reference citation can be placed before the quote, after the quote, or in the |source= parameter: Lua error: Cannot create process: proc_open(/home4/iltornan/lua/error.log): Failed to open stream: No such file or directory

Please do not place the citation in a |author= or |source= parameter by itself, as it will produce a nonsensical attribution line that looks like:
Template:In5— Template:Dummy reference
Please also do not put it just outside the {{Quote}} template, as this will cause a:
Template:In5Template:Dummy reference
on a line by itself.

Examples

Template:Markupv

Limitations

Lua error: Cannot create process: proc_open(/home4/iltornan/lua/error.log): Failed to open stream: No such file or directory 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 (=), you must use a named parameter (e.g. |text="E=MC2" 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 and other templates.

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 {{!}} and friends.

Next to right-floated boxes

Template:As of the text of a block quotation may rarely overflow (in Firefox or other Gecko browsers) a right-floated item (e.g. a {{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:

  1. removing the sizing on the upper item and letting it use its default size (e.g. removing ###x###px sizing or |upright= from a right-floated image above a wider right-floated object that is being overflowed by quotation text; or
  2. using |style=overflow:inherit; in the quotation template.

There may be other solutions, and future browser upgrades may eliminate the issue. It arises at all because of the blockquote {overflow: hidden;} CSS declaration in Mediawiki:Common.css, which itself works around other, more common display problems. A solution that fixes all of the issues is unknown at this time.

Vanishing quotes

In rare layout cases, e.g. when quotes are sandwiched between userboxes, a quotation may appear blanked out, in some browsers. The workaround for this problem is to add |style=overflow:inherit; to such an instance of the template.

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:
Template:In5text here Template:Template link with parameters More text here
spans a blank line, unless a Template:Template link with parameters is ended with a line break, then the next blank line might be ignored and two paragraphs joined.

Template:Blockquote paragraphs

Nested quotations

The <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 |style=font-size:inherit; on any inner {{Quote}} templates.

Technical issues with block templates

Template:Block bug documentation

Errors

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 |class=, |id=, |diff=, |4=, or |5=.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Quote

Adds a block quotation.

Template parameters

ParameterDescriptionTypeStatus
texttext 1 quote

The text to quote

Example
Cry "Havoc" and let slip the dogs of war.
Contentrequired
signsign 2 cite author

The person being quoted

Example
[[William Shakespeare]]
Contentsuggested
sourcesource 3

A source for the quote

Example
''[[Julius Caesar (play)|Julius Caesar]]'', act III, scene I
Contentsuggested

Template:Quotation templates