View source for Template:Infobox Australian road/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
<includeonly>{{Shortcut|WP:IARD}}</includeonly>
{{Lua|Module:Infobox|Module:InfoboxImage|Module:String|Module:Check for unknown parameters}}
{{esoteric}}
__NOTOC__
{{Infobox Australian road/pagelinks}}

== Usage ==
{{tl|Infobox Australian road}} is the standard infobox used in Australian articles. Australian articles using {{tl|Infobox road}} should be converted to use this infobox as it contains additional functionality, including that of {{tl|Infobox street}} and {{tl|Infobox road junction}}. Code exists for implementation of {{tl|Infobox road small}} functionality if that is deemed to be necessary. See [[Template talk:Infobox Australian road/Archive 2#Infobox Australian road small|this discussion]] for more information.

=== To use this template ===
#Copy the relevant blank template from the <u>'''[[Template:Infobox Australian road/Blank|Blank infobox template page]]'''</u> 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. For road junctions, use the reduced parameter set at [[Template:Infobox Australian road/Blank#Road junctions]].
# Enter values for the parameters as outlined in the [[Template:Infobox Australian road#Fields|table below]]. Fields left blank will automatically be hidden.
# Preview.
# Save the page with an appropriate edit summary.

=== Examples ===
* Examples of this template can found on the [[Template:Infobox Australian road/Examples|examples page]].

== Parameters ==
All parameters used by this template are optional, except for {{para|type}}. Some parameters require others to be completed in order to display data correctly. The following are available:
{|class="wikitable mw-collapsible" style="width:100%; margin:0;background:#FAFAFA;"
|-
!colspan=3 style="background:#FFFFFF;"|''Basic setup parameters:''
|-
! scope="col" style="background-color: whitesmoke; text-align:left; font-weight:normal; width:15em;" |
;Parameter
:Description
! scope="col" style="background-color: whitesmoke; width:50%" | Source/notes
! scope="col" style="background-color: whitesmoke;" | Values
|-
| scope="row" style="width:15em;" | 
;{{anchor|type}}type
: type of road
| style="width:50%;" | '''Required parameter.''' Sets up the template for a specific type of road or road junction.
| "highway", "road", "rural road", "street", "expressway", "freeway", "motorway", "parkway", "track" or "junction"
|-
| scope="row" |
;urban
: is in urban area?
| If the road is wholly contained within an urban area, set {{para|urban|yes}}.
| "yes" or empty
|-
| scope="row" |
;status <span style="font-weight:normal;">''or''</span>
;uc_former
: road status
| Status of the road for use in limited circumstances. Only use when the road is under construction, proposed or has been closed.
| Under construction: "uc" or "under construction"<br />Proposed: "proposed"<br />Closed: "closed"
|-
| scope="row" |
;road_name
: name of road
| Primary name used for road
| plain text, do not wikilink
|-
| scope="row" |
;road_name2
: alternative name
| Alternative name(s) for road
| plain text, do not wikilink. When there is more than one name, separate them with a solidus ( / ). If there are more than two names, use a [[WP:BULLETLIST|bulleted list]] (which will display as a [[Template:Plainlist|plain list]]).
|-
| scope="row" |
;state
: state where the road is located (end_a)
| Use the 2 or 3 digit state code corresponding to the location used for <code>direction_a</code> and <code>end_a</code>. It will automatically be converted to the full state name and wikilinked. If the road passes through more than one state, use <code>state2</code> for the "other end" of the road.
| rowspan="2" | "qld", "nsw", "act", "vic", "tas", "sa", "wa", "nt" or "jbt". <!-- These are actually case insensitve but let's specify lowercase for consistency and ease of management by automatic means. -->
|-
| scope="row" |
;state2
: state where the road is located (end_b)
| If the road passes through only one state, this parameter will not be used. When it is used, use the 2 or 3 digit state code corresponding to the location used for <code>direction_b</code> and <code>end_b</code>. It will automatically be converted to the full state name and wikilinked.
|}
{|class="wikitable mw-collapsible mw-collapsed" style="width:100%; margin:0; background:#FAF5FF;"
|-
!colspan=3 style="background:#F2E5FF;"|''Image and map parameters:''
|-
! scope="col" style="background-color: whitesmoke; text-align:left; font-weight:normal; width:15em;" |
;Parameter
:Description
! scope="col" style="background-color: whitesmoke; width:50%" | Source/notes
! scope="col" style="background-color: whitesmoke;" | Values
|-
| scope="row" style="width:15em;" |
;route_image
: route shield/box
| style="width:50%;" | {{plainlist|
* Should only be used on articles about a route itself, not standard highways and roads ([[Template:Infobox_Australian_road/Guidelines#Route_shields_section_of_infobox|further information]]).
* For noting routes allocated to a road, use <code>route</code>
* For promotional logos, use {{para|logo}}
}}
| {{tlx|AUshield}} with {{para|size}} set (for shields),<br /> or image filename without "File:" (for other images)
|-
| scope="row" |
;logo
: route logo
| Promotional logos can also be used here (subject to [[WP:NFCC|copyright considerations]]), see [[Majura Parkway]] as an example of this.
| image filename without "File:"
|-
| scope="row" |
;logo_upright
: width of the route logo image
| This is an optional field. If not specified, the image width will default to {{para|upright|0.81}}, which is approximately 180px 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 270px. See [[#Calculating "image_upright"|help below]] for guidance on determining the value to be used.
| number
|-
| scope="row" |
;logo_alt
| [[MOS:ALT|Alt text]] for the logo image
| wikitext (can contain links)
|-
| scope="row" |
;image
: generic image of the road
|
| image filename without "File:"
|-
| scope="row" |
;image_upright
: width of image
| This is an optional field. If not specified, the image width will default to {{para|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 [[#Calculating "image_upright"|help below]] for guidance on determining the value to be used.
| number
|-
| scope="row" |
;caption
: image caption
| a caption for the image
| rowspan="2" | wikitext (can contain links)
|-
| scope="row" |
;image_alt
: alt text
| [[MOS:ALT|Alt text]] for the image
|-
| scope="row" |
;location
: location map image
| a map showing the location of the road. See [[:File:Location Pacific Hwy.svg|this example]]. See ''[[:commons:Category:Highways in Australia|here]]'' for a list of map images. If an image is not available, the locator map function may be used to provide the reader with an indication of the road's general location.
| image filename without "File:"
|-
| scope="row" |
;mapframe
: show mapframe map?
| A [[mw:Maps|mapframe]] map showing the location of the road will display by default if both <code>location</code> is not set, and the page's Wikidata item has a {{Q|P625}} statement. The road itself may be highlighted on the map, depending on whether an appropriate OSM relation both exists and is tagged with the relevant Wikipedia page / Wikidata item (see [[mw:Help:Extension:Kartographer/OSM]] for further details). To turn off the mapframe map, set {{para|mapframe|no}}
| "no" or leave blank
|-
|colspan=3|{{cot|Additional parameters for mapframe map}}
{{Infobox mapframe/doc/parameters
 |mapframe=on if <code>{{!}}location=</code> is not set
 |mapframe-caption=value in <code>{{!}}loc_caption=</code> or blank (or if <code>{{!}}mapframe-geomask=</code> is set, "Location in {{kbd|geomask's label}}")
}}
{{cob}}
|-
| scope="row" |
;loc_caption
: location map caption
| a caption for the location map
| rowspan="2" | wikitext (can contain links)
|-
| scope="row" |
;location_alt
: alt text
| [[MOS:ALT|Alt text]] for the location map
|-
| scope="row" | 
;map_type
: controls the location map
| set to <code>nomap</code> to suppress any automatically generated location map
| nomap, auto, or blank
|-
| scope="row" |
;alternative_location_map
: locator map
| Forces the locator map to use an alternative, rather than the state map, regardless of the contents of <code>state</code>.
| Name of the alternative map
|-
| scope="row" |
;force_national_map
: use national locator map?
| Forces the locator map to use the Australian, rather than the state map, regardless of the contents of <code>state</code>.
| rowspan="3" | "yes" or leave blank, plain text, do not link <!-- Anything in this field will force the Australian map to be used. For consistency though, let's force people to use something simple and obvious. -->
|-
| scope="row" |
;use_lga_map
: use LGA locator map?
| Forces the locator map to use the lga map. For this to work, both <code>state</code> and <code>lga</code> must be set, with only one value in each.
|-
| scope="row" |
;relief
: use relief locator map?
| forces the locator map to use the relief version of the map. For an example of the relief map used in an infobox, see [[Top End]].
|-
| scope="row" |
;coordinates_a
: end_a road coordinates
| {{UF-coord|title=no}}<br />
| Example:<br /><nowiki>{{Coord|32|45|41.3|S</nowiki><wbr><nowiki>|151|44|38.6|E</nowiki><wbr><nowiki>|type:landmark_region:AU-NSW|display=inline}}</nowiki>
|-
| scope="row" |
;coordinates_b
: end_b road coordinates
| {{UF-coord|title=no}}<br />
| Example:<br /><nowiki>{{Coord|32|45|41.3|S</nowiki><wbr><nowiki>|151|44|38.6|E</nowiki><wbr><nowiki>|type:landmark_region:AU-NSW|display=inline}}</nowiki>
|-
| scope="row" |
;pushpin_label_position_a
: end_a label position
| position of the map label for <code>end_a</code> relative to the pushpin
| left, right, top, bottom<br />default: left
|-
| scope="row" |
;pushpin_label_position_b
: end_b label position
| position of the map label for <code>end_b</code> relative to the pushpin
| left, right, top, bottom<br />default: left
|-
| scope="row" |
; pushpin_map_caption
: caption
| a caption for the locator map
| optional, wikitext (can contain links)
|-
| scope="row" |
; map_alt
: alt text
| [[MOS:ALT|Alt text]] for the locator map
| wikitext (can contain links)
|}
{|class="wikitable mw-collapsible mw-collapsed" style="width:100%; margin:0; background:#F5F7FF;"
|-
!colspan=3 style="background:#E5EBFF;"|''General information parameters:''
|-
! scope="col" style="background-color: whitesmoke; text-align:left; font-weight:normal; width:15em;" |
;Parameter
:Description
! scope="col" style="background-color: whitesmoke; width:50%" | Source/notes
! scope="col" style="background-color: whitesmoke;" | Values
|-
| scope="row" style="width:15em;" |
;length
: road length
| style=width:50%;" | length of the road in km
| unformatted numeric value, will be formatted if length >= 1000.
|-
| scope="row" |
;length_rnd
: rounding
| Number of decimal places for round the converted length value. Normally not needed – only use if the default precision is not appropriate
| single integer numeric value
|-
| scope="row" |
;length_ref
: length reference
| reference for the length of the road
| properly formatted reference, preferably use {{tl|cite web}}, {{tl|cite news}} or other citation template
|-
|
;est
: date opened
|date or year that the road was opened
| rowspan="2" |plain text
|-
|
;closed
: date closed
|date or year that the road was closed
|-
|
;gazetted
: gazetted date
|Date the road was [[Gazetteer of Australia|gazetted]]
|date
|-
|
;gazetted_ref
: gazettal reference
|Reference for the road's gazettal
|properly formatted reference, preferably use {{tl|cite web}}, {{tl|cite news}} or other citation template
|-
|
;built_by
: construction details
|Name of the company or authority that built the road
| rowspan="3" |wikitext (can contain links)
|-
|
;maintained
: maintenance authority
|Name of the authority that maintains the road
|-
|
;history
: road history
|brief, significant notes about the road's history that should be expanded upon in the prose, and not be a replacement for it.
|-
|
;route
: routes
|[[Route number#Australia|route allocation]]
| rowspan="3" |route shield, wikitext (can contain links)
|-
|
;former
: former route information
|Information about former route designation, etc.
|-
|
;upcoming
: upcoming route information
|Information about upcoming route designation, etc.
|-
|
;tourist
: tourist routes
|a list of the tourist routes that follow the road
|-
|
;ring
: ring road
|The name of the locality that the [[ring road]] encircles. If this parameter is defined, it will override <code>tloop</code>. When this parameter is used, <code>direction_a</code> and <code>direction_b</code> should not be used.
| rowspan="2" |wikitext (can contain links)
|-
|
;tloop
: tourist loop
|The name of the locality that the tourist rad encircles. If <code>ring</code> is defined, it will override this parameter. When this parameter is used, <code>direction_a</code> and <code>direction_b</code> should not be used.
|}
{|class="wikitable mw-collapsible mw-collapsed" style="width:100%; margin:0; background:#F5FFFF;"
|-
! colspan="3" style="background:#E5FFFF;" |''Junction information parameters:'' (only use with <code>type=junction</code>)
|-
! scope="col" style="background-color: whitesmoke; text-align:left; font-weight:normal; width:15em;" |
;Parameter
:Description
! scope="col" style="background-color: whitesmoke; width:50%" | Source/notes
! scope="col" style="background-color: whitesmoke;" | Values
|-
|style="width:15em;"|
;jtype
: type of junction
|style="width:50%"|Type of road junction. See {{cl|Road junction types}} for examples.
|wikitext (can contain links)
|-
| scope="row" |
;height
: road junction height
| height of the road junction in metres
| unformatted numeric value, will be formatted if length >= 1000.
|-
| scope="row" |
;height_rnd
: rounding
| 
| single integer numeric value
|-
| scope="row" |
;height_ref
: height reference
| reference for the height of the road junction
| properly formatted reference, preferably use {{tl|cite web}}, {{tl|cite news}} or other citation template
|-
| scope="row" |
;spans
: number of spans
| number of bridge spans at the road junction
| number
|-
|
;roads
: roads at the junction
|List of roads at the road junction. Use a [[WP:BULLETLIST|bulleted list]] (which will display as a [[Template:Plainlist|plain list]]).
|wikitext (can contain links)
|}
{|class="wikitable mw-collapsible mw-collapsed" style="width:100%; margin:0; background:#F5FFF8;"
|-
! colspan="3" style="background:#E5FFEC;" |''Junction list parameters:''
|-
! scope="col" style="background-color: whitesmoke; text-align:left; font-weight:normal; width:15em;" |
;Parameter
:Description
! scope="col" style="background-color: whitesmoke; width:50%" | Source/notes
! scope="col" style="background-color: whitesmoke;" | Values
|-
| scope="row" style="width:15em;" |
;direction_a
: road direction
| style="width:50%;" | direction of one end of the road. For split roads (see further down), instead use <code>direction_a1</code>, <code>direction_a2</code> and <code>direction_a3</code>
| rowspan="2" | plain text, "North", "South", "East", "West" or, when the direction is not one of these, use an abbreviated version, "NE", "SSW" etc. See [[Cardinal direction]] for advice.
|-
| scope="row" |
;direction_b
: road direction
| direction of the other end of the road. For split roads (see further down), instead use <code>direction_b1</code>, <code>direction_b2</code> and <code>direction_b3</code>
|-
| scope="row" |
;end_a
: road end
| location of the end of the road. For split roads, instead use <code>end_a1</code>, <code>end_a2</code> and <code>end_a3</code>
| rowspan="2" | route shield, wikitext (can contain links)
|-
| scope="row" |
;end_b
: road end
| location of the other end of the road. For split roads, instead use <code>end_b1</code>, <code>end_b2</code> and <code>end_b3</code>
|-
| scope="row" |
;split
: split road
| If the road is split into named sections, set this to a non-null value. When set, it enables parameters listed further down this list used for the individual sections. up to 3 sections may be specified
| "yes" or leave blank, plain text, do not link <!-- Anything in this field will force the Australian map to be used. For consistency though, let's force people to use something simple and obvious. -->
|-
| scope="row" |
;exits
: exits/interchanges
| list of major exits/interchanges. For split roads, instead use <code>exits1</code>, <code>exits2</code> and <code>exits3</code>

Note: ''Do not'' include a note linking to the full list further down the article. <small>Per the [[Wikipedia:Manual of Style/Infoboxes|Manual of Style for Infoboxes]], this is not the purpose of the infobox – the table of contents provides that function.</small>
| route shield, wikitext (can contain links)
|-
| scope="row" |
;section1–3
: section headings
| For split roads with named sections, use <code>section1</code>, <code>section2</code> and <code>section3</code> to specify the names for each of up to 3 sections.
| wikitext (can contain links)
|}
{|class="wikitable mw-collapsible mw-collapsed" style="width:100%; margin:0; background:#FAFFF5;"
|-
!colspan=3 style="background:#F2FFE5;"|''Location parameters:''
|-
! scope="col" style="background-color: whitesmoke; text-align:left; font-weight:normal; width:15em;" |
;Parameter
:Description
! scope="col" style="background-color: whitesmoke; width:50%" | Source/notes
! scope="col" style="background-color: whitesmoke;" | Values
|-
| scope="row" style="width:15em;" |
;region
: region(s)
| style="width:50%;" | region(s) through which the road passes
| route shield, wikitext (can contain links)
|-
| scope="row" |
;lga
: lga(s)
| List of LGA(s) through which the road passes. For multiple LGAs, use a [[WP:BULLETLIST|bulleted list]] (which will display as a [[Template:Plainlist|plain list]]).
| rowspan="2" | wikitext (can contain links)
|-
| scope="row" |
;through
: suburbs/settlements
| List of suburbs and other settlements through which the road passes. For multiple locations, use a [[WP:BULLETLIST|bulleted list]] (which will display as a [[Template:Plainlist|plain list]]).
|-
|
;city
: location of the road
|Place where the road is located. This should be as detailed as is necessary. For road junctions, this will typically be a suburb.
|wikitext (can contain links)
|}
{|class="wikitable mw-collapsible mw-collapsed" style="width:100%; margin:0; background:#FFFDF5;"
|-
! colspan="3" style="background:#FFF9E5;" |''Highway system parameters:''
|-
! scope="col" style="background-color: whitesmoke; text-align:left; font-weight:normal; width:15em;" |
;Parameter
:Description
! scope="col" style="background-color: whitesmoke; width:50%" | Source/notes
! scope="col" style="background-color: whitesmoke;" | Values
|-
| scope="row" style="width:15em;" |
;show_links
: show highway links?
| style="width:50%;" | causes "Highway system" links to be shown at the bottom of the infobox. Is turned on by default when type = "highway", "expressway", "freeway", "motorway", or "parkway", and is usually not used for the other road types.
| "yes" or "no" or leave blank (for default behaviour), plain text, do not link
|-
| scope="row" |
;show_links2
: show additional highway link
| causes an additional "Highway system" link to be shown for the specified state or territory, in addition to the links automatically determined from the <code>state</code> and <code>state2</code> parameters. Will have no effect unless the highway links are already shown, either by default or with {{para|show_links|yes}}
| "qld", "nsw", "act", "vic", "tas", "sa", "wa", or "nt". <!-- These are actually case insensitve but let's specify lowercase for consistency and ease of management by automatic means. -->
|}
{|class="wikitable mw-collapsible mw-collapsed" style="width:100%; margin:0; background:#FFF5F5;"
|-
!colspan=3 style="background:#FFE5E5;"|''Restrictions parameters:''
|-
! scope="col" style="background-color: whitesmoke; text-align:left; font-weight:normal; width:15em;" |
;Parameter
:Description
! scope="col" style="background-color: whitesmoke; width:50%" | Source/notes
! scope="col" style="background-color: whitesmoke;" | Values
|-
| scope="row" style="width:15em;" |
;restrictions
: general restrictions
| style="width:50%;" | brief, significant notes about any restrictions on the road, such as regular seasonal closures or permit requirements needed for access. Content here should be expanded upon in the prose, and not be a replacement for it.
| wikitext (can contain links)
|-
| scope="row" |
;permit
: permits required?
| If permits are required, include number. Leave blank if not required. Only visible when type=track
| plain text
|-
| scope="row" |
;fuel
: fuel availability
| Brief description of fuel availability on the road, only visible when {{para|type|track}}
| rowspan="2" | wikitext (can contain links)
|-
| scope="row" |
;facilities
: facilities available
| Brief description of facilities on the road, only visible when {{para|type|track}}
|}

== TemplateData ==
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"params": {
		"status": {
			"aliases": [
				"uc_former"
			],
			"label": "road status",
			"description": "Only use when the road is under construction, proposed or has been closed. Allowed values: \"uc\" or \"under construction\" or \"proposed\" or \"closed\"",
			"type": "string"
		},
		"type": {
			"label": "type of road",
			"description": "Sets up the template for a specific type of road or road junction. Allowed values are \"highway\", \"road\", \"rural road\", \"street\", \"expressway\", \"freeway\", \"motorway\", \"parkway\", \"track\" or \"junction\"",
			"type": "string",
			"required": true,
		    "suggestedvalues": [
		        "highway",
        		"road",
		        "rural road",
		        "street",
		        "expressway",
		        "freeway",
		        "motorway",
		        "parkway",
		        "track",
		        "junction"
		    ]
		},
		"road_name": {
			"aliases": [
				"name"
			],
			"label": "name of road",
			"description": "Primary name used for road (plain text, do not wikilink)",
			"type": "string",
			"suggested": true
		},
		"road_name2": {
			"label": "alternative name",
			"description": "Alternative name(s) for road. plain text, do not wikilink. When there is more than one name, separate them with a solidus ( / ). If there are more than two names, use a bulleted list."
		},
		"state": {
			"label": "state where the road is located",
			"description": "Use the 2 or 3 digit state code corresponding to the location used for direction_a and end_a.  If the road passes through more than one state, use the state2 parameter for the \"other end\" of the road. Allowed values: \"qld\", \"nsw\", \"act\", \"vic\", \"tas\", \"sa\", \"wa\", \"nt\" or \"jbt\".",
			"type": "string",
			"suggested": true,
		    "suggestedvalues": [
		        "sa",
        		"vic",
		        "nsw",
		        "qld",
		        "nt",
		        "wa",
		        "tas",
		        "act",
		        "jbt"
		    ]
		},
		"state2": {
			"label": "state (other end of road)",
			"description": "If the road passes through more than one state, use the 2 or 3 digit state code corresponding to the location used for direction_b and end_b. Allowed values: \"qld\", \"nsw\", \"act\", \"vic\", \"tas\", \"sa\", \"wa\", \"nt\" or \"jbt\".",
			"type": "string",
		    "suggestedvalues": [
		        "sa",
        		"vic",
		        "nsw",
		        "qld",
		        "nt",
		        "wa",
		        "tas",
		        "act",
		        "jbt"
		    ]
		},
		"route_image": {
			"label": "route shield/box -- normally not required",
			"description": "ONLY use for articles about a specific route, NOT for articles about named roads! Specify the image filename (without \"File:\") for the specific route's marker image"
		},
		"image": {
			"label": "image of road",
			"description": "generic image of the road. Specify as image filename without \"File:\"",
            "type": "wiki-file-name"
		},
		"imagesize": {
			"label": "width of image",
			"description": "Width of image in pixels. Optional, generally used for images with portrait orientation. Specify a numeric value less than 300.",
			"type": "number"
		},
		"image_alt": {
			"label": "alt text for image",
			"description": "alt text for the image. See [[MOS:ALT]] for guidance"
		},
		"alt": {
			"label": "alt text for image",
			"description": "alt text for image or location map image",
			"deprecated": "use image_alt parameter for images, or location_alt parameter for location map images"
		},
		"caption": {
			"label": "image caption",
			"description": "a caption for the image"
		},
		"location": {
			"label": "location map image",
			"description": "a map showing the location of the road. Specify an image filename, without \"File:\""
		},
		"location_alt": {
			"label": "alt text for location map",
			"description": "alt text for the location map image. See [[MOS:ALT]] for guidance"
		},
		"loc_caption": {
			"label": "location map caption",
			"description": "a caption for the location map, generally of the form \"Map of (somewhere) with (road name) highlighted in (colour)\""
		},
		"coordinates_a": {
			"label": "end_a coordinates",
			"description": "end_a coordinates. Use {{coord}}."
		},
		"coordinates_b": {
			"label": "end_b coordinates",
			"description": "end_b coordinates. Use {{coord}}."
		},
		"alternative_location_map": {
			"description": "(locator map parameter) Forces the locator map to use an alternative, rather than the state map, regardless of the contents of 'state' parameter."
		},
		"force_national_map": {
			"description": "(locator map parameter) Forces the locator map to use an alternative, rather than the state map, regardless of the contents of 'state' parameter."
		},
		"use_lga_map": {
			"description": "(locator map parameter) Forces the locator map to use the lga map. For this to work, both 'state' and 'lga' parameters must be set, with only one value in each."
		},
		"lga": {
			"label": "LGA(s)",
			"description": "LGA(s) through which the road passes. For multiple LGAs, use a bulleted list."
		},
		"relief": {
			"description": "(locator map parameter) forces the locator map to use the relief version of the map."
		},
		"direction_a": {
			"label": "direction of one end of road. ",
			"description": "direction of one end of the road. Specify a plain text direction, such as \"North\", \"South\", \"Northwest\", etc.",
			"suggested": true
		},
		"pushpin_label_position_a": {
			"label": "end_a label position",
			"description": "position of the map label for end_a relative to the pushpin. allowed values: \"left\", \"right\", \"top\", or \"bottom\" (defaults to left)"
		},
		"direction_b": {
			"label": "direction of other end of road",
			"description": "direction of the other end of the road. Specify a plain text direction, such as \"North\", \"South\", \"Northwest\", etc.",
			"suggested": true
		},
		"pushpin_label_position_b": {
			"label": "end_b label position",
			"description": "position of the map label for end_b relative to the pushpin. allowed values: \"left\", \"right\", \"top\", or \"bottom\" (defaults to left)"
		},
		"map_alt": {
			"label": "alt text for locator map",
			"description": "alt text for the locator map. See [[MOS:ALT]] for guidance"
		},
		"pushpin_map_caption": {
			"label": "locator map caption",
			"description": "a caption for the locator map"
		},
		"jtype": {
			"label": "type of junction",
			"description": "Type of road junction"
		},
		"city": {
			"label": "location of the road",
			"description": "Place where the road is located. This should be as detailed as is necessary. For road junctions, this will typically be a suburb."
		},
		"length": {
			"label": "road length",
			"description": "Length of the road in km. Specify an unformatted numeric value",
			"type": "number"
		},
		"height": {
			"label": "road junction height",
			"description": "height of the road junction in metres"
		},
		"direction": {},
		"est": {
			"label": "date opened",
			"description": "date or year that the road was opened",
			"suggested": true
		},
		"closed": {
			"label": "date closed",
			"description": "date or year that the road was closed"
		},
		"gazetted": {
			"label": "gazetted date",
			"description": "Date that the road was gazetted"
		},
		"built_by": {
			"label": "construction details",
			"description": "Name of the company or authority that built the road"
		},
		"maintained": {
			"label": "maintenance authority",
			"description": "Name of the authority that maintains the road"
		},
		"history": {
			"label": "brief history",
			"description": "brief, significant notes about the road's history that should be expanded upon in the prose, and not be a replacement for it."
		},
		"route": {
			"label": "route number(s)",
			"description": "route marker image (use {{AUshield}}) AND route number as text (can be a wikilink). Use a bulleted list to specify multiple route allocations.",
			"suggested": true
		},
		"former": {
			"label": "former route information",
			"description": "Information about former route designation, etc."
        },
		"upcoming": {
			"label": "upcoming route information",
			"description": "Information about upcoming route designation, etc."
		},
		"ring": {
			"label": "ring road",
			"description": "The name of the locality that the ring road encircles. When this parameter is used, direction_a and direction_b should not be used."
		},
		"tloop": {
			"label": "tourist loop",
			"description": "The name of the locality that the tourist road encircles. When this parameter is used, direction_a and direction_b should not be used."
		},
		"tourist": {
			"label": "tourist routes",
			"description": "a list of the tourist routes that follow the road"
		},
		"split": {},
		"length_rnd": {
			"label": "length rounding",
			"description": "Primarily for short roads such as [[Mouat Street]]. Specify a single integer numeric value",
			"type": "number"
		},
		"length_ref": {
			"label": "length reference",
			"description": "reference for the length of the road. <ref> tags required; an existing reference can be reused"
		},
		"height_rnd": {
			"label": "height rounding",
			"description": "single integer numeric value"
		},
		"height_ref": {
			"label": "height reference",
			"description": "reference for the height of the road junction. <ref> tags required; an existing reference can be reused"
		},
		"spans": {
			"label": "number of spans",
			"description": "number of bridge spans at the road junction",
			"type": "number"
		},
		"gazetted_ref": {
			"label": "gazettal reference",
			"description": "Reference for the road's gazettal"
		},
		"roads": {
			"label": "roads at the junction",
			"description": "For a road junction, list of roads at the junction. Use a bulleted list."
		},
		"section1": {},
		"section2": {},
		"section3": {},
		"end_a": {
			"label": "end of road",
			"description": "intersecting road and location of the end of the road.",
			"suggested": true
		},
		"exits": {
			"label": "major exits/intersections",
			"description": "list of major exits/interchanges. Use a bulleted list.",
			"suggested": true
		},
		"end_b": {
			"label": "other end of road",
			"description": "intersecting road and location of the other end of the road.",
			"suggested": true
		},
		"direction_a1": {},
		"end_a1": {},
		"exits1": {},
		"direction_b1": {},
		"end_b1": {},
		"direction_a2": {},
		"end_a2": {},
		"exits2": {},
		"direction_b2": {},
		"end_b2": {},
		"direction_a3": {},
		"end_a3": {},
		"exits3": {},
		"direction_b3": {},
		"end_b3": {},
		"region": {
			"label": "region(s)",
			"description": "region(s) through which the road passes"
		},
		"through": {
			"label": "suburbs/settlements",
			"description": "List of suburbs and other settlements through which the road passes."
		},
		"urban": {
			"label": "in urban area?",
			"description": "If the road is wholly contained within an urban area, set to \"yes\", otherwise leave blank"
		},
		"restrictions": {
			"label": "general restrictions",
			"description": "brief, significant notes about any restrictions on the road, such as regular seasonal closures or permit requirements needed for access. Content here should be expanded upon in the prose, and not be a replacement for it."
		},
		"permit": {
			"label": "permits required",
			"description": "If permits are required, include number. Leave blank if not required. Only visible when 'type' parameter is specified as 'track'"
		},
		"fuel": {
			"label": "fuel availability",
			"description": "Brief description of fuel availability on the road. Only visible when 'type' parameter is specified as 'track'"
		},
		"facilities": {
			"label": "facilities available",
			"description": "Brief description of facilities on the road. Only visible when 'type' parameter is specified as 'track'"
		},
		"show_links": {
			"label": "show highway links?",
			"description": "causes \"Highway system\" links to be shown at the bottom of the infobox. Is turned on by default when type = \"highway\", \"expressway\", \"freeway\", \"motorway\", or \"parkway\", and is usually not used for the other road types. Specify \"yes\" or \"no\" or leave blank (for default behaviour)"
		},
		"show_links2": {
			"label": "show additional highway link",
			"description": "causes an additional \"Highway system\" link to be shown for the specified state or territory, in addition to the links automatically determined from the 'state' and 'state2' parameters. Will have no effect unless the highway links are already shown, either by default or by setting 'show_links' parameter to 'yes'. Allowed values: \"qld\", \"nsw\", \"act\", \"vic\", \"tas\", \"sa\", \"wa\", or \"nt\""
		}
	},
	"description": "An infobox template for Australian road articles.",
	"paramOrder": [
		"type",
		"urban",
		"jtype",
		"status",
		"road_name",
		"road_name2",
		"city",
		"state",
		"state2",
		"route_image",
		"image",
		"imagesize",
		"caption",
		"image_alt",
		"alt",
		"location",
		"loc_caption",
		"location_alt",
		"alternative_location_map",
		"force_national_map",
		"use_lga_map",
		"relief",
		"coordinates_a",
		"pushpin_label_position_a",
		"coordinates_b",
		"pushpin_label_position_b",
		"pushpin_map_caption",
		"map_alt",
		"est",
		"closed",
		"gazetted",
		"gazetted_ref",
		"built_by",
		"maintained",
		"history",
		"length",
		"length_rnd",
		"length_ref",
		"height",
		"height_rnd",
		"height_ref",
		"spans",
		"roads",
		"route",
		"former",
        "upcoming",
		"tourist",
		"ring",
		"tloop",
		"direction_a",
		"end_a",
		"exits",
		"direction_b",
		"end_b",
		"section1",
		"split",
		"direction_a1",
		"end_a1",
		"exits1",
		"direction_b1",
		"end_b1",
		"direction",
		"section2",
		"direction_a2",
		"end_a2",
		"exits2",
		"direction_b2",
		"end_b2",
		"section3",
		"direction_a3",
		"end_a3",
		"exits3",
		"direction_b3",
		"end_b3",
		"lga",
		"region",
		"through",
		"restrictions",
		"permit",
		"fuel",
		"facilities",
		"show_links",
		"show_links2"
	]
}
</templatedata>
{{Collapse bottom}}

== Notes ==
=== Type ===
The infobox type affects the colour of the top bar of the infobox.
{| class="wikitable plainrowheaders"  style="text-align:center; width:43%;"
|-
! scope="col" style="padding:0 8px; width:15%;" | Colour<ref group=lower-alpha name=colour>Colour names per [http://www.color-blindness.com/color-name-hue this site]</ref>
! scope="col" style="padding:0 8px; width:28%;" | {{para|type}}
|-
| scope="row" style="background:#e9f9d2; color:#100;" | Snow Flurry (greenish)
| highway
|-
| scope="row" style="background:#ffffe0; color:#100;" | Light Yellow
| road, rural road
|-.
| scope="row" style="background:#f9e2d2; color:#100;" | Antique White
| street
|-
| scope="row" style="background:#d2d5f9; color:#100;" | Lavender
| expressway, freeway, motorway, parkway
|-
| scope="row" style="background:#fee8ab; color:#100;" | Cape Honey (yellowish)
| track
|-
| scope="row" style="background:#f0f0ff; color:#100;" | Ghost White
| junction
|-
| scope="row" style="background:#e6c4fb; color:#100;" | Mauve
| Undefined
|-
! scope="col" style="padding:0 8px; width:19%;" | 
! scope="col" style="padding:0 8px; width:7%;" | {{para|status}}, {{para|uc_former}}
|-
| scope="row" style="background:#fc6; color:#100;" width=10px | Grandis
| under construction, uc, proposed
|-
| scope="row" style="background:#aaa; color:#100;" width=10px | Dark Grey
| closed
|}
{{reflist|group=lower-alpha}}
{{#section:Template:Infobox Australian place/doc|image_upright}}
=== "Ref" fields ===
Any references should be placed within the respective "_ref" parameter's field and not within the field reserved solely for a numeric value.  For example, place the reference used for the length of the road in the {{{length_ref}}} and not in the {{{length}}} 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.

== Tracking categories ==
*Articles that include deprecated parameters are automatically added to {{clc|Pages using infobox Australian road with deprecated parameters}}.
*Articles that use unknown parameters (e.g. typos) are automatically added to {{clc|Pages using infobox Australian road with unknown parameters}}.
*{{clc|Pages using infobox Australian road with coordinates for only one end point}}
*{{clc|Pages using infobox Australian road with an implicitly suppressed location map}}
*{{clc|Infobox Australian road articles with an infobox mapframe map}}

== Subpages ==
<!-- * [[Template:Infobox Australian road]]
* [[Template:Infobox Australian road/doc]]
* [[Template:Infobox Australian road/pagelinks]]
* [[Template:Infobox Australian road/sandbox]]
* [[Template:Infobox Australian road/sandbox/doc]]
* [[Template:Infobox Australian road/testcases]]
* [[Template:Infobox Australian road/Testing]]
-->
{{Special:PrefixIndex/Template:Infobox Australian road}}

== Microformat ==
{{UF-hcard-geo}}

{{Reflist}}

<includeonly>{{Sandbox other|
| <!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Highway infobox templates by country|Australian road]]
[[Category:Australia place infobox templates|road]]
[[Category:Templates that add a tracking category]]

}}</includeonly>