Editing Template:Infobox referendum/doc

{{Documentation subpage}}
{{Auto short description}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}
{{Uses TemplateStyles|Template:Infobox referendum/styles.css}}

== Basic usage ==
{{Parameter names example
| name                = {{{name}}}
| country             = Country
| flag_year           = 
| flag_image          = 
| date                = {{Start date|2000|01|01}}

<!-- Details -->
| question            = {{{question}}}
| image               = 
| image_width         = 
| image_alt           = 
| caption             = 
| voting_system       = {{{voting_system}}}
| votes_counted       = <!-- or | reporting = or | declared =, do not include percentage (%) sign -->
| last_update         = <!-- time of last update, for partial results -->
| time_zone           = <!-- time zone of the time given in the last_update field, must be linked -->
| outcome             = {{{outcome}}}
| website             = {{{website}}}

<!-- Results table -->
| yes_text            = {{{yes_text}}}
| yes                 = 1
| no_text             =	{{{no_text}}}
| no                  = 1
| blanktype           = {{{blanktype}}}
| blank               = 1
| othertype           = {{{othertype}}}
| other               = 1
| invalid             = 1
| total               = {{{total}}}
| totalref            = {{{totalref}}}
| electorate          = {{{electorate}}}
| voter_registration  = {{{voter_registration}}}
| turnoutpct          = 

<!-- Maps -->
| map                 = 
| map_size            = 
| map_alt             = 
| map_division        = {{{map_division}}}
| map_caption         = {{{map_caption}}}
| map2                = 
| map_size2           = 
| map_alt2            =
| mapdivision2        = 
| mapcaption2         = 

<!-- Bar graphs -->
| width               = 
| barwidth            = 
| part1_subject       = 
| part1_choice1       = 
| part1_percentage1   = 
| part1_color1        = 
| part1_choice2       = 
| part1_percentage2   = 
| part1_color2        = 
| part1_choice3       = 
| part1_percentage3   = 
| part1_color3        = 
| part1_choice4       =
| part1_percentage4   = 
| part1_color4        = 
| part1_choice5       =
| part1_percentage5   = 
| part1_color5        = 
| part1_caption       = 
| part2_subject       = 
| part2_choice1       = 
| part2_percentage1   = 
| part2_color1        = 
| part2_choice2       = 
| part2_percentage2   = 
| part2_color2        = 
| part2_choice3       = 
| part2_percentage3   = 
| part2_color3        = 
| part2_choice4       =
| part2_percentage4   = 
| part2_color4        = 
| part2_choice5       =
| part2_percentage5   = 
| part2_color5        = 
| part2_caption       = 

| notes               = {{{notes}}}
}}

This template is meant to work for referendums with [[polar question]]s as well as non-polar questions. This template can handle up to four subjects.

Please note the following:
* All numbers must be specified as plain numbers, without additional comments or references, or else the template will display improperly. The template uses the [[mw:Help:Magic word|magic word]] <code><nowiki>{{formatnum}}</nowiki></code> to insert commas for display.
* All percentages are calculated by the template, as well as the number of valid votes, invalid and blank votes, and voter turnout. Therefore, it is not necessary to find or have this data.
* The template figures out by itself whether the majority of voters approved or rejected the referendum based on the data it is fed. Therefore, it is not necessary to specify this. Furthermore, this cannot be overridden. The order the <code>yes</code> and <code>no</code> parameters are listed in does not affect which is displayed first.

<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox referendum
| name                = 
| country             = 
| flag_year           = 
| flag_image          = 
| date                = <!-- {{Start date|YYYY|MM|DD}} or {{Date_range|YYYY|MM|DD|YYYY|MM|DD}} -->

<!-- Details -->
| question            = <!-- or | title = -->
| image               = 
| image_width         = 
| image_alt           = 
| caption             = 
| voting_system       = 
| votes_counted       = <!-- or | reporting = or | declared =, do not include percentage (%) sign -->
| last_update         = <!-- time of last update, for partial results -->
| time_zone           = <!-- time zone of the time given in the last_update field, must be linked -->
| outcome             = 
| website             = <!-- use {{URL}} -->

<!-- Results table -->
| yes_text            = 
| yes                 = 
| no_text             =	
| no                  = 
| blanktype           = 
| blank               = 
| othertype           = 
| other               = 
| invalid             = 
| total               = 
| totalref            = 
| electorate          = 
| voter_registration  = 
| turnoutpct          = 

