Template:Blockquote/doc

DCCWiki, a community DCC encyclopedia.
Jump to: navigation, search

Template:Uses TemplateStyles

Template:High-risk

Template:Blockquote/doc/boilerplate

Usage

{{Blockquote}} 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:Crossreference).

Note: Block quotes do Template:Em normally contain quotation marks Template:Crossreference.

Examples

Basic useTemplate:Colon

Markup Renders asTemplate:For loop

With attribution displayedTemplate:Colon

Markup Renders asTemplate:For loop

With more attributionTemplate:Colon

Markup Renders asTemplate:For loop

Examples with "multiline"Template:Colon

Especially useful for translated quotes; see notes about this parameter.

Markup Renders asTemplate:For loop
Markup Renders asTemplate:For loop

An ample exampleTemplate:Colon Template:Markupv

Parameters

Parameter list

{{Blockquote
| text      =
| author    =
| title     =
| source    =
| character =
| multiline =
| class     =
| style     =
}}

See also section #TemplateData.

Quoted text

|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 (e.g., in a URL in a source citation) will break the template.

Displayed attribution

These parameters are for Template:Em attribution information below the quote; this should not be confused with citing a source Template:Crossreference. 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:Crossreference. 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= or |5= – to attribute fictional speech to a fictional character, Template:Em 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

  • |multiline= – keep forced linebreaks in output.Template:PbNotes:
    • Will only be applied if at least one of these other parameters or its aliases is not empty (including implicit, unnamed parameters):Template:Pb|author=, |title=, |source=, or |character=.
    • The value does not matter, as long it is not empty. Using a so called speaking parameter (such as true or yes) is highly recommended. Avoid values that can surprise users (e.g. false or no).
  • |style= – allows specifying additional CSS styles (Template:Em classes) to apply to the <blockquote>...</blockquote> element. Template:Crossreference
  • |class= – allows specifying additional HTML classes to apply to the same element.

Reference citations

A reference citation can be placed before the quote, after the quote, or in the |source= parameter:

  • Template:Tick Template:Stronggood In the regular-prose introduction to the quotation, when a quotation is given without the displayed |author=, |title=, or |source= parameters: According to Pat Doe, in "Underwater Basketweaving Tips" (2015):<ref>...</ref> {{blockquote |text=Quoted material.}}
  • At the end of the quotation, when a quotation is given without the displayed |author=, |title=, or |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: Pat Doe and Chris Foo took opposing positions: {{blockquote |text=Doe's Quoted material.<ref>...</ref>}} {{blockquote |text=Foo's Quoted material.<ref>...</ref>}}
  • After the |source= value (if a value is given for the |source= parameter other than the <ref>...</ref> itself):One expert noted in 2015: {{blockquote |text=Quoted material. |author=Pat Doe |source="Underwater Basketweaving Tips" (2015)<ref>...</ref>}}
  • Template:Xmark Template:Strongbad After the quoted person's name in |author=, or after the work's title in |title=, when a |source= parameter is not being added: As noted in "Underwater Basketweaving Tips" (2015): {{blockquote |text=Quoted material. |author=Pat Doe<ref>...</ref>}}Template:PbTemplate: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 |author= or |source= parameter by itself, as it will produce a nonsensical attribution line that looks like this: Template:Pb     — Template:Dummy referenceTemplate:Pb Please also do not put it just outside the {{blockquote}} template, as this will cause a: Template:Pb     Template:Dummy referenceTemplate:Pbon a line by itself.

Limitations

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 Template:Strong 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 Template:Em 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:
     text here {{blockquote|this is quoted}} More text here
spans a blank line, unless a {{blockquote|...}} 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 {{blockquote}} templates.

Technical issues with block templates

Template:Block bug documentation

TemplateData

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

TemplateData for Blockquote

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
authorauthor 2 cite sign

The writer of the source

Example
William Shakespeare
Contentsuggested
titletitle 3

The work being quoted from

Example
Julius Caesar
Contentsuggested
sourcesource 4

A source for the quote

Example
act III, scene I
Contentsuggested
charactercharacter 5 char

The speaker within the work who is being quoted

Example
Mark Antony
Contentoptional
multilinemultiline

Keeps forced linebreaks in output

Example
true
Stringoptional
stylestyle

Additional CSS styles (not classes) to apply

Example
font-size:inherit;
Stringoptional
classclass

Additional HTML classes to apply

Example
pullquote
Stringoptional

Tracking categories

  • Template:Category link with count generates a link to a category followed by the number of pages in the category. It uses the PAGESINCATEGORY parser function.

    Usage

    One parameter
    {{Category link with count|CATEGORY}}
    {{clc|CATEGORY}}
    {{CLC|CATEGORY}}
    Two parameters
    {{Category link with count|CATEGORY|TYPE}}
    {{clc|CATEGORY|TYPE}}
    {{CLC|CATEGORY|TYPE}}
    Name label
    {{Category link with count|Category:Guans (bird)|name=CAT:Guans}}
    Template loop detected: Template:Clc

    Examples

    Using the template shortcut {{clc}}:

    One parameter

    without "Category:"
    {{clc|Côte-d'Or}}Template loop detected: Template:Clc
    with "Category:"
    {{clc|Category:Côte-d'Or}}Template loop detected: Template:Clc

    Two parameters

    without "Category:"
    {{clc|Côte-d'Or|pages}}Template loop detected: Template:Clc
    {{clc|Côte-d'Or|subcats}}Template loop detected: Template:Clc
    {{clc|Côte-d'Or|files}}Template loop detected: Template:Clc
    with "Category:"
    {{clc|Category:Côte-d'Or|pages}}Template loop detected: Template:Clc
    {{clc|Category:Côte-d'Or|subcats}}Template loop detected: Template:Clc
    {{clc|Category:Côte-d'Or|files}}Template loop detected: Template:Clc

    See also

    Template:Internal category-link templates


    • Template:Category link with count generates a link to a category followed by the number of pages in the category. It uses the PAGESINCATEGORY parser function.

      Usage

      One parameter
      {{Category link with count|CATEGORY}}
      {{clc|CATEGORY}}
      {{CLC|CATEGORY}}
      Two parameters
      {{Category link with count|CATEGORY|TYPE}}
      {{clc|CATEGORY|TYPE}}
      {{CLC|CATEGORY|TYPE}}
      Name label
      {{Category link with count|Category:Guans (bird)|name=CAT:Guans}}
      Template loop detected: Template:Clc

      Examples

      Using the template shortcut {{clc}}:

      One parameter

      without "Category:"
      {{clc|Côte-d'Or}}Template loop detected: Template:Clc
      with "Category:"
      {{clc|Category:Côte-d'Or}}Template loop detected: Template:Clc

      Two parameters

      without "Category:"
      {{clc|Côte-d'Or|pages}}Template loop detected: Template:Clc
      {{clc|Côte-d'Or|subcats}}Template loop detected: Template:Clc
      {{clc|Côte-d'Or|files}}Template loop detected: Template:Clc
      with "Category:"
      {{clc|Category:Côte-d'Or|pages}}Template loop detected: Template:Clc
      {{clc|Category:Côte-d'Or|subcats}}Template loop detected: Template:Clc
      {{clc|Category:Côte-d'Or|files}}Template loop detected: Template:Clc

      See also

      Template:Internal category-link templates


      See also

      Template:Quotation templates