Template:Quote/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Added "Usage" header)
mNo edit summary
Line 1: Line 1:
{{Documentation subpage}}
{{documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page.) -->
Adds a [[block quotation]] to an article page.
 
== Usage ==
 
<code><nowiki>{{Quote}}</nowiki></code> adds a [[block quotation]] to an article page.
 
This is easier to type and more wiki-like than the equivalent [[HTML]] {{tag|blockquote}} tags, and has additional pre-formatted attribution and source parameters. <!-- THIS WORKAROUND FAILED; see talk page and its archives. New workaround provided hereafter. It also contains a workaround for [[Bugzilla:6200]], which means you don't need to type {{tag|p}} tags manually. -->
 
'''Note:''' Block quotes do not normally contain quotation marks.
 
=== Synopsis ===
 
;Unnamed (positional) parameters
<code><nowiki>{{quote|phrase|person|source}}</nowiki></code>
This markup will fail if any parameter contains an equals sign (=).
 
;Numbered (positional) parameters
<code><nowiki>{{quote|1=phrase|2=person|3=source}}</nowiki></code>
 
;Named parameters
<code><nowiki>{{quote|text=phrase|sign=person|source=source}}</nowiki></code>
 
=== Example ===
 
;Wikitext:
<code><nowiki>{{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=[[William Shakespeare]]|source=''[[Julius Caesar (play)|Julius Caesar]]'', act III, scene I}}</nowiki></code>
 
;Result:
{{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=[[William Shakespeare]]|source=''[[Julius Caesar (play)|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 [[vertical bar|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.


== Parameters and Examples ==
{| class=standard-table | style="width:100%;"
|-
! Parameter
! Description
! Example
! Preview
|-
| align="center" | {{Code|{{param|1}}}} <br>or<br> {{Code|{{param|text}}}}
| Quote text.
{{param|text}} allows you to use symbols such as equality and others in your quote.
| {{CodeBlock|<nowiki>{{Quote|Cry "Havoc" and let slip the dogs of war.}}</nowiki>}}{{CodeBlock|<nowiki>{{Quote|text=Cry "Havoc" and let slip the dogs of war.}}</nowiki>}}
| {{Doc/PreviewBlock|margin=5px|{{Quote|Cry "Havoc" and let slip the dogs of war.}}}} {{Doc/PreviewBlock|margin=5px|{{Quote|text=Cry "Havoc" and let slip the dogs of war.}}}}
|}


<includeonly>{{sandbox other||
<includeonly>{{sandbox other||

Revision as of 04:03, 1 February 2023

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.

Adds a block quotation to an article page.

Parameters and Examples

Parameter Description Example Preview
{{{1}}}
or
{{{text}}} 		Quote text.

{{{text}}} allows you to use symbols such as equality and others in your quote.

{{Quote|Cry "Havoc" and let slip the dogs of war.}}
{{Quote|text=Cry "Havoc" and let slip the dogs of war.}}
Cry "Havoc" and let slip the dogs of war.
Cry "Havoc" and let slip the dogs of war.


Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:Quote/doc&oldid=278728"