<!-- Maps -->
| map                 = 
| map_size            = 
| map_alt             = 
| map_division        = <!-- name of the political subdivisions shown in the map, defaults to "county" -->
| map_caption         = <!-- overrides the default caption -->
| map2                = 
| map_size2           = 
| map_alt2            =
| mapdivision2        = 
| mapcaption2         = 

<!-- Bar graphs -->
| width               = 
| barwidth            = 
| part1_subject       = 
| part1_choice1       = 
| part1_percentage1   = 
| part1_color1        = 
| part1_choice2       = 
| part1_percentage2   = 
| part1_color2        = 
| part1_choice3       = 
| part1_percentage3   = 
| part1_color3        = 
| part1_choice4       =
| part1_percentage4   = 
| part1_color4        = 
| part1_choice5       =
| part1_percentage5   = 
| part1_color5        = 
| part1_caption       = 
| part2_subject       = 
| part2_choice1       = 
| part2_percentage1   = 
| part2_color1        = 
| part2_choice2       = 
| part2_percentage2   = 
| part2_color2        = 
| part2_choice3       = 
| part2_percentage3   = 
| part2_color3        = 
| part2_choice4       =
| part2_percentage4   = 
| part2_color4        = 
| part2_choice5       =
| part2_percentage5   = 
| part2_color5        = 
| part2_caption       = 

| notes               = <!-- e.g. Source: [URL] -->
}}
</syntaxhighlight>

== Examples ==
Below are examples of single-choice polar questions, as well as a non-polar example with multiple options.
=== Before an election ===
{{Infobox referendum
| name        = Measure 56
| title       = Amends Constitution: Provides That May And November Property Tax Elections Are Decided By Majority Of Voters Voting
| location    = 
| date        = {{Start date|2018|11|04|df=y}}
| yes         = 
| no          = 
| total       = 
| electorate  = 
| map         = Oregon election results-ELECTION NOT YET.svg
| mapdivision = 
| notes       = 
}}

Use the model code below before an election for a referendum is held. [[Oregon Ballot Measure 56 (2008)]] is used as an example to the right.

<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox referendum
| name        = Measure 56
| title       = Amends Constitution: Provides That May And November Property Tax Elections Are Decided By Majority Of Voters Voting
| location    = 
| date        = {{Start date|2018|11|04|df=y}}
| yes         = 
| no          = 
| total       = 
| electorate  = 
| map         = Oregon election results-ELECTION NOT YET.svg
| mapdivision = 
| notes       = 
}}
</syntaxhighlight>

Keep in mind that, though the parameters <code>yes</code>, <code>no</code>, <code>total</code>, <code>electorate</code>, and <code>mapdivision</code> are blank, they ''should not'' be deleted. This makes it inconvenient to add data later.
{{clear}}
=== During the election ===

Once election day arrives, the image can be changed to '''File:Oregon election results-PENDING.svg'''. After the polls have closed and start announcing returns, start putting the data into the template, updating as often as reasonable. Use the <code>notes</code> parameter to cite the source of the election-night returns.
{{clear right}}

=== After an election ===
{{Infobox referendum
 | name = Measure 56
 | title = Amends Constitution: Provides That May And November Property Tax Elections Are Decided By Majority Of Voters Voting
 | yes = 959118
 | no = 735500
 | total = 1845251
 | electorate = 2153914
 | map = File:Oregon 2008 Measure 56.svg
 | mapdivision =
 | notes = Source: [[Oregon Secretary of State]]
 }}

The following code produces the table to the right:

<syntaxhighlight lang="wikitext" style="overflow:auto">
{{Infobox referendum
| name = Measure 56
| title = Amends Constitution: Provides That May And November Property Tax Elections Are Decided By Majority Of Voters Voting
| yes = 959118
| no = 735500
| total = 1845251
| electorate = 2153914
| map = File:Oregon 2008 Measure 56.svg
| mapdivision =
| notes = Source: [[Oregon Secretary of State]]
}}
</syntaxhighlight>

