Template:Infobox Australian road/doc

From blackwiki
Jump to navigation Jump to search
See also: Preferred usage guidelines | Blank infobox template page | Documentation page | Discussion page | Examples page

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

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.

TemplateData

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

TemplateData for Infobox Australian road

An infobox template for Australian road articles.

Template parameters

ParameterDescriptionTypeStatus
type of roadtype

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"

Stringrequired
in urban area?urban

If the road is wholly contained within an urban area, set to "yes", otherwise leave blank

Unknownoptional
type of junctionjtype

Type of road junction

Unknownoptional
road statusstatus 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"

Stringoptional
name of roadroad_name name

Primary name used for road (plain text, do not wikilink)

Stringsuggested
alternative nameroad_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.

Unknownoptional
location of the roadcity

Place where the road is located. This should be as detailed as is necessary. For road junctions, this will typically be a suburb.

Unknownoptional
state where the road is locatedstate

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".

Stringsuggested
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".

Stringoptional
route shield/box -- normally not requiredroute_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

Unknownoptional
image of roadimage

generic image of the road. Specify as image filename without "File:"

Unknownoptional
width of imageimagesize

Width of image in pixels. Optional, generally used for images with portrait orientation. Specify a numeric value less than 300.

Numberoptional
image captioncaption

a caption for the image

Unknownoptional
alt text for imageimage_alt

alt text for the image. See [[MOS:ALT]] for guidance

Unknownoptional
alt text for imagealt

alt text for image or location map image

Unknowndeprecated
location map imagelocation

a map showing the location of the road. Specify an image filename, without "File:"

Unknownoptional
location map captionloc_caption

a caption for the location map, generally of the form "Map of (somewhere) with (road name) highlighted in (colour)"

Unknownoptional
alt text for location maplocation_alt

alt text for the location map image. See [[MOS:ALT]] for guidance

Unknownoptional
Alternative_location_mapalternative_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.

Unknownoptional
Force_national_mapforce_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.

Unknownoptional
Use_lga_mapuse_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.

Unknownoptional
Reliefrelief

(locator map parameter) forces the locator map to use the relief version of the map.

Unknownoptional
end_a latitude (degrees)latd_a

degrees component of the end_a latitude

Unknownoptional
end_a latitude (minutes)latm_a

minutes component of the end_a latitude

Unknownoptional
end_a latitude (seconds)lats_a

seconds component of the end_a latitude

Unknownoptional
end_a longitude (degrees)longd_a

degrees component of the end_a longitude

Unknownoptional
end_a longitude (minutes)longm_a

minutes component of the end_a longitude

Unknownoptional
end_a longitude (seconds)longs_a

seconds component of the end_a longitude

Unknownoptional
end_a label positionpushpin_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)

Unknownoptional
Latd_blatd_b

no description

Unknownoptional
Latm_blatm_b

no description

Unknownoptional
Lats_blats_b

no description

Unknownoptional
Longd_blongd_b

no description

Unknownoptional
Longm_blongm_b

no description

Unknownoptional
Longs_blongs_b

no description

Unknownoptional
end_b label positionpushpin_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)

Unknownoptional
Latitudelatitude

no description

Unknownoptional
Longitudelongitude

no description

Unknownoptional
locator map captionpushpin_map_caption

a caption for the locator map

Unknownoptional
alt text for locator mapmap_alt

alt text for the locator map. See [[MOS:ALT]] for guidance

Unknownoptional
road coordinatescoordinates

For coordinates: either at the midpoint, or for both ends of the road. Use {{coord}} with display=inline,title. Please do not be overly precise. If the locator map function is being used, this may be omitted, as the template generates the {{coord}} string from the locator map parameters, in which case this parameter is overridden.

Unknownoptional
Coordinates_displaycoordinates_display

no description

Unknownoptional
date openedest

date or year that the road was opened

Unknownsuggested
date closedclosed

date or year that the road was closed

Unknownoptional
gazetted dategazetted

Date that the road was gazetted

Unknownoptional
gazettal referencegazetted_ref

