Template:Blockquote/doc: Difference between revisions

Nothing to hide, but nothing to show you either.
Jump to navigation Jump to search
Content added Content deleted
(merged example sections, example fix; fixed wording in templatedata)
(more documentation for parameter "multiline"; resorted "Parameters" section)
Line 16: Line 16:


=== Examples ===
=== Examples ===
;Basic use{{colon}}:
;Basic use{{colon}}
{{markup|
{{markup|
<nowiki>{{Quote
<nowiki>{{Quote
|text=Quoted material.
|text=Quoted material.
}} </nowiki>|{{Quote
}}</nowiki>|{{Quote
|text=Quoted material.
|text=Quoted material.
}}}}
}}}}<!-- Template:Mra -->


;With attribution displayed{{colon}}:
;With attribution displayed{{colon}}
{{markup|
{{markup|
<nowiki>{{Quote
<nowiki>{{Quote
|text=Quoted material.
|text=Quoted material.
|author=First M. Last
|author=First M. Last
}} </nowiki>|{{Quote
}}</nowiki>|{{Quote
|text=Quoted material.
|text=Quoted material.
|author=First M. Last
|author=First M. Last
}}}}
}}}}<!-- Template:Mra -->


;With more attribution{{colon}}:
;With more attribution{{colon}}
{{markup|
{{markup|
<nowiki>
<nowiki>
Line 42: Line 42:
|title="Article Title"
|title="Article Title"
|source=''Book Title'' (date)
|source=''Book Title'' (date)
}} </nowiki>|
}}</nowiki>|
{{Quote
{{Quote
|text=Quoted material.
|text=Quoted material.
Line 50: Line 50:
}}}}
}}}}


;Example with "multiline"{{colon}}
;An ample example<!-- no pun intended -->
Especially useful for translated quotes; ''see [[#multiline|notes about this parameter]]''.
* with "multiline" {{tick}}
{{markup|
<nowiki>
{{quote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
|multiline=yes
|author=[[René Magritte]]
|title=[[The Treachery of Images]]
}}</nowiki>|
{{quote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
|multiline=yes
|author=[[René Magritte]]
|title=[[The Treachery of Images]]
}}}}
* for comparison without "multiline" {{cross}}
{{markup|
<nowiki>
{{quote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
|author=[[René Magritte]]
|title=[[The Treachery of Images]]
}}</nowiki>|
{{quote|text=
{{lang|fr|Ceci n’est pas une pipe.}}
This is Not a Pipe.
|author=[[René Magritte]]
|title=[[The Treachery of Images]]
}}}}

;An ample example<!-- no pun intended -->{{colon}}
{{markupv
{{markupv
|markup=<syntaxhighlight 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</syntaxhighlight>
|markup=<syntaxhighlight 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</syntaxhighlight>
Line 57: Line 92:


== Parameters ==
== Parameters ==
=== Parameter list ===
<pre>
{{Quote
| text =
| author =
| title =
| source =
| character =
| multiline =
| style =
| notrim =
}}
</pre>

See also section [[#TemplateData]].

=== Quoted text ===
{{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|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.


Line 80: Line 132:


=== Rarely used technical parameters ===
=== Rarely used technical parameters ===
* {{anchor|multiline}}{{para|multiline}} – keep forced linebreaks in output.<br>
{{para|style}} – allows specifying additional [[Help:Cascading Style Sheets|CSS]] styles ({{em|not}} classes) to apply to the {{code|lang=html|code=<blockquote>...</blockquote>}} element. {{Crossreference|(See [[#Nested quotations]], below, for the most common use case.)}}
''Notes:''

** Will only be applied if at least one of these other parameters or its aliases is not empty (including implicit, unnamed parameters):<br>{{para|author}}, {{para|title}}, {{para|source}}, or {{para|character}}.
=== Parameter list ===
** The value does not matter, as long it is not empty. Using a so called speaking parameter (such as <code>true</code> or <code>yes</code>) is highly recommended. Avoid values that can surprise users (e.g. <code>false</code> or <code>no</code>).
<pre>
* {{para|style}} – allows specifying additional [[Help:Cascading Style Sheets|CSS]] styles ({{em|not}} classes) to apply to the {{code|lang=html|code=<blockquote>...</blockquote>}} element. {{Crossreference|(See [[#Nested quotations]], below, for the most common use case.)}}
{{Quote
| text =
| author =
| title =
| source =
| character =
| multiline =
| style =
}}
</pre>


== Reference citations ==
== Reference citations ==
Line 202: Line 245:
"example": "Mark Antony",
"example": "Mark Antony",
"suggested": false
"suggested": false
},
"multiline": {
"label": "multiline",
"description": "Keeps forced linebreaks in output",
"type": "string",
"required": false,
"example": "true",
"suggested": false
},
},
"style": {
"style": {
"label": "style",
"label": "style",
"description": "Additional CSS styles (not classes) to apply",
"description": "Additional CSS styles (not classes) to apply",
"type": "string",
"required": false,
"required": false,
"example": "font-size:inherit;",
"example": "font-size:inherit;",

Revision as of 21:29, 14 July 2020

Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab.

Lua error in package.lua at line 80: module 'Module:Transclusion_count/data/B' not found.


The Manual of Style guidelines for block quotations recommend formatting block quotations using the {{Blockquote}} template or the HTML <blockquote> element, for which that template provides a wrapper.

  • Quotes work best when used with short sentences, and at the start or end of a section, as a hint of or to help emphasize the section's content.
  • For typical quotes, especially those longer than the rest of the paragraph in which they are quoted, {{Cquote}} (for use outside of article space only) provides a borderless quote with decorative quotation marks, and {{Quote frame}} provides a bordered quote. Both span the page width.
  • For very short quotes, {{Rquote}} (with decorative quotation marks, for use outside of article space only) or {{Quote box}} (framed) can be used to set the quote off to either the right or left as in a magazine sidebar. This can be effective on essay pages and WikiProject homepages.

Usage

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

This is easier to type and is more wiki-like than the equivalent HTML <blockquote>...</blockquote> tags, and has additional pre-formatted attribution parameters for author and source (though these are not usually used in articles;