Difference between revisions of "Template:Quote/doc"

From Wildermyth Wiki
(Created page with "{{Documentation subpage}} {{For|linking a subject to a collection of quotes on Wikiquote|Template:Wikiquote}} == Usage == {{tlx|Quote}} adds a block quotation to an...")
 
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Documentation subpage}}
<includeonly>: ''This documentation is transcluded from [[Template:Quote/doc]]''</includeonly><!--
 
--><noinclude><div class="messagebox" style="padding-left:1ex;">'''This is a documentation subpage for [[Template:Quote]].'''</div></noinclude><!--
{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}
-->{{See also|Template:Data description}}


== Usage ==
== Usage ==


{{tlx|Quote}} adds a [[block quotation]] to an article page.
This template displays a description enclosed in smart quotes.
 
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]].
 
=== 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.


=== Multiple paragraphs ===
; 1: Description to quote


{{Blockquote paragraphs}}
== Example ==


== TemplateData ==
<pre><nowiki>{{Quote|{{Data description|Invigoration}}}}</nowiki></pre>
{{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 ==
{{Quote|{{Data description|Invigoration}}}}
{{Quotation templates see also}}


<includeonly>
<includeonly>[[Category:Template]]</includeonly>
<!-- ADD CATEGORIES AFTER THIS LINE -->
[[Category:Quotation templates|Quote]]
[[Category:Semantic markup templates]]
</includeonly>

Latest revision as of 13:30, 21 January 2022

This is a documentation subpage for Template:Quote.

Usage

This template displays a description enclosed in smart quotes.

1
Description to quote

Example

{{Quote|{{Data description|Invigoration}}}}
Twice per combat, <name> touches an adjacent target to grant  x Temp Health.