Difference between revisions of "Template: Quote/doc"

From wiki.pengtools.com
Jump to: navigation, search
m (1 revision imported)
(+cat.)
(One intermediate revision by one other user not shown)
Line 4: Line 4:
  
 
== Usage ==
 
== Usage ==
 +
 
{{tlx|Quote}} adds a [[block quotation]] to an article page.
 
{{tlx|Quote}} adds a [[block quotation]] to an article page.
  
−
This is easier to type and is more wiki-like than the equivalent [[HTML]] {{tag|blockquote}} tags, and has additional pre-formatted attribution parameters for author and source.
+
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 {{em|not}} normally contain quotation marks {{crossref|(see [[MOS:Blockquote]])}}.
+
'''Note:''' Block quotes do not normally contain quotation marks. See [[MOS:QUOTE]].
  
 
=== Synopsis ===
 
=== Synopsis ===
  
−
;Basic use{{colon}}: <code><nowiki>{{Quote|text=Quoted material. |author=Attribution |source=Reference }}</nowiki></code>
+
;Unnamed (positional) parameters
−
 
+
<code><nowiki>{{quote|phrase|person|source}}</nowiki></code>
−
=== Parameters ===
+
This markup will fail if any parameter contains an equals sign (=).
−
 
 
−
{{para|text}} a.k.a. {{para|1}}—The material being quoted, without quotation marks around it. It is always safest to name this parameter (rather than use an unnamed positional parameter), because, otherwise, any inclusion of a [[Template:=|non-escaped "=" character]] (e.g., in a URL in a source citation) will break the template.
 
−
 
 
−
{{para|author}} a.k.a. {{para|2}}—Author/speaker attribution information that will appear below the quotation, and preceded with an attribution dash.
 
−
 
 
−
{{para|title}} a.k.a. {{para|3}}—Title of the work the quote appears in. This parameter immediately follows the output of {{para|author}} (and an auto-generated comma), if one is provided. It does not auto-italicize. Major works (books, plays, albums, feature films, etc.) should be italicized; minor works (articles, chapters, poems, songs, TV episodes, etc.) go in quotation marks {{crossref|(see [[MOS:TITLES]])}}. Secondary citation information can be provided in a fourth parameter, {{para|source}}, below, which will appear after the title.
 
−
 
 
−
{{para|source}} a.k.a. {{para|4}}—Can optionally be used for additional source information, after {{para|title}}, like so: {{para|title|"The Aerodynamics of Shaved Weasels"}}{{para|source|<nowiki>''Perspectives on Mammal Barbering''</nowiki>, 2016}}; a comma will be auto-generated between the two parameters.  If {{para|source}} is used without {{para|title}}, it simply acts as {{para|title}}. <small>(This parameter was added primarily to ease conversion from misuse of the [[pull quote]] template {{tlx|Quote frame}} for block quotation, but it may aid in cleaner meta-data implementation later.)</small>
 
−
 
 
−
{{para|character}} a.k.a. {{para|char}}—to attribute fictional speech to a fictional character, {{em|with}} other citation information. Can also be used to attribute real speech to a specific speaker among many, e.g. in a roundtable/panel transcript, a band interview, etc.  This parameter outputs "[{{Var|Character's name}}], in" after the attribution dash and before the output of the parameters above, thus one or more of those parameters must also be supplied. If you need to cite a fictional speaker in an article about a single work of fiction, where repeating the author and title information would be redundant, you can just use the {{para|author}} parameter instead of {{para|character}}.
 
−
 
 
−
Technically, all citation information can be given in a single parameter, as in:
 
−
<code><nowiki>|source=Anonymous interview subject, in Jane G. Arthur, "The Aerodynamics of Shaved Weasels", ''Perspectives on Mammal Barbering''(2016), Bram Xander Yojimbo (ed.)</nowiki></code>
 
−
But this is a bit messy, and will impede later efforts to generate metadata from quotation citations the way we are already doing with source citations. This is much more usable:
 
−
<code><nowiki>|character=Anonymous interview subject |author=Jane G. Arthur |title="The Aerodynamics of Shaved Weasels" |source=''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.)</nowiki></code>
 
−
Later development can assign a CSS <code>class</code> and so forth to these separate parameters, upon which scripts would be able to operate (e.g. to look up things in WikiQuote).
 
−
 
 
−
{{para|multiline}}—some of the issues with the formatting of quotes with line breaks can be fixed by using {{para|multiline|y}} (see [[#Line_breaks|the line breaks section]] for other options).
 
  
−
{{para|style}}—allows specifying additional [[Help:Cascading Style Sheets|CSS]] styles (''not'' classes) to apply to the {{tag|blockquote}} element. For example, when putting a quotation inside a quotation, use <code>style=font-size:inherit</code> on the inner quotations so that the text doesn't get unreadably small or (on mobile) too large for the screen.
+
;Numbered (positional) parameters
 +
<code><nowiki>{{quote|1=phrase|2=person|3=source}}</nowiki></code>
  
−
==Reference citations==
+
;Named parameters
−
{{anchor|Attribution|reason=Old section name}}
+
<code><nowiki>{{quote|text=phrase|sign=person|source=source}}</nowiki></code>
−
A [[WP:Citing sources|reference citation]] can be placed:
 
−
<ul>
 
−
<li>In the regular-prose introduction to the quotation:<br /><code><nowiki>According to Pat Doe, in "Underwater Basketweaving Tips" (2015):<ref>...</ref> {{quote |text=Quoted material.}}</nowiki></code></li>
 
−
<li>At the end of the quotation, when a quotation is given without {{para|author}} or {{para|source}} (e.g. because the material before the quote makes it clear who is being quoted):<br /><code><nowiki>According to Pat Doe, in "Underwater Basketweaving Tips" (2015): {{quote |text=Quoted material.<ref>...</ref>}}</nowiki></code></li>
 
−
<li>After the quoted person's name, in {{para|author}}, when a {{para|source}} is not being added:<br /><code><nowiki>As noted in "Underwater Basketweaving Tips" (2015): {{quote |text=Quoted material. |author=Pat Doe<ref>...</ref>}}</nowiki></code></li>
 
−
<li>After the source title, in {{para|source}} (the preferred location when both attribution parameters are present):<br /><code><nowiki>One expert noted in 2015: {{quote |text=Quoted material. |author=Pat Doe |source="Underwater Basketweaving Tips"<ref>...</ref>}}</nowiki></code></li>
 
−
</ul>
 
  
−
Please do not place the citation in a {{para|author}} or {{para|source}} parameter by itself, as it will produce a nonsensical attribution line that looks like:<br />{{in5}}—&#8239;{{fake ref}}<br />Please also do not put it just outside the {{tnull|Quote}} template, as this will cause a:<br />{{in5}}{{fake ref}}<br />on a line by itself.
+
=== Example ===
  
−
== Style ==
+
;Wikitext:
−
Styling is applied through CSS rules in [[MediaWiki:Common.css]].
+
<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>
−
<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>
 
−
HTML:
 
−
<syntaxhighlight lang=html>
 
−
<blockquote class="templatequote">
 
−
<p>Quote text.</p>
 
−
<div class="templatequotecite"><cite>—Author, Source</cite></div>
 
−
</blockquote>
 
−
</syntaxhighlight>
 
  
−
== Examples ==
+
;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}}
  
−
{{markupv
+
=== Restrictions ===
−
|markup=<source lang="moin">{{Quote|text=Cry "Havoc" and let slip the dogs of war.|character=Mark Antony|author=[[William Shakespeare]]|title=''[[Julius Caesar (play)|Julius Caesar]]''|source=act III, scene I}}</source>
 
−
|renders=
 
−
{{Quote|text=Cry "Havoc" and let slip the dogs of war.|character=Mark Antony|author=[[William Shakespeare]]|title=''[[Julius Caesar (play)|Julius Caesar]]''|source=act III, scene I}}
 
−
}}
 
  
−
== Limitations ==
+
If you do not provide quoted text, the template generates a parser error message, which will appear in red text in the rendered page.
−
{{anchor|Restrictions|reason=Old section name}}
 
−
If you do not provide 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]] (<code>=</code>), 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). Be wary of URLs, which frequently contain this character.
+
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.
 
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.
  
