Difference between revisions of "Template:Quote/doc"

From D&D 5e
Jump to: navigation, search
m (71 revisions imported: Export Template:Quote from mediawiki.org)
 
(28 intermediate revisions by 19 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
{{For|linking a subject to a collection of quotations on [[Wikiquote]]|Template:Wikiquote}}
 
  
'''{{tl|Quote}}''' adds a [[block quote]] to an article page.
+
{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}
  
This is easier to type and more wiki-like than the equivalent HTML {{tag|blockquote}} tags, has additional pre-formatted attribution and source parameters, and contains a workaround for [[Bugzilla:6200]], which means you don't need to type {{tag|p}} tags manually.
+
== Usage ==
  
Note: Block quotes do not normally contain quotation marks.
+
{{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 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]].
 
 
 
 
See [[MOS:QUOTE]].
 
  
 
=== Synopsis ===
 
=== Synopsis ===
Line 18: Line 15:
 
;Unnamed (positional) parameters
 
;Unnamed (positional) parameters
 
<code><nowiki>{{quote|phrase|person|source}}</nowiki></code>
 
<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
+
;Named parameters
 
<code><nowiki>{{quote|text=phrase|sign=person|source=source}}</nowiki></code>
 
<code><nowiki>{{quote|text=phrase|sign=person|source=source}}</nowiki></code>
  
 
=== Example ===
 
=== Example ===
  
; Wikitext:
+
;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>
+
<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'']], Act III, Scene I}}
+
{{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 34: Line 35:
 
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 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 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.
 +
 
 +
=== Multiple paragraphs ===
  
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.
+
{{Blockquote paragraphs}}
  
Be wary of URLs which contain restricted characters. The equals sign is especially common.
+
== TemplateData ==
 +
{{TemplateDataHeader}}
 +
<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 is being quoted",
 +
      "type": "string",
 +
      "required": false,
 +
      "aliases": [ "2", "cite" ]
 +
    },
 +
    "source": {
 +
      "label": "source",
 +
      "description": "A source for the quote",
 +
      "type": "string",
 +
      "required": false,
 +
      "aliases": [ "3" ]
 +
    }
 +
  }
 +
}</templatedata>
  
=== See also ===
+
== See also ==
 
{{Quotation templates see also}}
 
{{Quotation templates see also}}
  
 
<includeonly>
 
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
+
<!-- ADD CATEGORIES AFTER THIS LINE -->
[[Category:Quotation templates|{{PAGENAME}}]]
+
[[Category:Quotation templates|Quote]]
 
+
[[Category:Semantic markup templates]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
[[ar:قالب:اقتباس]]
 +
[[as:Template:Quote]]
 +
[[bg:Шаблон:Цитат]]
 +
[[ca:Plantilla:Citació]]
 +
[[cs:Šablona:Citace]]
 +
[[cy:Nodyn:Dyfyniad]]
 +
[[da:Skabelon:Citat]]
 +
[[de:Vorlage:Zitat]]
 +
[[dsb:Pśedłoga:Citat]]
 
[[es:Plantilla:Cita]]
 
[[es:Plantilla:Cita]]
 
[[eo:Ŝablono:Citaĵo]]
 
[[eo:Ŝablono:Citaĵo]]
 +
[[eu:Txantiloi:Aipua]]
 +
[[fa:الگو:نقل قول]]
 +
[[fi:Malline:Cquote]]
 
[[fr:modèle:citation]]
 
[[fr:modèle:citation]]
 +
[[gl:Modelo:Cita]]
 
[[gu:ઢાંચો:ઉક્તિ]]
 
[[gu:ઢાંચો:ઉક્તિ]]
 +
[[he:Template:ציטוט]]
 
[[hi:साँचा:Quote]]
 
[[hi:साँचा:Quote]]
 +
[[hsb:Předłoha:Citat]]
 +
[[hu:Sablon:Idézet]]
 +
[[hy:Կաղապար:Քաղվածք]]
 +
[[id:Templat:Quote]]
 +
[[is:Snið:Tilvitnun]]
 
[[it:Template:quote]]
 
[[it:Template:quote]]
 
[[ja:Template:Quote]]
 
[[ja:Template:Quote]]
 +
[[ka:თარგი:ციტირება]]
 +
[[kk:Үлгі:Cquote]]
 +
[[ky:Калып:Цитата]]
 +
[[la:Formula:Locus]]
 +
[[lv:Veidne:Quotation]]
 +
[[mwl:Modelo:Quote]]
 
[[no:Mal:Sitat]]
 
[[no:Mal:Sitat]]
 +
[[os:Хуызæг:Cquote]]
 +
[[pl:Szablon:Cytat]]
 
[[pt:Predefinição:Quote]]
 
[[pt:Predefinição:Quote]]
[[th:แม่แบบ:คำพูด]]
+
[[ro:Format:Cquote]]
[[zh-yue:Template:Quote]]
+
[[ru:Шаблон:Цитата]]
[[zh:Template:Quote]]
+
[[sco:Template:Quote]]
 +
[[sh:Šablon:Citat]]
 +
[[sk:Šablóna:Citát]]
 +
[[sl:Predloga:Citatni blok]]
 +
[[sv:Mall:Citat]]
 
</includeonly>
 
</includeonly>

Latest revision as of 21:40, 28 January 2018

{{#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[edit]

{{[[{{#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[edit]

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[edit]

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 |
William Shakespeare{{#if:Julius Caesar, act III, scene I

|, Julius Caesar, act III, scene I

}}
}}

Restrictions[edit]

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[edit]

{{#if:y||This box: }}{{#if:|[}}{{#if:|v|view}} · {{#if:|d|talk}}{{#if:|| · {{#if:|e|edit}}}}{{#if:|]}}

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:

{{#if: | |+ {{{title}}}}} {{#if: || ! style="width:50%" scope="col" | Markup}} {{#if: || ! style="width:50%" scope="col" | Renders as}}{{#if: <blockquote> Line 1 Line 2 Line 3 Line 4 </blockquote>

<blockquote>
Line 1
Line 2
Line 3
Line 4
</blockquote>

Line 1 Line 2 Line 3 Line 4

}}{{#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:|

|

}}:

{{#if: | |+ {{{title}}}}} {{#if: || ! style="width:50%" scope="col" | Markup}} {{#if: || ! style="width:50%" scope="col" | Renders as}}{{#if: <blockquote><poem> Line 1 Line 2 Line 3 Line 4 </poem></blockquote>

<blockquote><poem>
Line 1
Line 2
Line 3
Line 4
</poem></blockquote>
<poem>

Line 1 Line 2 Line 3 Line 4

</poem>

}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}{{#if: |


}}

TemplateData[edit]

{{#if:| |This is the TemplateData documentation for this template used by VisualEditor and other tools.}}

Quote

{{#ifeq:doc|sandbox||

}} <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 is being quoted",
     "type": "string",
     "required": false,
     "aliases": [ "2", "cite" ]
   },
   "source": {
     "label": "source",
     "description": "A source for the quote",
     "type": "string",
     "required": false,
     "aliases": [ "3" ]
   }
 }

}</templatedata>

See also[edit]

Template:Tnavbar

Similar templates comparison: