Template:Infobox Australian electorate/doc

This is a documentation subpage for Template:Infobox Australian electorate.
It may contain usage information, categories and other content that is not part of the original template page.

This template adds an automatically generated short description. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article.

This template uses Lua:

Usage

Copy and paste one of the following for use in articles. If not sure what to put in them, look at the Fields section below.

For federal divisions

{{Infobox Australian electorate
| federal            = yes
| name               = 
| image              = 
| image_upright      = 
| image_alt          = 
| caption            = 
| created            = 
| mp                 = 
| mp-party           = 
| namesake           = 
| electors           = 
| electors_year      = 
| electors_footnotes = 
| area               = 
| class              = 
| stategov           =
| territorygov       =
| coordinates        = <!-- {{coord|LAT|S|LON|E|display=inline,title}} -->
| near-n             = 
| near-ne            = 
| near-e             = 
| near-se            = 
| near-s             = 
| near-sw            = 
| near-w             = 
| near-nw            = 
| footnotes          = 
}}

For state lower house districts

{{Infobox Australian electorate
| name               = 
| state              = 
| image              = 
| image_upright      = 
| image_alt          = 
| caption            = 
| created            = 
| mp                 = 
| mp-party           = 
| namesake           = 
| electors           = 
| electors_year      = 
| electors_footnotes = 
| area               = 
| class              = 
| fedgov             =
| coordinates        = <!-- {{coord|LAT|S|LON|E|display=inline,title}} -->
| near-n             = 
| near-ne            = 
| near-e             = 
| near-se            = 
| near-s             = 
| near-sw            = 
| near-w             = 
| near-nw            = 
| footnotes          = 
}}

For state upper house divisions or provinces

{{Infobox Australian electorate
| upper              = yes
| name               = 
| state              = 
| image              = 
| image_upright      = 
| image_alt          = 
| caption            = 
| created            = 
| mp                 = 
| mp-party           = 
| namesake           = 
| electors           = 
| electors_year      = 
| electors_footnotes = 
| area               = 
| class              = 
| fedgov             =
| stategov           =
| coordinates        = <!-- {{coord|LAT|S|LON|E|display=inline,title}} -->
| near-n             = 
| near-ne            = 
| near-e             = 
| near-se            = 
| near-s             = 
| near-sw            = 
| near-w             = 
| near-nw            = 
| footnotes          = 
}}

Fields

All fields used by this template are optional. Leaving "federal" or "upper" blank assumes "no" on each. The following fields are available:

Field name	Description	Valid for blank = all	Source/notes	Values
federal	is it federal?			'yes'
upper	is it a state upper house district? (ignored if incorrectly used)			'yes'
name	name of electorate			plain text (e.g. Werriwa)
state	state abbreviation			'nsw', 'vic', 'qld', 'sa', 'wa', 'tas', 'act', 'nt'
image	image or map relevant to electorate			filename
image_upright	width of generic image of the locality		This is an optional field. If not specified, the image width will default to `\|upright=1.23`, which is approximately 270px if the default thumbnail size has not been changed at Special:Preferences) The size should not be set to a value that would result in an image width greater than 300px. See help below for guidance on determining the value to be used.	number
image_alt	Alt text for the image			wikitext (can contain links)
caption	caption for the locality image			wikitext (can contain links)
created	date or year electorate was created			year or wiki date
abolished	date or year electorate was abolished			year or wiki date
lifespan	lifespan of electorate for cases where the seat has been recreated			year or wiki date (e.g. 1890–1950, 1962–present)
mp	current MP in office (for proportional, list of all MPs)			plain text or wikilink
mp-party	current party in office			plain text or wikilink
namesake	who or what electorate is named after			plain text or wikilink
electors	how many people are enrolled to vote in the area			number, unformatted
electors_year	year to which the figure in `electors` applies			raw year
electors_footnotes	footnote for `electors` figure			wikitext (can contain links) Best when used with <ref> </ref> tags
area	area in square kilometres (do not use commas or punctuation)			number
class	AEC class of the electorate (e.g. Rural)			plain text
fedgov	federal electorates within a state/territory electorate			plain text
stategov	state electorates within a federal electorate (can also be used for Upper House electorates)			plain text
territorygov	territory electorates within a federal electorate			plain text
coordinates	coordinates of the electorate; use "display=inline,title"; region is set automatically based on `\|state=`.		For coordinates, use {{coord}} with display=inline,title. Please do not be overly precise.	Example: {{Coord\|32\|45\|41.3\|S\|151\|44\|38.6\|E\|display=inline,title}}
near-n/ne/e/se/s/sw/w/nw	neighbouring electorates	small electorates	Only electorates that share borders with the subject electorate should be included in these fields. Do NOT use on large electorates.	plain text, link
footnotes	footnotes			wikitext (can contain links) Best when used with <ref> </ref> tags and a citation template such as {{cite web}}
module	embedding other templates		See Wikipedia:WikiProject Infoboxes/embed	Example: {{Other infobox/ other template}}
module2	embedding other templates		See Wikipedia:WikiProject Infoboxes/embed	Example: {{Other infobox/ other template}}
module2	embedding other templates		See Wikipedia:WikiProject Infoboxes/embed	Example: {{Other infobox/ other template}}