−
Put a break (newline) after the template, or the next blank line might be ignored.
+
Be wary of URLs which contain restricted characters. The equals sign is especially common.
−
 
 
−
=== Preserving line breaks and spacing from the original ===
 
−
Use {{tag|poem}} around material, such as poems and interlinear glosses, that require that whitespace formatting be preserve as in the original.  Due to limitations of how MediaWiki parses wikimarkup and HTML, attempts to do this by just inserting blank lines and extra spaces will not work. This is true of all block elements, not just block quotations.
 
  
−
=== Next to right-floated boxes ===
+
=== Multiple paragraphs ===
−
{{As of|2015|09}}, the text of a block quotation may rarely overflow (in Firefox or other Gecko browsers) a right-floated item (e.g. a {{tlx|Listen}} box, when that item is below another right-floated item of a fixed size that is narrower. In Safari and other Webkit browsers (and even more rarely in Chrome/Chromium) the same condition can cause the block quotation to be pushed downward.  Both of these problems can be fixed by either:
 
−
# removing the sizing on the upper item and letting it use its default size (e.g. removing <code>{{var|###}}x{{var|###}}px</code> sizing or {{para|upright}} from a right-floated image above a wider right-floated object that is being overflowed by quotation text; or
 
−
# using {{para|style|overflow:inherit;}} in the quotation template.
 
−
There may be other solutions, and future browser upgrades may eliminate the issue. It arises at all because of the <code>blockquote { overflow: hidden; }</code> CSS declaration in [[Mediawiki:Common.css]], which itself works around other, more common display problems. A solution that fixes {{em|all}} of the issues is unknown at this time.
 
  
−
=== Vanishing quotes ===
 
−
In rare layout cases, e.g. when quotes are sandwiched between userboxes, a quotation may appear blanked out, in some browsers. The workaround for this problem is to add {{para|style|overflow:inherit;}} to such an instance of the template.
 
−
 
−
=== Line breaks ===
 
 
{{Blockquote paragraphs}}
 
{{Blockquote paragraphs}}
−
 
−
=== Nested quotations ===
 
−
The {{tag|blockquote}} element has styles that change the font size: on desktop, text is smaller; on mobile, it's larger. This change is relative to the enclosing context, meaning that, if you quote from a source that itself uses a block quotation, you'll find that the inner quotation is either really tiny and hard to read, or really large and barely fits on the screen. Additionally, on mobile, you'll get an extra pair of oversize quotation marks. To fix both these issues, add the parameter <code>|style=font-size:inherit;quotes:none</code> on each of the inner {{tl|quote}} templates.
 
  
 
== TemplateData ==
 
== TemplateData ==
 
{{TemplateDataHeader}}
 
{{TemplateDataHeader}}
−
<templatedata>
+
<templatedata>{
−
{
+
  "description": "Adds a block quotation.",
−
"description": "Adds a block quotation.",
+
  "params": {
−
"params": {
+
    "text": {
−
"text": {
+
      "label": "text",
−
"label": "text",
+
      "description": "The text to quote",
−
"description": "The text to quote",
+
      "type": "string",
−
"type": "content",
+
      "required": false,
−
"required": true,
+
      "aliases": [ "1", "quote" ]
−
"aliases": [
+
    },
−
"1",
+
    "sign": {
−
"quote"
+
      "label": "sign",
−
],
+
      "description": "The person who is being quoted",
−
"example": "Cry \"Havoc\" and let slip the dogs of war."
+
      "type": "string",
−
},
+
      "required": false,
−
"sign": {
+
      "aliases": [ "2", "cite" ]
−
"label": "sign",
+
    },
−
"description": "The person being quoted",
+
    "source": {
−
"type": "content",
+
      "label": "source",
−
"required": false,
+
      "description": "A source for the quote",
−
"aliases": [
+
      "type": "string",
−
"2",
+
      "required": false,
−
"cite",
+
      "aliases": [ "3" ]
−
"author"
+
    }
−
],
+
  }
−
"example": "[[William Shakespeare]]",
+
}</templatedata>
−
"suggested": true
 
−
},
 
−
"source": {
 
−
"label": "source",
 
−
"description": "A source for the quote",
 
−
"type": "content",
 
−
"required": false,
 
−
"aliases": [
 
−
"3"
 
−
],
 
−
"example": "''[[Julius Caesar (play)|Julius Caesar]]'', act III, scene I",
 
−
"suggested": true
 
−
}
 
−
}
 
−
}
 
−
</templatedata>
 
−
 
 
−
== Errors ==
 
−
Pages where this template is not used correctly populate [[:Category:Pages incorrectly using the quote template]].
 
−
 
 
−
== 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.
 
  
−
{{Quotation templates}}
+
== See also ==
 +
{{Quotation templates see also}}
  
−
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|
+
<includeonly>
−
| <!-- ADD CATEGORIES AFTER THIS LINE, PLEASE: -->
+
<!-- ADD CATEGORIES AFTER THIS LINE -->
−
[[Category:Quotation templates]]
+
[[Category:Quotation templates|Quote]]
−
[[Category:Wikipedia XHTML tag-replacing templates]]
+
[[Category:Semantic markup templates]]
−
}}</includeonly>
+
[[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]]
 +
