View source for Template:Infobox mountain pass/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Coordinates|Module:Check for unknown parameters}}

This template can be used to create an [[Help:Infobox|infobox]] for an article about a [[mountain pass]]. Other infoboxes can be embedded in this template, and it can be embedded in other infoboxes. For more information on these options, read [[Template:Infobox#Embedding|Infobox Embedding]].

== Usage == 

=== Cut and paste box ===
These parameters can be used to create a fully functional infobox.

<syntaxhighlight lang="wikitext" style="width:20em;">
{{Infobox mountain pass
| name = 
| photo = 
| photo_caption = 
| elevation = 
| traversed = 
| location = 
| range = 
| coordinates = 
}}</syntaxhighlight>

=== Full parameters ===
<syntaxhighlight lang="wikitext" style="width:20em;">
{{Infobox mountain pass
| name              = 
| other_name        = 
| photo             = 
| photo_size        = 
| photo_alt         = 
| photo_caption     = 
| map               = 
| map_alt           = 
| map_caption       = 
| map_relief        = 
| map_size          = 
| label             = 
| label_position    = 
| elevation         = 
| elevation_m       = 
| elevation_ft      = 
| elevation_ref     = 
| traversed         =
| length            =
| length_km         =
| length_mi         =
| length_ref        =
| grade_avg         =
| grade_max         =
| ascent             =
| traversed2         =
| length2            =
| length_km2         =
| length_mi2         =
| length_ref2        =
| grade_avg2         =
| grade_max2         =
| ascent2            =
| traversed3         =
| length3            =
| length_km3         =
| length_mi3         =
| length_ref3        =
| grade_avg3         =
| grade_max3         =
| ascent3            =
| location          = 
| range             = 
| grid_ref_UK       = 
| grid_ref_Ireland  = 
| coordinates       = 
| coordinates_ref   = 
| topo              = 
| embedded          = 
| child             =
}}</syntaxhighlight>

=== Parameter descriptions ===
This table describes most of the parameters available. See below for additional parameters. Only the <code>name</code> parameter must be assigned a value. Remember to reduce the width of photos and maps so that they do not inappropriately dominate the infobox.

{| class="wikitable" style="width: 97%;"
! Parameter || Description
|-
| <code>name</code> || Required. The name of the pass. It will be displayed at the top of the infobox. In most cases this should be the same as the article name less any disambiguation. For example, if the article title is [[Lolo Pass (Idaho–Montana)]] then <code>name=Lolo Pass</code>.
|-
| <code>other_name</code> || This parameter can be used to display the name in the local language or for an alternate English name if it is commonly used. Use a language template if the name is not English. For example: <nowiki>{{langx|fr|Ventour in Provençal}}</nowiki> → {{langx|fr|Ventour in Provençal}}.
|-
| <code>photo</code> || The name of an image file to be displayed. No special formatting is needed.
|-
| <code>photo_width</code> || Can be used to change the display width of the image. The default and maximum value is 280px. Images with a horizontal orientation (landscape mode) will generally display well at the default setting. An image with vertical orientation (portrait mode) may need to be adjusted to 180px or 220px. For example, <code>photo_width=200</code> and not <code>photo_width=200px</code>.
|-
| <code>photo_alt</code> || Alt text for the photo, for visually impaired readers. See [[WP:ALT]].
|-
| <code>photo_caption</code> || A caption which will appear below the image if one is required.
|-
| <code>map</code> || The name of the map to be displayed. See [[#Map display methods|Map display methods]] below.
|-
| <code>map_alt</code> || Alt text for the map. See [[WP:ALT]].
|-
| <code>map_caption</code> || A caption which will appear below the map if one is required.
|-
| <code>map_relief</code> || This infobox will attempt to display a relief map if one is available. To force display of the default map image use {{para|map_relief|0}}.
|-
|<code>map_size</code> || Can change the display width of the map. The default and maximum width is 272px, but usually the map should be much smaller. For example, <code>map_size=200</code> and not <code>map_size=200px</code>.
|-
| <code>coordinates</code> or <code>coords</code> || For use with the {{tl|coord}} template. When using the {{tlf|coord}} template standard [[help:footnotes|footnote]] syntax can be used; {{para|coordinates_ref}} can also be used.
|-
| <code>elevation</code> || The elevation of summit. Metres should be used first for all passes outside of the United States and feet for those within the U.S. For conversions, use <code>elevation_m</code> for metres to feet or <code>elevation_ft</code> for feet to metres.
|-
| <code>elevation_ref</code> || 	Reference for the elevation using {{nowrap|<code><nowiki><ref>...</ref></nowiki></code>}} tags. If <code>elevation_m</code> or <code>elevation_ft</code> was used, the reference must be supplied using this parameter.
|-
| <code>length</code> (or <code>length2</code> and <code>length3</code>) || The length of (first) ascent. Kilometres should be used first for all passes outside of the United States and miles for those within the U.S. For conversions, use <code>length_km</code> for kilometres to miles or <code>length_mi</code> for miles to kilometres.
|-
| <code>length_ref</code> (or <code>length_ref2</code> and <code>length_ref3</code>) || 	Reference for the length using {{nowrap|<code><nowiki><ref>...</ref></nowiki></code>}} tags. If <code>length_km</code> or <code>length_mi</code> was used, the reference must be supplied using this parameter.
|-
| <code>traversed</code> (or <code>traversed2</code> and <code>traversed3</code>) || A route which traverses the pass.
|-
| <code>grade_avg</code>(or <code>grade_avg2</code> and <code>grade_avg3</code>) || The average gradient of an ascent of the pass.
|-
| <code>grade_max</code> (or <code>grade_max2</code> and <code>grade_max3</code>) || The maximum gradient of an ascent of the pass.
|-
| <code>ascent</code> (or <code>ascent2</code> and <code>ascent3</code>) || A foot of the pass, the place from which the pass ascends.
|-
| <code>location</code> || The location of the pass. Don't be too precise. County, state and country are good in the USA. If the area is within a city specify the city, state and country. If the area is in multiple counties just list the state and country. For areas in other countries adjust accordingly.
|-
| <code>range</code> || [[Mountain range]] if applicable. A subrange should be provided instead of any major mountain system unless there is no applicable subrange. For example, use [[Teton Range]] and not [[Rocky Mountains]] or [[Bernese Alps]] not [[Alps]].
|-
| <code>grid_ref_UK</code> || If the mountain pass is in [[Great Britain]], the [[British national grid reference system|British grid reference]]. For locations outside of Great Britain, this field is not applicable and therefore should be removed if it is present.
|-
| <code>grid_ref_Ireland</code> || If the mountain pass is in [[Ireland]] (whether [[Northern Ireland]] or the [[Republic of Ireland|Republic]]), the [[Irish national grid reference system|Irish grid reference]]. For location outside Ireland, this field is not applicable and therefore should be removed if it is present.
|-
| <code>topo</code> || The name of the [[topographic map]] showing the mountain. In Canada, this is usually the [[National Topographic System]] map number while for the USA, it's the map name from the USGS.
|-
|}

== Map display method ==

=== Display a marker on a map using a template and coordinates ===

A marker can be superimposed on a map using one of a set of special map templates. To display a marker, the geographic coordinates must be specified using the {{tl|Coord}} template inside the {{para|{{{coordinates|coordinates}}}}} parameter. See the documentation for {{tl|Location map}}. The parameters for this template map to a subset of the parameters used by {{tlf|Location map}}. A map template can be found using these sources:
:[[Template:Location map/List|List of templates]] – Many of the listed items are redirects and a few templates may not function as expected.
:[[:Category:Location map templates]] – templates sorted by category.
:[[Special:WhatLinksHere/Template:Location map/Info]] – a search that might help.
:[[Special:PrefixIndex/Module:Location map/data/]] – another search that might help.
:[[Special:Prefixindex/Template:Location map]] – another search that might help.

All of the names begin with the words "Location map" followed by the area covered. The value you need to specify is the area name. The map template for the Alps is [[Module:Location map/data/Alps]]. In this case specify {{para|map|Alps}}.
{{Infobox mountain pass
| name = Turracher Höhe Pass
| map = Alps
| map_caption = Location in the Alps. The pass is on the [[Styria]]–[[Carinthia (state)|Carinthia]] border
| location = [[Austria]]
| coordinates = {{coord|46.91442|13.87500|region:AT|display=inline}}
}}

<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Infobox mountain pass
| name = Turracher Höhe Pass
| map = Alps
| map_caption = Location in the Alps. The pass is on the [[Styria]]–[[Carinthia (state)|Carinthia]] border
| location = [[Austria]]
| coordinates = {{coord|46.91442|13.87500|region:AT}}
}}
</syntaxhighlight>

{{Infobox mountain pass
|name=Kirkstone Pass
|photo=Kirkstone_pass_inn.jpeg
|photo_caption=Kirkstone Pass Inn
|elevation_ft=1489
|coordinates={{coord|54.47733|N|2.92283|W|region:GB_source:enwiki-osgb36(NY403095)|display=title,inline}}<!-- Note: WGS84 lat/long, converted from OSGB36 grid ref -->
|traversed=[[A592 road]]
|ascent=[[Ullswater]]
|traversed2=[[A592 road]]
|ascent2=[[Ambleside]]
|traversed3=''The Struggle''
|grade_max3=24
|grade_avg3=8.2
|length_km3=4.8
|ascent3=[[Ambleside]]
}}

<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Infobox mountain pass
|name=Kirkstone Pass
|photo=Kirkstone_pass_inn.jpeg
|photo_caption=Kirkstone Pass Inn
|elevation_ft=1489
|coordinates={{coord|54.47733|N|2.92283|W|region:GB_source:enwiki-osgb36(NY403095)|display=title,inline}}<!-- Note: WGS84 lat/long, converted from OSGB36 grid ref -->
|traversed=[[A592 road]]
|ascent=[[Ullswater]]
|traversed2=[[A592 road]]
|ascent2=[[Ambleside]]
|traversed3=''The Struggle''
|grade_max3=24
|grade_avg3=8.2
|length_km3=4.8
|ascent3=[[Ambleside]]
}}
</syntaxhighlight>
{{clear}}

== Microformat ==
The articles created using this template include an hCard microformat. For more information read [[:Template:UF-hcard-place|this]].

== Tracking category ==
* {{clc|Pages using infobox mountain pass with unknown parameters}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Place infobox templates|Mountain Pass]]
[[Category:WikiProject Mountains templates]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>