View source for Template:Compact election box/doc

{{Documentation subpage}}
{{Lua|Module:Political party}}

== Purpose ==
A set of templates to produce a table displaying the results of [[first-past-the-post]] elections in a more compact format than offered by {{tl|Election box}}.

== Example ==
These templates produce results like this:
{{Compact election box begin}}
{{Compact election box
 | election_title = [[Foobar South-Central by-election, 1953|1953 by-election]]
 |election_note = death of [[Sir Bufton Tufton]]
 | electorate 	= 57,901
 | turnout_votes = 31,432
 | turnout_percent = 66.2
 | majority_votes = 2,507
 | majority_percent = 12.5
 |result = gain
 |loser_party = Scottish National Party
 |swing = 17.1
 |swing_from = Scottish National Party
 |swing_to = Conservative Party (UK)
 |election_ref = 

 | winner           = [[Jimmy Smith (Foobar politician)|Jimmy Smith]]
 | winner_party     = Conservative Party (UK)
 | winner_votes     = 26,241
 | winner_percent   = 50.5
 | winner_change    = N/A

 | candidate2         = [[Dave Spart (Borsetshire politician)|Dave Spart]]
 | candidate2_party   = Labour Party (UK)
 | candidate2_votes   = 10,719
 | candidate2_percent = 20.1
 | candidate2_change  = N/A
}}
{{Template:Compact election box
 | election_title = [[United Kingdom general election, 1955|1955 general election]]
 | electorate 	= 57,901
| turnout_votes = 
| turnout_percent = 
| majority_votes = 
| majority_percent = 
|result = hold
| winner = [[Jimmy Abdul Rudigger Smith (junior)|Jimmy Smith]]
| winner_party = 	Conservative Party (UK)
}}
{{Template:Compact election box
 | election_title = [[United Kingdom general election, 1959|1959 general election]]
 | electorate 	= 57,901
| turnout_votes = 31,432
| turnout_percent = 66.2
| majority_votes = 12,952
| majority_percent = 19.5
|result = hold
| winner = [[Jimmy Abdul Rudigger Smith (junior)|Jimmy Smith]]
| winner_party = 	Conservative Party (UK)
| winner_votes = 	27,709
| winner_percent = 54.5
| winner_change  = N/A

| candidate2 = [[Dave Spart (Borsetshire politician)|Dave Spart]]
| candidate2_party = 	Labour Party (UK)
| candidate2_votes = 	8,604
| candidate2_percent = 16.2
| candidate2_change  = N/A

| candidate3 = Eric The Viking
| candidate3_party_unlinked = 	Vikings for Borsetshire
| candidate3_votes = 	6,903
| candidate3_percent = 12.5
| candidate3_change  = N/A
}}
{{Template:Compact election box
 | election_title = [[United Kingdom general election, 1964|1964 general election]]
 | electorate 	= 62,184
| turnout_votes = 41,401
| turnout_percent = 69.8
| turnout_change = +3.6
| majority_votes = 2,011
| majority_percent = 9.5
|result = gain
|loser_party = Conservative Party (UK) 
| winner = [[Dave Spart (Borsetshire politician)|Dave Spart]]
| winner_party = 	Labour Party (UK)
| winner_votes = 	20,591
| winner_percent = 38.9
| winner_change  = +22.7

| candidate2 = [[Jimmy Abdul Rudigger Smith (junior)|Jimmy Smith]]
| candidate2_party = 	Conservative Party (UK)
| candidate2_votes = 	18,709
| candidate2_percent = 33.4
| candidate2_change  = &minus;22.1

| candidate3 = Col. Theo Smithers
| candidate3_party_unlinked = 	Borsetshire Ratepayers
| candidate3_votes = 	1,903
| candidate3_percent = 6.7
| candidate3_change = N/A

| candidate4 = [[William W. W. W. W. W. Williamson|William Williamson]]
| candidate4_party = 	Liberal Party (UK)
| candidate4_votes = 	1,812
| candidate4_percent = 6.4
| candidate4_change = N/A

| candidate5 = [[Verte Profonde]]
| candidate5_party = 	Green Party of England and Wales
| candidate5_votes = 	1,561
| candidate5_percent = 6.0
| candidate5_change = N/A

| candidate6         = Egbert Monster
| candidate6_party   = 	Official Monster Raving Loony Party
| candidate6_votes   = 	912
| candidate6_percent = 3.1
| candidate6_change  = N/A


| candidate7         = A. N. Ulsterman
| candidate7_party   = 	Ulster Unionist Party
| candidate7_votes   = 	874
| candidate7_percent = 2.7
| candidate7_change  = N/A

| candidate8         = A. Alba
| candidate8_party   = 	Scottish National Party
| candidate8_votes   = 	540
| candidate8_percent = 2.3
| candidate8_change  = N/A
}}
{{Template:Compact election box
 | election_title = [[United Kingdom general election, 1966|1966 general election]]
 | electorate 	= 62,184
| turnout_votes = 41,401
| turnout_percent = 69.8
| majority_votes = 2,011
| majority_percent = 9.5
| majority_change = +1.4
|result = hold

| winner         = [[Dave Spart (Borsetshire politician)|Dave Spart]]
| winner_party   = Labour Party (UK)
| winner_votes   = 20,591
| winner_percent = 39.9
| winner_change  = +1.1

| candidate2 = [[Jimmy Abdul Rudigger Smith (junior)|Jimmy Smith]]
| candidate2_party = 	Conservative Party (UK)
| candidate2_votes = 	18,709
| candidate2_percent = 32.3
| candidate2_change = &minus;1.1

| candidate3 = Col. Theo Smithers
| candidate3_party_unlinked = 	Borsetshire Ratepayers
| candidate3_votes = 	1,903
| candidate3_percent = 6.7
}}
{{Compact election box end}}

