Template:Infobox road/doc

Usage
This template generates an infobox for roads, both numbered and unnumbered. Below is the basic syntax needed to get a complete infobox for an article. Place this below any hatnotes and before any other text and fill in the variables. If a variable is empty, it should be omitted. Other, more specific, parameters exist and are described in detail below.

Numbered roads
This is the basic code needed to set up an infobox for a numbered route.



Unnumbered roads
This is the basic code needed to set up an infobox for an unnumbered route. See also infobox street.



Numbered roads
These parameters are typically used only for numbered routes.
 * country: the ISO 3166-1 alpha-3 code of the country that the route is in (not to be confused with the countries location parameter). Use this list to find the correct code for the country. These countries have had the necessary subtemplates set up; see that page for instructions on how to set up new countries. If the route is located in Australia, the United States, Canada, or Mexico, and the route is located within one state or province use state (Australia, US, and Mexico) or province (Canada) instead (not to confused with the states and provinces location parameters). The "state" and "province" parameters are not interchangeable. Accepted values for these two parameters are as follows:
 * Australian state: the two- or three-letter abbreviation of the state. Note:  must also be set if the state is NT or WA to avoid conflicts with other countries.
 * U.S. state: the two-letter postal abbreviation of the state.
 * Canadian province: the two-letter postal abbreviation of the province.
 * Mexican state: the three-letter ISO 3166-2:MX code of the state, minus the "MX-" prefix.
 * type: the type of route the article is about. See this page for a list.
 * subtype: the type of special route that the article route is, if applicable
 * county: the county associated with the route that the article is about (not to be confused with the counties location parameter). Use only for county routes.
 * route: the number of the route.
 * section: the section of code that defines this route. Very few areas use this, and the appropriate subpage ( /law/USA for example) must be set up for the parameter to work. The state of Minnesota also uses subsection to specify the exact section of the legal code definition.
 * spur_type: defines the type of route that the route is a spur of. Use for spur routes, such as a loop road, bypass, alternate route, business route, truck route, or other type of route. Example: Use WV for West Virginia Route 10 Alternate.
 * spur_of: defines what the parent route is, such as Highway 7A's parent is Highway 7, or Interstate 110's parent is Interstate 10. The usual text that would go here is the road number, such as "7" or "10" or "500".
 * previous_type: this is the type of route that proceeds the current one in the system. See this page for a list.
 * previous_route: the number of the route preceding this one
 * previous_dab: any disambiguation needed to generate the correct link to the previous route
 * browse_route: the route associated with the current browse row. Typically used only if the browsing route is not the route that the rest of the infobox is about.
 * next_type: same as "previous_type" but for the route following this one
 * next_route: the number of the route succeeding this one
 * next_dab: same as "previous_dab" but for the route following this one
 * browse: use to add additional browse lines, which are generated by templates similar to ny browse. These templates accept the seven parameters given above plus "county"; however, "route" is used instead of "browse_route".

Historical roads
These parameters are typically used only for roads of a historic nature, such as the Silk Road.
 * time_period: the time period that the road existed in.
 * established_by: the body that built or established the road. Used only in conjunction with "time_period".
 * significance: the historical/cultural significance of the route. Used only in conjunction with "time_period".
 * related: roads related to the historical road. Used only in conjunction with "time_period".
 * margary: the Margary number of a Roman road in Britain.

