Template:Blockquote/doc

Revision as of 09:46, 5 August 2015 by wikipedia>SMcCandlish (Documenting the CSS the Template:Quote/to right of image variant uses; adding: →‎Attribution: New section.)

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 and source parameters.

Note: Block quotes do not normally contain quotation marks. See MOS:Blockquote.

Next to left-floated images: The variant template {{Quote/to right of image}} will work around a CSS bug, in which the block quotation does not indent if it is next to a left-floated image. As of 4 August 2015, this problem and the fix for it has been reported to Mediawiki talk:Common.css#Fix for very long-standing problem of blockquote not working with images. It is not known when this will be fixed. After it is fixed, this variant template can be replaced with the stock {{Quote}}.

Synopsis

Unnamed (positional) parameters {{quote|phrase|person|source}} This markup will fail if any parameter contains an equals sign (=).

Numbered (positional) parameters {{quote|1=phrase|2=person|3=source}}

Named parameters {{quote|text=phrase|author=person|source=source}}

Style

Styling is applied through CSS rules in MediaWiki:Common.css.

/* Styling for Template:Quote */
blockquote.templatequote {
     margin-top: 0;
}
blockquote.templatequote div.templatequotecite {
    line-height: 1.5em;
    /* @noflip */
    text-align: left;
    /* @noflip */
    padding-left: 1.6em;
    margin-top: 0;
}

HTML:

<blockquote class="templatequote">
<p>Quote text.</p>
<div class="templatequotecite">—Author, <cite>Source</cite></div>
</blockquote>

The Template:Cite variant of the template adds margin-left: 0; margin-right: 0; padding-left: 2.8em; padding-right: 2.8em; to blockquote.templatequote { }.

Attribution

The source title in |source= is enclosed in <cite>...</cite>, thus it shows italicized, due to a default style being applied to the <cite> element. Per MOS:TITLE, italicization of titles should only be done for major works (books, journals, albums, movies and TV series, plays or operas, etc.), not for minor works, which are enclosed in quotation marks (chapters, articles, songs, episodes, scenes or acts, etc.). As of 4 August 2015, this unnecessary forced italicization has been reported to Mediawiki talk:Common.css#The cite element needs to not auto-italicize any longer for removal. It is unknown when it will be fixed. In the interim, the following approach to quotation attribution is recommended:

  • {{quote |text=Lorem ipsum ... |author=Pat Doe, "Minor Work" (2015) |source=Major Work}}

If it is appropriate to include a full source citation at this point, it can be done like so:

  • {{quote |text=Lorem ipsum ...<ref>{{cite journal |first=Pat |last=Doe |title=Minor Work |work=Major Work |date=2015}}</ref>}}

If a full citation and an in-text attribution should appear:

  • {{quote |text=Lorem ipsum ... |author=Pat Doe, "Minor Work", ''Major Work'' (2015)<ref>{{cite journal |first=Pat |last=Doe |title=Minor Work |work=Major Work |date=2015}}</ref>}}

Until the problem with <cite> is fixed, the |source= parameter has extremely limited application. After it is fixed, the entire |author=|source= block will likely be wrapped in <cite>...</cite>, and the parameters may be merged.


Examples

Markup
{{Quote|text=Cry "Havoc" and let slip the dogs of war.|author=[[William Shakespeare]]|source=''[[Julius Caesar (play)|Julius Caesar]]'', act III, scene I}}
Renders as

Cry "Havoc" and let slip the dogs of war.

— William Shakespeare, Julius Caesar, act III, scene I

Restrictions

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 named parameters or a blank-name parameter, as: {{{|text}}}. (The text before the equals sign gets interpreted as a named parameter otherwise.)

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.

Be wary of URLs which contain restricted characters. The equals sign is especially common. Put a break (newline) after the template, or the next blank line might be ignored.

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 section is transcluded from Template:Blockquote paragraphs)

The <blockquote> element and any templates that use it do not honor newlines:

Markup Renders as
<blockquote>
Line 1
Line 2
Line 3
Line 4
</blockquote>

Line 1 Line 2 Line 3 Line 4

An easy solution is to use the {{poemquote}} template instead of <tag>. This is effectively the same as using the <poem> tag inside <blockquote>, which converts line breaks to <br /> tags:

Markup Renders as
<blockquote><poem>
Line 1
Line 2
Line 3
Line 4
</poem></blockquote>

<poem>

Line 1 Line 2 Line 3 Line 4

</poem>

To markup actual paragraphs within block quotations, entire blank lines can be used between them, which will convert to <p>...</p> tags:

Markup Renders as
<blockquote>
Paragraph 1

Paragraph 2

Paragraph 3
</blockquote>

Paragraph 1

Paragraph 2

Paragraph 3

This paragraph style also works with {{quote}}, which is a replacement for <tag> that also has parameters to make formatting of the attribution more conveniently and consistently.



</noinclude>

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

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

Known problems

This template sets a text style which might ignore one blank line, and so the template must be ended with a break (newline). Otherwise, beware inline, as:

  • text here {{quote|this is quoted}} More text here spans a blank line

Unless a {{quote|xx}} is ended with a line break, then the next blank line might be ignored and two paragraphs joined.

See also