View source for Template:Canadian election result/doc

{{Documentation subpage}}
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}

The template {{tl|Canadian election result}} is intended to create tables showing the election or by-election results in one riding. It can be used on the pages of the ridings, of the candidates, or on template pages that are transcluded onto both. It works in conjunction with five other templates: {{tl|Canadian election result/top}}, {{tl|Canadian election result/total}}, {{tl|Canadian election result/gain}}, {{tl|Canadian election result/hold}}, and {{tl|Canadian election result/source}}. This template can duplicate the functions of all of the 53 existing federal and provincial [[:Category:Canada election result templates|CanElec templates]].

== /top template ==
Begin each table with {{tl|Canadian election result/top}}.

The first thing that needs to be specified is whether this is a federal election, or provincial or territorial.

Use the standard two-letter codes for [[Canadian subnational postal abbreviations|postal abbreviations]] or [[.ca#Second-level domains|second-level domains of the <code>.ca</code> country-code]] domain.  A table is given at the bottom of this page.

===General format===
;Basic form
Use <code><nowiki>{{</nowiki>Canadian election result/top|''jurisdiction''|''election''<nowiki>}}</nowiki></code>. The ''jurisdiction'' field should be the two-letter code and the ''election'' field should be the year.

For example, <code><nowiki>{{Canadian election result/top|MB|2011}}</nowiki></code> gives:
{{Canadian election result/top|MB|2011|nocat=true}}
{{end}}

;With riding name
Use <code><nowiki>{{</nowiki>Canadian election result/top|''jurisdiction''|''election''|''riding''|''riding display''<nowiki>}}</nowiki></code>. The <code>''riding display''</code> field can be omitted when the riding's article name does not contain disambiguation.

For example, <code><nowiki>{{</nowiki>Canadian election result/top|CA|2008|Barrie (federal electoral district)|Barrie<nowiki>}}</nowiki></code> gives:
{{Canadian election result/top|CA|2008|Barrie (federal electoral district)|Barrie|nocat=true}}
{{end}}

;With extra data columns:
Extra columns can be added to provide additional dato. For example, <code><nowiki>{{</nowiki>Canadian election result/top|CA|2006|Toronto—Danforth<nowiki>|percent=yes|change=yes|expenditures=yes}}</nowiki></code> gives:
{{Canadian election result/top|CA|2011|Toronto—Danforth|percent=yes|change=yes|expenditures=yes|nocat=true}}
{{end}}

===General parameters===
;first unnamed parameter; or <code>jurisdiction=</code>
:This is a two-letter code. Valid two-letter codes correspond to the standard [[Canadian subnational postal abbreviations|postal abbreviations]] or [[.ca#Second-level domains|second-level domains of <code>.ca</code>]]. Note that for Newfoundland and Labrador elections before 2001, the code is <code>NF</code> rather than <code>NL</code>.

;second unnamed parameter or <code>election=</code>
:This is the four-digit year for a general election, or some other text (for example a full date) for a by-election.

;third unnamed parameter or <code>riding=</code>
:This is the full title of a Wikipedia article about a riding.  For example: <code><nowiki>Barrie (federal electoral district)</nowiki></code>
:Note that Canadian federal ridings often use an [[em dash]] naming convention (for example: [[Brome—Missisquoi (federal electoral district)]]).  Other jurisdictions may have different conventions; for instance, Quebec provincial ridings use an [[en dash]] instead, and only if hyphens already occur elsewhere in the name (eg, [[Drummond–Bois-Francs]], but [[Brome-Missisquoi (provincial electoral district)|Brome-Missisquoi]]).

;(''optional'') fourth unnamed parameter or <code>riding_display=</code>
:This is the displayed text for the riding name, if different from the above.  For example: <code><nowiki>Barrie</nowiki></code>

===Optional parameters===

;by=yes
:Use for by-elections. When using this, give the full date of the by-election rather than just the year.
;reason=
:Explain the reason for the by-election. For example, <code>reason=upon the resignation of Jon Doe</code>.
;percent=yes
:Use this parameter to add a column with the heading "%".
;change=yes
:Use this parameter to add a column with the heading "[[Percentage point|∆%]]".
;expenditures=yes
:Use this parameter to add a column with the heading "Expenditures".
;elected=yes
:Use for multi-member ridings that elect multiple members off of one ballot to add a column with the heading "Elected".
;1st=yes|percent=yes|final=yes|percent2=yes
:Use these parameters to create columns for multi-round elections.
;ballot=A ''or'' ballot=B ''or'' ballot=C
:Use one of these parameters for multi-member ridings that run multiple ballots each with a different slate of candidates during each election. It will only change the links in the heading.
;collapsed=
:The table is by default [[Help:Collapsing|collapsible]].  You can set the initial collapsedness as follows: <code>yes</code>, <code>auto</code>, or <code>no</code>. These correspond to initial states of "collapsed", "autocollapse", or none, as documented at [[Help:Collapsing]]. For instance, if an article about a riding has a long list of election results from years past, you may want to have the first one display (for the most recent election) but keep the previous election years collapsed.

== Main template ==
Use a copy of this template, {{tl|Canadian election result}}, for each row. The basic version of template is <code><nowiki>{{</nowiki>Canadian election result |''jurisdiction'' |''party'' |''candidate'' |''votes''<nowiki>}}</nowiki></code>. The jurisdiction must be the two-letter provincial code or "CA" for federal elections. The party name must match the format of party names in the "input text" column of [[Template:Canadian party colour/list of parties/doc|the '''master list of parties''']]. The candidate name can be wikilinked if the article exists. The full version of this template is <code><nowiki>{{</nowiki>Canadian election result |''jurisdiction'' |''party'' |''candidate'' |''votes'' |''4th column'' |''5th column'' |''6th column''<nowiki>}}</nowiki></code>. The last three fields are optional, and what should be put in them depends on what headers were used. For multi-member ridings, use <code>elected=yes</code> to add a checkmark in the "Elected" column.

== /total template ==
Use a copy of this template, {{tl|Canadian election result/total}}, for each total row (for example, Total valid votes, Total rejected ballots, Total turnout). The full version of this template is <code><nowiki>{{</nowiki>Canadian election result/total |''heading'' |''votes column'' |''4th column'' |''5th column'' |''6th column''<nowiki>}}</nowiki></code>. The last three fields are optional.

See [[Template:Canadian election result/total/doc|Canadian election result/total documentation]] for instructions on how to find the data and complete the various total rows.

== /gain and /hold templates ==

These templates can be used to identify gains and holds for the winning party, together with the [[swing (politics)|swing]] calculated for the result compared to the previous election. The basic version of template is <code><nowiki>{{</nowiki>Canadian election result/gain |''jurisdiction'' |''gaining party'' |''losing party'' |''swing''<nowiki>}}</nowiki></code> and <code><nowiki>{{</nowiki>Canadian election result/hold |''jurisdiction'' |''party'' |''swing''<nowiki>}}</nowiki></code>, with the jurisdiction and party input in the same way as in {{tl|Canadian election result}}. The /gain template may additionally add the party that the seat was taken from in the third parameter.

Swing calculated using the formula {{large|(}}(∆%₁&minus; ∆%₂) ÷ 2&thinsp;{{large|)}} (i.e. ''Change in winner's percentage compared to previous year'' minus ''change in second place percentage'' divided by two)

For example, <code><nowiki>{{CANelec/gain |AB |Liberal |PC |+11.20}}</nowiki></code> produces:
{| class="wikitable"
{{CANelec/gain |AB |Liberal |PC |+11.20}}
|}

== /source and /note templates ==
These templates can be used to add a row to the bottom of the table. For example: <code><nowiki>{{Canadian election result/source|All data comes from elections Canada.}}</nowiki></code>. If the line of text contains an equals sign, as many government links do, name the field <code>source=</code>.

Links to multiple source can be added in an expandable “{{Resize|'''Source(s)'''}}}” section by assigning all the links to the parameter <code>hide=</code> {{resize|(create separate lines by separating each source with <code>&lt;br /&gt;</code>)}}.

For example: <code><nowiki>{{CANelec/source|hide={{cite web |title=Source 1 |url=http://www.elections.ca/source1 |publisher=[[Elections Canada]]}}<br />{{cite web |title=Source 2 |url=http://www.elections.ca/source2 |access-date=</nowiki>{{Date}}}} }}</code> in a table produces:

{{CANelec/top|CA|percent=yes|change=yes}}
{{CANelec/source|hide={{cite web |title=Source 1 |url=http://www.elections.ca/source1 |publisher=[[Elections Canada]]}}<br />{{cite web |title=Source 2 |url=http://www.elections.ca/source2 |access-date={{Date}}}} }}
|}

== end template ==
Finish election boxes with the {{tl|end}} template.

==Example==
Here is an example using the federal riding of Ottawa Centre in the 2011 federal election. The code:
<syntaxhighlight lang="wikitext">{{Canadian election result/top|CA|2011|Ottawa Centre (federal electoral district)|Ottawa Centre|percent=yes|change=yes}}
{{CANelec|CA|NDP|[[Paul Dewar]]|33,805|52.11|+12.37}}
{{CANelec|CA|Conservative|Damian Konstantinakos|14,063|21.68|-1.89}}
{{CANelec|CA|Liberal|Scott Bradley|13,049|20.12|-5.90}}
{{CANelec|CA|Green|Jen Hunter|3,262|5.03|-4.89}}
{{CANelec|CA|Marijuana|John Andrew Akpata|326|0.50|-0.09}}
{{CANelec|CA|Independent|Romeo Bellai|210|0.32|&ndash;}}
{{CANelec|CA|Communist|Stuart Ryan|109|0.17|&ndash;}}
{{CANelec|CA|Marxist-Leninist|Pierre Soublière|44|0.07|-0.08}}
{{Canadian election result/total|Total valid votes/Expense limit|64,868|100.00|&ndash;}}
{{Canadian election result/total|Total rejected ballots|267|0.41|0.00}}
{{Canadian election result/total|Turnout|65,135|74.96|+5.85}}
{{Canadian election result/total|Eligible voters|86,898}}
{{CANelec/hold |CA |NDP |+9.14%}}
{{end}}</syntaxhighlight>
will produce:
{{Canadian election result/top|CA|2011|Ottawa Centre (federal electoral district)|Ottawa Centre|percent=yes|change=yes|nocat=true}}
{{CANelec|CA|NDP|[[Paul Dewar]]|33,805|52.11|+12.37}}
{{CANelec|CA|Conservative|Damian Konstantinakos|14,063|21.68|-1.89}}
{{CANelec|CA|Liberal|Scott Bradley|13,049|20.12|-5.90}}
{{CANelec|CA|Green|Jen Hunter|3,262|5.03|-4.89}}
{{CANelec|CA|Marijuana|John Andrew Akpata|326|0.50|-0.09}}
{{CANelec|CA|Independent|Romeo Bellai|210|0.32|&ndash;}}
{{CANelec|CA|Communist|Stuart Ryan|109|0.17|&ndash;}}
{{CANelec|CA|Marxist-Leninist|Pierre Soublière|44|0.07|-0.08}}
{{Canadian election result/total|Total valid votes/Expense limit|64,868|100.00|&ndash;}}
{{Canadian election result/total|Total rejected ballots|267|0.41|0.00}}
{{Canadian election result/total|Turnout|65,135|74.96|+5.85}}
{{Canadian election result/total|Eligible voters|86,898}}
{{CANelec/hold |CA |NDP |+9.14%}}
{{end}}

== TemplateData (main template) ==
{{CANelec/doc}}

== See also ==

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Election and referendum result templates|{{PAGENAME}}]]

}}</includeonly>