View source for Template:Election box ranked choice begin/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
This template begins a summary table of candidates for a ranked choice voting (instant runoff) election contest.  The table contains information about party affiliation, candidate name, and the maximum number of votes counted for the candidate.

This template starts the table, providing the table column headings.  The table should always be completed with the [[Template:Election box ranked choice end]].  In between those two templates, one or more templates such as [[Template:Election box ranked choice candidate with party link]] can describe the candidates.
== Usage ==

The following table describes the parameters to use with this template.

{| class="wikitable" 
|-
! Parameter Name !! Required? !! Default Value !! Description
|-
| title || required || undefined || The name of the contest being described, including possibly citations for the data.  
Example:  title=Jurisdiction name office, year
|-
| partywidth || optional || undefined || Combined width of party color and party name columns.  
Use to fold long party names and avoid extra wide columns.  If not given, fit width to column content.  
Example:  partywidth=30ex
|-
| candidatewidth || optional || undefined || Width of the candidate name column.
Use to fold long candidate names and avoid extra wide columns.  If not given, fit width to column content.  
Example:  candidatewidth=25ex
|-
| barwidth || optional || 40ex || Width of the max votes bar graph column.
Use the same or smaller values to describe the available width for bars of each candidate.  
Example:  barwidth=20ex
|}

== Examples ==

=== Basic example ===

<code><nowiki>{{Election box ranked choice begin | title=Alcatraz mayor, 1935 }}</nowiki><br /><br /><nowiki>
{{Election box ranked choice candidate with party link </nowiki><br /><nowiki>
| party = Republican Party (US) | candidate = [[Aaron Adimsan]] </nowiki><br /><nowiki>
| maxround=2 | maxvotes=112 | maxvotespercent=56.00 | r1votes=75 | fullwidthvotes=120 </nowiki><br /><nowiki>
}} </nowiki><br /><nowiki>
{{Election box ranked choice candidate with party link </nowiki><br /><nowiki>
| party = Democratic Party (US) </nowiki><br /><nowiki>
| candidate = [[Billy Belingtoon]] </nowiki><br /><nowiki>
| maxround=2 | maxvotes=88 | maxvotespercent=44.00 | r1votes=67 | fullwidthvotes=120 </nowiki><br /><nowiki>
}} </nowiki><br /><nowiki>
{{Election box ranked choice candidate with party link </nowiki><br /><nowiki>
| party = Independent politician | candidate = [[Charles Crankellz]] </nowiki><br /><nowiki>
| maxround=1 | maxvotes=61 | maxvotespercent=30.05 | r1votes=61 | fullwidthvotes=120 </nowiki><br /><nowiki>
}} </nowiki><br /><br /><nowiki>
{{Election box ranked choice end}} </nowiki><br /><nowiki>
</nowiki></code>

{{Election box ranked choice begin | title=Alcatraz mayor, 1935 }}
{{Election box ranked choice candidate with party link 
| party = Republican Party (US) | candidate = [[Aaron Adimsan]] 
| maxround=2 | maxvotes=112 | maxvotespercent=56.00 | r1votes=75 | fullwidthvotes=120
}}
{{Election box ranked choice candidate with party link 
| party = Democratic Party (US) 
| candidate = [[Billy Belingtoon]] 
| maxround=2 | maxvotes=88 | maxvotespercent=44.00 | r1votes=67 | fullwidthvotes=120
}} 
{{Election box ranked choice candidate with party link 
| party = Independent politician | candidate = [[Charles Crankellz]] 
| maxround=1 | maxvotes=61 | maxvotespercent=30.05 | r1votes=61 | fullwidthvotes=120
}} 
{{Election box ranked choice end}}

== See also ==
* [[Template:Election box ranked choice end]]
* [[Template:Election box ranked choice candidate with party link]]
* [[Template:Election box ranked choice bar]]