Difference between revisions of "Template:Quote/doc"
m |
m |
||
| Line 1: | Line 1: | ||
| − | The {{ | + | The {{tlg|quote}} formats block quotations and provides a wrapper with decorative marks for the HTML {{tag|blockquote|open}} element. |
This template should {{strong|not be used}} for block quotations in article text. 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. | This template should {{strong|not be used}} for block quotations in article text. 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. | ||
| Line 5: | Line 5: | ||
== Usage == | == Usage == | ||
| − | {{ | + | {{tlg|code=yes|nolink=yes|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. |
{{note|Block quotes do {{em|not}} normally contain quotation marks.}} | {{note|Block quotes do {{em|not}} normally contain quotation marks.}} | ||
| Line 12: | Line 12: | ||
; {{para|1}} or {{para|quote}} : The material being quoted, without quotation marks around it. | ; {{para|1}} or {{para|quote}} : The material being quoted, without quotation marks around it. | ||
| − | |||
; {{para|2}} or {{para|source}} : Optional speaker or source information to display that will appear below the quotation, and preceded with an attribution dash. | ; {{para|2}} or {{para|source}} : Optional speaker or source information to display that will appear below the quotation, and preceded with an attribution dash. | ||
| Line 22: | Line 21: | ||
! Renders as | ! Renders as | ||
|- | |- | ||
| − | | {{ | + | | {{tlg|code=yes|nolink=yes|quote|Quoted material.}} |
| {{quote|Quoted material.}} | | {{quote|Quoted material.}} | ||
|- | |- | ||
| − | | {{ | + | | {{tlg|code=yes|nolink=yes|quote|Quoted material.|Source material}} |
| {{quote|Quoted material.|Source material}} | | {{quote|Quoted material.|Source material}} | ||
|- | |- | ||
| − | | {{ | + | | {{tlg|code=yes|nolink=yes|quote|text{{=}}Quoted material.|source{{=}}Source material}} |
| {{quote|text=Quoted material.|source=Source material}} | | {{quote|text=Quoted material.|source=Source material}} | ||
|} | |} | ||
| Line 36: | Line 35: | ||
If you do not provide text, the template generates a parser error message, which will appear in red text in the rendered page. | 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 “=”, you {{strong|must}} use a named parameter (e.g. {{para|text|2=“E=MC<sup>2</sup>”}} is a formula everyone knows but few understand | + | If any parameter’s actual value contains an equals sign “=”, you {{strong|must}} use a named parameter (e.g. {{para|text|2=“E=MC<sup>2</sup>”}} is a formula everyone knows but few understand, not a blank‐name positional parameter. The text before the equals sign gets misinterpreted as a named parameter otherwise. Be wary of URLs, which frequently contain this character. Named parameters are always safer, in this and other templates. |
[[Category:Templates]] | [[Category:Templates]] | ||
[[Category:Templates documentation]] | [[Category:Templates documentation]] | ||
Revision as of 18:28, 21 July 2020
The {{quote}} formats block quotations and provides a wrapper with decorative marks for the HTML <blockquote> element.
This template should not be used for block quotations in article text. 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.
Contents
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.
- Block quotes do not normally contain quotation marks.
Parameters
|1=or|quote=- The material being quoted, without quotation marks around it.
|2=or|source=- Optional speaker or source information to display that will appear below the quotation, and preceded with an attribution dash.
Examples
| Markup | Renders as | ||
|---|---|---|---|
{{quote|Quoted material.}}
|
| ||
{{quote|Quoted material.|Source material}}
|
| ||
{{quote|text=Quoted material.|source=Source material}}
|
|
Limitations
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 “=”, you must use a named parameter (e.g. |text=“E=MC2” is a formula everyone knows but few understand, not a blank‐name positional parameter. The text before the equals sign gets misinterpreted as a named parameter otherwise. Be wary of URLs, which frequently contain this character. Named parameters are always safer, in this and other templates.