View source for Template:Endorsements box/doc

{{Documentation subpage}}
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 [[MOS:COLLAPSE|our MoS]]).
{{Endorsements box
| title = Sophie Kandidatin
| list =
* [[Franz Beckenbauer]]<ref>[http://example.de/ "Der Kaiser mag Sophie"] (in German)</ref>
* Women In Power<ref>[http://example.net/ "WIP endorses SK"]</ref>
* International Pipefitters Union<ref>[http://example.com/ "Sophie gains Pipefitters"]</ref>
* Young Social Green Democrats of Idaho<ref>[http://example.news/ "YSGDoI supporting SK"]</ref>
}}


{{Uses TemplateStyles|Template:Endorsements box/styles.css}}
__TOC__

== 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 {{code|list}} parameter. In particular, <code><nowiki><small></small></nowiki></code> and {{tlx|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:

{| class="wikitable" role="presentation" style="margin:0 auto;"
|+Template syntax for Template:Endorsements box
! Full version (copy and paste text below and delete parameters you don't need)
|-
|
:{{code|<nowiki>{{Endorsements box |title= |color= |columns= |colwidth= |width= |list=}}</nowiki>}}
|}

== Fields ==
All parameters are optional, although without ''list'', the template is rather silly and produces either an empty box or merely <nowiki>{{{list}}}</nowiki>.

* '''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., "{{code|red}}", "{{code|LightGreen"}}), hex color codes (e.g., "{{code|#FF0000}}", "{{code|#90ee90"}}) or RGB Decimal (e.g., "{{code|rgb(255, 0, 0)}}", "{{code|rgb(144, 238, 144)}}"). Note that the background color is already a medium gray; many foreground colors will be hard to discern.
* '''columns''': When non-empty, causes contents of {{code|list}} to be formatted into columns of 20em width, unless colwidth is set (in which case, {{code|columns}} is ignored)
* '''colwidth''': Width into which contents of {{code|list}} should be formatted, overriding presence or value of {{code|columns}} (a valid value here always causes columns). Units not required, e.g., em, px, or %, but em units (e.g., "{{code|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.
* '''list''': List of parties (i.e., individuals, groups, companies, etc.) endorsing the candidacy. [[WP:CITE|Reference citations]] are expected (just as with prose additions).

== Examples ==
=== Without columns ===
<pre>
{{Endorsements box
| title = Example without columns
| list =
* Item 1
* Item 2
}}
</pre>
{{Endorsements box
| title = Example without columns
| list =
* Item 1
* Item 2
}}

=== With columns ===
Any value in the {{para|columns}} parameter will create a list with column widths of 20em (although the {{para|colwidth}} parameter can override this). 
<pre>
{{Endorsements box
| title = Example with columns
| columns = yes
| list =
* Item 1
* Item 2
* Item 3
* Item 4
}}
</pre>
{{Endorsements box
| title = Example with columns
| columns = yes
| list =
* Item 1
* Item 2
* Item 3
* Item 4
}}

=== With color and other column widths ===
A color can be set for the title bar text (ordinarily the candidate's name). The {{para|colwidth}} parameter causes columns to be used at the specified width. 
<pre>
{{Endorsements box
| title = Example with color and wider columns
| color = darkorange
| colwidth = 29em
| list =
* Item 1
* Item 2
* Item 3
* Item 4
}}
</pre>
{{Endorsements box
| title = Example with color and wider columns
| color = darkorange
| colwidth = 29em
| list =
* Item 1
* Item 2
* Item 3
* Item 4
}}

=== With color and constrained width ===
A color can be set for the title bar text (ordinarily the candidate's name). The {{para|colwidth}} parameter causes columns to be used at the specified width. 
<pre>
{{Endorsements box
| title = Example with color and constrained width
| color = #3366CC
| width = 40%
| list =
* Item 1
* Item 2
* Item 3
* Item 4
}}
</pre>
{{Endorsements box
| title = Example with color and constrained width
| color = #3366CC
| width = 40%
| list =
* Item 1
* Item 2
* Item 3
* Item 4
}}


{{Reflist-talk}}
<includeonly>{{Sandbox other||
[[Category:Collapse templates]]

}}</includeonly>