Difference between revisions of "Template:Quote"

From
Jump to: navigation, search
(Created page with "<blockquote class="templatequote"><div class="Bug6200">{{{text|{{{quote|{{{1|<noinclude>{{lorem ipsum}}</noinclude><includeonly>{{error|Error: No text given for quotation (or...")
 
Line 1: Line 1:
<blockquote class="templatequote"><div class="Bug6200">{{{text|{{{quote|{{{1|<noinclude>{{lorem ipsum}}</noinclude><includeonly>{{error|Error: No text given for quotation (or equals sign used in the actual argument to an unnamed parameter)}}</includeonly>}}}}}}}}}</div>{{#if:{{{sign|{{{cite|{{{2|<noinclude>TRUE</noinclude>}}}}}}}}}
+
{{Documentation subpage}}
|<div class="templatequotecite">&#8212;{{{sign|{{{cite|{{{2|<noinclude>[[Someone's full name|Someone]]</noinclude>}}}}}}}}}{{#if:{{{source|{{{3|<noinclude>TRUE</noinclude>}}}}}}
+
 
  |,&nbsp;<cite>{{{source|{{{3|<noinclude>Source</noinclude>}}}}}}</cite>
+
 
}}</div>
+
== Usage ==
}}</blockquote><noinclude>
+
 
{{documentation}}
+
{{tlx|Quote}} adds a block quotation to a page.
<!-- Add cats and interwikis to the /doc subpage, not here! -->
+
 
</noinclude>
+
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. -->
 +
 
 +
 
 +
=== 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'', act III, scene I}}</nowiki></code>
 +
 
 +
;Result:
 +
{{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=William Shakespeare|source=''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 ===
 +
 
 +
<div style="float: right; padding: 0 1em;">{{navbar|Blockquote paragraphs|plain=y}}</div>
 +
The {{tag|blockquote|o}} element and any templates that use it do not honor newlines:
 +
{{markup
 +
|<nowiki><blockquote>
 +
Line 1
 +
Line 2
 +
Line 3
 +
Line 4
 +
</blockquote></nowiki>
 +
|<blockquote>
 +
Line 1
 +
Line 2
 +
Line 3
 +
Line 4
 +
</blockquote>
 +
}}
 +
 
 +
To resolve this, use the {{xtag|poem}} tag inside {{tag|blockquote|o}}:
 +
{{markup
 +
|<nowiki><blockquote><poem>
 +
Line 1
 +
Line 2
 +
Line 3
 +
Line 4
 +
</poem></blockquote></nowiki>
 +
|<blockquote><poem>
 +
Line 1
 +
Line 2
 +
Line 3
 +
Line 4
 +
</poem></blockquote>
 +
}}
 +
 
 +
== 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 ==
 +
{{Quotation templates see also}}
 +
 
 +
<includeonly>
 +
<!-- ADD CATEGORIES AFTER THIS LINE -->
 +
[[Category:Quotation templates|Quote]]
 +
[[Category:Semantic markup templates]]
 +
</includeonly>

Revision as of 23:35, 2 December 2021

Template:Documentation subpage


Usage

Template:Tlx adds a block quotation to a page.

This is easier to type and more wiki-like than the equivalent HTML Template:Tag tags, and has additional pre-formatted attribution and source parameters.


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'', act III, scene I}}

Result

"{{{1}}}"
— {{{2}}}


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

Template:Navbar

The Template:Tag element and any templates that use it do not honor newlines: Template:Markup

To resolve this, use the Template:Xtag tag inside Template:Tag: Template:Markup

TemplateData

Template: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

Template:Quotation templates see also