Difference between revisions of "Template:Quote/doc"

From Remorra
Jump to: navigation, search
imported>SantaCruzSentinel
m (70 revisions imported)
 
(59 intermediate revisions by 44 users not shown)
Line 1: Line 1:
−
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
+
{{Documentation subpage}}
−
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
−
<includeonly>{{esoteric}}</includeonly>
 
  
−
<code>{&#123;[[Template:{{PAGENAME}}|{{lcfirst:{{PAGENAME}}}}]]&#125;}</code> adds a [[block quote]] to an article page.
+
{{For|linking a subject to a collection of quotes on [[Wikiquote]]|Template:Wikiquote}}
  
−
This is easier to type and more wiki-like than the equivalent HTML <code><nowiki><blockquote></nowiki></code> tags, has additional pre-formatted attribution and source parameters, and contains a workaround for [[Bugzilla:6200]], which means you don't need to type <code><nowiki><p></nowiki></code> tags manually.
+
== Usage ==
  
−
Note: Block quotes do not normally contain quotation marks.  See [[Block_quote#Formatting_block_quotes|Formatting block quotes]].
+
{{tlx|Quote}} adds a [[block quotation]] to an article page.
  
−
==Usage==
+
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. -->
−
<code><nowiki>{{Quote|Phrase}}</nowiki></code> produces:
 
  
−
{{Quote|Phrase}}
+
'''Note:''' Block quotes do not normally contain quotation marks. See [[MOS:QUOTE]].
  
−
<code><nowiki>{{Quote|Phrase|Somebody}}</nowiki></code> produces:
+
=== Synopsis ===
  
−
{{Quote|Phrase|Somebody}}
+
;Unnamed (positional) parameters
 +
<code><nowiki>{{quote|phrase|person|source}}</nowiki></code>
 +
This markup will fail if any parameter contains an equals sign (=).
  
−
<code><nowiki>{{Quote|Phrase|Somebody|''Source''}}</nowiki></code> produces:
+
;Numbered (positional) parameters
 +
<code><nowiki>{{quote|1=phrase|2=person|3=source}}</nowiki></code>
  
−
{{Quote|Phrase|Somebody|''Source''}}
+
;Named parameters
 +
<code><nowiki>{{quote|text=phrase|sign=person|source=source}}</nowiki></code>
  
−
== Example ==
+
=== Example ===
−
<!-- for the documentation don't subst the result -->
 
−
{| class="wikitable"
 
−
| '''Code'''
 
−
| '''Result'''
 
−
|-
 
−
| valign="top" | <code>{&#123;{{BASEPAGENAME}}&#124;<nowiki>{{lorem_ipsum}}</nowiki>|Some Latin Guy|'&#39;Italic Nonsense&#39;'&#125;}</code>
 
−
| {{msg:{{BASEPAGENAME}}|{{lorem ipsum}}|Some Latin Guy|''Italic Nonsense''}}
 
−
|}
 
  
−
== See also ==
+
;Wikitext:
 +
<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>
 +
 
 +
;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}}
 +
 
 +
=== 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 [[vertical bar|pipe]], [[brackets]], single quotation marks, etc.), you may need to escape it. See [[Template:!]] and friends.
  
−
<!-- self-listing for quick access on edit history -->
+
Be wary of URLs which contain restricted characters. The equals sign is especially common.
−
* {{Lts|{{BASEPAGENAME}}}}
 
−
* {{Lts|Cquote}}
 
  
−
<includeonly>
+
=== Multiple paragraphs ===
−
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
−
Quotes
 
−
[[Category:Quotation templates|{{PAGENAME}}]]
 
  
−
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
{{Blockquote paragraphs}}
−
—"Congressmen who willfully take actions during wartime that damage morale and undermine the military are saboteurs who should be arrested, exiled or hanged." Abraham Lincoln
 
  
−
Retrieved from "http://en.wikipedia.org/wiki/Wikipedia:Introduction"
+
== TemplateData ==
 +
{{TemplateDataHeader}}
 +
<templatedata>{
 +
  "description": "Adds a block quotation.",
 +
  "params": {
 +
    "text": {
 +
      "label": "text",
 +
      "description": "The text to quote",
 +
      "type": "string",
 +
      "required": false,
 +
      "aliases": [ "1", "quote" ]
 +
    },
 +
    "sign": {
 +
      "label": "sign",
 +
      "description": "The person who is being quoted",
 +
      "type": "string",
 +
      "required": false,
 +
      "aliases": [ "2", "cite" ]
 +
    },
 +
    "source": {
 +
      "label": "source",
 +
      "description": "A source for the quote",
 +
      "type": "string",
 +
      "required": false,
 +
      "aliases": [ "3" ]
 +
    }
 +
  }
 +
}</templatedata>
  
 +
== See also ==
 +
{{Quotation templates see also}}
 +
 +
<includeonly>
 +
<!-- ADD CATEGORIES AFTER THIS LINE -->
 +
[[Category:Quotation templates|Quote]]
 +
[[Category:Semantic markup templates]]
 +
[[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]]
 
[[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]]
 
[[it:Template:quote]]
 +
[[ja:Template:Quote]]
 +
[[ka:თარგი:ციტირება]]
 +
[[kk:Үлгі:Cquote]]
 +
[[ky:Калып:Цитата]]
 +
[[la:Formula:Locus]]
 +
[[lv:Veidne:Quotation]]
 +
[[mwl:Modelo:Quote]]
 
[[no:Mal:Sitat]]
 
[[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>
 
</includeonly>

Latest revision as of 07:55, 18 April 2019

Template:Mbox

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

{{#invoke:Template translation|renderTranslatedTemplate|template=Template:Navbar|noshift=1}}

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

To resolve this, use the <poem > tag inside <blockquote>:

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

Line 1
Line 2
Line 3
Line 4

TemplateData

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

Quote

<templatedata>{ 

 "description": "Adds a block quotation.",
 "params": {
   "text": {
     "label": "text",
     "description": "The text to quote",
     "type": "string",
     "required": false,
     "aliases": [ "1", "quote" ]
   },
   "sign": {
     "label": "sign",
     "description": "The person who is being quoted",
     "type": "string",
     "required": false,
     "aliases": [ "2", "cite" ]
   },
   "source": {
     "label": "source",
     "description": "A source for the quote",
     "type": "string",
     "required": false,
     "aliases": [ "3" ]
   }
 }

}</templatedata>

See also

Template:Tnavbar

Similar templates comparison:


Retrieved from "https://remorra.beetlewing.com/w/index.php?title=Template:Quote/doc&oldid=2207"