Reference for the road's gazettal

Unknownoptional
construction detailsbuilt_by

Name of the company or authority that built the road

Unknownoptional
maintenance authoritymaintained

Name of the authority that maintains the road

Unknownoptional
brief historyhistory

brief, significant notes about the road's history that should be expanded upon in the prose, and not be a replacement for it.

Unknownoptional
road lengthlength

Length of the road in km. Specify an unformatted numeric value

Numberoptional
length roundinglength_rnd

Primarily for short roads such as [[Mouat Street]]. Specify a single integer numeric value

Numberoptional
length referencelength_ref

reference for the length of the road. <ref> tags required; an existing reference can be reused

Unknownoptional
road junction heightheight

height of the road junction in metres

Unknownoptional
height roundingheight_rnd

single integer numeric value

Unknownoptional
height referenceheight_ref

reference for the height of the road junction. <ref> tags required; an existing reference can be reused

Unknownoptional
number of spansspans

number of bridge spans at the road junction

Numberoptional
roads at the junctionroads

For a road junction, list of roads at the junction. Use a bulleted list.

Unknownoptional
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.

Unknownsuggested
former route informationformer

Information about former route designation, etc.

Unknownoptional
tourist routestourist

a list of the tourist routes that follow the road

Unknownoptional
ring roadring

The name of the locality that the ring road encircles. When this parameter is used, direction_a and direction_b should not be used.

Unknownoptional
tourist looptloop

The name of the locality that the tourist road encircles. When this parameter is used, direction_a and direction_b should not be used.

Unknownoptional
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.

Unknownsuggested
end of roadend_a

intersecting road and location of the end of the road.

Unknownsuggested
major exits/intersectionsexits

list of major exits/interchanges. Use a bulleted list.

Unknownsuggested
direction of other end of roaddirection_b

direction of the other end of the road. Specify a plain text direction, such as "North", "South", "Northwest", etc.

Unknownsuggested
other end of roadend_b

intersecting road and location of the other end of the road.

Unknownsuggested
Section1section1

no description

Unknownoptional
Splitsplit

no description

Unknownoptional
Direction_a1direction_a1

no description

Unknownoptional
End_a1end_a1

no description

Unknownoptional
Exits1exits1

no description

Unknownoptional
Direction_b1direction_b1

no description

Unknownoptional
End_b1end_b1

no description

Unknownoptional
Directiondirection

no description

Unknownoptional
Section2section2

no description

Unknownoptional
Direction_a2direction_a2

no description

Unknownoptional
End_a2end_a2

no description

Unknownoptional
Exits2exits2

no description

Unknownoptional
Direction_b2direction_b2

no description

Unknownoptional
End_b2end_b2

no description

Unknownoptional
Section3section3

no description

Unknownoptional
Direction_a3direction_a3

no description

Unknownoptional
End_a3end_a3

no description

Unknownoptional
Exits3exits3

no description

Unknownoptional
Direction_b3direction_b3

no description

Unknownoptional
End_b3end_b3

no description

Unknownoptional
LGA(s)lga

LGA(s) through which the road passes. For multiple LGAs, use a bulleted list.

Unknownoptional
region(s)region

region(s) through which the road passes

Unknownoptional
suburbs/settlementsthrough

List of suburbs and other settlements through which the road passes.

Unknownoptional
general restrictionsrestrictions

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.

Unknownoptional
permits requiredpermit

If permits are required, include number. Leave blank if not required. Only visible when 'type' parameter is specified as 'track'

Unknownoptional
fuel availabilityfuel

Brief description of fuel availability on the road. Only visible when 'type' parameter is specified as 'track'

Unknownoptional
facilities availablefacilities

Brief description of facilities on the road. Only visible when 'type' parameter is specified as 'track'

Unknownoptional
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)

Unknownoptional
show additional highway linkshow_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"

Unknownoptional

Notes

Type

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

Colour[lower-alpha 1] |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
  1. Colour names per this site

{{#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

Subpages

Microformat

Template:UF-hcard-geo