Template:Endorsements box/doc

This template generates a framed box for use in listing political endorsements (see example below). The generated box is collapsible, but initially presented uncollapsed (per our MoS).

Sophie Kandidatin

• Franz Beckenbauer
• Women In Power
• International Pipefitters Union
• Young Social Green Democrats of Idaho

Usage

This template outputs a framed box with table-like background coloring for use in listing political endorsements. The kind of listing, e.g. bulleted lists, numbered lists, etc., (and, in fact, all of the content) is up to the editor's discretion, although bullet lists are presumed to be the preferred format. Images, prose text, wikiheadings, etc., are all technically supported, but users should keep community usage consensus in mind when filling the list parameter. In particular, <small></small> and {{small}} should not be used, per MOS:SMALL, as the template outputs text at 88% of the base font size, so it's already rather, well, small.

All field names used must be in lowercase.

You can copy a blank version to use. Remember to use the "|" (pipe) character between each field. Please delete any unused fields to avoid clutter in the edit window.

The template has the following syntax:

Template syntax for Template:Endorsements box Full version (copy and paste text below and delete parameters you don't need)

{{Endorsements box |title= |color= |columns= |colwidth= |width= |collapsed= |list=}}

With top and bottom (copy and paste text below and delete parameters you don't need)

{{Endorsements box |top |title= |color= |columns= |colwidth= |width= |collapsed= }}

{{Endorsements box |bottom }}

This template can cause pages to exceed the Post-expand include size when it is used in large quantities on a page. To mitigate this, you should use the top/bottom notation rather than |list=.

Fields

All parameters are optional, although when used without list or the "top" option, the template is rather silly and produces either an empty box or merely {{{list}}}.

title

Candidate name; appears in the title bar of the generated box. If not present, "List of political endorsements" is displayed.

columns

When non-empty, causes contents of list to be formatted into columns of 20em width, unless colwidth is set (in which case, columns is ignored)

colwidth

Width into which contents of list should be formatted, overriding presence or value of columns (a valid value here always causes columns). Units not required, e.g., em, px, or %, but em units (e.g., "30em") are recommended.

width

Settable (approximate) width of entire box; defaults to 100%. Units required, e.g., em, px, or %. Careless setting of this parameter can cause box to overrun available display width.

collapsed

When non-empty, sets the box to be collapsed by default.

list

List of parties (i.e., individuals, groups, companies, etc.) endorsing the candidacy. Reference citations are expected (just as with prose additions).

Examples

Without top/bottom

{{Endorsements box
| title = Example without columns
| list =
* Item 1
* Item 2
}}

Example without columns

• Item 1
• Item 2

With top/bottom

{{Endorsements box|top
| title = Example without columns}}
* Item 1
* Item 2
{{Endorsements box|bottom}}

Example without columns

• Item 1
• Item 2

With columns

Any value in the |columns= parameter will create a list with column widths of 20em (although the |colwidth= parameter can override this).

{{Endorsements box
| title = Example with columns
| columns = yes
| list =
* Item 1
* Item 2
* Item 3
* Item 4
}}

Example with columns

• Item 1
• Item 2
• Item 3
• Item 4

With other column widths

The |colwidth= parameter causes columns to be used at the specified width.

{{Endorsements box
| title = Example with wider columns
| colwidth = 29em
| list =
* Item 1
* Item 2
* Item 3
* Item 4
}}

Example with wider columns

• Item 1
• Item 2
• Item 3
• Item 4

With constrained width

The |width= parameter sets the width of the box.

{{Endorsements box
| title = Example with constrained width
| width = 40%
| list =
* Item 1
* Item 2
* Item 3
* Item 4
}}

Example with constrained width

• Item 1
• Item 2
• Item 3
• Item 4

References