== Usage ==
<pre>
{{Compact election box begin}}
{{Compact election box}}
{{Compact election box}}
{{Compact election box}}
...
{{Compact election box end}}
</pre>
=== Simple usage ===
Blank example with basic parameters
<pre>
{{Compact election box begin}}
{{Compact election box
 | election_title     =

 | winner             =
 | winner_party       =
 | winner_votes       =
 | winner_percent     =
 | winner_change      =
 
 | candidate2         =
 | candidate2_party   =
 | candidate2_votes   =
 | candidate2_percent =
 | candidate2_change  =
}}
{{Compact election box end}}
</pre>

=== Full usage ===
Blank example with all parameters
<pre>
{{Compact election box begin}}
{{Compact election box
 | election_title             = 
 | election_note              = 
 | election_ref               = 

 | anchor                     =
 | anchor2                    =
 | anchor3                    =

 | electorate 	              = 
 | turnout_votes              = 
 | turnout_percent            = 
 | turnout_change             = 
 | majority_votes             = 
 | majority_percent           = 
 | majority_change            = 
 
 | result                     = 
 | loser_party                = 
 | loser_party_unlinked       = 
 
 | swing                      = 
 | swing_from                 = 
 | swing_to                   = 

 | winner                     = 
 | winner_party               = 
 | winner_party_unlinked      = 
 | winner_votes               = 
 | winner_percent             = 
 | winner_change              = 
 
 | candidate2                 = 
 | candidate2_party           = 
 | candidate2_party_unlinked  = 
 | candidate2_votes           = 
 | candidate2_percent         = 
 | candidate2_change          = 
 
 | candidate3                 = 
 | candidate3_party           = 
 | candidate3_party_unlinked  = 
 | candidate3_votes           = 
 | candidate3_percent         = 
 | candidate3_change          = 
 
 | candidate4                 = 
 | candidate4_party           = 
 | candidate4_party_unlinked  = 
 | candidate4_votes           = 
 | candidate4_percent         = 
 | candidate4_change          = 
 
 | candidate5                 = 
 | candidate5_party           = 
 | candidate5_party_unlinked  = 
 | candidate5_votes           = 
 | candidate5_percent         = 
 | candidate5_change          = 
 
 | candidate6                 = 
 | candidate6_party           = 
 | candidate6_party_unlinked  = 
 | candidate6_votes           = 
 | candidate6_percent         = 
 | candidate6_change          = 
 
 | candidate7                 = 
 | candidate7_party           = 
 | candidate7_party_unlinked  = 
 | candidate7_votes           = 
 | candidate7_percent         = 
 | candidate7_change          = 
 
 | candidate8                 = 
 | candidate8_party           = 
 | candidate8_party_unlinked  = 
 | candidate8_votes           = 
 | candidate8_percent         = 
 | candidate8_change          = 
 
 | candidate9                 = 
 | candidate9_party           = 
 | candidate9_party_unlinked  = 
 | candidate9_votes           = 
 | candidate9_percent         = 
 | candidate9_change          = 
 
 | candidate10                = 
 | candidate10_party          = 
 | candidate10_party_unlinked = 
 | candidate10_votes          = 
 | candidate10_percent        = 
 | candidate10_change         = 
 
 | candidate11                = 
 | candidate11_party          = 
 | candidate11_party_unlinked = 
 | candidate11_votes          = 
 | candidate11_percent        = 
 | candidate11_change         = 
 
 | candidate12                = 
 | candidate12_party          = 
 | candidate12_party_unlinked = 
 | candidate12_votes          = 
 | candidate12_percent        = 
 | candidate12_change         = 
 
 | candidate13                = 
 | candidate13_party          = 
 | candidate13_party_unlinked = 
 | candidate13_votes          = 
 | candidate13_percent        = 
 | candidate13_change         = 
 
 | candidate14                = 
 | candidate14_party          = 
 | candidate14_party_unlinked = 
 | candidate14_votes          = 
 | candidate14_percent        = 
 | candidate14_change         = 
 
 | candidate15                = 
 | candidate15_party          = 
 | candidate15_party_unlinked = 
 | candidate15_votes          = 
 | candidate15_percent        = 
 | candidate15_change         = 
 
 | candidate16                = 
 | candidate16_party          = 
 | candidate16_party_unlinked = 
 | candidate16_votes          = 
 | candidate16_percent        = 
 | candidate16_change         = 
 
 | candidate17                = 
 | candidate17_party          = 
 | candidate17_party_unlinked = 
 | candidate17_votes          = 
 | candidate17_percent        = 
 | candidate17_change         = 
 
 | candidate18                = 
 | candidate18_party          = 
 | candidate18_party_unlinked = 
 | candidate18_votes          = 
 | candidate18_percent        = 
 | candidate18_change         = 
 
 | candidate19                = 
 | candidate19_party          = 
 | candidate19_party_unlinked = 
 | candidate19_votes          = 
 | candidate19_percent        = 
 | candidate19_change         = 
 
 | candidate20                = 
 | candidate20_party          = 
 | candidate20_party_unlinked = 
 | candidate20_votes          = 
 | candidate20_percent        = 
 | candidate20_change         = 
 
 | candidate21                = 
 | candidate21_party          = 
 | candidate21_party_unlinked = 
 | candidate21_votes          = 
 | candidate21_percent        = 
 | candidate21_change         = 
 
 | candidate22                = 
 | candidate22_party          = 
 | candidate22_party_unlinked = 
 | candidate22_votes          = 
 | candidate22_percent        = 
 | candidate22_change         = 
 
 | candidate23                = 
 | candidate23_party          = 
 | candidate23_party_unlinked = 
 | candidate23_votes          = 
 | candidate23_percent        = 
 | candidate23_change         = 
 
 | candidate24                = 
 | candidate24_party          = 
 | candidate24_party_unlinked = 
 | candidate24_votes          = 
 | candidate24_percent        = 
 | candidate24_change         = 
 
 | candidate25                = 
 | candidate25_party          = 
 | candidate25_party_unlinked = 
 | candidate25_votes          = 
 | candidate25_percent        = 
 | candidate25_change         = 
 
 | candidate26                = 
 | candidate26_party          = 
 | candidate26_party_unlinked = 
 | candidate26_votes          = 
 | candidate26_percent        = 
 | candidate26_change         = 

 | candidate27                = 
 | candidate27_party          = 
 | candidate27_party_unlinked = 
 | candidate27_votes          = 
 | candidate27_percent        = 
 | candidate27_change         = 

 | candidate28                = 
 | candidate28_party          = 
 | candidate28_party_unlinked = 
 | candidate28_votes          = 
 | candidate28_percent        = 
 | candidate28_change         = 

 | candidate29                = 
 | candidate29_party          = 
 | candidate29_party_unlinked = 
 | candidate29_votes          = 
 | candidate29_percent        = 
 | candidate29_change         = 

 | candidate30                = 
 | candidate30_party          = 
 | candidate30_party_unlinked = 
 | candidate30_votes          = 
 | candidate30_percent        = 
 | candidate30_change         = 

 | candidate31                = 
 | candidate31_party          = 
 | candidate31_party_unlinked = 
 | candidate31_votes          = 
 | candidate31_percent        = 
 | candidate31_change         = 
 
 | candidate32                = 
 | candidate32_party          = 
 | candidate32_party_unlinked = 
 | candidate32_votes          = 
 | candidate32_percent        = 
 | candidate32_change         = 
 
 | candidate33                = 
 | candidate33_party          = 
 | candidate33_party_unlinked = 
 | candidate33_votes          = 
 | candidate33_percent        = 
 | candidate33_change         = 
 
 | candidate34                = 
 | candidate34_party          = 
 | candidate34_party_unlinked = 
 | candidate34_votes          = 
 | candidate34_percent        = 
 | candidate34_change         = 
 
 | candidate35                = 
 | candidate35_party          = 
 | candidate35_party_unlinked = 
 | candidate35_votes          = 
 | candidate35_percent        = 
 | candidate35_change         = 
 
 | candidate36                = 
 | candidate36_party          = 
 | candidate36_party_unlinked = 
 | candidate36_votes          = 
 | candidate36_percent        = 
 | candidate36_change         = 
 
 | candidate37                = 
 | candidate37_party          = 
 | candidate37_party_unlinked = 
 | candidate37_votes          = 
 | candidate37_percent        = 
 | candidate37_change         = 
 
 | candidate38                = 
 | candidate38_party          = 
 | candidate38_party_unlinked = 
 | candidate38_votes          = 
 | candidate38_percent        = 
 | candidate38_change         = 
 
 | candidate39                = 
 | candidate39_party          = 
 | candidate39_party_unlinked = 
 | candidate39_votes          = 
 | candidate39_percent        = 
 | candidate39_change         = 
 
 | candidate40                = 
 | candidate40_party          = 
 | candidate40_party_unlinked = 
 | candidate40_votes          = 
 | candidate40_percent        = 
 | candidate40_change         = 
 
 | candidate41                = 
 | candidate41_party          = 
 | candidate41_party_unlinked = 
 | candidate41_votes          = 
 | candidate41_percent        = 
 | candidate41_change         = 
 
 | candidate42                = 
 | candidate42_party          = 
 | candidate42_party_unlinked = 
 | candidate42_votes          = 
 | candidate42_percent        = 
 | candidate42_change         = 
 
 | candidate43                = 
 | candidate43_party          = 
 | candidate43_party_unlinked = 
 | candidate43_votes          = 
 | candidate43_percent        = 
 | candidate43_change         = 
 
 | candidate44                = 
 | candidate44_party          = 
 | candidate44_party_unlinked = 
 | candidate44_votes          = 
 | candidate44_percent        = 
 | candidate44_change         = 
 
 | candidate45                = 
 | candidate45_party          = 
 | candidate45_party_unlinked = 
 | candidate45_votes          = 
 | candidate45_percent        = 
 | candidate45_change         = 
 
 | candidate46                = 
 | candidate46_party          = 
 | candidate46_party_unlinked = 
 | candidate46_votes          = 
 | candidate46_percent        = 
 | candidate46_change         = 

 | candidate47                = 
 | candidate47_party          = 
 | candidate47_party_unlinked = 
 | candidate47_votes          = 
 | candidate47_percent        = 
 | candidate47_change         = 

 | candidate48                = 
 | candidate48_party          = 
 | candidate48_party_unlinked = 
 | candidate48_votes          = 
 | candidate48_percent        = 
 | candidate48_change         = 

 | candidate49                = 
 | candidate49_party          = 
 | candidate49_party_unlinked = 
 | candidate49_votes          = 
 | candidate49_percent        = 
 | candidate49_change         = 

 | candidate50                = 
 | candidate50_party          = 
 | candidate50_party_unlinked = 
 | candidate50_votes          = 
 | candidate50_percent        = 
 | candidate50_change         = 
}}
{{Compact election box end}}
</pre>

== Parameters ==
=== Header parameters ===
The parameters are used once
{| class="wikitable"
|-
!Parameter !!Purpose !! Example1 !! Example2
|-
|colspan="4"|''Required parameters''
|-
| '''election_title'''
| title of election, may be wikilinked
| <nowiki>[[Foobar South-Central by-election, 1953|1953 by-election]]</nowiki>
| <nowiki>[[United Kingdom election, 1951|1951]]</nowiki>
|-
|colspan="4"|''Optional parameters''
|-
| '''anchor''', anchor2, anchor3
|a HTML anchor, to allow direct linking to the results for a particular election
|<nowiki>anchor=GE2020result</nowiki>
|<nowiki>anchor2=1917byelection</nowiki>
|-
| '''election_ref'''
|reference, usually to the source of the results
|<nowiki><ref>[http://www.foobar-politics-today.com Foobar South-Central by-election results], Politics Today</ref></nowiki>
|<nowiki><ref name="somesource" /></nowiki>
|-
| '''election_note'''
| very short note on the election. Probably best kept to a terse reason for a by-election
| <nowiki>death of [[Sir Bufton Tufton]]</nowiki>
| <nowiki>resignation of [[Jane Imefedup]]</nowiki>
|-
| '''electorate'''
| number of registered voters
| 57,901
|-
| '''turnout_votes'''
| Number of ballots cast
| 31,432
|-
| '''turnout_percent'''
| Turnout as a percentage of registered electors
| 20.5
| 8.76
|-
| '''turnout_change'''
| Change in turnout as a percentage of registered electors
| +1.2
| <nowiki>&minus;5.3</nowiki>
|-
| '''majority_votes'''
| majority of the winning candidate in number of votes
| 1,607
|-
| '''majority_percent'''
| Majority as a percentage of valid votes
| +6.1
| <nowiki>&minus;3.7</nowiki>
|-
| '''majority_change'''
| Change in majority as a percentage of valid votes
| +1.2
| <nowiki>&minus;5.3</nowiki>
|-
| '''result'''
| whether the seat changed party
| hold, or gain (default=win)
|-
| '''loser_party'''
| name of the party which lost, to be wikilinked
| Social Democratic Party (UK)
| Labour Party (UK)
|-
| '''loser_party_unlinked'''
| name of the party which lost, will not be wikilinked
| Let's have a party all night Party
|-
| '''swing'''
| swing in percentage 
| 4.3
| <nowiki>&minus;6.8</nowiki>
|-
| '''swing_from'''
| party which votes swung away from
| Labour Party (UK)
|-
| '''swing_to'''
| party which votes swung away from
| Conservative Party (UK)
|}

=== Winner parameters ===
One set of these parameters for each candidate
{| class="wikitable"
|-
!Parameter !!Purpose !! Example
|-
|'''winner'''
| Name of candidate (may be wikilinked)
| <nowiki>[[Jimmy Abdul Rudigger Smith (junior)|Jimmy Smith]]</nowiki>
|-
|'''winner_party'''
| name of article on party
| Conservative Party (UK)
|-
|'''winner_party_unlinked'''
| text of article on party
| Borsetshire Free Lunch Party
|-
|'''winner_votes'''
|Number of votes received by the candidate
|26,241
|-
|'''winner_percent'''
|Percentage of votes received by the candidate
|50.5
|-
|'''winner_change'''
|Change in that party's percentage share of votes
|<nowiki>&minus;0.5</nowiki>
|}

=== Candidate parameters ===
One set of these parameters for each candidate, starting candidate''2''. Maximum of 25.
{| class="wikitable"
|-
!Parameter !!Purpose !! Example
|-
|'''candidate''n'''''
| Name of candidate (may be wikilinked)
| <nowiki>[[Jimmy Abdul Rudigger Smith (junior)|Jimmy Smith]]</nowiki>
|-
|'''candidate''n''_party'''
| name of article on party
| Conservative Party (UK)
|-
|'''candidate''n''_party_unlinked'''
| text of article on party
| Borsetshire Free Lunch Party
|-
|'''candidate''n''_votes'''
|Number of votes received by the candidate
|26,241
|-
|'''candidate''n''_percent'''
|Percentage of votes received by the candidate
|50.5
|-
|'''candidate''n''_change'''
|Change in that party's percentage share of votes
| +1.6
|}

== Anchors ==
By default, the template creates two anchors to the results of that election, using the following formats:
# <code>&lt;election name as displayed&gt; result</code>, 
# <code>&lt;election name as displayed&gt; result</code>, all converted to lowercase

So for example, on [[Bradford West (UK Parliament constituency)]], the table row for the 1970 general election has the automatically-generated anchors <code>General election 1970 result</code> and <code>general election 1970 result</code>.  They can be  can be linked to as [[Bradford West (UK Parliament constituency)#General election 1970 result]] and [[Bradford West (UK Parliament constituency)#general election 1970 result]]

=== Custom anchors ===
In addition to the auto-generated anchors, up to 3 custom anchors may be added using the parameters {{para|anchor}}, {{para|anchor2}}, and {{para|anchor3}}.

For example, on [[Bradford Central (UK Parliament constituency)]], the entry for the 1886 by-election has the parameter {{para|anchor|1886 unopposed}} ... which allows a link to [[Bradford Central (UK Parliament constituency)#1886 unopposed]]

== See also ==
*[[Template:Compact election box no change]]
*[[Template:Election box]]
<includeonly>{{Sandbox other||[[Category:Election and referendum infobox templates|{{PAGENAME}}]]}}</includeonly>