Misplaced Pages

Template:Epigraph

Article snapshot taken from Wikipedia with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.

This is an old revision of this page, as edited by Cynddl (talk | contribs) at 15:26, 6 May 2011 (Includeonly tags). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Revision as of 15:26, 6 May 2011 by Cynddl (talk | contribs) (Includeonly tags)(diff) ← Previous revision | Latest revision (diff) | Newer revision → (diff)


Template documentation[view] [edit] [history] [purge]
This template uses Lua:
Shortcuts
CSSThis template uses TemplateStyles:
"Template:Long quotation" redirects here. For maintenance templates about excessively long quotations, see Template:Long quote and Template:Over-quotation. For linking a subject to a collection of quotes on Wikiquote, see Template:Wikiquote.
WarningThis template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Template:Epigraph/doc/boilerplate

Usage

{{Epigraph}} 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; see § Reference citations, below).

Note: Block quotes do not normally contain quotation marks (see MOS:BLOCKQUOTE).

This template is for actual quotations only.Do not use it for block indentation of other material; see {{Block indent}} for that purpose.

Examples

Basic use:

Markup Renders as
{{Blockquote
|text=Quoted material.
}}

Quoted material.

With attribution displayed:

Markup Renders as
{{Blockquote
|text=Quoted material.
|author=First M. Last
}}

Quoted material.

— First M. Last

With more attribution:

Markup Renders as
{{Blockquote
|text=Quoted material.
|author=First M. Last
|title="Article Title"
|source=''Book Title'' (date)
}}

Quoted material.

— First M. Last, "Article Title", Book Title (date)

Examples with "multiline":

Especially useful for translated quotes; see notes about this parameter.

  • with "multiline" checkY
Markup Renders as
{{blockquote|text=
{{lang|fr|Ceci n'est pas une pipe.}}
This is Not a Pipe.
|multiline=yes
|author=]
|title='']''
}}

Ceci n'est pas une pipe.

This is Not a Pipe.

— René Magritte, The Treachery of Images
  • for comparison without "multiline" ☒N
Markup Renders as
{{blockquote|text=
{{lang|fr|Ceci n'est pas une pipe.}}
This is Not a Pipe.
|author=]
|title='']''
}}

Ceci n'est pas une pipe. This is Not a Pipe.

— René Magritte, The Treachery of Images

An ample example:

Markup Renders as
{{Blockquote|text=Cry "Havoc" and let slip the dogs of war.|character=Mark Antony|author=]|title='']''|source=act III, scene I}}

Cry "Havoc" and let slip the dogs of war.

— Mark Antony, in William Shakespeare, Julius Caesar, act III, scene I

Parameters

Parameter list

{{Blockquote
| text      =
| author    =
| title     =
| source    =
| character =
| multiline =
| class     =
| style     =
}}

See also section #TemplateData.

Quoted text

|text= a.k.a. |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 non-escaped "=" character (e.g., in a URL in a source citation) will break the template.

Displayed attribution

These parameters are for displaying attribution information below the quote; this should not be confused with citing a source (see § Reference citations, below). These parameters are entirely optional, and are usually used with famous quotations, not routine block quotations, which are usually sourced at the end of the introductory line immediately before the quotation, with a normal <ref>...</ref> tag.

|author= a.k.a. |2= – optional author/speaker attribution information that will appear below the quotation, and preceded with an attribution dash.

|title= a.k.a. |3= – optional title of the work the quote appears in, to display below the quotation. This parameter immediately follows the output of |author= (and an auto-generated comma), if one is provided. It does not auto-italicize. Major works (books, plays, albums, feature films, etc.) should be italicized; minor works (articles, chapters, poems, songs, TV episodes, etc.) go in quotation marks (see MOS:TITLES). Additional citation information can be provided in a fourth parameter, |source=, below, which will appear after the title.

|source= a.k.a. |4= – optionally used for additional source information to display, after |title=, like so: |title="The Aerodynamics of Shaved Weasels" |source=''Perspectives on Mammal Barbering'', 2016; a comma will be auto-generated between the two parameters. If |source= is used without |title=, it simply acts as |title=. (This parameter was added primarily to ease conversion from misuse of the pull quote template {{Quote frame}} for block quotation, but it may aid in cleaner meta-data implementation later.)

|character= a.k.a. |char= or |5= – to attribute fictional speech to a fictional character, with other citation information. Can also be used to attribute real speech to a specific speaker among many, e.g. in a roundtable/panel transcript, a band interview, etc. This parameter outputs ", in" after the attribution dash and before the output of the parameters above, thus one or more of those parameters must also be supplied. If you need to cite a fictional speaker in an article about a single work of fiction, where repeating the author and title information would be redundant, you can just use the |author= parameter instead of |character=.

