Template:Infobox Australian road/doc

Usage

{{Infobox Australian road }} is the standard infobox used in Australian articles. Australian articles using {{Infobox road }} should be converted to use this infobox as it contains additional functionality, including that of {{Infobox street }} and {{Infobox road junction }}. Code exists for implementation of {{Infobox road small }} functionality if that is deemed to be necessary. See this discussion for more information.

To use this template

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

Examples

• Examples of this template can found on the examples page.

Parameters

All parameters used by this template are optional, except for |type=. Some parameters require others to be completed in order to display data correctly. The following are available:

Basic setup parameters:
Parameter Description	Source/notes	Values
type type of road	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"
urban is in urban area?	If the road is wholly contained within an urban area, set |urban=yes.	"yes" or empty
status or 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" Proposed: "proposed" Closed: "closed"
road_name name of road	Primary name used for road	plain text, do not wikilink
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 bulleted list (which will display as a plain list).
state state where the road is located (end_a)	Use the 2 or 3 digit state code corresponding to the location used for direction_a and end_a. It will automatically be converted to the full state name and wikilinked. If the road passes through more than one state, use state2 for the "other end" of the road.	"qld", "nsw", "act", "vic", "tas", "sa", "wa", "nt" or "jbt".
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 direction_b and end_b. It will automatically be converted to the full state name and wikilinked.

Image and map parameters:
Parameter Description	Source/notes	Values
route_image route shield/box	Should only be used on articles about a route itself, not standard highways and roads (further information). For noting routes allocated to a road, use route For promotional logos, use |logo=	{{AUshield}} with |size= set (for shields), or image filename without "File:" (for other images)
logo route logo	Promotional logos can also be used here (subject to copyright considerations), see Majura Parkway as an example of this.	image filename without "File:"
logo_upright width of the route logo image	This is an optional field. If not specified, the image width will default to |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 help below for guidance on determining the value to be used.	number
logo_alt	Alt text for the logo image	wikitext (can contain links)
image generic image of the road		image filename without "File:"
image_upright width of image	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 image caption	a caption for the image	wikitext (can contain links)
image_alt alt text	Alt text for the image
location location map image	a map showing the location of the road. See this example. See 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:"
mapframe show mapframe map?	A mapframe map showing the location of the road will display by default if both location is not set, and the page's Wikidata item has a (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 |mapframe=no	"no" or leave blank
Additional parameters for mapframe map
loc_caption location map caption	a caption for the location map	wikitext (can contain links)
location_alt alt text	Alt text for the location map
map_type controls the location map	set to nomap to suppress any automatically generated location map	nomap, auto, or blank
alternative_location_map 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 use national locator map?	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 use LGA locator map?	Forces the locator map to use the lga map. For this to work, both state and lga must be set, with only one value in each.
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.
coordinates_a end_a road coordinates	Template:UF-coord	Example: {{Coord|32|45|41.3|S|151|44|38.6|E|type:landmark_region:AU-NSW|display=inline}}
coordinates_b end_b road coordinates	Template:UF-coord	Example: {{Coord|32|45|41.3|S|151|44|38.6|E|type:landmark_region:AU-NSW|display=inline}}
pushpin_label_position_a end_a label position	position of the map label for end_a relative to the pushpin	left, right, top, bottom default: left
pushpin_label_position_b end_b label position	position of the map label for end_b relative to the pushpin	left, right, top, bottom default: left
pushpin_map_caption caption	a caption for the locator map	optional, wikitext (can contain links)
map_alt alt text	Alt text for the locator map	wikitext (can contain links)

General information parameters:
Parameter Description	Source/notes	Values
length road length	length of the road in km	unformatted numeric value, will be formatted if length >= 1000.
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
length_ref length reference	reference for the length of the road	properly formatted reference, preferably use {{Cite web }}, {{Cite news }} or other citation template
est date opened	date or year that the road was opened	plain text
closed date closed	date or year that the road was closed
gazetted gazetted date	Date the road was gazetted	date
gazetted_ref gazettal reference	Reference for the road's gazettal	properly formatted reference, preferably use {{Cite web }}, {{Cite news }} or other citation template
built_by construction details	Name of the company or authority that built the road	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 allocation	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 tloop. When this parameter is used, direction_a and direction_b should not be used.	wikitext (can contain links)
tloop tourist loop	The name of the locality that the tourist rad encircles. If ring is defined, it will override this parameter. When this parameter is used, direction_a and direction_b should not be used.

Junction information parameters: (only use with type=junction)
Parameter Description	Source/notes	Values
jtype type of junction	Type of road junction. See Category:Road junction types for examples.	wikitext (can contain links)
height road junction height	height of the road junction in metres	unformatted numeric value, will be formatted if length >= 1000.
height_rnd rounding		single integer numeric value
height_ref height reference	reference for the height of the road junction	properly formatted reference, preferably use {{Cite web }}, {{Cite news }} or other citation template
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 bulleted list (which will display as a plain list).	wikitext (can contain links)