The parameters <code>yes</code>, <code>no</code>, <code>total</code>, and <code>electorate</code> take only values '''without commas'''. The template automatically formats the numbers when displayed by inserting commas.
{{clear}}
===Multichoice referendums===
{{Infobox multichoice referendum
| name = 2016 United Kingdom European Union membership referendum
| country = United Kingdom
| date = {{Start date|2016|06|23|df=y}}  
| image = 
| caption = The results in the United Kingdom by constituency
| choice1 = Remain in the European Union
| percentage1 = 55.11
| choice2 = Leave the European Union
| percentage2 = 44.89
| choice3 = Invalid votes
| percentage3 = 0.08
}}
<syntaxhighlight lang="wikitext" style="overflow: auto"><nowiki>
{{Infobox multichoice referendum
| name = 2016 United Kingdom European Union membership referendum
| country = United Kingdom
| date = {{Start date|2016|06|23|df=y}}  
| choice1 = Remain in the European Union 
| percentage1 = 55.11
| choice2 = Leave the European Union
| percentage2 = 44.89
| choice3 = Invalid votes
| percentage3 = 0.08
{{clear}}
</nowiki></syntaxhighlight>

== Parameters ==
;name
:The name of the referendum, such as ''Measure 56'' or ''Proposition 1A''.

;question {{nobold|or}} title
:The official ballot question or title.

;location
:The administrative division (or country for a nationwide vote) where the referendum was held.

;date
:When the referendum was held.

;yes
:The number of votes approving the referendum.

;no
:The number of votes rejecting the referendum.

;total
:The total number of votes cast in the election.
:(''This includes all counted votes as well as invalid or blank votes.'')

;electorate
:The number of people eligible to vote in the election (in some countries this means the number of people ''registered'' to vote).
:(''This includes people who did not cast a vote on the referendum.'')

;voter registration
: Whether voter registration determines the number of eligible voters. If no, the term "registered voters" will not be used for the parameter "electorate", but "eligible to vote" is used instead.

;map
:The map of election results.

;mapdivision
:The name of the political subdivisions shown in the map, such as ''county'', ''parish'', or ''canton''.
:(''If no value is given, the default is '''county'''. Give any value to override this.'')

;map2
:A supplementary map for election results, like population density

;mapdivision
:The name of the political subdivisions shown in the map, such as ''county'', ''parish'', or ''canton''.
:(''If no value is given, the default is '''county'''. Give any value to override this.'')

;outcome
:Outcome of the election (e.g. Not passed due to insufficient turnout).

;notes
:Any notes, such as the source of the data.

=== Additional parameters ===
;other
:The total number of valid votes which were not yes or no (e.g., informal votes)

;othertype
:Label to use for the "other votes" statistics, where those are part of the valid votes (e.g., Informal votes or Blank votes). If "Blank votes" is used here, the text "Invalid or blank votes" is also changed to "Invalid votes"

;invalid
:The total number of invalid votes.  This may be used as an alternative to <code>total</code>, in which case the total number of votes is computed as the sum of <code>yes</code>, <code>no</code>, and <code>invalid</code>.  If both <code>invalid</code> and <code>total</code> are specified, the <code>total</code> parameter will be used for computing the total number of votes.
:To suppress the inclusion of invalid votes, specify <code>invalid</code>, but leave the value blank

;totalref
:A citation for the total number of votes

;turnoutpct
:The percentage of the electorate who voted in the referendum.  Note that this is automatically computed from the value of <code>electorate</code> and the total number of votes, if <code>electorate</code> is specified.

;mapcaption
:Use this parameter to override the default legend caption used for the map.

== Region-specific information ==

=== United States ===

==== California ====
The [[California Secretary of State]]'s [https://www.sos.ca.gov/elections website] prominently displays results for the latest election. Results are also available as far back as June 1990 on [https://www.sos.ca.gov/elections/prior-elections another page] at the website. Before 2000, results are listed in a single document, both the ''statement of vote'' (which is brief) and the ''supplement to the statement of vote'' (which is highly detailed). Starting in 2000, results are organized into a table of contents.

==== Oregon ====
The [[Oregon Secretary of State]]'s [https://sos.oregon.gov/voting-elections/Pages/default.aspx website] maintains an online record of detailed election results going back to {{#formatdate:1995-12-05}}. Results by county for each ballot measure since then are included. Statistics on voter registration (fitting the <code>electorate</code> parameter) and participation/turnout (the <code>total</code> parameter) is available alongside the official results for each election.

Basic data (i.e., without results by county) on all ballot measures in Oregon history can also be found in the [https://sos.oregon.gov/blue-book/Pages/state/elections/history.aspx online edition] of the ''[[Oregon Blue Book]]''. Voter registration information going back to 1950 is also provided.

The following images can be used in place of an election results map when none can be made:

<gallery>
File:Oregon election results-ELECTION NOT YET.svg|The election has not been held yet
File:Oregon election results-PENDING.svg|The votes are being counted
File:Oregon election results-DATA MISSING.svg|The needed data has not been found
</gallery>

{{clear}}

==See also==
* {{tl2|bar_box}}
<includeonly>{{Sandbox other||
[[Category:Election and referendum infobox templates|referendum]]
}}</includeonly>