Template:Quote/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Added "Usage" header)
m (→‎Parameters and Examples: clean up, replaced: {{ModernNote| → {{note|)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{doc/subpage}}__NOTOC__
<!-- 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 ==
{{note|Named parameters allow you to use equality symbols and much more. Numbered parameters can be used instead.}}
{| class=standard-table | style="width:100%;"
|-
! width=15% | Parameter
! Description
! Example
! width=30% | Preview
|-
| align="center" | ''No parameters''
| Outputs an error message
| {{CodeBlock|<nowiki>{{Quote}}</nowiki>}}
| {{Capsule|margin=5px|{{Quote}}}}
|-
| align="center" | {{Code|{{param|1}}}} or {{Code|{{param|text}}}}
| Quote text.
| {{CodeBlock|<nowiki>{{Quote|Quote text.}}</nowiki>}} {{CodeBlock|<nowiki>{{Quote|1=Quote text.}}</nowiki>}} {{CodeBlock|<nowiki>{{Quote|text=Quote text.}}</nowiki>}}
| {{Capsule|margin=5px|{{Quote|Quote text.}}}} {{Capsule|margin=5px|{{Quote|1=Quote text.}}}} {{Capsule|margin=5px|{{Quote|text=Quote text.}}}}
|-
| align="center" | {{Code|{{param|2}}}} or {{Code|{{param|sign}}}}
| Quote signature.
| {{CodeBlock|<nowiki>{{Quote|Quote text.|[[Gabe Newell]]}}</nowiki>}} {{CodeBlock|<nowiki>{{Quote|text=Quote text.|sign=[[Gabe Newell]]}}</nowiki>}}
| {{Capsule|margin=5px|{{Quote|Quote text.|[[Gabe Newell]]}}}} {{Capsule|margin=5px|{{Quote|text=Quote text.|sign=[[Gabe Newell]]}}}}
|-
| align="center" | {{Code|{{param|3}}}} or {{Code|{{param|source}}}}
| Quote source.
Does not appear if the signature was not specified.
| {{CodeBlock|<nowiki>{{Quote
| Quote text.
| [[Gabe Newell]]
| Source
}}</nowiki>}}
{{CodeBlock|<nowiki>{{Quote
| text = Quote text.
| sign = [[Gabe Newell]]
| source = Source
}}</nowiki>}}
| {{Capsule
| margin = 5px
| {{Quote|Quote text.|[[Gabe Newell]]|Source}}}} {{Capsule|margin=5px|{{Quote|text=Quote text.|sign=[[Gabe Newell]]|source=Source}}
  }}
|}


<includeonly>{{sandbox other||
<includeonly>{{sandbox other||
<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
 
[[Category:Templates]][[Category:Formatting templates]]
}}</includeonly>
}}</includeonly>

Latest revision as of 10:52, 6 January 2024

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

Note.pngNote:Named parameters allow you to use equality symbols and much more. Numbered parameters can be used instead.
Parameter Description Example Preview
No parameters Outputs an error message
{{Quote}}
Error: No text given for quotation (or equals sign used in the actual argument to an unnamed parameter)
{{{1}}} or {{{text}}} Quote text.
{{Quote|Quote text.}}
{{Quote|1=Quote text.}}
{{Quote|text=Quote text.}}
Quote text.
Quote text.
Quote text.
{{{2}}} or {{{sign}}} Quote signature.
{{Quote|Quote text.|[[Gabe Newell]]}}
{{Quote|text=Quote text.|sign=[[Gabe Newell]]}}
Quote text.
Quote text.
{{{3}}} or {{{source}}} Quote source.

Does not appear if the signature was not specified.

{{Quote | Quote text. | [[Gabe Newell]] | Source }}
{{Quote | text = Quote text. | sign = [[Gabe Newell]] | source = Source }}
Quote text.
— Gabe Newell, Source
Quote text.
— Gabe Newell, Source


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