Difference between revisions of "Template:Quote/doc"

From D&D 5e
Jump to: navigation, search
(add template data)
(→‎TemplateData: use aliases)
Line 50: Line 50:
 
   "description": "Adds a block quotation.",
 
   "description": "Adds a block quotation.",
 
   "params": {
 
   "params": {
−
    "1": {
 
−
      "label": "phrase",
 
−
      "description": "The text to quote. An alternative to the named 'text' parameter.",
 
−
      "type": "string",
 
−
      "required": false
 
−
    },
 
−
    "2": {
 
−
      "label": "person",
 
−
      "description": "The person who quote it is. An alternative to the 'sign' named parameter.",
 
−
      "type": "string",
 
−
      "required": false
 
−
    },
 
−
    "3": {
 
−
      "label": "src",
 
−
      "description": "A source for the quote. An alternative to the 'source' named parameter.",
 
−
      "type": "string",
 
−
      "required": false
 
−
    },
 
 
     "text": {
 
     "text": {
 
       "label": "text",
 
       "label": "text",
−
       "description": "The text to quote, an alternative to the numbered parameter 1 ('phrase')",
+
       "description": "The text to quote",
 
       "type": "string",
 
       "type": "string",
−
       "required": false
+
       "required": false,
 +
      "aliases": [ "1" ]
 
     },
 
     },
 
     "sign": {
 
     "sign": {
 
       "label": "sign",
 
       "label": "sign",
−
       "description": "The person who quote it is,  an alternative to the numbered parameter 2 ('person')",
+
       "description": "The person who quote it is",
 
       "type": "string",
 
       "type": "string",
−
       "required": false
+
       "required": false,
 +
      "aliases": [ "2" ]
 
     },
 
     },
 
     "source": {
 
     "source": {
 
       "label": "source",
 
       "label": "source",
−
       "description": "A source for the quote,  an alternative to the numbered parameter 2 ('src')",
+
       "description": "A source for the quote",
 
       "type": "string",
 
       "type": "string",
−
       "required": false
+
       "required": false,
 +
      "aliases": [ "3" ]
 
     }
 
     }
 
   }
 
   }
 
}</templatedata>
 
}</templatedata>
 +
 
== See also ==
 
== See also ==
 
{{Quotation templates see also}}
 
{{Quotation templates see also}}

Revision as of 07:42, 24 July 2013

{{#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]]
                  |
                 }}
        }}
    | 
   }}
For {{#if:linking a subject to a collection of quotes on Wikiquote|linking a subject to a collection of quotes on Wikiquote|other uses}}, see Template:Wikiquote{{#if:|{{#if:|, [[:{{{3}}}]], {{#if:|[[:{{{4}}}]], and [[:{{{5}}}]]|and [[:{{{4}}}]]}}| and [[:{{{3}}}]]}}}}.

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

|, 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.

Multiple paragraphs

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


<templatedata>{



 "description": "Adds a block quotation.",
 "params": {
   "text": {
     "label": "text",
     "description": "The text to quote",
     "type": "string",
     "required": false,
     "aliases": [ "1" ]
   },
   "sign": {
     "label": "sign",
     "description": "The person who quote it is",
     "type": "string",
     "required": false,
     "aliases": [ "2" ]
   },
   "source": {
     "label": "source",
     "description": "A source for the quote",
     "type": "string",
     "required": false,
     "aliases": [ "3" ]
   }
 }



}</templatedata>



See also


Template:Tnavbar


Similar templates comparison:











					

						Retrieved from "http://52.89.179.207/index.php?title=Template:Quote/doc&oldid=3358"