[[eo:Ŝablono:Citaĵo]]
 +
[[eu:Txantiloi:Aipua]]
 +
[[fa:الگو:نقل قول]]
 +
[[fi:Malline:Cquote]]
 +
[[fr:modèle:citation]]
 +
[[gl:Modelo:Cita]]
 +
[[gu:ઢાંચો:ઉક્તિ]]
 +
[[he:Template:ציטוט]]
 +
[[hi:साँचा:Quote]]
 +
[[hsb:Předłoha:Citat]]
 +
[[hu:Sablon:Idézet]]
 +
[[hy:Կաղապար:Քաղվածք]]
 +
[[id:Templat:Quote]]
 +
[[is:Snið:Tilvitnun]]
 +
[[it:Template:quote]]
 +
[[ja:Template:Quote]]
 +
[[ka:თარგი:ციტირება]]
 +
[[kk:Үлгі:Cquote]]
 +
[[ky:Калып:Цитата]]
 +
[[la:Formula:Locus]]
 +
[[lv:Veidne:Quotation]]
 +
[[mwl:Modelo:Quote]]
 +
[[no:Mal:Sitat]]
 +
[[os:Хуызæг:Cquote]]
 +
[[pl:Szablon:Cytat]]
 +
[[pt:Predefinição:Quote]]
 +
[[ro:Format:Cquote]]
 +
[[ru:Шаблон:Цитата]]
 +
[[sco:Template:Quote]]
 +
[[sh:Šablon:Citat]]
 +
[[sk:Šablóna:Citát]]
 +
[[sl:Predloga:Citatni blok]]
 +
[[sv:Mall:Citat]]
 +
</includeonly>

Revision as of 08:44, 25 July 2016


For linking a subject to a collection of quotes on Wikiquote, see Template:Wikiquote.

Usage

{{Quote}} adds a block quotation to an article page.

This is easier to type and more wiki-like than the equivalent HTML <blockquote>...</blockquote> 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.
— William Shakespeare, 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

The <blockquote> element and any templates that use it do not honor newlines:

Markup Renders as 
<blockquote>
Line 1
Line 2
Line 3
Line 4
</blockquote>

Line 1 Line 2 Line 3 Line 4

The simplest workaround for this is to use the <poem> tag inside <blockquote>, which will convert line breaks to <br /> tags:

Markup Renders as 
<blockquote><poem>
Line 1
Line 2
Line 3
Line 4
</poem></blockquote>
<poem>

Line 1 Line 2 Line 3 Line 4

</poem>

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error report for this template.

TemplateData for Quote/doc

Adds a block quotation.

Template parameters

ParameterDescriptionTypeStatus
texttext1quote

The text to quote

Default
empty
Example
empty
Auto value
empty
Stringoptional
signsign2cite

The person who is being quoted

Default
empty
Example
empty
Auto value
empty
Stringoptional
sourcesource3

A source for the quote

Default
empty
Example
empty
Auto value
empty
Stringoptional

See also

Similar templates comparison:


Retrieved from "https://wiki.pengtools.com/index.php?title=Template:Quote/doc&oldid=1461"