Difference between revisions of "Template:Quote/doc"
(dox overhaul) |
(Notably : typography, accessibility.) |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
+ | |||
{{For|linking a subject to a collection of quotations on [[Wikiquote]]|Template:Wikiquote}} | {{For|linking a subject to a collection of quotations on [[Wikiquote]]|Template:Wikiquote}} | ||
==Usage== | ==Usage== | ||
+ | |||
{{tlx|Quote}} adds a [[block quotation]] to an article page. | {{tlx|Quote}} 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 | + | 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. See [[MOS:QUOTE]]. | Note: Block quotes do not normally contain quotation marks. See [[MOS:QUOTE]]. | ||
Line 24: | Line 26: | ||
;Wikitext: | ;Wikitext: | ||
− | <code><nowiki>{{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=[[William Shakespeare]]|source=''[[Julius Caesar (play)|Julius Caesar]]'', | + | <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: | ;Result: | ||
− | {{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=[[William Shakespeare]]|source=''[[Julius Caesar (play)|Julius Caesar]]'', | + | {{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 === | === Restrictions === | ||
Line 35: | Line 37: | ||
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 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, | + | 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. | Be wary of URLs which contain restricted characters. The equals sign is especially common. | ||
Line 47: | Line 49: | ||
<includeonly> | <includeonly> | ||
− | <!-- ADD CATEGORIES | + | |
+ | <!-- ADD CATEGORIES AFTER THIS LINE --> | ||
[[Category:Quotation templates|{{PAGENAME}}]] | [[Category:Quotation templates|{{PAGENAME}}]] | ||
− | <!-- ADD INTERWIKIS | + | <!-- ADD INTERWIKIS AFTER THIS LINE --> |
[[as:Template:Quote]] | [[as:Template:Quote]] | ||
[[ca:Plantilla:Citació]] | [[ca:Plantilla:Citació]] | ||
Line 66: | Line 69: | ||
[[zh-yue:Template:Quote]] | [[zh-yue:Template:Quote]] | ||
[[zh:Template:Quote]] | [[zh:Template:Quote]] | ||
+ | |||
</includeonly> | </includeonly> |
Revision as of 13:38, 2 March 2012
{{#ifeq:doc |doc
|
{{#ifeq:show |show
| Template:Mbox }}{{#if: | | {{#ifexist:Template:Quote | [[Category:{{#switch:Template |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]] | }} }} | }}
Usage
{{[[{{#if:|{{{SISTER}}}Template|Template}}:Quote|Quote]]{{#if:||{{{2}}}}}{{#if:||{{{3}}}}}{{#if:||{{{4}}}}}{{#if:||{{{5}}}}}{{#if:||{{{6}}}}}{{#if:||{{{7}}}}}{{#if:||...}}}} adds a block quotation to an article page.
This is easier to type and more wiki-like than the equivalent HTML {{#if:|
|
}}{{#switch:pair
|c|close = |s|single |o|open |p|pair = <blockquote{{#if:| {{{params}}}}}
}}{{#switch:pair
|c|close = |s|single = /> |o|open = > |p|pair = >...
}}{{#switch:pair
|s|single |o|open = |c|close |p|pair = </blockquote>
}}{{#if:|
|
}} tags, and has additional pre-formatted attribution and source parameters.
Note: Block quotes do not normally contain quotation marks. See MOS: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|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.{{#if:William Shakespeare | }}
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.
Multiple paragraphs
The {{#if:|
|
}}{{#switch:o
|c|close = |s|single |o|open |p|pair = <blockquote{{#if:| {{{params}}}}}
}}{{#switch:o
|c|close = |s|single = /> |o|open = > |p|pair = >...
}}{{#switch:o
|s|single |o|open = |c|close |p|pair = </blockquote>
}}{{#if:|
|
}} element and any templates that use it do not honor newlines:
<blockquote> Line 1 Line 2 Line 3 Line 4 </blockquote> |
}}{{#if: | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}} | |
To resolve this, use the {{#switch:pair
|c|close = |s|single |o|open |p|pair = <{{#switch:poem |categorytree=categorytree |charinsert=charinsert |gallery=gallery |hiero=hiero |imagemap=imagemap |inputbox=inputbox |math=math |nowiki=nowiki |poem=poem |pre=pre |ref=ref |references=references |section=section |score=score |source=source |syntaxhighlight=syntaxhighlight |templatedata=templatedata |timeline=timeline |#default=tag
}}{{#if:| {{{params}}}}} }}{{#switch:open
|c|close = |s|single = /> |o|open = > |p|pair = >...
}}{{#switch:open
|s|single |o|open = |c|close |p|pair = </poem>
}} tag inside {{#if:|
|
}}{{#switch:o
|c|close = |s|single |o|open |p|pair = <blockquote{{#if:| {{{params}}}}}
}}{{#switch:o
|c|close = |s|single = /> |o|open = > |p|pair = >...
}}{{#switch:o
|s|single |o|open = |c|close |p|pair = </blockquote>
}}{{#if:|
|
}}:
<blockquote><poem> Line 1 Line 2 Line 3 Line 4 </poem></blockquote> |
<poem> }}{{#if: | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}}{{#if: | | |
}} | |
See also
Similar templates comparison:
- Template:Epigraph – quote without border, page-wide, normal-sized attribution
- 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:Cquote – pull-quote between graphic quotation marks, page-wide
- Template:Rquote – pull-quote between graphic quotation marks, in a reduced floating area
- Category:Quotation templates – more templates