Route information

 * marker_image: shield image to be displayed. Requires full wiki markup. Typically not needed for numbered routes. Can be set to 'none' to show no marker
 * name: road name to be displayed. Typically not needed for numbered routes.
 * maint: the agency that maintains the highway. If the appropriate subpage ( /maint/USA for example) exists and a specific jurisdiction is specified (such as "state=AZ"), this parameter will be filled in automatically with that jurisdiction's department of transportation. "maint" still works, however, if the default agency needs to be overwritten, for instance if the route is maintained by another agency.
 * alternate_name: Use in situations where the entire route has another name. For example, New York State Route 590 is called the Sea Breeze Expressway for its entire length.
 * map: image name of a map for the route, without the  namespace prefix, which the template will place into an image link for you. For example,   will render as:  . Note: this will pull the file name from Wikidata if left empty and the associated item has the information.
 * map_alt: alt text for the map, for visually impaired readers. See WP:ALT. This parameter should be specified if map is specified.
 * map_notes: an optional parameter with text to display along with the map.
 * map_custom: optionally set to yes if you want to override the template's default image link; then you may specify your own complete image link with:
 * For best results, your map image width should be 290px.
 * See the WP:USRD maps task force for maps for roads in the United States.
 * photo or image: image name of a photo for the route, without the  namespace prefix, which the template will place into an image link for you. For example,   will render as:.
 * photo_width or image_width: sets the width in pixels of non-map images. Default value is 290.
 * photo_alt or image_alt: alt text for the photo, for visually impaired readers. See WP:ALT. This parameter should be specified if photo is specified.
 * photo_notes or image_notes: an optional parameter with text to display along with the photo.
 * This set of parameters will not work for articles in the United States per WP:USRD consensus.
 * length_mi or length_km: length of the route in miles (in countries where the imperial system is used) or kilometres (in countries where the metric system is used). Only one can be used in an article. The value from the one defined is the one that appears first. The other is calculated and rounded to the same level of precision as the stated value. If neither "length_mi" nor "length_km" exists, no length is displayed.
 * length_ref, if defined, appears after the first length. Use a citation for the length (wrapped in  tags) or fact here. Be sure that the first length is the one for which you have a reference.
 * length_notes, if defined, appears as a note below the length. This can be used to show former length, or future length, etc.
 * status: the status of cancelled or under construction roadways; this will not show unless the infobox uses header_type with historic, former or under construction values (or their alternates).
 * established: this is the date or year in which the route was commissioned or assigned to its current alignment. (Alternate parameter: formed)
 * decommissioned: the date or year the route was decommissioned (Alternate parameter: deleted)
 * history: a brief summary of the route's history. Typically used in place of the above two parameters.
 * known_for: if defined, prints any notable landmarks on the road with an independent article; eg: Stonehenge, Angel of the North
 * allocation: a list of highway designations allocated to the roadway. For Australia, this uses a label of "Allocation:" while for other countries it will use "Component highways:" instead.
 * tourist: a list of the tourist routes that follow the route; currently only set up for use in Australia, New Zealand, Canada, and the US.
 * restrictions: a brief mention of any restrictions on the road. Examples include regular seasonal closures or permit requirements needed by motorists.

Major intersections

 * beltway_city, orbital, loop, or tloop: for beltways, orbitals, loop roads, or tourist loops only. This is the city that the beltway/orbital/loop encircles. The output differs  between the three to accommodate variation in English for different geographic areas. In the case of tourist loops, using none will omit a location around which the roadway would loop.
 * direction_a: for U.S. roads, this should be either "South" or "West" per the standards set by the U.S. Roads project. For roads in other jurisdictions, consult that area's WikiProject to determine which direction to put here.
 * terminus_a or end_a: this is where the route begins and, for U.S. roads, is either at the southern terminus or western terminus
 * junction: a list of major junctions. Each WikiProject has different standards for major junctions, so consult the relevant WikiProject for more details. Uses plainlist class so is not necessary; only a bulleted list is needed.
 * direction_b: The opposite of "direction_a"
 * terminus_b or end_b: where the route ends, in accordance with the guidelines set forth with terminus_a

This template is capable of creating separate "major intersection" sections for individual segments of a route that is split into two to four segments. The parameters associated with this feature are:
 * section#, where # is the number of the segment (1 being the first entered into the infobox, 2 being the next, and so on). By default, the text "Major intersections" is replaced in the header with "Section #"; this parameter allows for a custom header to be used.
 * length_mi# or length_km#: "length_mi" or "length_km" for the # segment
 * length_ref#: "length_ref" for the # segment
 * length_notes#: "length_notes" for the # segment
 * direction_a: same as described above; however, in this usage it will provide a default direction for the beginning point of all of the segments. If the direction of one endpoint is different, use direction_a# for that endpoint.
 * terminus_a# or end_a#: "terminus_a"/"end_a" for the # segment
 * junction#: "junction" for the # segment
 * direction_b: same as described above; however, in this usage it will provide a default direction for the ending point of all of the segments. If the direction of one endpoint is different, use direction_b# for that endpoint.
 * terminus_b# or end_b#: for the # segment

