Template:Cquote/doc: Difference between revisions
meta>SMcCandlish normalizing the pull quote templates' documentation |
meta>SMcCandlish more work on synching the pull quote templates' documentation |
||
Line 1: | Line 1: | ||
{{Documentation subpage}}{{TOC right}} | {{Documentation subpage}}{{TOC right}} | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | ||
{{warning|'''NOTE''': This template should '''not be used''' for block quotations in article text.}} | {{warning|'''NOTE''': This template should '''not be used''' for block quotations in article text.}} | ||
This template is meant for [[pull quote]]s, the visually distinctive {{em|repetition}} of text that is {{em|already present}} on the same page. In most cases, this is not appropriate for use in encyclopedia articles. The [[Wikipedia:Manual of Style#Block quotations|Manual of Style guidelines for block quotations]] recommend formatting block quotations using the {{tlx|Quote}} template or the HTML <[[blockquote]]> element, for which that template provides a wrapper. | This template is meant for [[pull quote]]s, the visually distinctive {{em|repetition}} of text that is {{em|already present}} on the same page. In most cases, this is not appropriate for use in encyclopedia articles. The [[Wikipedia:Manual of Style#Block quotations|Manual of Style guidelines for block quotations]] recommend formatting block quotations using the {{tlx|Quote}} template or the HTML <[[blockquote]]> element, for which that template provides a wrapper. | ||
* Pull 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. | * Pull 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 very short pull quotes, | * For typical pull quotes, especially those longer than the rest of the paragraph in which they are quoted, {{tlx|Pull quote}} provides a borderless quote box spanning the page width. | ||
* For very short pull quotes, {{tl|Reduced pull quote}} can be used to set the quote off to either the right or left as in a magazine [[Sidebar (publishing)|sidebar]]. This can be effective on [[WP:ESSAY|essay]] pages and [[WP:WIKIPROJECT|WikiProject]] homepages. | |||
For a visually distinctive block quotation, use the {{tlx|Quotation}} templates. Generally, do not mix-and-match styles in an article. | For a visually distinctive block quotation, use the {{tlx|Quotation}} templates. Generally, do not mix-and-match styles in an article. | ||
==Usage== | == Usage == | ||
For actual [[pull quote]]s, this template provides a centered, borderless pull quote, with scalable decorative quotation marks, and optional attribution of the source of the quote. It can be used with or without the names of the parameters. | |||
===Syntax=== | ===Syntax=== |
Revision as of 18:51, 14 September 2015
This is a documentation subpage for Template:Cquote. It may contain usage information, categories and other content that is not part of the original template page. |
NOTE: This template should not be used for block quotations in article text. |
This template is meant for pull quotes, the visually distinctive repetition of text that is already present on the same page. In most cases, this is not appropriate for use in encyclopedia articles. The Manual of Style guidelines for block quotations recommend formatting block quotations using the {{Quote}}
template or the HTML <blockquote> element, for which that template provides a wrapper.
- Pull 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 pull quotes, especially those longer than the rest of the paragraph in which they are quoted,
{{Pull quote}}
provides a borderless quote box spanning the page width. - For very short pull quotes, {{Reduced pull quote}} 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.
For a visually distinctive block quotation, use the {{Quotation}}
templates. Generally, do not mix-and-match styles in an article.
Usage
For actual pull quotes, this template provides a centered, borderless pull quote, with scalable decorative quotation marks, and optional attribution of the source of the quote. It can be used with or without the names of the parameters.
Syntax
{{Cquote|quote=text of the quotation|author=person quoted|source=source of the quotation}}
{{Cquote|text of quotation|person quoted|source of the quotation}}
Parameters
- Parameter 1
- text of the quote; use
<br />
between paragraphs. - Required
- Note: if the quote text contains a
=
(equal sign), then the template must be called with a named parameter for the content, e.g. {{pull quote|quote=quote text}} - author
- Name of the person that wrote or spoke the text being quoted. Can include wiki syntax.
- source
- Source of the quote (publication title, speech, etc.). Can include wiki syntax.
- bgcolor
- The color of the background.
- float
- Defaults to center, but can also be right or left
- wide
- When set to "yes", the quote expands to the entire width of the page. Useful for long quotes, but may clash with other floating objects, such as infoboxes.
- qcolor
- color of quotemarks (only for use in WP:Signpost, and personal pages; do not use in articles, guidelines, etc.)
Simple example
{{pull quote|quote text}}
Sourced example
{{pull quote|Life is like riding a bicycle. To keep your balance you must keep moving. |author=[[Albert Einstein]] |source=in a letter to his son<ref>[[Walter Isaacson]], ''Einstein: His Life and Universe'' (2007), p. 367.</ref> }}
Other examples
{{pull quote|1=F=ma|author=[[Isaac Newton]]}}
(the 1= is necessary as quote text contains an equal sign) Template:Pull quote
{{pull quote|1=Thus: {{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}
(quote text contains an equal sign and math syntax) Template:Pull quote