Jump to content

Template:Infobox Australian road/doc

Add links
From Inqubos Wiki

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.
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
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
 For coordinates, use {{coord}} with display=inline. Please do not be overly precise.
 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
 For coordinates, use {{coord}} with display=inline. Please do not be overly precise.
 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

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

The HTML markup produced by this template includes an hCard microformat, which makes the place-name and location parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to an address book. Within the hCard is a Geo microformat, which additionally makes the coordinates (latitude & longitude) parsable, so that they can be, say, looked up on a map, or downloaded to a GPS unit. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

If the place or venue has "established", "founded", "opened" or similar dates, use {{start date}} for the earliest of those dates unless the date is before 1583 CE.

If it has a URL, use {{URL}}.

Please do not remove instances of these sub-templates.

Classes

hCard uses HTML classes including:

  • adr
  • agent
  • category
  • county-name
  • extended-address
  • fn
  • label
  • locality
  • nickname
  • note
  • org
  • region
  • street-address
  • uid
  • url
  • vcard

Geo is produced by calling {{coord}}, and uses HTML classes:

  • geo
  • latitude
  • longitude

Please do not rename or remove these classes nor collapse nested elements which use them.

Precision

When giving coordinates, please use an appropriate level of precision. Do not use {{coord}}'s |name= parameter.


Retrieved from "https://wiki.inqubos.com/index.php?title=Template:Infobox_Australian_road/doc&oldid=3113"