Template:Quotebox

From Itora Wiki

Hello everyone, and welcome to tonight's episode of Critical Role, where a bunch of us nerdy-ass voice actors sit around and play Dungeons & Dragons.

Template documentation (for the above template, sometimes hidden or invisible)[view] [edit] [history] [refresh]

Description

This template can be used for block quotations (long quotes set off from the main 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.

Dependencies

Usage

For actual quotes, and poems, this template can be used to present a title, quote, author, and source in a box such as that shown opposite, with options to customise its bordering, background, alignment and other aspects. The box itself is floating div, which, like images, can appear on the right or left or across the entire page. Article text will wrap around the div in the first two cases. This is useful in articles that are short on images and need some graphic-like element, or where an important or interesting quote wants to be presented in a way that sets it off from the surrounding text.

Caution: This is a div-based template, so it may malfunction if indented using wikitext syntax.

When used with a poem, it is convenient to wrap the poem's content in <poem>...</poem> tags; these preserve line breaks without having to manually insert <br /> markup.

To be or not to be...

Parameters

Basic parameters

  • |title=: Optional title to appear at the top of the quotebox.
  • |quote=: The quote or other text to be displayed in the box.
  • |author=: Optional name of the author. A <ref>...</ref> reference citation can be added at the end.
  • |source=: Optional source of the quote ("Quoted" or Italic work title, and other publication data). A <ref>...</ref> reference citation can be added at the end.

Main box styling

  • |align=: Alignment of the quotebox on the page—left / right / center / none. Defaults to center alignment. Using align=none will remove word wrapping.
  • |width=: The width of the quotebox. Defaults to the width of the quote included, unless |align=center or |align=none where the width will default to 100%.
  • |border=: The width of the quotebox border. Defaults to 1px. Remember to include 'px' or 'em' to specify the correct width.
  • |fontsize=: The fontsize of the quotebox text. Defaults to 88%.
  • |bgcolor=: The RGB background color of the box. Defaults to white.
  • |style=: A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding parameters.

Title styling

  • |title_bg=: The RGB background color of the title. Defaults to white.
  • |title_fnt=: The title font color. Defaults to black.
  • |tstyle=: A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding title parameters.

Quote styling

  • |qalign=: Alignment of the quote element—left / right / center. Defaults to left.
  • |qstyle=: A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding quote parameters.
  • |quoted=: If this parameter evaluates to true (is not 0, false, or empty) the quotebox will enclose the quote in fat-quotes. Use judiciously.

Source styling These affect the entire |author= and |source= block, below the quotation.

  • |salign=: Alignment of the source element—left / right / center. Defaults to the value of qalign.
  • |sstyle=: A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding source parameters.

Full syntax

{{quotebox
 |class     = <!-- Advanced users only. See the "Custom classes" section below. -->
 |title     = 
 |quote     = 
 |author    = 
 |source    = 
 |align     = 
 |width     = 
 |border    = 
 |fontsize  = 
 |bgcolor   = 
 |style     = 
 |title_bg  = 
 |title_fnt = 
 |tstyle    = 
 |qalign    = 
 |qstyle    = 
 |quoted    = 
 |salign    = 
 |sstyle    = 
}}

Examples

Various example codes and their results.

Floating and wrapping

Minimal code, defaults to center and minimal width:

{{quotebox
 |quote  = You need me more than I need you.
 |author = [[Fjord]]
 |source = [[Campaign 2]], "[[Refjorged]]"
}}

You need me more than I need you.

— Fjord, Campaign 2, "Refjorged"

Floating right:

{{quotebox
 |quote  = You need me more than I need you.
 |author = [[Fjord]]
 |source = [[Campaign 2]], "[[Refjorged]]"
 |width  = 50%
 |align  = right
}}

You need me more than I need you.

— Fjord, Campaign 2, "Refjorged"

Floating left:

{{quotebox
 |quote  = You need me more than I need you.
 |author = [[Fjord]]
 |source = [[Campaign 2]], "[[Refjorged]]"
 |width  = 50%
 |align  = left
}}

You need me more than I need you.

— Fjord, Campaign 2, "Refjorged"

Fat-quotes

{{quotebox
 |quote  = You need me more than I need you.
 |author = [[Fjord]]
 |source = [[Campaign 2]], "[[Refjorged]]"
 |quoted = 1
}}

You need me more than I need you.

— Fjord, Campaign 2, "Refjorged"

Custom classes

This parameter should only be used by editors who fully understand how this template works.

The "class=" parameter can be used add a generic CSS class to this template. Some classes are not compatible with other options or require specific options be set to be useful or look good.

TemplateData

Put a quote, and its source, inside a box, with flexible control over bordering, background color, alignment, and other features

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
CSS classclass

Optional CSS class to modify or override the default class ''quotebox''. Care should be used when using this parameter. Consider using other templates instead. See the ''Custom classes'' section of this document for more information.

Stringoptional
Titletitle

Optional title to appear at the top of the quotebox.

Stringoptional
Quotequote 1 content quotetext text

The quote or text to be displayed in the box.

Stringrequired
Authorauthor 2

The author to whom the quote is attributed

Lineoptional
Sourcesource 3

Optional source of the quote (author, publication, etc.). Set off from author with a comma.

Stringoptional
Alignmentalign

Alignment of the quotebox on the page—left / right / center / none. Defaults to center alignment. Using align=none will remove word wrapping.

Suggested values
left center right none
Stringoptional
Widthwidth

The width of the quotebox. Defaults to the width of the quote included, unless align=center where the width will default to 100%. Use CSS lengths eg. 50% or 400px

Stringoptional
Border widthborder

The width of the quotebox border. Defaults to 1px. Remember to include 'px' or 'em' to specify the correct width.

Stringoptional
Font sizefontsize

The fontsize of the quotebox text. Defaults to 88%.

Stringoptional
Background colorbgcolor

The RGB background color of the box. Defaults to white.

Stringoptional
CSS stylestyle

A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding parameters.

Stringoptional
Title background colortitle_bg

The RGB background color of the title. Defaults to #F9F9F9 (light gray).

Stringoptional
Title font colortitle_fnt

The title font color. Defaults to black.

Stringoptional
Title CSS styletstyle

A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding title parameters.

Stringoptional
Quote alignmentqalign halign

Alignment of the quote element—left / right / center. Defaults to left.

Suggested values
left center right
Stringoptional
Quote CSS styleqstyle

A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding quote parameters.

Stringoptional
Add quotes?quoted

If this parameter evaluates to true (is not 0, false, or empty) the quotebox will enclose the quote in fat-quotes. Use judiciously, and read the Manual of Style.

Stringoptional
Source alignmentsalign

Alignment of the source element—left / right / center. Defaults to the value of qalign.

Suggested values
left center right
Stringoptional
Source CSS stylesstyle

A generic CSS style parameter. Entries in this parameter supersede any duplicates in the preceding source parameters.

Stringoptional
Title CSS classtclass

Advanced: additional classes to apply to the title element

Stringoptional
Quote CSS classqclass

Advanced: additional classes to apply to the quote's element

Unknownoptional

Template:Sandbox other

The above text is transcluded from Template:Quotebox/doc; you can change it or view its history. (How does this work?)
If you're done making changes, please refresh the text. (Why?)
You can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories and interwikis to Template:Quotebox/doc. (View all subpages of this page.)