Template:Infobox road/doc: Difference between revisions
en>Trialpears m (Removing unnecessary Template:Intricate template per Template talk:Intricate template#Change to editnotice? (via WP:JWB)) |
m (1 revision imported) |
Latest revision as of 23:16, 20 October 2020
This is a documentation subpage for Template:Infobox road. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
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.
{{Infobox road | country = | type = | route = | map = | length_mi = | length_km = | length_round = | length_ref = | established = | direction_a = | terminus_a = | junction = | direction_b = | terminus_b = | previous_type = | previous_route = | next_type = | next_route = }}
Unnumbered roads
This is the basic code needed to set up an infobox for an unnumbered route. See also {{infobox street}}.
{{Infobox road | name = | marker_image = | map = | length_mi = | length_km = | length_round = | length_ref = | established = | allocation = | direction_a = | terminus_a = | junction = | direction_b = | terminus_b = }}
Full
{{Infobox road | country = | name = | state = | type = | route = | alternate_name = | marker_image = | province = | subtype = | county = | translation = | map = | map_notes = | image = | image_width = | image_alt = | image_notes = | section = | maint = | time_period = | length_mi = | length_km = | length_notes = | established = | formed = | history = | known_for = | spur_of = | restrictions = | tourist = | allocation = | status = | spur_type = | e-road = | ahn = | tahn = | mrn = | e-road-shield = | arn-shield = | tahn-shield = | mrn-shield = | established_by = | header_type = | decommissioned = | deleted = | significance = | related = | terminus_a = | end_a = | beltway_city = | orbital = | loop = | tloop = | junction = | section0 = | ring_road = | direction_a = | terminus_b = | end_b = | direction_b = | system = | previous_route = | browse = | previous_type = | browse_route = | next_type = | next_route = | previous_dab = | next_dab = | nrhp = }}
Parameters
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:
|country=AUS
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.
- Australian state: the two- or three-letter abbreviation of the state. Note:
- 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".
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
File:
namespace prefix, which the template will place into an image link for you. For example,map=map_name|map_alt=alt text
will render as:[[File:map_name|290x172px|alt=alt text]]
. 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:
map=[[File:map_name|...]]
- 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
File:
namespace prefix, which the template will place into an image link for you. For example,photo=photo_name|photo_alt=alt text
will render as:[[File:photo_name|290px|alt=alt text]]
.- 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_round: number of decimal places to be used in the conversion. If the length should be converted to a greater precision than the given value, 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 (wrapped in
<ref>...</ref>
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
|tloop=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.
- 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_round#: "length_round" 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). Even where usage is possible, each parameter is still optional on an article-by-article basis based on local consensus.
Parameter | Usage | Allowed for |
---|---|---|
countries | a list of countries that the route enters | EUR, ASIA |
regions | a list of regions that the route enters | EUR, ITA, HRV, CZE, CYP, GRC, POL, SVN, SVK, AUT, TUR, UKR, BIH, SRB, SGP |
states | a list of states that the route enters | USA (but not for intrastate articles), IND, DEU |
provinces | a list of provinces that the route enters | CAN, IRN, TUR, THA, BEL, NLD |
counties | a list of counties that the route enters | USA, HUN (no restrictions) |
parishes | a list of parishes that the route enters | Louisiana (USA) |
rural_municipalities | a list of rural municipalities that the route enters | Manitoba, Saskatchewan (CAN) |
municipalities | a list of municipalities that the route enters | Puerto Rico (USA) |
districts | a list of districts that the route enters | Indian states (and other locations) that use districts instead of counties |
cities | used to list the cities that the route serves | everywhere but USA (per USRD) |
towns | used to list the towns that the route serves | everywhere but USA (per USRD) |
villages | used to list the villages that the route serves | everywhere but USA (per USRD) |
destinations | used to list the Primary destinations that the route serves | AUS, GBR, IRL, MYS, NZL, IND |
lga | used to list the Local Government Areas that the route servers | AUS |
locations | used to list the locations that the route serves; label varies based on route type | AUS |
(The countries, states, provinces, and counties location parameters should not be confused with the country, state, province, and county numbered roads parameters.)
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)
- freeway: Canada only. For roads that are freeways for their entire length.
- 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.
- 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
{{Infobox road/shieldmain/|province=¬|state=NJ|type=Turnpike|county=|route=|subtype=}} {{Infobox road/name/|province=¬|state=NJ|type=Turnpike|subtype=|route={{{route}}}|county=}} | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Route information | ||||||||||
Maintained by the New Jersey Turnpike Authority | ||||||||||
Length | 122.40 mi[4][2] (196.98 km) | |||||||||
Existed | 1951–present | |||||||||
Component highways |
| |||||||||
Major junctions | ||||||||||
South end | Invalid type: I / Invalid type: US in Pennsville Township | |||||||||
| ||||||||||
North end | Invalid type: I / Invalid type: US / Invalid type: US in Fort Lee | |||||||||
Location | ||||||||||
Counties | Salem, Gloucester, Camden, Burlington, Mercer, Middlesex, Union, Essex, Hudson, Bergen | |||||||||
Highway system | ||||||||||
{{Infobox road/browselinks/|province=¬|state=NJ|type=Turnpike|county=|route=}}
|
{{Infobox road |state=NJ |type=Turnpike |maint=the [[New Jersey Turnpike Authority]] |map=New Jersey Turnpike simple map.svg |map_notes=Map of the New Jersey Turnpike mainline and spurs in red in relation to other Interstates (blue) and toll roads (green) in the state |map_alt=Map of New Jersey with a long red line running from the southwest corner of the state to the northeast corner of the state signifying the mainline, three short red lines signifying the spur routes |length_mi=122.40 |length_ref=<ref name="sld 0">{{cite web |author= Staff |url=http://www.state.nj.us/transportation/refdata/sldiag/00000700__-.pdf |title=Route 700 Straight Line Diagram |accessdate=March 25, 2016 |format=PDF |publisher=New Jersey Department of Transportation}}</ref><ref name="sld 1" /><!--equation is 76.78+52.17-6.55=122.4--> |length_notes={{plainlist| *{{convert|11.03|mi|km|2|abbr=on}}—Western Spur<ref name="sld 2">{{cite web |author= Staff |url=http://www.state.nj.us/transportation/refdata/sldiag/00000095W_-.pdf |title=Route 95W Straight Line Diagram |accessdate=March 25, 2016 |format=PDF |publisher=New Jersey Department of Transportation}}</ref> *{{convert|6.55|mi|km|2|abbr=on}}—Pennsylvania Extension<ref name="sld 1">{{cite web |author= Staff |url=http://www.state.nj.us/transportation/refdata/sldiag/00000095__-.pdf |title=Route 95 Straight Line Diagram |accessdate=March 25, 2016 |format=PDF |publisher=New Jersey Department of Transportation}}</ref> *{{convert|8.17|mi|km|1|abbr=on}}—Newark Bay Extension<ref name="sld 3">{{cite web |author= Staff |url=http://www.state.nj.us/transportation/refdata/sldiag/00000078__-.pdf |title=Route 78 Straight Line Diagram |accessdate=March 25, 2016 |format=PDF |publisher=New Jersey Department of Transportation}}</ref> }} |established=1951 |allocation={{plainlist|1= *{{jct|state=NJ|US|40}} in [[Pennsville Township, New Jersey|Pennsville Township]] *{{Jct|state=NJ|Route|700|nolink1=yes|noshield1=yes}} from [[Pennsville Township, New Jersey|Pennsville Township]] to [[Mansfield Township, Burlington County, New Jersey|Mansfield Township]] *{{jct|state=NJ|I|95}} from Mansfield Township to [[Fort Lee, New Jersey|Fort Lee]] *{{Jct|state=NJ|I|78}} from I-95 to [[New Jersey Route 139|Route 139]] }} |direction_a=South |direction_b=North |terminus_a={{jct|state=NJ|I|295|US|40}} in Pennsville Township |junction={{plainlist| *{{jct|state=NJ|PAEX|nolink1=yes||I|95}} in [[Mansfield Township, Burlington County, New Jersey|Mansfield Township]] *{{jct|state=NJ|I|195}} in [[Robbinsville Township, New Jersey|Robbinsville Township]] *{{jct|state=NJ|I|287|NJ|440}} in [[Edison, New Jersey|Edison Township]] *{{jct|state=NJ|GSP||US|9}} in [[Woodbridge Township, New Jersey|Woodbridge Township]] *{{jct|state=NJ|I|278}} in [[Linden, New Jersey|Linden]]/[[Elizabeth, New Jersey|Elizabeth]] *{{jct|state=NJ|I|78|US|1-9|US|22}} in [[Newark, New Jersey|Newark]] *{{jct|state=NJ|I|280}} in [[Kearny, New Jersey|Kearny]] *{{jct|state=NJ|NJ|495}} in [[Secaucus, New Jersey|Secaucus]] *{{jct|state=NJ|I|80}} in [[Teaneck, New Jersey|Teaneck Township]] *{{jct|state=NJ|US|1-9|US|46|US|9W|PIP}} in [[Fort Lee, New Jersey|Fort Lee]] }} |terminus_b={{jct|state=NJ|I|95|US|1-9|US|46}} in Fort Lee |counties=[[Salem County, New Jersey|Salem]], [[Gloucester County, New Jersey|Gloucester]], [[Camden County, New Jersey|Camden]], [[Burlington County, New Jersey|Burlington]], [[Mercer County, New Jersey|Mercer]], [[Middlesex County, New Jersey|Middlesex]], [[Union County, New Jersey|Union]], [[Essex County, New Jersey|Essex]], [[Hudson County, New Jersey|Hudson]], [[Bergen County, New Jersey|Bergen]] |previous_type=I |previous_route=695 |browse_route=700 |next_type=I |next_route=895 |browse={{nj browse |previous_type=I |previous_route=95 |route={{nowrap|100}} |next_type=NJ-old |next_route=101 }}{{nj browse |previous_type=I |previous_route=295 |route={{nowrap|300}} |next_type=NJ |next_route=303 }} }}
- Example references
- ↑ Staff. "Route 95W Straight Line Diagram" (PDF). New Jersey Department of Transportation. Retrieved March 25, 2016.
- ↑ 2.0 2.1 Staff. "Route 95 Straight Line Diagram" (PDF). New Jersey Department of Transportation. Retrieved March 25, 2016.
- ↑ Staff. "Route 78 Straight Line Diagram" (PDF). New Jersey Department of Transportation. Retrieved March 25, 2016.
- ↑ Staff. "Route 700 Straight Line Diagram" (PDF). New Jersey Department of Transportation. Retrieved March 25, 2016.
TemplateData
TemplateData documentation used by VisualEditor and other tools
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
See the monthly parameter usage report for this template.
TemplateData for Infobox road An infobox template for highway articles.
|
Technical details
See Infobox road/doc/tech for details on the inner workings of the template, including a list of tracking categories.
Tracking categories
- Category:Infobox road transclusion errors (37)
- Category:Infobox road maps for Wikidata migration (0)
- Category:Infobox road articles without wikidata country (0)
- Category:Infobox road articles without wikidata instance of (0)
- Category:Pages using infobox road with unknown parameters (9)
See also
- {{Infobox Australian road}} – A similar template that includes several additional parameters that are specific for roads in Australia.
- {{Infobox road small}} – Compact version of this template, used for special routes that are present on lists or parent route articles.
- {{Infobox road junction}} – An infobox for use on articles about road junctions and interchanges.
- {{Infobox street}} – An infobox for use on streets.