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.
 * 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:

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 °N, °W." },		"coordinates_b": { "label": "end_b coordinates", "description": "end_b coordinates. Use °N, °W." },		"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 ) 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. 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. 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" ] }

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

"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 and not in the  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.
 * Articles that use unknown parameters (e.g. typos) are automatically added to.