Template:Infobox Australian road/sandbox/doc
![]() | This is a documentation subpage for Template:Infobox Australian road/sandbox. It contains usage information, categories and other content that is not part of the original template page. |
![]() | This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |
Usage
{{Infobox Australian road}} is the standard infobox used in Australian articles. Australian articles using {{Infobox road}} should be converted to use this infobox.
To use this template
- Copy the relevant blank template from the Blank template below 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.
- Enter values for the fields as outlined in the 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 examples page.
Blank template
{{Infobox Australian road | type = | uc_former = | road_name = | road_name2 = | state = | state2 = | route_image = | route_image2 = | route_image3 = | route_image4 = | route_image5 = | route_image6 = | route_image7 = | route_image8 = | former = | photo = | photosize = | caption = | photo_alt = | location = | location_alt = | alternative_location_map = | force_national_map = | use_lga_map = | relief = | coordinates = | latd_a = | latm_a = | lats_a = | longd_a = | longm_a = | longs_a = | pushpin_label_position_a = | latd_b = | latm_b = | lats_b = | longd_b = | longm_b = | longs_b = | pushpin_label_position_b = | pushpin_map_caption = | map_alt = | kml = | kml_map = | length = | length_rnd = | length_ref = | direction = | direction_a = | direction_b = | est = | closed = | gazetted = | gazetted_ref = | maintained = | history = | route = | tourist = | ring = | split = | tloop = | end_a = | end_b = | exits = | section1 = | direction_a1 = | end_a1 = | direction_b1 = | end_b1 = | exits1 = | section2 = | direction_a2 = | end_a2 = | direction_b2 = | end_b2 = | exits2 = | section3 = | direction_a3 = | end_a3 = | direction_b3 = | end_b3 = | exits3 = | region = | lga = | through = | restrictions = | permit = | fuel = | facilities = | show_links = }}
Fields
All fields used by this template are optional but some fields require other fields to be completed in order to display data correctly. The following fields are available:
Parameter | Description | Source/notes | Values |
---|---|---|---|
type | type of road | Sets up the template for a specific type of road. Should be left empty when the road is not one of the defined types. | "freeway", "highway", "city highway", "road", "rural road", "street" or "track" |
uc_former | road status | Status of the road for use in limited circumstances. Only use when the road is under construction or has been closed. | Under construction: "uc" or "under construction" 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 {{Plainlist}} |
state | state where the road is located | 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 | 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.
|
"qld", "nsw", "act", "vic", "tas", "sa", "wa", "nt" or "jbt". |
route_image | route shield/box | See here for a list of shields | image filename without "File:" |
route_image2-8 | route shield/box | See here for a list of shields | image filename without "File:" |
former | former route information | Information about former route designation, etc. | route shield, wikitext (can contain links) |
photo | generic image of the road | image filename without "File:" | |
photosize | width of photo | This is an optional field, generally used for images with portrait orientation. If not specified, image width defaults to 270px | numeric value, should not be greater than 300 |
caption | image caption | a caption for the image | wikitext (can contain links) |
photo_alt | alt text | Alt text for the image | wikitext (can contain links) |
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:" |
location_alt | alt text | Alt text for the location map | wikitext (can contain links) |
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 | 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 | 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.
|
"yes" or leave blank, plain text, do not link |
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. | "yes" or leave blank, plain text, do not link |
coordinates | road coordinates | Template:UF-coord 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 field is overridden. |
Example: {{Coord|32|45|41.3|S|151|44|38.6|E|type:landmark_region:AU-NSW|display=inline,title}} |
latd_a latm_a lats_a |
end_a latitude | coordinates field
|
degrees minutes seconds |
longd_a longm_a longs_a |
end_a longitude | coordinates field
|
degrees minutes seconds |
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 |
latd_b latm_b lats_b |
end_b latitude | coordinates field
|
degrees minutes seconds |
longd_b longm_b longs_b |
end_b longitude | coordinates field
|
degrees minutes seconds |
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) |
kml | KML | setting this parameter enables links to the popular web mapping services Google and Bing on articles. When coupled with the content of a KML file produces a route line on those maps. | "yes" or leave blank, plain text, do not link |
kml_map | alternative KML map | enables use of an alternative map file. See Notes section for further information. | Valid KML file name. See Notes section |
length | road length | length of the road in km | unformatted numeric value, will be formatted if length >= 1000. |
length_rnd | rounding | Primarily for short roads such as Mouat Street. | 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 |
direction | road direction (deprecated) |
direction of the road. Deprecated in favour of direction_a and direction_b
|
|
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" etc. |
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
|
plain text, "North", "South", "East", "West" etc. |
est | date established | date or year that the road was established | plain text |
closed | date closed | date or year that the road was closed | plain text |
gazetted | gazetted dat | 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 |
maintained | maintenance authority | Name of the authority that maintains the road | wikitext (can contain links) |
history | route history | brief, significant notes about the road's history that should be expanded upon in the prose, and not be a replacement for it. | wikitext (can contain links) |
route | routes | route allocation | route shield, wikitext (can contain links) |
tourist | tourist routes | a list of the tourist routes that follow the road | route shield, wikitext (can contain links) |
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.
|
wikitext (can contain links) |
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 |
start | road start (deprecated) |
road starting point. Deprecated in favour of end_a
|
|
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) |
finish | road end (deprecated) |
road end point. Deprecated in favour of end_b
|
|
end_b | road end | location of the other end of the road. For split roads, instead use end_b1 , end_b2 and end_b3
|
route shield, wikitext (can contain links) |
exits | route | list of major exits/interchanges. For split roads, instead use exits1 , exits2 and exits3
|
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) |
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 {{Plainlist}} | wikitext (can contain links) |
through | suburbs/settlements | List of suburbs and other settlements through which the road passes. For multiple locations, use {{Plainlist}} | wikitext (can contain links) |
show_links | show highway links? | causes "Highway system" links to be shown at the bottom of the infobox. Should only be set when type = "highway", "city highway" or "freeway", not if type = "road", "rural road", "street" or "track" | "yes" or leave blank, plain text, do not link |
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 | fel 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 | wikitext (can contain links) |
Notes
Type
The infobox type affects the colour of the top bar of the infobox.
- Green: "highway", "city highway"
- Blue: "freeway"
- Yellow: "road", "rural road"
- Pink: "street"
- Orange: "track"
- Grey:
undefined
"Ref" fields
Any references should be placed within the respective "_ref" 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.
KML
Setting |kml=yes
enables the display of links to the popular web mapping services Google and Bing. However, in order for this to function a valid KML page must exist. As KML files cannot currently be uploaded, the text of those files must be copied into a Wikipedia page. By default, the infobox uses a file name with the same title as the article at the location Template:Infobox Australian road/KML/<road name>
e.g. Mouat Street uses Template:Infobox Australian road/KML/Mouat Street. It is possible to use an alternate map by specifying the name of the map to be used in the kml_map
parameter. A list of currently available maps may be found here. More pages are available at Template:Attached KML. These need to be copied to the appropriate subpage for this infobox.
Unformatted numbers and expression errors
Certain fields 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.
Deprecated field tracking
Articles that include deprecated fields are automatically added to Category:Pages using infobox Australian road with deprecated parameters.
Subpages
- Template:Infobox Australian road
- Template:Infobox Australian road/doc
- Template:Infobox Australian road/sandbox
- Template:Infobox Australian road/sandbox/doc
- Template:Infobox Australian road/testcases
List of available KML files