Junction list parameters:
Parameter Description	Source/notes	Values
direction_a road direction	direction of one end of the road. For split roads (see further down), instead use direction_a1, direction_a2 and direction_a3	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.
direction_b road direction	direction of the other end of the road. For split roads (see further down), instead use direction_b1, direction_b2 and direction_b3
end_a road end	location of the end of the road. For split roads, instead use end_a1, end_a2 and end_a3	route shield, wikitext (can contain links)
end_b road end	location of the other end of the road. For split roads, instead use end_b1, end_b2 and end_b3
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
exits exits/interchanges	list of major exits/interchanges. For split roads, instead use exits1, exits2 and exits3 Note: Do not include a note linking to the full list further down the article. Per the Manual of Style for Infoboxes, this is not the purpose of the infobox – the table of contents provides that function.	route shield, wikitext (can contain links)
section1–3 section headings	For split roads with named sections, use section1, section2 and section3 to specify the names for each of up to 3 sections.	wikitext (can contain links)

Location parameters:
Parameter Description	Source/notes	Values
region region(s)	region(s) through which the road passes	route shield, wikitext (can contain links)
lga lga(s)	List of LGA(s) through which the road passes. For multiple LGAs, use a bulleted list (which will display as a plain list).	wikitext (can contain links)
through suburbs/settlements	List of suburbs and other settlements through which the road passes. For multiple locations, use a bulleted list (which will display as a 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)

Highway system parameters:
Parameter Description	Source/notes	Values
show_links show highway links?	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
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 state and state2 parameters. Will have no effect unless the highway links are already shown, either by default or with |show_links=yes	"qld", "nsw", "act", "vic", "tas", "sa", "wa", or "nt".

Restrictions parameters:
Parameter Description	Source/notes	Values
restrictions general restrictions	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)
permit permits required?	If permits are required, include number. Leave blank if not required. Only visible when type=track	plain text
fuel fuel availability	Brief description of fuel availability on the road, only visible when |type=track	wikitext (can contain links)
facilities facilities available	Brief description of facilities on the road, only visible when |type=track

TemplateData

TemplateData documentation used by VisualEditor and other tools

