Template:Endorsements box/doc
This is a documentation subpage for Template:Endorsements box. It may contain usage information, categories and other content that is not part of the original template page. |
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 ).
- Franz Beckenbauer[1]
- Women In Power[2]
- International Pipefitters Union[3]
- Young Social Green Democrats of Idaho[4]
This template uses TemplateStyles: |
Usage
lembaThis 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
parameter. In particular, list
<small></small>
and {{small}} should not be used, per , 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:
Full version (copy and paste text below and delete parameters you don't need) |
---|
|
Fields
lembaAll parameters are optional, although without list, 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.
- color: Color of title text. Can be any recognized definition, such as HTML names (e.g., "
", "red
), hex color codes (e.g., "LightGreen"
", "#FF0000
) or RGB Decimal (e.g., "#90ee90"
", "rgb(255, 0, 0)
"). Note that the background color is already a medium gray; many foreground colors will be hard to discern.rgb(144, 238, 144)
- columns: When non-empty, causes contents of
to be formatted into columns of 20em width, unless colwidth is set (in which case,list
is ignored)columns
- colwidth: Width into which contents of
should be formatted, overriding presence or value oflist
(a valid value here always causes columns). Units not required, e.g., em, px, or %, but em units (e.g., "columns
") are recommended.30em
- 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.
- list: List of parties (i.e., individuals, groups, companies, etc.) endorsing the candidacy. Reference citations are expected (just as with prose additions).
Examples
lembaWithout columns
lemba{{Endorsements box | title = Example without columns | list = * Item 1 * Item 2 }}
- Item 1
- Item 2
With columns
lembaAny 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 }}
- Item 1
- Item 2
- Item 3
- Item 4
With color and other column widths
lembaA color can be set for the title bar text (ordinarily the candidate's name). The |colwidth=
parameter causes columns to be used at the specified width.
{{Endorsements box | title = Example with color and wider columns | color = darkorange | colwidth = 29em | list = * Item 1 * Item 2 * Item 3 * Item 4 }}
- Item 1
- Item 2
- Item 3
- Item 4
With color and constrained width
lembaA color can be set for the title bar text (ordinarily the candidate's name). The |colwidth=
parameter causes columns to be used at the specified width.
{{Endorsements box | title = Example with color and constrained width | color = #3366CC | width = 40% | list = * Item 1 * Item 2 * Item 3 * Item 4 }}
- Item 1
- Item 2
- Item 3
- Item 4
References