Template:Quote/doc

From Sapphire Wiki
Revision as of 02:08, 16 January 2014 by Bryan (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Usage

{{Quote}} adds a block quotation to an article page.

This is easier to type and 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.

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|sign=person|source=source}}

Example

Wikitext

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

Result

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

William ShakespeareJulius Caesar, act III, scene I

Restrictions

If you do not provide quoted 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 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.

Multiple paragraphs


(This section is transcluded from Template:Blockquote paragraphs)

The <syntaxhighlight lang="html" class="" id="" style="" inline="1">

</syntaxhighlight> element and any templates that use it do not honor newlines:

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

An easy solution is to use the {{poem quote}} template instead of <blockquote>...</blockquote>. This is effectively the same as using the <poem> tag inside <syntaxhighlight lang="html" class="" id="" style="" inline="1">

</syntaxhighlight>, which converts line breaks to <syntaxhighlight lang="html" class="" id="" style="" inline="1">
</syntaxhighlight> tags:

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

To markup actual paragraphs within block quotations, entire blank lines can be used between them, which will convert to <syntaxhighlight lang="html" class="" id="" style="" inline="1">

...

</syntaxhighlight> tags:

Markup Renders as
<blockquote>
Paragraph 1

Paragraph 2

Paragraph 3
</blockquote>

Note that it may be necessary to put a line break in the wikitext before <blockquote> and after </blockquote> in order for the paragraphs to render with the intended separation. (This also makes the wikitext easier to read.)

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

Blockquote and templates that call it, and are indented with colon (:), bulleted with asterisk (*), or numbered with number (#), will generate errors and incorrectly display anything after a newline character.

Markup Renders as
:<blockquote>Paragraph 1
Paragraph 2</blockquote>
Markup Renders as
*<blockquote>Paragraph 1
Paragraph 2</blockquote>
Markup Renders as
#<blockquote>Paragraph 1
Paragraph 2</blockquote>

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Quote

<templatedata>{ "description": "Adds a block quotation.", "params": { "text": { "label": "text", "description": "The text to quote", "type": "string", "required": false, "aliases": [ "1", "quote" ] }, "sign": { "label": "sign", "description": "The person who quote it is", "type": "string", "required": false, "aliases": [ "2", "cite" ] }, "source": { "label": "source", "description": "A source for the quote", "type": "string", "required": false, "aliases": [ "3" ] } } }</templatedata>

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

  • Template:Bq—quote without border, page-wide; like (and compatible with parameters of) the older {{Quote}} but with more features; conversion from all others listed here is trivially easy (retaining key data, losing decoration, etc.)
  • Template:Centered pull quote—pull quote between large quotation marks, page-wide; should rarely be used in articles and is not for block quotations, only pull quotes
  • Template:Quote—quote without border, page-wide, smaller-sized attribution
  • Template:Quotation—quote with border, page-wide
  • Template:Quote box—quote with border, in a reduced floating box
  • Template:Rquote—pull quote between large quotation marks, in a reduced floating area; also rarely appropriate in articles
  • Template:Talkquote—for quoting other editors (or guidelines, etc.) on talk pages (in a block)
  • Template:Tq—for quoting on talk pages, inline
  • Category:Quotation templates