ᱪᱷᱟᱸᱪ:Infobox Australian place/doc
This is a documentation subpage for ᱪᱷᱟᱸᱪ:Infobox Australian place. It contains usage information, categories and other content that is not part of the original ᱪᱷᱟᱸᱪ page. |
This template is used on 14430 pages, and changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in a user subpage, and consider discussing changes at the talk page before implementing them. |
This template uses Lua: |
This template adds an automatically generated short description. |
ᱪᱷᱟᱸᱪ:Infobox Australian place/pagelinks
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 a population density (in the density
field) is not specified, this will be automatically generated based on the pop
and area
fields. 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 fields, Template:Infobox Australian place/cleanup may be substed. This will reformat the infobox and remove invalid fields.
Usage
ᱥᱟᱯᱲᱟᱣTo use this template
ᱥᱟᱯᱲᱟᱣ- Copy the relevant blank template from the Blank infobox page into the beginning of your document, remembering to put the code at the very top of the article and the first word of the article on the very next line.
- Enter values for the fields as outlined in the table below. Fields left blank will automatically be hidden.
- Preview.
- Save the page with an appropriate edit summary.
Examples
ᱥᱟᱯᱲᱟᱣ- Examples of this template can be found on the examples page.
Parameters
ᱥᱟᱯᱲᱟᱣBoth type
and state
are required parameters. All other parameters used by this template are optional. The following are available:
Parameter | Description | Valid for blank = all |
Source/notes | Values |
---|---|---|---|---|
ᱪᱷᱟᱸᱪ:Visible anchor | infobox type | Sets up the template for a specific type of locality. Should be set to other when the place is not one of the defined types.
|
"city", "suburb", "town", "lga", "region", "cadastral", "protected" or "other" | |
name | name of place | If this field does not exist, the template will use the name of the article. If the field exists, but the place name is not defined, the infobox title will be blank. | plain text | |
city | city name | suburb | See List of cities in Australia.In some cases it may be desirable to include the name of a non-city here. In any case, if the name is not wikilinked, it will automatically be linked. | plain text, may be linked. |
ᱪᱷᱟᱸᱪ:Visible anchor | state or territory abbreviation | Abbreviation for the state or territory. For consistency, lower case is preferred, but upper case may be used. When a state code is not applicable, "au" should be used, although the field may be left blank. | "qld", "nsw", "act", "vic", "tas", "sa", "wa", "nt", or use "au" for Australia – plain text, do not link | |
iucn_category | IUCN category | protected area | This field should be populated with the IUCN category associated with the protected area. Although optional, use of this field is strongly recommended. For more information on how this field is displayed, see IUCN Categories below. | Ia, Ib, II, III, IV, V, or VI (plain text, do not wikilink) |
iucn_ref | IUCN category reference | protected area | Reference for the iucn_category field
|
wikitext (can contain links) Best when used with <ref> </ref> tags and {{cite web}} |
image | generic image of the locality | For cadastral units, this is typically a map showing the location of the cadastral unit within the state or territory. | 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 | |
caption | caption for the locality image | wikitext (can contain links) | ||
image_alt | for the image | wikitext (can contain links) | ||
image2 | A second image of the locality | In LGA articles this is typically used where a map of the LGA is required but the appropriate locator map template is not available in Category:Australia location map templates. | filename | |
image2_upright | width of the second 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 | |
caption2 | caption for the second locality image | wikitext (can contain links) | ||
image2_alt | for the image | wikitext (can contain links) | ||
coordinates | coordinates of the locality | ᱪᱷᱟᱸᱪ:UF-coord |
Example: {{Coord|32|45|41.3|S|151|44|38.6|E|type:city_region:AU-NSW|display=inline,title}} | |
map_scale | changes scale of map | The scale of the map linked to in the generated coordinates string can be changed from the default by setting this field. | unformatted number. See {{coord}} for examples. | |
map_type | controls the location map | set to nomap to suppress any automatically generated location map
|
nomap, auto, or blank | |
alternative_location_map | forces locator map | Forces the locator map to use an alternative, rather than the state map, regardless of the contents of state .
|
Name of the alternative map | |
force_national_map | forces locator map | city, region, protected | Forces the locator map to use the Australian, rather than the state map, regardless of the contents of state .
|
"yes" or leave blank, plain text, do not link |
use_lga_map | forces locator map | suburb, lga, protected | Forces the locator map to use the lga map. For this to work, both state and lga must be set to the correct parameters.
|
"yes" or leave blank, plain text, do not link |
relief | forces relief map | "yes" or leave blank, plain text, do not link | ||
pushpin_map_caption | caption | optional, plain text or linked | ||
pushpin_label_position | label position | left, right, top, bottom default: left | ||
map_alt | for the location map | wikitext (can contain links) | ||
local_map | enable map of local area | Setting |local_map=yes enables a map of the local area below the main locator map. In order for the map to display properly, the current location must be connected to a Wikidata entry and a map border must have been created on OpenStreetMap. If these have not happened, the map will not display correctly.
|
"yes" or leave blank, plain text, do not link | |
zoom | change zoom size of local map | Setting this field to a value between 1 and 18 adjusts the zoom of the displayed map. The default zoom value is 10. For more information see {{Infobox mapframe}} instructions. | numeric value between 1 and 18. | |
local_map_id | Wikidata id | use of infobox on "other" pages | Normally, this field is unnecessary. However, if it is necessary to use the infobox on a page that is not connected to a Wikidata entry, including this field with a Wikidata id (e.g. local_map_id = Q595259) will display a map for that locality, if one exists. | Wikidata id. e.g. Q595259 |
nearest_town_or_city | nearest town or city to the area | protected | If the area is not within a town or city, the nearest town or city to the area can be listed here. If only one, wikilinking may be omitted as the article will be automatically linked. If there are more than one, use {{Plainlist}}. | wikitext (can contain links) |
pop | population | all except protected; use approx for region | ABS (generic) 2016 Census QuickStats Do not add anything else to this field (years, references etc.) |
number. should be plain, either with or without a comma. i.e. 12345 or 12,345 |
pop_year | population year | all except protected; use approx for region | Year applicable to the population figure | number When the population is for a census year, use {{CensusAU}} |
pop_footnotes | population footnote for references | all except protected; use approx for region | ABS (generic) 2016 Census QuickStats |
wikitext (can contain links) Best when used with <ref> </ref> tags and {{Census 2016 AUS}} |
pop2 | 2nd population figure | all except protected; use approx for region | ABS (generic) 2016 Census QuickStats Do not add anything else to this field (years, references etc.) In some articles it may be necessary to provide a second population figure. (see Clarence Town, New South Wales for an example) Use pop2 , pop2_year and pop2_footnotes for the second figure.
|
number. should be plain, either with or without a comma. i.e. 12345 or 12,345 |
pop2_year | 2nd population year | all except protected; use approx for region | Year applicable to the population figure | number When the population is for a census year, use {{CensusAU}} |
pop2_footnotes | population footnote for pop2 references
|
all except protected; use approx for region | ABS (generic) 2016 Census QuickStats |
wikitext (can contain links) Best when used with <ref> </ref> tags and {{Census 2016 AUS}} |
poprank | population rank | city | Used with pop List of cities in Australia by population |
number |
density | population density | city, region | ABS | unformatted number (people/km²) |
density_footnotes | population density footnote for references | city, region | ABS | wikitext (can contain links) Best when used with <ref> </ref> tags and {{cite web}} |
established | established | Date the location was established. If the exact date is unknown, a year will suffice | date | |
established_footnotes | reference(s) for establishment date | wikitext (can contain links) Best when used with <ref> </ref> tags and {{cite web}} | ||
abolished | abolished | Date the location was abolished. If the exact date is unknown, a year will suffice | date | |
gazetted | Date the place name was gazetted | date | ||
postcode | suburb, town | Australia Post postcode search tool | number | |
elevation | measured from sea level in metres | suburb, town | unformatted number (m) | |
elevation_footnotes | elevation footnote for references | suburb, town | wikitext (can contain links) Best when used with <ref> </ref> tags and {{cite web}} | |
area | ABS | unformatted number (km2) | ||
area_footnotes | area footnote for references | ABS | wikitext (can contain links) Best when used with <ref> </ref> tags and {{cite web}} | |
timezone | timezone | city, suburb, town, lga, region | See Time in Australia | plain text, link |
utc | utc offset | city, suburb, town, lga, region | "+" followed by number | |
timezone-dst | summer timezone | city, suburb, town, lga, region | See Time in Australia | plain text, link |
utc-dst | summer utc offset | city, suburb, town, lga, region | "+" followed by number | |
mayor | Mayor of LGA | lga | Name of the mayor only. Do not include titles, postnominals or political party information. | plain text |
mayortitle | Title of the mayor | lga | Wiki text. If omitted (but mayor is provided), defaults to "Mayor". Otherwise likely to be "Lord Mayor", "President" or "Chairman" (etc.). The text can include a link to a list of mayors etc. | |
dist# | See Notes below | city, suburb, town (other cities) | Distance by road, not direct – maps, Google earth, whereis (get directions), Route planner – Victoria, Australia | unformatted number (km) |
dir# | See Notes below | city, suburb, town (other cities) | plain text, normally "N", "S", "E", "W", "NE", "SW", "SSE", "WNW" etc., or "north", "south" (lower case, per ) etc. | |
location# | See Notes below | city, suburb, town | maps, Google earth | plain text, may be wikilinked, automatically links the name |
lga | local government area | city, suburb, town | Name of the local government area NSW Geographical Names Board (NSW only) |
plain text, may be wikilinked, automatically links the name |
lga2-lga5 | 2nd–5th LGAs | city, suburb, town | If more than 5 LGAs are required, use {{plainlist}} as necessary. See Hunter Region for an example. | plain text, link |
seat | LGA seat | lga | plain text, link | |
region | Name of region location is in | city, suburb, town, lga, cadastral, protected | plain text, link | |
county | lands administrative division (not in all areas) | city, suburb, town, lga | Lands administrative divisions of Australia NSW Geographical Names Board (NSW only) |
plain text, link |
parish | NSW, Qld, Vic only | city, suburb, town | Lands administrative divisions of Australia NSW Geographical Names Board (NSW only) |
plain text |
hundred | lands administrative division (not in all areas) | cadastral | plain text, link | |
former_hundred | lands administrative division (not in all areas) | cadastral | plain text, link | |
division | lands administrative division (NSW only) | cadastral | Lands administrative divisions of New South Wales | plain text, link |
stategov | state government electorates | city, suburb, town, lga, region | plain text, link | |
stategov2-stategov5 | 2nd–5th state government electorates | city, suburb, town, lga, region | plain text, link | |
fedgov | federal government electorates | city, suburb, town, lga, region | plain text, link | |
fedgov2-fedgov4 | 2nd–4th federal government electorates | city, suburb, town, lga, region | plain text, link | |
logo | Logo of LGA | lga | Individual LGA website | image link |
logo_upright | width of LGA logo | lga | This is an optional field. If not specified, the image width will default to |upright=0.8 , which is approximately 176px if the default thumbnail size has not been changed at Special:Preferences) See help below for guidance on determining the value to be used.
|
number |
visitation_num | number of visitors | protected | The number of visitors in a recent year if known. | unformatted number, will be formatted automatically |
visitation_year | year of visitation_num
|
protected | The year during which the number of visitors was counted | raw year plain text, do not wikilink |
visitation_footnotes | reference(s) for visitation figure and year | protected | wikitext (can contain links) Best when used with <ref> </ref> tags and {{cite web}} | |
managing_authorities | authority that manages the area | protected | Name of the authority or organisation that manages the area. | wikitext (can contain links). If an unpiped link is to be used, wikilinking may be excluded as an existing article will be wikilinked automatically. |
url | website address | lga, protected | Individual website for the LGA or protected area (Do not use for former LGAs) |
bare url. e.g. http://www.example.com |
maxtemp | max average annual temperature | suburb, town | Bureau of Meteorology | number (°C) |
maxtemp_footnotes | footnote for references | suburb, town | Bureau of Meteorology | wikitext (can contain links) Best when used with <ref> </ref> tags and {{cite web}} |
mintemp | min average annual temperature | suburb, town | Bureau of Meteorology | number (°C) |
mintemp_footnotes | footnote for references | suburb, town | Bureau of Meteorology | wikitext (can contain links) Best when used with <ref> </ref> tags and {{cite web}} |
rainfall | average annual rainfall | suburb, town | Bureau of Meteorology | unformatted number (mm) |
rainfall_footnotes | footnote for references | suburb, town | Bureau of Meteorology | wikitext (can contain links) Best when used with <ref> </ref> tags and {{cite web}} |
near-n/ne/e/se/s/sw/w/nw | neighbours (suburb, lga) | suburb, lga | Only places that share borders with the subject place should be included in these fields. | plain text, link |
near | Central to neighbours | suburb, lga | replaces name (best used without any near-* e.g. to specify a #link to the main text for further info) | plain text, link |
footnotes | general footnotes | Additional footnotes for fields that do not have their own field for footnotes | wikitext (can contain links) Best when used with <ref> </ref> tags. | |
_noautocat | auto categorisation | In a very limited number of cases, the automatic categorisation built into this template may cause anomalies. In such cases, this parameter may be used to prevent automatic categorisation. However, it should only be used when absolutely necessary. When it is used, a hidden note should be included to explain why the parameter is being used in the article. | "yes" to not categorise, or leave blank to categorise |
Notes
ᱥᱟᱯᱲᱟᱣType
ᱥᱟᱯᱲᱟᱣThe infobox type affects the colour of the top bar of the infobox.
Colour[lower-alpha ᱑] | |type=
|
---|---|
Light Goldenrod Yellow | city |
Antique White | suburb |
Snow Flurry (greenish) | town |
Lavender | lga |
Mauve | region |
Light Yellow | cadastral |
No colour | protected |
No colour | "other" |
Very Light Grey | Undefined |
IUCN categories for protected areas
ᱥᱟᱯᱲᱟᱣDepending on the value of the iucn_category
parameter, 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. If you cannot find the correct code in a reliable source, leave blank.
IUCN category Ia (strict nature reserve)
|
IUCN category Ib (wilderness area)
|
IUCN category II (national park)
|
IUCN category III (natural monument or feature)
|
IUCN category IV (habitat/species management area)
|
IUCN category V (protected landscape/seascape)
|
IUCN category VI (protected area with sustainable use of natural resources)
|
Calculating "image_upright"
ᱥᱟᱯᱲᱟᱣThe image_upright
parameter, and image2_upright
and logo_upright
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: 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 fields
ᱥᱟᱯᱲᱟᱣAny references should be placed within the respective "_footnotes" field and not within the field reserved solely for a numeric value. For example, place the reference used for the area of City X in the parameter {{{area_footnotes}}} and not in the {{{area}}} parameter. 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.
Dist#, Dir# and Location#
ᱥᱟᱯᱲᱟᱣThis is the distance and approximate direction from another location. The '#' is replaced with a number between 1 and 5. Therefore, distances for up to five locations can be listed using the range 'dist1' – 'dist5'. Direction from the locations can be specified using 'dir1' – 'dir5' and the locations can be listed as 'location1' – 'location5'. Each dist# must be partnered with an appropriate location#. Dir# is optional.
Where to find information
ᱥᱟᱯᱲᱟᱣ- WikiProject Australian places – Useful resources
- Australian Bureau of Statistics
- LGA links for each state
- Bureau of Meteorology
Tracking categories
ᱥᱟᱯᱲᱟᱣDeprecated fields
ᱥᱟᱯᱲᱟᱣ- Category:Australian place articles using missing parameters (᱐) – articles that include deprecated fields are automatically added. As of 5 April 2016, the tracked parameters are
imagesize
,image2size
,imagesize2
,image_alt2
,logosize
andofficial_site
.
Errors
ᱥᱟᱯᱲᱟᱣ- Category:Australian place articles using missing parameters (᱐) – articles that contain general errors are automatically added.
- Category:Australian place articles with no population year (᱐) – articles missing the
pop_year
orpop2_year
fields are automatically added. - Category:Australian place articles with no population footnotes (᱐) – Articles missing the
pop_footnotes
orpop2_footnotes
fields are automatically added. - Category:Australian place articles with density errors (᱐)
- Category:Pages using infobox Australian place with unknown parameters (᱖) – Articles that include parameters that are not included in the infobox. This category may include articles with incorrectly spelled, but valid parameters.
Temporary
ᱥᱟᱯᱲᱟᱣ- Category:Pages using infobox Australian place with non-lga type and suppressed location map (᱐)
- Category:Pages using infobox Australian place with lga type and location map (᱐)
- Category:Pages using infobox Australian place with an implicitly-suppressed location map (᱐)
- Category:Pages using infobox Australian place with an explicitly-suppressed location map (᱐)
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
Microformat
ᱥᱟᱯᱲᱟᱣThe HTML mark up produced by this template includes an hCard microformat, which makes the place-name and location parsable by computers, either acting automatically to catalogue article 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.
If the place or venue has an "established", "founded", "opened" or similar date, use {{Start date}} (unless the date is before 1583 CE).
If it has a URL, use {{URL}}.
hCard uses HTML classes including:
- adr
- agent
- category
- county-name
- extended-address
- fn
- label
- locality
- nickname
- note
- org
- region
- street-address
- 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.
When giving coordinates, please don't be overly precise.
TemplateData
ᱥᱟᱯᱲᱟᱣTemplateData documentation used by VisualEditor and other tools | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Italic textSee the monthly error report for this template.
TemplateData for Infobox Australian place Display information about a place in Australia in a standard infobox format.
|