Technically, all citation information can be given in a single parameter, as in: |source=Anonymous interview subject, in Jane G. Arthur, "The Aerodynamics of Shaved Weasels", ''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.) But this is a bit messy, and will impede later efforts to generate metadata from quotation attribution the way we are already doing with source citations. This is much more usable:

|character=Anonymous interview subject
|author=Jane G. Arthur
|title="The Aerodynamics of Shaved Weasels"
|source=''Perspectives on Mammal Barbering'' (2016), Bram Xander Yojimbo (ed.)


Later development can assign a CSS class and so forth to these separate parameters, upon which scripts would be able to operate (e.g. to look up things in WikiQuote).

Rarely used technical parameters

  • |multiline= – keep forced linebreaks in output.Notes:
    • Will only be applied if at least one of these other parameters or its aliases is not empty (including implicit, unnamed parameters):|author=, |title=, |source=, or |character=.
    • The value does not matter, as long it is not empty. Using a so called speaking parameter (such as true or yes) is highly recommended. Avoid values that can surprise users (e.g. false or no).
  • |style= – allows specifying additional CSS styles (not classes) to apply to the <blockquote>...</blockquote> element. (See #Nested quotations, below, for the most common use case.)
  • |class= – allows specifying additional HTML classes to apply to the same element.

Reference citations

A reference citation can be placed before the quote, after the quote, or in the |source= parameter:

  • checkY Typical use: In the regular-prose introduction to the quotation, when a quotation is given without the displayed |author=, |title=, or |source= parameters: According to Pat Doe, in "Underwater Basketweaving Tips" (2015):<ref>...</ref> {{blockquote |text=Quoted material.}}
  • At the end of the quotation, when a quotation is given without the displayed |author=, |title=, or |source= parameters, and placement before the quote isn't appropriate (e.g. because the material immediately before the quote isn't cited to the same source or introduces multiple quotes from different sources: Pat Doe and Chris Foo took opposing positions: {{blockquote |text=Doe's Quoted material.<ref>...</ref>}} {{blockquote |text=Foo's Quoted material.<ref>...</ref>}}
  • After the |source= value (if a value is given for the |source= parameter other than the <ref>...</ref> itself):One expert noted in 2015: {{blockquote |text=Quoted material. |author=Pat Doe |source="Underwater Basketweaving Tips" (2015)<ref>...</ref>}}
  • ☒N Deprecated: After the quoted person's name in |author=, or after the work's title in |title=, when a |source= parameter is not being added: As noted in "Underwater Basketweaving Tips" (2015): {{blockquote |text=Quoted material. |author=Pat Doe<ref>...</ref>}}information Note: Please avoid this format, as it will pollute the author or title metadata with non-author or non-title information.

Please do not place the citation in a |author= or |source= parameter by itself, as it will produce a nonsensical attribution line that looks like this:

     — 

Please also do not put it just outside the {{blockquote}} template, as this will cause a:

     on a line by itself.

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=MC" 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.

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 {{!}} and friends.

Next to right-floated boxes

As of September 2015, the text of a block quotation may rarely overflow (in Firefox or other Gecko browsers) a right-floated item (e.g. a {{Listen}} box, when that item is below another right-floated item of a fixed size that is narrower. In Safari and other Webkit browsers (and even more rarely in Chrome/Chromium) the same condition can cause the block quotation to be pushed downward. Both of these problems can be fixed by either:

  1. removing the sizing on the upper item and letting it use its default size (e.g. removing ###x###px sizing or |upright= from a right-floated image above a wider right-floated object that is being overflowed by quotation text; or
  2. using |style=overflow:inherit; in the quotation template.

There may be other solutions, and future browser upgrades may eliminate the issue. It arises at all because of the blockquote {overflow: hidden;} CSS declaration in Mediawiki:Common.css, which itself works around other, more common display problems. A solution that fixes all of the issues is unknown at this time.

Vanishing quotes

In rare layout cases, e.g. when quotes are sandwiched between userboxes, a quotation may appear blanked out, in some browsers. The workaround for this problem is to add |style=overflow:inherit; to such an instance of the template.

Line breaks

This template sets a text style which might ignore one blank line, and so the template must be ended with a break (newline) or the next blank line might be ignored. Otherwise, beware inline, as:
     text here {{blockquote|this is quoted}} More text here
spans a blank line, unless a {{blockquote|...}} is ended with a line break, then the next blank line might be ignored and two paragraphs joined.

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

An easy solution is to use the {{poem quote}} template instead of <blockquote>...</blockquote>. This is effectively the same as using the <poem> tag inside <blockquote>, which converts line breaks to <br /> tags:

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

Line 1
Line 2
Line 3
Line 4

To markup actual paragraphs within block quotations, entire blank lines can be used between them, which will convert to <p>...</p> tags:

Markup Renders as
<blockquote>
Paragraph 1
Paragraph 2
Paragraph 3
</blockquote>

Paragraph 1

Paragraph 2

Paragraph 3

Note that it may be necessary to put a line break in the wikitext before <blockquote> and after </blockquote> in order for the paragraphs to render with the intended separation. (This also makes the wikitext easier to read.)

This paragraph style also works with {{blockquote}}, which is a replacement for <blockquote> that also has parameters to make formatting of the attribution more convenient and consistent.

Blockquote and templates that call it, and are indented with colon (:), bulleted with asterisk (*), or numbered with number (#), will generate errors and incorrectly display anything after a newline character.

Markup Renders as
:<blockquote>Paragraph 1
Paragraph 2</blockquote>

Paragraph 1

Paragraph 2
Markup Renders as
*<blockquote>Paragraph 1
Paragraph 2</blockquote>
  • Paragraph 1

Paragraph 2
Markup Renders as
#<blockquote>Paragraph 1
Paragraph 2</blockquote>
  1. Paragraph 1

Paragraph 2

Nested quotations

The <blockquote>...</blockquote> element has styles that change the font size: on desktop, text is smaller; on mobile, it is larger. This change is relative to the enclosing context, meaning that if you quote from a source that itself uses a block quotation, you'll find that the inner quotation is either really tiny and hard to read, or really large and barely fits on the screen. To fix this issue, add the parameter |style=font-size:inherit; on any inner {{blockquote}} templates.

Technical issues with block templates

If the block-formatted content uses a named parameter (including |1=) and begins with a list (or any other wikimarkup that is dependent upon a specific markup character being at the beginning of a line), because MediaWiki behavior is to strip whitespace from named parameters, a <nowiki /> and a new line must exist before the list (or whatever) starts. This no longer affects unnamed parameters. Compare:

  code result
Works as intended {{Epigraph|
*Firstly, ...
*Secondly, ...
*Thirdly, ...
}}

{{{quote}}}

—{{{cite}}}

FAIL {{Epigraph|1=
*Firstly, ...
*Secondly, ...
*Thirdly, ...
}}

{{{quote}}}

—{{{cite}}}

Works as intended {{Epigraph|1=<nowiki />
*Firstly, ...
*Secondly, ...
*Thirdly, ...
}}

{{{quote}}}

—{{{cite}}}

To embed a table in block markup like this, the block template's content parameter must be named or numbered and include the self-closing nowiki – as in |1=<nowiki /> – then every | character in the table markup must be escaped with {{!}}. An alternative is to use explicit HTML <table>, <tr>, <th>, and <td> markup.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Epigraph in articles based on its TemplateData.

TemplateData for Epigraph

Adds a block quotation.

Template parameters

ParameterDescriptionTypeStatus
texttext 1 quote

The text to quote

Example
Cry "Havoc" and let slip the dogs of war.
Contentrequired
authorauthor 2 cite sign

The writer of the source

Example
William Shakespeare
Contentsuggested
titletitle 3

The work being quoted from

Example
Julius Caesar
Contentsuggested
sourcesource 4

A source for the quote

Example
act III, scene I
Contentsuggested
charactercharacter 5 char

The speaker within the work who is being quoted

Example
Mark Antony
Contentoptional
multilinemultiline

Keeps forced linebreaks in output

Example
true
Stringoptional
stylestyle

Additional CSS styles (not classes) to apply

Example
font-size:inherit;
Stringoptional
classclass

Additional HTML classes to apply

Example
pullquote
Stringoptional

Tracking categories

See also

Quotation templates
Template  Use / description 
Block quotations General purpose
{{Blockquote}} Our standard block quotation template: unbordered page-wide quotation with optional smaller-sized attribution
{{Break lines}} Transforms line breaks into <br /> tags. It is very similar to the {{poem}} template, except that it does not invoke the <poem> MediaWiki extension.
{{Numbered verses}} Quote poems showing the verse numbers
{{Poem}} {{Blockquote}} variant for use with poems, song lyrics, and other things that would otherwise require the use of <poem> tags or frequent formatting elements (such as <br />); requires substitution
{{Poem quote}} {{Blockquote}} variant for use with poems, song lyrics, and other things that would otherwise require the use of <poem> tags or frequent formatting elements (such as <br />); does not require substitution
{{Poetically break lines}} (shortcut: {{pbl}}) Designed to format poetry simply and reliably; it differs from {{Poem quote}} in two significant ways: it does not add spacing around the poem that sets it apart as “block quote”, and it automatically provides hanging indentation when lines are so long that they wrap
{{Translated blockquote}} Displays original language above and translated text below
{{Text and translation}} Displays original language and translated text, one beside the other
{{Verse translation}} Displays original language verse (defaults to italics) and translated verse (roman) side-by-side
{{Verse transliteration-translation}} Like {{Verse translation}}, but with a transliteration separate from the original version
{{Quote inline}}(shortcut: {{qi}}) Inline quotation
{{Cquote}} "centered quote" – Page-wide quote, between large quotation marks
{{Rquote}} "reduced quote" – Quote between large quotation marks in a reduced floating area
{{Quote frame}} Page-wide bordered quote
{{Quote box}} Quote floated in a reduced bordered box
{{Tweet}} For quoting directly from tweets. Automatically generates {{Cite tweet}} citation, or a custom reference can be provided.
  
Talk page quoting Not for use in articles nor the project space at all
{{Talk quote inline}}(shortcut: {{tq}},{{tqq}}, {{tqi}}, or {{tqqi}}) Inline quotation for use on talk pages
{{Not talk quote inline}}(shortcut: {{!tq}},{{!tqq}}, {{!tqi}}, or {{!tqqi}}) Inline quotation for what someone didn't say but could have, or perhaps should have, said.
{{Talk quote block}}(shortcut: {{tqb}}, {{tq2}}) Block-style quotation for use on talk pages
{{Talk quote block minimalist}}(shortcut: {{tqbm}}) Minimalist version of above
  
Alternative For indenting non-quotations
{{Block indent}} To indent an entire block of content (uses <div> and CSS margins)
{{Divbox}} To frame messages or the example output of an article or template
Semantic markup templates
Template  Example output  Use 
{{strong}} Important! To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
{{strongbad}} "Never use ..." Same as {{strong}} but in red
{{stronggood}} "Only use ..." Same as {{strong}} but in green
{{em}} "An emphatic phrase" To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
{{var}} strPrefix To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
{{var serif}} strIllustratePrefix (see {{var}} above)
{{tld}} {{DEFAULTSORT:Y, X}} To display wikicode variables and magic words as they would appear in code
{{para}} |year=2008 To display template parameters with or without values
{{param}} {{{title|alt}}} To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
{{tjp}} selfref=yes To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates)
{{param value}} ··2·blanks·fore·and·aft·· To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.
{{tlx}} etc. {{Template|1|2|...|10}} To display a template call (with or without parameters and values) as code
{{tji}} {{hatnote|Hello|selfref=yes|category=no}} To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{tag}} "The <img>...</img> tags ..." To render HTML elements ("tags") in prose
{{code}}/{{codett}} "Ensure the alt= parameter ..." To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: someMethod becomes someMethod
{{PreCode}} "FORTH has keyword ?BRANCH." Like {{code}}, but prevents line breaks inside the code. Only for very short code parts.
{{subst:codenowiki}} {{small|small text example}} To wrap example code in <code><nowiki>...</nowiki></code>
{{subst:kbdnowiki}} {{large|large text example}} To wrap example code in <kbd><nowiki>...</nowiki></kbd>
{{syntaxhighlight}}     ( or {{sxhl}} )  Wrapper for <syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text
{{deprecated code}} "Do not use <blink>." ( or {{dc}} )  To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2}} variant uses strike-through (<blink>) while {{dcr}} uses red (<blink>).
{{pre}}     For larger blocks of source code and other pre-formatted text
{{tj}}     To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{quote}}     For block quotations (only – never for non-quotations)
{{block indent}}     For indented blocks of material; visually identical to {{quote}} but without quote markup
{{kbd}} user input To indicate user input
{{key press}} Ctrl+x To indicate specific-keystroke input, including combinations
{{key top}} Left shift Similar; includes more symbols, but does not directly support combinations
{{button}} Don't save To indicate a button in a user interface
{{samp}} example output To indicate sample or example output
The above documentation is transcluded from Template:Epigraph/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template. Categories: