Template:Canadian election result/gain/sandbox

This is the template sandbox page for Template:Canadian election result/gain (diff).

Template documentation[view] [edit] [history] [purge]

The template {{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: {{Canadian election result/top}}, {{Canadian election result/total}}, {{Canadian election result/gain}}, {{Canadian election result/hold}}, and {{Canadian election result/source}}. This template can duplicate the functions of all of the 53 existing federal and provincial CanElec templates.

/top template

Begin each table with {{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 postal abbreviations or second-level domains of the .ca country-code domain. A table is given at the bottom of this page.

General format

Basic form

Use {{Canadian election result/top|jurisdiction|election}}. The jurisdiction field should be the two-letter code and the election field should be the year.

For example, {{Canadian election result/top|MB|2011}} gives:

2011 Manitoba general election
Party	Candidate	Votes

With riding name

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

For example, {{Canadian election result/top|CA|2008|Barrie (federal electoral district)|Barrie}} gives:

2008 Canadian federal election: Barrie
Party	Candidate	Votes

With extra data columns

Extra columns can be added to provide additional dato. For example, {{Canadian election result/top|CA|2006|Toronto—Danforth|percent=yes|change=yes|expenditures=yes}} gives:

2011 Canadian federal election: Toronto—Danforth
Party	Candidate	Votes	%	±%	Expenditures

General parameters

first unnamed parameter; or jurisdiction=: This is a two-letter code. Valid two-letter codes correspond to the standard postal abbreviations or second-level domains of .ca. Note that for Newfoundland and Labrador elections before 2001, the code is NF rather than NL.

second unnamed parameter or election=: 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 riding=: This is the full title of a Wikipedia article about a riding. For example: Barrie (federal electoral district); 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).

(optional) fourth unnamed parameter or riding_display=: This is the displayed text for the riding name, if different from the above. For example: Barrie

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, reason=upon the resignation of Jon Doe.
percent=yes: Use this parameter to add a column with the heading "%".
change=yes: Use this parameter to add a column with the heading "∆%".
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 collapsible. You can set the initial collapsedness as follows: yes, auto, or no. 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, {{Canadian election result}}, for each row. The basic version of template is {{Canadian election result |jurisdiction |party |candidate |votes}}. 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 the master list of parties. The candidate name can be wikilinked if the article exists. The full version of this template is {{Canadian election result |jurisdiction |party |candidate |votes |4th column |5th column |6th column}}. The last three fields are optional, and what should be put in them depends on what headers were used. For multi-member ridings, use elected=yes to add a checkmark in the "Elected" column.

/total template

Use a copy of this template, {{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 {{Canadian election result/total |heading |votes column |4th column |5th column |6th column}}. The last three fields are optional.

See 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 calculated for the result compared to the previous election. The basic version of template is {{Canadian election result/gain |jurisdiction |gaining party |losing party |swing}} and {{Canadian election result/hold |jurisdiction |party |swing}}, with the jurisdiction and party input in the same way as in {{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 ((∆%₁− ∆%₂) ÷ 2 ) (i.e. Change in winner's percentage compared to previous year minus change in second place percentage divided by two)

For example, {{CANelec/gain |AB |Liberal |PC |+11.20}} produces:

	Liberal gain from Progressive Conservative		Swing		+11.20

/source and /note templates

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

Links to multiple source can be added in an expandable “Source(s)}” section by assigning all the links to the parameter hide= (create separate lines by separating each source with <br />).

For example: {{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=6 May 2025}} }} in a table produces:

Canadian federal election
Party	Candidate	Votes	%	±%
Source(s) "Source 1". Elections Canada. "Source 2". Retrieved 6 May 2025.

end template

Finish election boxes with the {{end}} template.

Example

Here is an example using the federal riding of Ottawa Centre in the 2011 federal election. The code:

{{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}}

will produce:

2011 Canadian federal election: Ottawa Centre
Party	Candidate	Votes	%	±%
	New Democratic	Paul Dewar	33,805	52.11	+12.37
	Conservative	Damian Konstantinakos	14,063	21.68	-1.89
	Liberal	Scott Bradley	13,049	20.12	-5.90
	Green	Jen Hunter	3,262	5.03	-4.89
	Marijuana	John Andrew Akpata	326	0.50	-0.09
	Independent	Romeo Bellai	210	0.32	–
	Communist	Stuart Ryan	109	0.17	–
	Marxist–Leninist	Pierre Soublière	44	0.07	-0.08
Total valid votes/Expense limit			64,868	100.00	–
Total rejected ballots			267	0.41	0.00
Turnout			65,135	74.96	+5.85
Eligible voters			86,898
	New Democratic hold		Swing		+9.14%

TemplateData (main template)

This template produces one row in a table of Canadian election results

Template parameters[Edit template data]
Parameter		Description	Type	Status
Jurisdiction	`1`	Use two-letter codes. Canada=CA, Ontario=ON, PEI=PE, etc. For cities, use three-letter codes.	Line	required
Party	`2`	Short-form name of the candidate's political party	Line	required
Candidate	`3`	Name of the candidate. Can be wikilinked.	Line	optional
Votes	`4`	Number of votes won by the candidate.	Line	optional
4th column	`5`	Adds text to the 4th column. Most often this is used for percentage of the total vote, but check the table's headings to see what information belongs in this column.	Line	optional
5th column	`6`	Adds text to the 5th column. Check the table's headings to see what information belongs in this column.	Line	optional
6th column	`7`	Adds text to the 6th column. Check the table's headings to see what information belongs in this column.	Line	optional
Elected	`elected`	Used for ridings that elect multiple candidates on one ballot. Write 'yes' to add a checkmark in the last column.	Line	optional