Template:Infobox Australian place/doc

Purpose
Infobox Australian place is used to add infoboxes to articles on places in Australian states and territories. It is not limited to populated places such as cities, towns and suburbs, but may be used on any place including regions, local government areas, cadastral units, protected areas and even some areas that do not fall into any of the preceding descriptions and for which no other infobox is appropriate. It is the standard infobox used in Australian articles. Australian articles using Infobox settlement should be converted to use this infobox.

The infobox has been extensively customised for Australia and includes automation that results in some parameters being redundant to other parameters. For example, if population density (in the density parameter) is not specified, this will be automatically generated based on the pop and area parameters. It is therefore important to read parameter descriptions thoroughly, to avoid unnecessarily providing redundant or incorrect information.

For infoboxes that require reformatting, general cleanup or addition of missing parameters, Template:Infobox Australian place/cleanup can be substituted. This will reformat the infobox and remove invalid parameters.

To use this template

 * 1) Copy the relevant blank template from the Blank infobox page into the beginning of your document, remembering to put the code on the line directly before the start of the article's lead.
 * 2) Enter values for the parameters as outlined under, particularly type and state. Parameters left blank will automatically be hidden.
 * 3) Preview the page with your edits.
 * 4) Save the page with an appropriate edit summary (e.g., " Added ", which will display as, "Added Infobox Australian place" ).

Examples

 * Examples of this template can be found on the examples page.

Parameters
Both  and   are required parameters. All other parameters used by this template are optional.

Required
These parameters must be set for every infobox as they affect the behaviour of many other parameters.

The type parameter sets up the template for a specific type of location. It regulates which parameters can be used and sets the colour of the top bar of the infobox. The entered values for this parameter should be plain, unlinked text.

The state parameter defines the state or territory of the infobox's location. It sets up the template to refer to and link to the correct state or territory throughout. The entered values for this parameter should be plain, unlinked text; for consistency, lower case is preferred. If the parameter is left blank, the infobox will default to  (i.e., Australia).

Locator map generated by coordinates
The recommended and most common locator map is auto-generated by coordinates, but can be toggled off using nomap (see in table). All of the following parameters require coordinates to be properly set using coord.

Locator map generated by wikidata
A second map can be generated using pre-defined wikidata. This can either replace, or be in addition to, the map generated by the  parameter. It will display below the map.

IUCN categories for protected areas
Depending on the value given for iucn_category, one of the following banners will be displayed below the name. Valid values are Ia, Ib, II, III, IV, V and VI. For more information read the IUCN protected area categories article.



Calculating "image_upright"
The  parameter, and   and   where applicable, is/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:  ), 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.


 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;
 * &rarr;



Footnote and reference parameters
Any references to support a parameter reserved solely for a numeric value should be placed within the respective ..._footnotes or ..._ref parameters. For example, place the reference used for the area of City X in the area_footnotes parameters and not in the area parameter. Otherwise, an error may result.

Unformatted numbers and expression errors
Certain parameters 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.

Dist#, Dir# and Location#
This is the distance and approximate direction to another location. The '#' is replaced with a number between 1 and 5. Therefore, five locations can be listed, using location1 through location5. The distances can be listed using dist1 through dist5. Direction from the locations is optional, and can be specified using dir1 through dir5.

Population from Wikidata
If the pop parameter is left empty or not supplied, the template will attempt to retrieve population data from Wikidata. For more information, see the documentation of Module:PopulationFromWikidata. This is a new feature as of June 2022 (to coincide with the release of the 2021 Australian Census data). Please report any feedback to Template talk:Infobox Australian place.

Where to find information

 * WikiProject Australian places
 * Australian Bureau of Statistics
 * LGA links for each state
 * Climate Data Online at the Bureau of Meteorology

Tracking categories

 * – articles that display population values from Wikidata, rather than directly via the pop parameter.

Deprecated parameters

 * – articles that include deprecated parameters are automatically added. As of 5 April 2016, the tracked parameters are imagesize, image2size, imagesize2, image_alt2, logosize and official_site.

Errors

 * – articles that contain general errors are automatically added.
 * – articles missing pop_year or pop2_year parameters are automatically added.
 * – articles missing pop_footnotes or pop2_footnotes parameters are automatically added.
 * – articles using parameters that are not included in the infobox. This category may include articles with incorrectly spelled parameters.
 * – articles using parameters that are not included in the infobox. This category may include articles with incorrectly spelled parameters.

