Template:Quote/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Documentation subpage for Template:Quote)
 
m (Added "Usage" header)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page.) -->
<!-- Please place categories where indicated at the bottom of this page.) -->
== Usage ==


<code><nowiki>{{Quote}}</nowiki></code> adds a [[block quotation]] to an article page.
<code><nowiki>{{Quote}}</nowiki></code> adds a [[block quotation]] to an article page.

Revision as of 18:20, 24 February 2020

Edit-copy.png
This is a documentation subpage for Template:Quote.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

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.

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 Shakespeare, 'Julius 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. (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.