Template:Cquote/doc: Difference between revisions

Nothing to hide, but nothing to show you either.
Jump to navigation Jump to search
Content added Content deleted
VisualWikitext
(→‎Usage: text tweaks)
(doc cleanup)
Line 5: Line 5:
==Usage==
==Usage==
This template is meant for [[pull quote]]s, 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.
This template is meant for [[pull quote]]s, 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.

It 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.


* {{strong|NOTE: This template should {{em|only}} be used for short pull quotes, which repeat quoted text already appearing in the article, and {{em|never}} for block quotations.}}.
* {{strong|NOTE: This template should {{em|only}} be used for short pull quotes, which repeat quoted text already appearing in the article, and {{em|never}} for block quotations.}}.
Line 12: Line 14:


===Syntax===
===Syntax===
# <code><nowiki>{{pull quote|quote text}}</nowiki></code>
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|quote={{var|text of the quotation}}|author={{var|person quoted}}|source={{var|source of the quotation}}<nowiki>}}</nowiki></code>
# <code><nowiki>{{pull quote|quote text|author=author or speaker}}</nowiki></code>
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|{{var|text of quotation}}|{{var|person quoted}}|{{var|source of the quotation}}<nowiki>}}</nowiki></code>
# <code><nowiki>{{pull quote|quote text|author=author or speaker|source=title of article, speech, book, etc.}}</nowiki></code>


===Parameters===
===Parameters===
; Parameter 1: text of the quote; use <code><nowiki><br /></nowiki></code> between paragraphs.
; Parameter 1: text of the quote; use <code><nowiki><br /></nowiki></code> between paragraphs.
: '''''Required'''''
: '''''Required'''''
: '''Note''': if the quote text contains one or more "=" (equal signs), then the template must be called as <nowiki>{{pull quote|</nowiki>'''<span style="color:red;">1=</span>'''<nowiki>quote text}}</nowiki> (see [[m:Help:Templates#Equals sign in parameter value|"Equals sign in parameter value"]])
: '''Note''': if the quote text contains a <code>=</code> (equal sign), then the template must be called with a named parameter for the content, e.g. <nowiki>{{pull quote|</nowiki>'''<span style="color:red;">quote=</span>'''<nowiki>quote text}}</nowiki> {{crossref|1=(see {{section link|Help:Template#Usage hints and workarounds}})}}.
; author: Name of the person that wrote or spoke the text being quoted. Can include wiki syntax.
; 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.
; source: Source of the quote (publication title, speech, etc.). Can include wiki syntax.
; bgcolor: The color of the background.
; bgcolor: The color of the background.
; float: Defaults to center, but can also be right or left
; 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 small quotes, but may clash with other floating objects, such as infoboxes.
; 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 The Signpost)
; qcolor : color of quotemarks (only for use in [[WP:Signpost]], and personal pages; do not use in articles, guidelines, etc.)


===Simple example===
===Simple example===
<pre>{{pull quote|quote text}}</pre>
<pre>{{pull quote|quote text}}</pre>
{{pull quote|To be, or not to be.}}
{{pull quote|To be, or not to be ...}}


===Sourced example===
===Sourced example===
Line 50: Line 51:


<pre>{{pull quote|1=Thus:
<pre>{{pull quote|1=Thus:
:<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre>
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}</pre>
(quote text contains an equal sign and math syntax)
(quote text contains an equal sign and math syntax)
{{pull quote|1=Thus:
{{pull quote|1=Thus:
:<math>E=mc^2</math>|author=[[Albert Einstein]]}}
{{in5}}<math>E=mc^2</math>|author=[[Albert Einstein]]}}




Revision as of 21:21, 12 September 2015

Usage

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.

It 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.

  • NOTE: This template should only be used for short pull quotes, which repeat quoted text already appearing in the article, and never for block quotations..
  • The Manual of Style guidelines for block quotations recommend formatting block quotations using the HTML <blockquote> element (which can be done with the {{quote}} or {{quote box}} quotation templates).
  • Pull quotes work best when used with short sentences, and at the start or end of a section, as a hint of the following section's content.
  • For very short pull quotes, consider using {{Reduced pull quote}} which sets the quote off to either the right or left as in a magazine sidebar. This can be effective on essay pages and WikiProject homepages.

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}}
(see Help:Template § Usage hints and workarounds).
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}}

Template:Pull quote

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

Template:Pull quote

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



Retrieved from ‘https://privacywiki.xyz/wiki/Template:Cquote/doc?oldid=14351’