Template:Infobox road/doc

This is the template documentation page for Template:Infobox road.

This page is not necessarily intended to be viewed directly. If it uses variables, some links may appear broken. Do not replace these variables with hardcoded page names or URLs.

This is the basic syntax you need to get a complete routebox on the article page, just place this before any other text and fill in the variables. Note that this is a complete list of every variable that can be used with Infobox road and that many are unnecessary in most cases. Variables that are empty can be omitted.

{{Infobox road
|marker_image=
|state=
|highway_name=
|name_notes=
|type=
|route=
|alternate_name=
|maint=
|section=
|map=
|length_mi=
|length_round=
|length_ref=
|length_notes=
|established=
|decommissioned=
|direction_a=
|starting_terminus=
|beltway_city=
|junction=
|direction_b=
|ending_terminus=
|counties=
|rural_municipalities=
|cities=
|system=
|previous_type=
|previous_route=
|next_type=
|next_route=
|browse=
|commons=
|customcommons=
}}

Parameter breakdown

Political entities

Three parameters exist for supplying the political entity that the road is located in. Only one may be used on a given article, preferably the most applicable of the three.

Parameter	What it takes	Suggested usage
state	The two-letter abbreviation of the state that the article route is located in	U.S. roads
province	The two-letter abbreviation of the province that the article route is located in	Canadian roads
country	Full name of the country that the article route is located in	International roads

Shields and highway names

If no political entity is specified, two parameters may be used to add a shield and the highway name. If a political entity is specified, there is no need to use these parameters except to overwrite the text generated by the political entity, "type" and "route".

marker_image: shield image to be displayed
highway_name: road name to be displayed, usually the number of the road (example: "New York State Route 5").

Length

Multiple scenarios for lengths have been detailed below.

If neither length_mi nor length_km exists, no length is displayed.
If both length_mi and length_km are defined, use length_first to specify which one appears first. Accepted values are "mi" and "km".
If only one of length_mi or length_km is defined, that one appears first. The other is calculated and rounded to length_round (default 0) places. If the length is to a greater precision than the nearest unit, adjust length_round to match but be sure to avoid false precision.
length_ref, if defined, appears after the first length. Use a citation for the length 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.

General content

name_notes: foot notes that will be displayed in small text underneath the highway name
type: usually the two-letter state abbreviation for state roads; see the state WikiProject for more details
route: This is the number of the route the article is about (used only with a political entity)
alternate_name: Use in situations where the entire route has another name (i.e. NY 590 is called the Sea Breeze Expressway for its entire length)
maint: The agency that maintains the highway
section The section of code that defines this route. Only CA and WA use this, and the appropriate subpage ([[/CA law]] for example) must be set up.
map: image name of a map for the route, width should be 290px; see the maps task force for maps
established: This is the date the route was commissioned or assigned to its current alignment
decommissioned: date the route was decommissioned
direction_a: For U.S. roads, this should be either south or west to keep in accordance with the U.S. Roads project, which lists termini and junctions in progression traveling from West to East and South to North.
starting_terminus: This is where the route begins and, for U.S. roads, is either at the southern terminus or western terminus.
beltway_city: for beltways. This is the city that the beltway encircles
junction: a list of major junctions. Each WikiProject has different standards for major junctions, so consult the relevant WikiProject for more details.
direction_b: The opposite of direction_a
ending_terminus: where the route ends, in accordance with the guidelines set forth with starting_terminus
counties: a list of counties that the route enters
rural_municipalities: a list of rural municipalities that the route enters (specific to Manitoba and Saskatchewan)
cities: a list of cities that the route enters
system: the highway system that the article route is part of
previous_type: This is the type of route that proceeds the current one in the system. For U.S. roads, the value for this is: Interstate, US, or (State) for Interstates, U.S. Routes and other state roads, respectively. Each state has a different parameter for state roads, so consult the WikiProject if in doubt.
previous_route: The number of the route preceding this one
next_type: Same as previous_type but for the route following this one
next_route: The number of the route succeeding this one
browse: use to add additional browse lines
commons: use to add link to image gallery or category in commons, input should be gallery, category, or left blank
customcommons: (use with commons) use to specify a different gallery/category than the default that is linked