Notes

Calculating "image_upright"

The |image_upright= parameter, and |image2_upright= and |logo_upright= where applicable, are provided so as to facilitate the use of scalable images in this infobox, in accordance with the instructions at WP:IMAGESIZE, which advises against the use of "px" (for example: thumb|300px), as this forces a fixed image width.

Scalable images respect the user's base preference, which may have been selected for that user's particular devices. Module:InfoboxImage, which is used in this infobox, accommodates the use of scaling. However, setting the appropriate scale is slightly more complex than setting a raw "px" value. This guide provides a quick conversion table to make the process of setting a scale easier. It is based on a default thumbnail setting of 220px.

170px → upright=0.75
180px → upright=0.8
190px → upright=0.85
200px → upright=0.9
210px → upright=0.95
220px → upright=1
230px → upright=1.05
240px → upright=1.1
250px → upright=1.15
260px → upright=1.2
270px → upright=1.23
280px → upright=1.25
290px → upright=1.3
300px → upright=1.35

Footnotes field

Any references should be placed within the "footnotes" field and not within the field reserved solely for a numeric value. Otherwise, an error may result.

Unformatted numbers and expression errors

Certain fields require numeric values to be entered in an unformatted/raw fashion—i.e. 1000.0 NOT 1,000.0. If an expression error is present, simply remove any commas or spaces from the number.

Tracking categories

Category:Pages using infobox Australian electorate with unknown parameters (0) – Articles that include deprecated or otherwise invalid fields are automatically added.
Category:Pages using infobox Australian electorate with near parameters (436) – Articles using "near" fields (near-n, near-ne, near-e, near-se, near-s, near-sw, near-w and near-nw) are automatically added. These fields should not be used on large electorates and may become inaccurate after electoral redistributions are completed, so their use needs to be tracked.

Subpages

Microformat

The HTML markup produced by this template includes an hCard microformat, which makes the place-name and location parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to an address book. Within the hCard is a Geo microformat, which additionally makes the coordinates (latitude & longitude) parsable, so that they can be, say, looked up on a map, or downloaded to a GPS unit. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

If the place or venue has "established", "founded", "opened" or similar dates, use {{start date}} for the earliest of those dates unless the date is before 1583 CE.

If it has a URL, use {{URL}}.

Please do not remove instances of these sub-templates.

Classes

hCard uses HTML classes including:

adr
agent
category
county-name
extended-address
fn
label
locality
nickname
note
org
region
street-address
uid
url
vcard

Geo is produced by calling {{coord}}, and uses HTML classes:

geo
latitude
longitude

Please do not rename or remove these classes nor collapse nested elements which use them.

Precision

When giving coordinates, please use an appropriate level of precision. Do not use {{coord}}'s |name= parameter.

For Australian lower house electorates and for State upper and lower house electorates

Template parameters
Parameter		Description	Type	Status
Name	`name`	Name of electorate	Line	suggested
Federal?	`federal`	If a federal electorate, put 'yes', otherwise blank	Line	suggested
State	`state`	If a state electorate (upper or lower), put one of 'nsw', 'vic', 'qld', 'sa', 'wa', 'tas', 'act', 'nt'	Line	suggested
State upper house?	`upper`	If a state upper-house electorate, put 'yes', otherwise blank	Line	suggested
Image	`image`	File name for the image (omit the 'File:' prefix)	Line	suggested
Image size	`image_size`	no description	Unknown	optional
Imagesize	`imagesize`	no description	Unknown	optional
Image upright	`image_upright`	no description	Unknown	optional
Image alt	`image_alt`	no description	Unknown	optional
Alt	`alt`	no description	Unknown	optional
Caption	`caption`	Description of the image	String	suggested
Created	`created`	no description	Unknown	optional
Abolished	`abolished`	no description	Unknown	optional
Lifespan	`lifespan`	years (e.g. 1890–1950, 1962–present)	String	suggested
MP name(s)	`mp`	Name of current member of parliament (for proportional, list of all MPs)	String	suggested
MP party	`mp-party`	Party of current member of parliament (for proportional, list all parties)	String	suggested
Namesake	`namesake`	Who or what is the electorate named after?	Line	suggested
Electors	`electors`	no description	Unknown	optional
Electors year	`electors_year`	no description	Unknown	optional
Electors footnotes	`electors_footnotes`	no description	Unknown	optional
Area	`area`	no description	Unknown	optional
Area footnotes	`area_footnotes`	no description	Unknown	optional
Class	`class`	no description	Unknown	optional
Coordinates	`coordinates`	no description	Unknown	suggested
Footnotes	`footnotes`	no description	Unknown	optional