Subpages

 * Template:Infobox Australian place
 * Template:Infobox Australian place/Blank
 * Template:Infobox Australian place/Examples
 * Template:Infobox Australian place/doc
 * Template:Infobox Australian place/sandbox
 * Template:Infobox Australian place/sandbox/doc
 * Template:Infobox Australian place/testcases

TemplateData
{	"description": "Display information about a place in Australia in a standard infobox format.", "params": { "type": { "label": "Type", "description": "The type of place, which determines the look of the infobox. Can be empty or one of the following: 'city', 'suburb', 'town', 'lga', 'region', or 'cadastral'.", "type": "string", "required": false, "suggestedvalues": [ "city", "suburb", "town", "lga", "region", "cadastral", "protected", "other" ]		},		"name": { "label": "Name", "description": "The name of the place. If this parameter is left empty, the infobox title will be blank, while if this parameter is not called at all, it defaults to the name of the article.", "type": "string", "required": false },		"city": { "label": "City", "description": "The name of the city the place is located in, which is automatically wikilinked.", "type": "string", "required": false },		"state": { "label": "State Abbreviation", "description": "The abbreviation for the state the place in located in, which can be uppercase or lowercase.", "type": "string", "required": false, "suggestedvalues": [ "sa", "vic", "nsw", "qld", "nt", "wa", "tas", "act", "jbt", "ni", "au" ]		},		"image": { "label": "Image", "description": "A filename for a generic image of the locality.", "type": "string", "required": false },		"image_upright": { "label": "Image Width", "description": "Override the default width of the image, scalable.", "type": "number", "required": false },		"caption": { "label": "Caption", "description": "A caption for the image.", "type": "string", "required": false },		"image_alt": { "label": "Image Alt Text", "description": "Alt text for the image.", "type": "string", "required": false },		"image2": { "label": "Image 2", "description": "A filename for a second image of the locality. Usually used for maps, especially in LGA articles.", "type": "string", "required": false },		"image2_upright": { "label": "Image 2 Width", "description": "Override the default width of the second image, scalable.", "type": "number", "required": false },		"caption2": { "label": "Image 2 Caption", "description": "A caption for the second image.", "type": "string", "required": false },		"image2_alt": { "label": "Image 2 Alt Text", "description": "Alt text for the second image.", "type": "string", "required": false },		"coordinates": { "label": "Coordinates", "description": "Coordinates of the locality. Use °N, °W with 'display=inlines,title'. Please don't be overly precise.", "type": "string", "required": false },		"alternative_location_map": { "label": "Locator Map Alternative Map File", "description": "Forces the locator map to use this alternative map instead of the default state map.", "type": "wiki-file-name", "required": false },		"force_national_map": { "label": "Locator Map Set to National Map", "description": "Set to 'yes' to force the locator map to use the Australian map instead of the default state map.", "type": "string", "required": false, "example": "yes", "default": "no", "suggestedvalues": [ "yes", "no" ]		},		"use_lga_map": { "label": "Locator Map Set to LGA Map", "description": "Set to 'yes' to force the locator map to use the LGA map instead of the default state one.", "type": "string", "required": false, "example": "yes", "default": "no", "suggestedvalues": [ "yes", "no" ]		},		"relief": { "label": "Locator Map Set to Relief Map", "description": "Set to 'yes' to make the locator map use a relief map.", "type": "string", "required": false, "example": "yes", "default": "no", "suggestedvalues": [ "yes", "no" ]		},		"pushpin_map_caption": { "label": "Locator Map Pushpin Caption", "description": "The caption for the locator map's pushpin.", "type": "string", "required": false, "example": "Testville Testplace", "default": "value of the 'name' parameter" },		"pushpin_label_position": { "label": "Locator Map Pushpin Label Position", "description": "Where the caption should appear relative to the locator map's pushpin.", "type": "string", "default": "right", "required": false, "example": "top", "suggestedvalues": [ "left", "right", "top", "bottom" ]		},		"map_alt": { "label": "Locator Map Alternative Text", "description": "Alternative text for the locator map.", "type": "string", "required": false },		"pop": { "label": "Population", "description": "The total population of the place. If left empty, population data will be displayed from Wikidata (for appropriate geography).", "type": "number", "required": false },		"pop_year": { "label": "Population Year", "description": "The year in which the population measurement was taken. may be used.", "type": "number", "required": false },		"pop_footnotes": { "label": "Population Footnotes", "description": "Footnotes for the population figure. Please use references here.", "type": "string", "required": false },		"pop2": { "label": "Population 2", "description": "A second total population measurement.", "type": "number", "required": false },		"pop2_year": { "label": "Population 2 Year", "description": "The year in which the second population measurement was taken. may be used.", "type": "number", "required": false },		"pop2_footnotes": { "label": "Population 2 Footnotes", "description": "Footnotes for the second population figure. Please use references here.", "type": "string", "required": false },		"poprank": { "label": "Population Rank", "description": "Only for cities. The total population rank of the city.", "type": "number", "required": false },		"density": { "label": "Population Density", "description": "The population density of the place.", "type": "number", "required": false },		"density_footnotes": { "label": "Population Density Footnotes", "description": "Footnotes for the population density figure. Please use references here.", "type": "string", "required": false },		"established": { "aliases": [ "est" ],			"label": "Established", "description": "The date the place was established.", "type": "string", "required": false },		"abolished": { "label": "Abolished", "description": "The date the place was abolished.", "type": "string", "required": false },		"gazetted": { "label": "Gazetted", "description": "The date the place was gazetted.", "type": "string", "required": false },		"postcode": { "label": "Postcode", "description": "The postcode of the place.", "type": "number", "required": false },		"elevation": { "label": "Elevation", "description": "Elevation of the place above sea level in metres.", "type": "number", "required": false },		"elevation_footnotes": { "label": "Elevation Footnotes", "description": "Footnotes for the elevation figure.", "type": "string", "required": false },		"area": { "label": "Area", "description": "Area of the place in square kilometres.", "type": "number", "required": false },		"area_footnotes": { "label": "Area Footnotes", "description": "Footnotes for the area figure.", "type": "string", "required": false },		"timezone": { "label": "Time Zone", "description": "The time zone the place is located in.", "type": "string", "required": false },		"utc": { "label": "UTC Time", "description": "The difference between UTC time and the time zone the place resides in, in the format '+' followed by a number.", "type": "string", "required": false },		"timezone-dst": { "label": "Summer Time Zone (DST)", "description": "The summer time zone the place is located in.", "type": "string", "required": false },		"utc-dst": { "label": "Summer UTC Time (DST)", "description": "The difference between UTC time and the time zone the place resides in in the summer, in the format '+' followed by a number.", "type": "string", "required": false },		"mayor": { "label": "Mayor", "description": "LGA only. The name of the mayor of the LGA.", "type": "string", "required": false },		"mayortitle": { "label": "Mayor Title", "description": "LGA only. The title of the mayor of the LGA. Defaults to 'Mayor'.", "type": "string", "required": false },		"dist1": { "label": "Distance 1", "description": "The distance by road in kilometres from location 1 to the place.", "type": "number", "required": false },		"dir1": { "label": "Direction 1", "description": "The compass direction from location 1 to the place. Examples are 'NW', 'E', and 'SSE'.", "type": "string", "required": false },		"location1": { "label": "Location 1", "description": "Another location to compare with this one.", "type": "string", "required": false },		"dist2": { "label": "Distance 2", "description": "The distance by road in kilometres from location 2 to the place.", "type": "number", "required": false },		"dir2": { "label": "Direction 2", "description": "The compass direction from location 2 to the place. Examples are 'NW', 'E', and 'SSE'.", "type": "string", "required": false },		"location2": { "label": "Location 2", "description": "Another location to compare with this one.", "type": "string", "required": false },		"dist3": { "label": "Distance 3", "description": "The distance by road in kilometres from location 3 to the place.", "type": "number", "required": false },		"dir3": { "label": "Direction 3", "description": "The compass direction from location 3 to the place. Examples are 'NW', 'E', and 'SSE'.", "type": "string", "required": false },		"location3": { "label": "Location 3", "description": "Another location to compare with this one.", "type": "string", "required": false },		"dist4": { "label": "Distance 4", "description": "The distance by road in kilometres from location 4 to the place.", "type": "number", "required": false },		"dir4": { "label": "Direction 4", "description": "The compass direction from location 4 to the place. Examples are 'NW', 'E', and 'SSE'.", "type": "string", "required": false },		"location4": { "label": "Location 4", "description": "Another location to compare with this one.", "type": "string", "required": false },		"dist5": { "label": "Distance 5", "description": "The distance by road in kilometres from location 5 to the place.", "type": "number", "required": false },		"dir5": { "label": "Direction 5", "description": "The compass direction from location 5 to the place. Examples are 'NW', 'E', and 'SSE'.", "type": "string", "required": false },		"location5": { "label": "Location 5", "description": "Another location to compare with this one.", "type": "string", "required": false },		"lga": { "label": "Local Government Area (LGA)", "description": "The name of the local government area of the place.", "type": "string", "required": false },		"lga2": { "label": "Local Government Area (LGA) 2", "description": "Another local government area of the place.", "type": "string", "required": false },		"lga3": { "label": "Local Government Area (LGA) 3", "description": "Another local government area of the place.", "type": "string", "required": false },		"lga4": { "label": "Local Government Area (LGA) 4", "description": "Another local government area of the place.", "type": "string", "required": false },		"lga5": { "label": "Local Government Area (LGA) 5", "description": "Another local government area of the place.", "type": "string", "required": false },		"seat": { "label": "Local Government Area (LGA) Seat", "description": "The local government area's seat of government.", "type": "string", "required": false },		"region": { "label": "Region", "description": "The region the LGA is in.", "type": "string", "required": false },		"county": { "label": "County", "description": "The county the place is in.", "type": "string", "required": false },		"parish": { "label": "Parish", "description": "The parish the place is in.", "type": "string", "required": false },		"hundred": { "label": "Hundred", "description": "The hundred the place is in.", "type": "string", "required": false },		"former_hundred": { "label": "Former Hundred", "description": "The former hundred the place is in.", "type": "string", "required": false },		"division": { "label": "Division", "description": "The division the place is in.", "type": "string", "required": false },		"localgov": { "label": "Local Government", "description": "The local government electorate of the place.", "type": "string", "required": false },		"stategov": { "label": "State Government", "description": "The state government electorate of the place.", "type": "string", "required": false },		"stategov2": { "label": "State Government 2", "description": "Another state government electorate of the place.", "type": "string", "required": false },		"stategov3": { "label": "State Government 3", "description": "Another state government electorate of the place.", "type": "string", "required": false },		"stategov4": { "label": "State Government 4", "description": "Another state government electorate of the place.", "type": "string", "required": false },		"stategov5": { "label": "State Government 5", "description": "Another state government electorate of the place.", "type": "string", "required": false },		"fedgov": { "label": "Federal Government", "description": "The federal government electorate of the place.", "type": "string", "required": false },		"fedgov2": { "label": "Federal Government 2", "description": "Another federal government electorate of the place.", "type": "string", "required": false },		"fedgov3": { "label": "Federal Government 3", "description": "Another federal government electorate of the place.", "type": "string", "required": false },		"fedgov4": { "label": "Federal Government 4", "description": "Another federal government electorate of the place.", "type": "string", "required": false },		"logo": { "label": "LGA Logo", "description": "A filename for the logo, if any, of the place's LGA.", "type": "string", "required": false },		"logosize": { "label": "LGA Logo Size", "description": "Override the default width of the LGA logo, which is 175px.", "type": "number", "required": false },		"url": { "label": "LGA URL", "description": "The bare URL for the place's LGA's website.", "type": "string", "required": false },		"maxtemp": { "label": "Maximum Temperature", "description": "The maximum average annual temperature of the place in degrees Celsius.", "type": "number", "required": false },		"maxtemp_footnotes": { "label": "Maximum Temperature Footnotes", "description": "Footnotes for the maximum temperature figure. Please use references here.", "type": "string", "required": false },		"mintemp": { "label": "Minimum Temperature", "description": "The minimum average annual temperature of the place in degrees Celsius.", "type": "number", "required": false },		"mintemp_footnotes": { "label": "Minimum Temperature Footnotes", "description": "Footnotes for the minimum temperature figure. Please use references here.", "type": "string", "required": false },		"rainfall": { "label": "Rainfall", "description": "The average annual rainfall of the place in millimetres.", "type": "number", "required": false },		"rainfall_footnotes": { "label": "Rainfall Footnotes", "description": "Footnotes for the rainfall figure.", "type": "string", "required": false },		"near": { "label": "Central Near Grid", "description": "Replace the default text in the center of the 'Near' grid (the name of the place).", "type": "string", "required": false },		"near-n": { "label": "North Near Grid", "description": "The nearest neighbour of the place to the north.", "type": "string", "required": false },		"near-ne": { "label": "Northeast Near Grid", "description": "The nearest neighbour of the place to the northeast.", "type": "string", "required": false },		"near-e": { "label": "East Near Grid", "description": "The nearest neighbour of the place to the east.", "type": "string", "required": false },		"near-se": { "label": "Southeast Near Grid", "description": "The nearest neighbour of the place to the southeast.", "type": "string", "required": false },		"near-s": { "label": "South Near Grid", "description": "The nearest neighbour of the place to the south.", "type": "string", "required": false },		"near-sw": { "label": "Southwest Near Grid", "description": "The nearest neighbour of the place to the southwest.", "type": "string", "required": false },		"near-w": { "label": "West Near Grid", "description": "The nearest neighbour of the place to the west.", "type": "string", "required": false },		"near-nw": { "label": "Northwest Near Grid", "description": "The nearest neighbour of the place to the northwest.", "type": "string", "required": false },		"native_name": { "label": "Native name", "description": "Name in the local language if different to 'name'.", "type": "line" },		"native_name_lang": { "label": "Native name language", "description": "ISO 639-1 code for the native language, e.g. \"fr\" for French.", "type": "string" },		"local_map": { "label": "Local Map Enabled", "description": "Set to 'yes' to display an additional map showing the OpenStreetMap relation from the related Wikidata item. If no OpenStreetMap relation is specified, a point is shown from the coordinates of the related Wikidata item instead. This additional map is typically useful for showing the boundaries of area features such as administrative regions and national parks, or showing the extent of linear features such as roads and railways.", "example": "yes", "type": "string", "default": "no", "suggested": true, "suggestedvalues": [ "yes", "no" ]		},		"zoom": { "label": "Local Map Zoom Level", "description": "Defines a zoom level for the local map between level 1 (whole world) to 18 (smallest area). Most common zoom levels are between 7 (a large national park) and 13 (a school campus). If this field is not specified, the local map guesses a zoom level however the guess is typically not suitable.", "example": "10", "type": "number", "suggestedvalues": [ "1",				"2",				"3",				"4",				"5",				"6",				"7",				"8",				"9",				"10",				"11",				"12",				"13",				"14",				"15",				"16",				"17",				"18"			],			"default": "10", "suggested": true },		"local_map_id": { "label": "Local Map Wikidata Item ID", "description": "A manually selected Wikidata Item (QID) from which an OpenStreetMap Relation will be extracted for display on the local map. If this value is blank (default), the Wikidata Item associated with the page using this template will be used.", "example": "Q402", "type": "string" }	},	"paramOrder": [ "type", "name", "city", "state", "image", "image_upright", "caption", "image_alt", "image2", "image2_upright", "caption2", "image2_alt", "coordinates", "alternative_location_map", "force_national_map", "use_lga_map", "relief", "pushpin_map_caption", "pushpin_label_position", "map_alt", "local_map", "zoom", "local_map_id", "pop", "pop_year", "pop_footnotes", "pop2", "pop2_year", "pop2_footnotes", "poprank", "density", "density_footnotes", "established", "abolished", "gazetted", "postcode", "elevation", "elevation_footnotes", "area", "area_footnotes", "timezone", "utc", "timezone-dst", "utc-dst", "mayor", "mayortitle", "dist1", "dir1", "location1", "dist2", "dir2", "location2", "dist3", "dir3", "location3", "dist4", "dir4", "location4", "dist5", "dir5", "location5", "lga", "lga2", "lga3", "lga4", "lga5", "seat", "region", "county", "parish", "hundred", "former_hundred", "division", "localgov", "stategov", "stategov2", "stategov3", "stategov4", "stategov5", "fedgov", "fedgov2", "fedgov3", "fedgov4", "logo", "logosize", "url", "maxtemp", "maxtemp_footnotes", "mintemp", "mintemp_footnotes", "rainfall", "rainfall_footnotes", "near", "near-n", "near-ne", "near-e", "near-se", "near-s", "near-sw", "near-w", "near-nw", "native_name", "native_name_lang" ] }