Editing Template:Quote/doc

{{Documentation subpage}}

{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}

== Usage ==
{{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:Blockquote]].

=== 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>

== Style ==
Styling is applied through CSS rules in [[MediaWiki:Common.css]].
<syntaxhighlight lang=css>
/* Styling for Template:Quote */
blockquote.templatequote {
     margin-top: 0;
}
blockquote.templatequote div.templatequotecite {
    line-height: 1.5em;
    /* @noflip */
    text-align: left;
    /* @noflip */
    padding-left: 1.6em;
    margin-top: 0;
}
</syntaxhighlight>

The source title is enclosed in {{tag|cite}}, thus it shows italicized.

=== Examples ===

{{markupv
|markup=<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>
|renders=
{{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 or a blank-name parameter, as: <nowiki>{{{|text}}}</nowiki>. (The text before 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. Put a break (newline) after the template, or the next blank line might be ignored.

=== Line breaks ===
{{Blockquote paragraphs}}

== 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 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>

== Known problems ==
This template sets a text style which might ignore one blank line, and so the template must be ended with a break (newline). Otherwise, beware inline, as:
::* text here <nowiki>{{quote|this is quoted}}</nowiki> More text here spans a blank line
Unless a <nowiki>{{quote|xx}}</nowiki> is ended with a line break, then the next blank line might be ignored and two paragraphs joined.

== See also ==
{{Quotation templates}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- ADD CATEGORIES AFTER THIS LINE, PLEASE: -->
[[Category:Quotation templates]]

[[la:Formula:Locus]]
[[ro:Format:Cquote]]
}}</includeonly>