Infobox Australian road An infobox template for Australian road articles. Template parameters Parameter Description Type Status type of road type 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" Suggested values highway road rural road street expressway freeway motorway parkway track junction String required in urban area? urban If the road is wholly contained within an urban area, set to "yes", otherwise leave blank Unknown optional type of junction jtype Type of road junction Unknown optional road status status uc_former Only use when the road is under construction, proposed or has been closed. Allowed values: "uc" or "under construction" or "proposed" or "closed" String optional name of road road_name name Primary name used for road (plain text, do not wikilink) String suggested alternative name road_name2 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. Unknown optional location of the road city Place where the road is located. This should be as detailed as is necessary. For road junctions, this will typically be a suburb. Unknown optional state where the road is located state 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". Suggested values sa vic nsw qld nt wa tas act jbt String suggested state (other end of road) state2 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". Suggested values sa vic nsw qld nt wa tas act jbt String optional route shield/box -- normally not required route_image 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 Unknown optional image of road image generic image of the road. Specify as image filename without "File:" File optional width of image imagesize Width of image in pixels. Optional, generally used for images with portrait orientation. Specify a numeric value less than 300. Number optional image caption caption a caption for the image Unknown optional alt text for image image_alt alt text for the image. See [[MOS:ALT]] for guidance Unknown optional alt text for image alt alt text for image or location map image Unknown deprecated location map image location a map showing the location of the road. Specify an image filename, without "File:" Unknown optional location map caption loc_caption a caption for the location map, generally of the form "Map of (somewhere) with (road name) highlighted in (colour)" Unknown optional alt text for location map location_alt alt text for the location map image. See [[MOS:ALT]] for guidance Unknown optional alternative_location_map alternative_location_map (locator map parameter) Forces the locator map to use an alternative, rather than the state map, regardless of the contents of 'state' parameter. Unknown optional force_national_map force_national_map (locator map parameter) Forces the locator map to use an alternative, rather than the state map, regardless of the contents of 'state' parameter. Unknown optional use_lga_map use_lga_map (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. Unknown optional relief relief (locator map parameter) forces the locator map to use the relief version of the map. Unknown optional end_a coordinates coordinates_a end_a coordinates. Use {{coord}}. Unknown optional end_a label position pushpin_label_position_a position of the map label for end_a relative to the pushpin. allowed values: "left", "right", "top", or "bottom" (defaults to left) Unknown optional end_b coordinates coordinates_b end_b coordinates. Use {{coord}}. Unknown optional end_b label position pushpin_label_position_b position of the map label for end_b relative to the pushpin. allowed values: "left", "right", "top", or "bottom" (defaults to left) Unknown optional locator map caption pushpin_map_caption a caption for the locator map Unknown optional alt text for locator map map_alt alt text for the locator map. See [[MOS:ALT]] for guidance Unknown optional date opened est date or year that the road was opened Unknown suggested date closed closed date or year that the road was closed Unknown optional gazetted date gazetted Date that the road was gazetted Unknown optional gazettal reference gazetted_ref Reference for the road's gazettal Unknown optional construction details built_by Name of the company or authority that built the road Unknown optional maintenance authority maintained Name of the authority that maintains the road Unknown optional brief history history brief, significant notes about the road's history that should be expanded upon in the prose, and not be a replacement for it. Unknown optional road length length Length of the road in km. Specify an unformatted numeric value Number optional length rounding length_rnd Primarily for short roads such as [[Mouat Street]]. Specify a single integer numeric value Number optional length reference length_ref reference for the length of the road. <ref> tags required; an existing reference can be reused Unknown optional road junction height height height of the road junction in metres Unknown optional height rounding height_rnd single integer numeric value Unknown optional height reference height_ref reference for the height of the road junction. <ref> tags required; an existing reference can be reused Unknown optional number of spans spans number of bridge spans at the road junction Number optional roads at the junction roads For a road junction, list of roads at the junction. Use a bulleted list. Unknown optional route number(s) route route marker image (use {{AUshield}}) AND route number as text (can be a wikilink). Use a bulleted list to specify multiple route allocations. Unknown suggested former route information former Information about former route designation, etc. Unknown optional upcoming route information upcoming Information about upcoming route designation, etc. Unknown optional tourist routes tourist a list of the tourist routes that follow the road Unknown optional ring road ring The name of the locality that the ring road encircles. When this parameter is used, direction_a and direction_b should not be used. Unknown optional tourist loop tloop The name of the locality that the tourist road encircles. When this parameter is used, direction_a and direction_b should not be used. Unknown optional direction of one end of road. direction_a direction of one end of the road. Specify a plain text direction, such as "North", "South", "Northwest", etc. Unknown suggested end of road end_a intersecting road and location of the end of the road. Unknown suggested major exits/intersections exits list of major exits/interchanges. Use a bulleted list. Unknown suggested direction of other end of road direction_b direction of the other end of the road. Specify a plain text direction, such as "North", "South", "Northwest", etc. Unknown suggested other end of road end_b intersecting road and location of the other end of the road. Unknown suggested section1 section1 no description Unknown optional split split no description Unknown optional direction_a1 direction_a1 no description Unknown optional end_a1 end_a1 no description Unknown optional exits1 exits1 no description Unknown optional direction_b1 direction_b1 no description Unknown optional end_b1 end_b1 no description Unknown optional direction direction no description Unknown optional section2 section2 no description Unknown optional direction_a2 direction_a2 no description Unknown optional end_a2 end_a2 no description Unknown optional exits2 exits2 no description Unknown optional direction_b2 direction_b2 no description Unknown optional end_b2 end_b2 no description Unknown optional section3 section3 no description Unknown optional direction_a3 direction_a3 no description Unknown optional end_a3 end_a3 no description Unknown optional exits3 exits3 no description Unknown optional direction_b3 direction_b3 no description Unknown optional end_b3 end_b3 no description Unknown optional LGA(s) lga LGA(s) through which the road passes. For multiple LGAs, use a bulleted list. Unknown optional region(s) region region(s) through which the road passes Unknown optional suburbs/settlements through List of suburbs and other settlements through which the road passes. Unknown optional general restrictions restrictions 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. Unknown optional permits required permit If permits are required, include number. Leave blank if not required. Only visible when 'type' parameter is specified as 'track' Unknown optional fuel availability fuel Brief description of fuel availability on the road. Only visible when 'type' parameter is specified as 'track' Unknown optional facilities available facilities Brief description of facilities on the road. Only visible when 'type' parameter is specified as 'track' Unknown optional show highway links? show_links 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) Unknown optional show additional highway link show_links2 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" Unknown optional

Notes

Type

The infobox type affects the colour of the top bar of the infobox.

Colour	|type=
Snow Flurry (greenish)	highway
Light Yellow	road, rural road
Antique White	street
Lavender	expressway, freeway, motorway, parkway
Cape Honey (yellowish)	track
Ghost White	junction
Mauve	Undefined
	|status=, |uc_former=
Grandis	under construction, uc, proposed
Dark Grey	closed

"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 Category:Pages using infobox Australian road with deprecated parameters (0).
• Articles that use unknown parameters (e.g. typos) are automatically added to Category:Pages using infobox Australian road with unknown parameters (0).
• Category:Pages using infobox Australian road with coordinates for only one end point (0)
• Category:Pages using infobox Australian road with an implicitly suppressed location map (0)
• Category:Infobox Australian road articles with an infobox mapframe map (0)

Subpages

• Infobox Australian road
• Infobox Australian road/doc