Location
This infobox has several parameters to list locations; however, many are restricted to use in only certain regions or countries for various reasons, including but not limited to local WikiProject consensus and common sense (for example, "countries" shouldn't be used on intra-country articles, and since the only locations with rural municipalities are Manitoba and Saskatchewan, "rural_municipalities" should be used there and nowhere else). Updates in 2022 added many new parameters for describing locations and made them available to more locations. Even where usage is possible, each parameter is still optional on an article-by-article basis based on local consensus.

Other parameters

 * header_type: IBR has a small set of alternate header shades for specific sets of articles. They are:
 * under construction: for roads where construction has begun on the highway and no sections have been opened to traffic. Do not use for roads that are open to traffic in some capacity. (Alternate values: const, uc)
 * historic: for roads of a historic nature, such as auto trails or highways posted with brown, historical or scenic signage. (Alternate values: historical, hist, scenic)
 * former: for highway designations no longer maintained by the corresponding government authority. (Alternate value: decommissioned)
 * minor: UK only. For A roads signed with black-on-white markers.
 * system: the highway system that the article route is part of. Typically not needed for numbered routes.
 * system#, where # is the number of the next additional highway system to be displayed (1 being the first entered into the infobox, 2 being the next, and so on).
 * e-road, ahn, tahn or mrn: used to indicate that a roadway is part of the International E-road network in Europe, the Asian Highway Network, the Trans-African Highway network or the Arab Mashreq International Road Network.
 * e-road-shield, ahn-shield, tahn-shield or mrn-shield: shield or route marker image for the E-road, AHN, TAHN or MRN route. Requires full wiki markup.
 * embedded: embed another infobox with such capability like Designation list and Infobox NRHP.

Example



 * Example references

TemplateData
{	"description": "An infobox template for highway articles. ", "params": { "country": { "label": "Country", "type": "string", "description": "The ISO 3166-1 alpha-3 code of the country the route is in." },		"state": { "label": "State", "type": "string", "description": "The two to three letter abbreviation of the Australian, U.S., or Mexican state the route is in." },		"province": { "label": "Province", "type": "string", "description": "The two letter postal abbreviation of the Canadian province the route is in." },		"type": { "label": "Type", "type": "string", "description": "The type code of the route from Template:Infobox_road/doc/type." },		"route": { "label": "Route number", "type": "string", "description": "The number of the route." },		"marker_image": { "label": "Marker image", "type": "content", "description": "Marker image or shield to be displayed. Use full wiki markup. Not needed for numbered routes, usually." },		"name": { "label": "Name", "type": "string", "description": "The name of the road (not used for numbered routes)." },		"alternate_name": { "label": "Alternate name", "type": "string", "description": "The alternate name of the road. Use only when the entire route has that name." },		"maint": { "label": "Maintenance", "type": "string", "description": "The agency that maintains the road. Numbered routes have this automatically populated." },		"map": { "label": "Map", "type": "string", "description": "The file name of the map of the road, without File:. If this is blank and the map is available on Wikidata, it will be used." },		"map_alt": { "label": "Map alternate text", "type": "string", "description": "The alternate text for the map, for visually impaired readers." },		"map_notes": { "label": "Map notes", "type": "string", "description": "Text to display with the map." },		"photo": { "label": "Photo", "type": "wiki-file-name", "description": "A photo to display, without File:. Does not work in the US.", "aliases": [ "image" ]		},		"photo_alt": { "label": "Photo alternate text", "type": "string", "description": "The alternate text for the photo, for visually impaired readers.", "aliases": [ "image_alt" ]		},		"photo_notes": { "label": "Photo notes", "type": "string", "description": "Text to display with the map.", "aliases": [ "image_notes" ]		},		"map_custom": { "label": "Map custom", "type": "string", "description": "Use yes if you want to override the template's default image link; then use the Map parameter to specify a link instead." },		"length_mi": { "label": "Length in miles", "type": "number", "description": "If and only if the route is in a country on the imperial system, list the length in miles here." },		"length_km": { "label": "Length in kilometres", "type": "number", "description": "If and only if the route is in a country on the metric system, list the length in kilometres here." },		"length_ref": { "label": "Length reference", "type": "string", "description": "A reference for the given length." },		"length_notes": { "label": "Length notes", "type": "string", "description": "Notes for the length." },		"established": { "label": "Established", "type": "string", "description": "Date the route was commissioned.", "aliases": [ "formed" ]		},		"decommissioned": { "label": "Decommissioned", "type": "string", "description": "Date the route was decommissioned.", "aliases": [ "deleted" ]		},		"history": { "label": "History", "type": "content", "description": "Summary of the route's history, instead of the established and decommissioned fields." },		"allocation": { "label": "Allocation", "type": "string", "description": "Highway designations allocated to the roadway." },		"tourist": { "label": "Tourist routes", "type": "string", "description": "Tourist routes that follow the route (Australia, New Zealand, Canada, US)." },		"restrictions": { "label": "Restrictions", "type": "string", "description": "Summary of the route's restrictions such as closures or permits." },		"direction_a": { "label": "Direction A", "type": "string", "description": "The first direction." },		"direction_b": { "label": "Direction B", "type": "string", "description": "The second direction." },		"terminus_a": { "label": "Terminus A", "type": "string", "description": "The first terminus.", "aliases": [ "end_a" ]		},		"terminus_b": { "label": "Terminus B", "type": "string", "description": "The second terminus.", "aliases": [ "end_b" ]		},		"junctions": { "label": "Major junctions", "type": "string", "description": "A brief list of major junctions. In the US, do not use more than 10.", "aliases": [ "junction" ]		},		"beltway_city": { "label": "Beltway city", "type": "string", "description": "The city the beltway encircles." },		"orbital": { "label": "Orbital city", "type": "string", "description": "The city the orbital encircles." },		"loop": { "label": "Loop road city", "type": "string", "description": "The city the loop road encircles." },		"tloop": { "label": "Tourist loop city", "type": "string", "description": "The city the tourist loop encircles." },		"time_period": { "label": "Time period", "type": "string", "description": "The time period the road existed in." },		"established_by": { "label": "Established by", "type": "string", "description": "If a time period is used, the body that built or established the road." },		"significance": { "label": "Significance", "type": "string", "description": "If a time period is used, the historical/cultural significance of the route." },		"related": { "label": "Related roads", "type": "string", "description": "If a time period is used, roads related to the historical road." },		"subtype": { "label": "Subtype", "type": "string", "description": "If the route is a spur or a special route." },		"spur_type": { "label": "Spur type", "type": "string", "description": "The type of the parent route that this is a spur of." },		"spur_of": { "label": "Spur of", "type": "string", "description": "The parent route of this spur route." },		"county": { "label": "County (for county routes)", "type": "string", "description": "The county associated with the route that the article is about. Use only for county routes." },		"previous_type": { "label": "Previous route type", "type": "string", "description": "The type code of the previous route in the system from Template:Infobox_road/doc/type." },		"next_type": { "label": "Next route type", "type": "string", "description": "The type code of the next route in the system from Template:Infobox_road/doc/type." },		"previous_route": { "label": "Previous route", "type": "string", "description": "The number of the previous route in the system." },		"next_route": { "label": "Next route", "type": "string", "description": "The number of the next route in the system." },		"previous_dab": { "label": "Previous route disambiguation", "type": "string", "description": "The disambiguation suffix of the previous route in the system." },		"next_dab": { "label": "Next route disambiguation", "type": "string", "description": "The disambiguation suffix of the next route in the system." },		"browse_route": { "label": "Browse route", "type": "string", "description": "The number of the current route in the system, if not the same as the rest of the infobox." },		"browse": { "label": "Additional browse lines", "type": "string", "description": "Use to add additional browse lines with additional templates" },		"countries": { "label": "List of countries", "type": "string", "description": "A list of countries the route enters (EUR, ASIA)" },		"regions": { "label": "List of regions", "type": "string", "description": "A list of regions the route enters (EUR, ITA, HRV, CZE, CYP, GRC, POL, HUN, SVN, SVK, AUT, TUR, UKR, BIH, SRB, SGP)" },		"states": { "label": "List of states", "type": "string", "description": "A list of states the route enters (USA in multiple states, IND, DEU)" },		"provinces": { "label": "List of provinces", "type": "string", "description": "A list of provinces the route enters (IRN, TUR, THA)" },		"counties": { "label": "List of counties", "type": "string", "description": "A list of counties the route enters (anywhere)" },		"parishes": { "label": "List of parishes", "type": "string", "description": "A list of parishes the route enters (Louisiana)" },		"rural_municipalities": { "label": "List of rural municipalities", "type": "string", "description": "A list of countries the route enters (Manitoba, Saskatchewan)" },		"municipalities": { "label": "List of municipalities", "type": "string", "description": "A list of municipalities the route enters (Puerto Rico)" },		"districts": { "label": "List of districts", "type": "string", "description": "A list of districts the route enters (India, other countries with districts)" },		"boroughs": { "label": "List of boroughs", "type": "string", "description": "A list of boroughs the route enters (Alaska)", "aliases": [ "borough" ]		},		"divisions": { "label": "List of divisions", "type": "string", "description": "A list of divisions the route enters (Ontario)" },		"cities": { "label": "List of cities", "type": "string", "description": "A list of cities the route enters (everywhere but USA)" },		"towns": { "label": "List of towns", "type": "string", "description": "A list of towns the route enters (everywhere but USA)" },		"villages": { "label": "List of villages", "type": "string", "description": "A list of villages the route enters (everywhere but USA)" },		"destinations": { "label": "List of destinations", "type": "string", "description": "A list of primary destinations the route enters (AUS, GBR, IRL, MYS, NZL, IND)" },		"lga": { "label": "List of LGAs", "type": "string", "description": "A list of LGAs the route enters (Australia)" },		"locations": { "label": "List of locations", "type": "string", "description": "A list of locations the route enters (Australia)" },		"section": { "label": "Section of code", "type": "string", "description": "The section of the highway code the route is defined in." },		"subsection": { "label": "Subsection of code", "type": "string", "description": "The subsection of the highway code the route is defined in (for Minnesota only)." },		"header_type": { "label": "Header type", "type": "string", "description": "under construction, historic, former, freeway (Canada only), minor (UK only)" },		"system": { "label": "Highway system", "type": "string", "description": "The highway system the article route is a part of. Typically not used for numbered routes." },		"e-road": { "label": "E-road", "type": "string", "description": "The E-road that the route is a part of (Europe)." },		"e-road-shield": { "label": "E-road route marker image", "type": "string", "description": "Route marker image for the E-road that the route is a part of (Europe). Requires full wiki markup." },		"ahn": { "label": "Asian Highway Network designation", "type": "string", "description": "The Asian Highway that the route is a part of." },		"ahn-shield": { "label": "Asian Highway route marker image", "type": "string", "description": "Route marker image for the Asian Highway that the route is a part of. Requires full wiki markup." },		"tahn": { "label": "Trans-African Highway designation", "type": "string", "description": "The Trans-African Highway that the route is a part of." },		"tahn-shield": { "label": "Trans-African Highway route marker image", "type": "string", "description": "Route marker image for the Trans-African Highway that the route is a part of. Requires full wiki markup." },		"section1": { "label": "Header for section 1", "type": "string", "default": "Section 1", "description": "If the route is divided into sections, this is the header for section 1." },		"length_mi1": { "label": "Section 1 length in miles", "type": "number", "description": "If and only if the route is in a country on the imperial system, list the length in miles on section 1 here." },		"length_km1": { "label": "Section 1 length in kilometres", "type": "number", "description": "If and only if the route is in a country on the metric system, list the length in kilometres on section 1 here." },		"length_ref1": { "label": "Length reference for section 1", "type": "string", "description": "A reference for the given length for section 1." },		"length_notes1": { "label": "Length notes for section 1", "type": "string", "description": "Notes for the length for section 1." },		"direction_a1": { "label": "Direction A for section 1", "type": "string", "description": "The first direction for section 1, to override direction_a." },		"direction_b1": { "label": "Direction B for section 1", "type": "string", "description": "The second direction for section 1, to override direction_b." },		"terminus_a1": { "label": "Terminus A for section 1", "type": "string", "description": "The first terminus for section 1.", "aliases": [ "end_a1" ]		},		"terminus_b1": { "label": "Terminus B for section 1", "type": "string", "description": "The second terminus for section 1.", "aliases": [ "end_b1" ]		},		"junctions1": { "label": "Major junctions for section 1", "type": "string", "description": "A brief list of major junctions for section 1. In the US, do not use more than 10." },		"section2": { "label": "Header for section 2", "type": "string", "default": "Section 2", "description": "If the route is divided into sections, this is the header for section 2." },		"length_mi2": { "label": "Section 2 length in miles", "type": "number", "description": "If and only if the route is in a country on the imperial system, list the length in miles on section 2 here." },		"length_km2": { "label": "Section 2 length in kilometres", "type": "number", "description": "If and only if the route is in a country on the metric system, list the length in kilometres on section 2 here." },		"length_ref2": { "label": "Length reference for section 2", "type": "string", "description": "A reference for the given length for section 2." },		"length_notes2": { "label": "Length notes for section 2", "type": "string", "description": "Notes for the length for section 2." },		"direction_a2": { "label": "Direction A for section 2", "type": "string", "description": "The first direction for section 2, to override direction_a." },		"direction_b2": { "label": "Direction B for section 2", "type": "string", "description": "The second direction for section 2, to override direction_b." },		"terminus_a2": { "label": "Terminus A for section 2", "type": "string", "description": "The first terminus for section 2.", "aliases": [ "end_a2" ]		},		"terminus_b2": { "label": "Terminus B for section 2", "type": "string", "description": "The second terminus for section 2.", "aliases": [ "end_b2" ]		},		"junctions2": { "label": "Major junctions for section 2", "type": "string", "description": "A brief list of major junctions for section 2. In the US, do not use more than 10." },		"section3": { "label": "Header for section 3", "type": "string", "default": "Section 3", "description": "If the route is divided into sections, this is the header for section 3." },		"length_mi3": { "label": "Section 3 length in miles", "type": "number", "description": "If and only if the route is in a country on the imperial system, list the length in miles on section 3 here." },		"length_km3": { "label": "Section 3 length in kilometres", "type": "number", "description": "If and only if the route is in a country on the metric system, list the length in kilometres on section 3 here." },		"length_ref3": { "label": "Length reference for section 3", "type": "string", "description": "A reference for the given length for section 3." },		"length_notes3": { "label": "Length notes for section 3", "type": "string", "description": "Notes for the length for section 3." },		"direction_a3": { "label": "Direction A for section 3", "type": "string", "description": "The first direction for section 3, to override direction_a." },		"direction_b3": { "label": "Direction B for section 3", "type": "string", "description": "The second direction for section 3, to override direction_b." },		"terminus_a3": { "label": "Terminus A for section 3", "type": "string", "description": "The first terminus for section 3.", "aliases": [ "end_a3" ]		},		"terminus_b3": { "label": "Terminus B for section 3", "type": "string", "description": "The second terminus for section 3.", "aliases": [ "end_b3" ]		},		"junctions3": { "label": "Major junctions for section 3", "type": "string", "description": "A brief list of major junctions for section 3. In the US, do not use more than 10." },		"section4": { "label": "Header for section 4", "type": "string", "default": "Section 4", "description": "If the route is divided into sections, this is the header for section 4." },		"length_mi4": { "label": "Section 4 length in miles", "type": "number", "description": "If and only if the route is in a country on the imperial system, list the length in miles on section 4 here." },		"length_km4": { "label": "Section 4 length in kilometres", "type": "number", "description": "If and only if the route is in a country on the metric system, list the length in kilometres on section 4 here." },		"length_ref4": { "label": "Length reference for section 4", "type": "string", "description": "A reference for the given length for section 4." },		"length_notes4": { "label": "Length notes for section 4", "type": "string", "description": "Notes for the length for section 4." },		"direction_a4": { "label": "Direction A for section 4", "type": "string", "description": "The first direction for section 4, to override direction_a." },		"direction_b4": { "label": "Direction B for section 4", "type": "string", "description": "The second direction for section 4, to override direction_b." },		"terminus_a4": { "label": "Terminus A for section 4", "type": "string", "description": "The first terminus for section 4.", "aliases": [ "end_a4" ]		},		"terminus_b4": { "label": "Terminus B for section 4", "type": "string", "description": "The second terminus for section 4.", "aliases": [ "end_b4" ]		},		"junctions4": { "label": "Major junctions for section 4", "type": "string", "description": "A brief list of major junctions for section 4. In the US, do not use more than 10." },		"translation": { "label": "Translated title", "description": "A translation of the title, displayed as a subheading.", "type": "content" }	},	"format": "block" }

Technical details
See Infobox road/doc/tech for details on the inner workings of the template, including a list of tracking categories.