Template:Canadian election result/top/doc

From blackwiki
Jump to navigation Jump to search

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Canadian election result/top

The header for a table of the Canadian election results

Template parameters

ParameterDescriptionTypeStatus
Jurisdiction1

The two-letter code for a province/territory, the three-letter code for a city, or CA for federal.

Default
Linerequired
Election2

The four-digit year for a general election, or some other text (for example a full date) for a by-election.

Default
Linerequired
Riding3

The full title of a Wikipedia article about a riding. For example: 'Barrie (electoral district)'

Default
Lineoptional
Riding display4

The displayed text for the riding name, if different from the above. For example: 'Barrie'.

Default
Lineoptional
By-electionby

Set to 'yes' for by-elections. When using this, give the full date of the by-election rather than just the year.

Default
Lineoptional
By-election linkby-link

Pagename for by-election.

Default
Pageoptional
Reasonreason

Text describing reason for by-election, added on line below main title. For example: 'Resignation of [[Bugs Bunny]]'

Default
Lineoptional
Add percent columnpercent

Set to 'yes' to add a column with the heading '%'.

Default
Lineoptional
Add change columnchange

Set to 'yes' to add a column with the heading '∆%'.

Default
Lineoptional
Add expenditures columnexpenditures

Set to 'yes' to add a column with the heading 'Expenditures'.

Default
Lineoptional
Add elected columnelected

Set to 'yes' for ridings that elect multiple members off of one ballot to add a column for with the heading 'Elected'.

Default
Lineoptional
Add 1st ballot column1st

Set to 'yes' for ridings with multiple-rounds of voting to create a column for the first round of voting.

Default
Lineoptional
Add final ballot columnfinal

Set to 'yes' for ridings with multiple-rounds of voting to create a column for the final round of voting.

Default
Lineoptional
Add second percent columnpercent2

Set to 'yes' for ridings with multiple-rounds of voting to add a column for percents for the final round.

Default
Lineoptional
Mark as multi-ballot ridingballot

Set to A, B, or C for ridings that run multiple ballots each with a different slate of candidates during each election. It will only change the links in the heading.

Default
Lineoptional
''Future'' election dateon

The date of an upcoming election “YYYY-MM-DD” (or other machine interpretable date) to add a coloured title line “The YYYY general/municipal election will be held on Month day.” or (if parameter by=yes) “The by-election will be held on Month day, year.”

Default
Stringoptional
Note results ''Preliminary''prelim

Setting any value other than “no” adds the large title line “ ** Preliminary results — Not yet official ** ”

Default
Lineoptional
collapsedcollapsed

The table is by default collapsible. You can set the initial collapsedness to 'yes', 'auto', or 'no'. These correspond to initial states of 'collapsed', 'autocollapse', or 'none', respectively. 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.

Default
Lineoptional