View source for Template:Infobox cave/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Location map|Module:Coordinates|Module:Check for unknown parameters}}

This template can be used to create an [[Help:Infobox|infobox]] for articles about [[cave]]s. See the section about caves of the British Isles.

== Usage ==
{{Parameter names example | embed | child | name | other_name | alt_name | photo | photo_width | photo_alt | photo_caption | map=Earth | map_caption | location | grid_ref_UK | grid_ref | grid_ref_Ireland | coords={{coord|0|0|type:landmark|display=inline}} | coords_ref | depth | length | height_variation | elevation | discovery | geology  | entrance_count | entrance_list | difficulty | hazards | access | show_cave | show_cave_length | lighting | visitors | features | translation | language | pronunciation | survey | survey_format | bcra_grade | registry | register | free_label_1 | free_data_1 | free_label_2 | free_data_2 | website | embedded }}

{|
! Basic usage
! Full usage
|- style="vertical-align:top;"
|<pre style="overflow:auto;">
{{Infobox cave
| name                = 
| other_name          = 
| photo               = 
| photo_width         = 
| photo_alt           = 
| photo_caption       = 
| map                 = <!-- or | map_image = -->
| map_width           = 
| map_alt             = 
| map_caption         = 
| mapframe            = <!-- set to "yes" to show an interactive map -->
| location            = 
| land_registry_number= 
| grid_ref_UK         = 
| grid_ref_Ireland    = 
| grid_ref            = 
| coords              = 
| coords_ref          = 
| depth               = 
| length              = 
| height_variation    = 
| elevation           = 
| discovery           = 
| geology             = 
| entrance_count      = 
| entrance_list       = 
| difficulty          = 
| hazards             = 
| access              = 
| show_cave           = 
| show_cave_length    = 
| lighting            = 
| visitors            = 
| features            = 
| survey              = 
| survey_format       = 
| website             = 
}}</pre>
|<pre style="overflow: auto;">
{{Infobox cave
| child            = 
| name             = 
| other_name       = 
| alt_name         = 
<!--    Image    -->
| photo            = 
| photo_width      = 
| photo_alt        = 
| photo_caption    = 
<!--    Map      -->
| map              = <!-- or | map_image = -->
| map_width        = 
| relief           = 
| map_alt          = 
| map_caption      = 
| label            = 
| label_position   = 
| mark             = 
| mark_width       = 
| location         = 
| grid_ref_UK      = 
| grid_ref_Ireland = 
| grid_ref         = 
| coords           = 
| coords_ref       = 
| mapframe         = <!-- set to "yes" to show an interactive map -->
<!--    Stats    -->
| depth            = 
| length           = 
| height_variation = 
| elevation        = 
| discovery        = 
| geology          = 
| entrance_count   = 
| entrance_list    = 
| difficulty       = 
| hazards          = 
| access           = 
| show_cave        = 
| show_cave_length = 
| lighting         = 
| visitors         = 
| features         = 
| translation      = 
| language         = 
| pronunciation    = 
| survey           = 
| survey_format    = 
| bcra_grade       = 
| registry         = 
| free_label_1     = 
| free_data_1      = 
| free_label_2     = 
| free_data_2      = 
| website          = 
| embedded         = 
}}</pre>
|}
{{clear}}

=== Example ===
{{Infobox cave
| name = Minnetonka Cave
| photo = Minnetonka Cave.JPG
| photo_caption = Minnetonka Cave, administered by the U.S. Forest Service
| map = USA
| relief = 1
| location = [[Bear Lake County, Idaho]], [[United States]]
| depth = 
| length = 
| coords = {{coord|42|5|14|N|111|31|7|W|type:landmark_region:US-ID|display=inline<!--,title-->}}
| coords_ref = 
| survey = 
| survey_format = 
| discovery = 1907
| geology = [[Karst topography|Karst cavern]], [[Mississippian age|Mississippian]] [[Limestone]]
| entrance_count = 1
| entrance_list =
| difficulty = 
| hazards = 
| access = Tours are available in season
}}

<pre style="overflow:auto;">
{{Infobox cave
| name = Minnetonka Cave
| photo = Minnetonka Cave.JPG
| photo_caption = Minnetonka Cave, administered by the U.S. Forest Service
| map = USA
| relief = 1
| location = [[Bear Lake County, Idaho]], [[United States]]
| depth = 
| length = 
| coords = {{coord|42|5|14|N|111|31|7|W|type:landmark_region:US-ID|display=inline<!--,title-->}}
| coords_ref = 
| survey = 
| survey_format = 
| discovery = 1907
| geology = [[Karst topography|Karst cavern]], [[Mississippian age|Mississippian]] [[Limestone]]
| entrance_count = 1
| entrance_list =
| difficulty = 
| hazards = 
| access = Tours are available in season
}}
</pre>
{{clear}}

== Parameter descriptions ==

This table describes all parameters which can be used in building infoboxes. Only the <code>name</code> parameter must be assigned a value.

{| class="wikitable" style="width: 97%;"
! style="width: 12%" | Parameter || Description
|-
| <code>name</code> || Required. The name of the cave. 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 [[Blue Grotto (Capri)]] then use <code>name=Blue Grotto</code>.
|-
| <code>other_name</code> || If there is a common English name for the cave use it for the <code>name</code> parameter. This parameter can be used to display the name in the local language or for an alternate English name if it is commonly used. If you would like to italicize the text use wiki markup.
|-
| <code>photo</code> || The name of an image file to be displayed. No special formatting is needed.
|-
| <code>photo_width</code> || Determines the width of the image. The default and maximum value is 256px. Images with a horizontal orientation (landscape mode) will generally display well at the default setting. An image with vertical orientation (portrait mode) will need to be adjusted. 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> || The caption that will appear below the image if one is required.
|-
| <code>map</code> || The name of the [[Template:location map|location map]] to be displayed. See [[#Map display|Map display]].  To use a static image, use {{para|map_image}}
|-
| <code>map_image</code> || The file name of a static map image to be displayed.  To use a [[Template:location map|location map]], use {{para|map}}.
|-
| <code>map_width</code> || Determines the width of the map. The default width is 220px and maximum width is 256px. For example, <code>map_width=180</code> and '''not''' <code>map_width=180px</code>.
|-
| <code>map_alt</code> || Alt text for the map. See [[WP:ALT]].
|-
| <code>map_caption</code> || The caption that will appear below the map if one is required.
|-
| <code>relief</code> || Selects a relief map when assigned any value. This is functional when a location map template is used. See [[#Map display methods|Map display methods]].
|-
| <code>mark</code> || A marker which shows the location of the cave on a map. The default image is [[:File:Red pog.svg|Red pog.svg]]. For more information, see [[Template:Location map]].
|-
| <code>marker_size</code> || The width of the location marker image in pixels. Seldom used. The default width is 8px.
|-
| <code>label_position</code> || This seldom used parameter will generate a text label next to the a location marker. Valid values are <code>left</code>, <code>right</code>, <code>top</code> and <code>bottom</code>. If no value is assigned to the <code>label</code> parameter below, the <code>name</code> will be used.
|-
| <code>label</code> || Text that will be displayed next to the location marker. See <code>label_position</code> above.
|-
| <code>location</code> || The location of the cave. 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. The text should be meaningful to a reader who lacks knowledge of local geography.
|-
| <code>coords</code><br /><code>coordinates</code> || For the {{tl|Coord}} template. Will generate a location marker if a map is used. See the Coord template documentation for information on adding <code>type</code>, <code>source</code>, <code>format</code>, <code>region</code>, and <code>display</code> data. Using <code>display:inline,title</code> is recommended.
|-
| <code>coords_ref</code><br /><code>coordinates ref</code> || Used with either coordinate display method above. Strongly recommended. Specify a citation for the coordinates using {{nowrap|<code><nowiki><ref>...</ref></nowiki></code>}} tags.
|-
| <code>land_registry_number</code> || Reference number of the cave in the relevant land registry.
|-
| <code>depth</code> || The distance from the surface to the deepest portion of the cave.
|-
| <code>length</code> || The surveyed length of the cave.
|-
| <code>height_variation</code> || The variation in height of the [show] cave passageway, e.g. 5m (+2m, -3m)
|-
| <code>elevation</code> || The elevation of the cave entrance above sea level.
|-
| <code>discovery</code> || The date the cave was discovered and who discovered it.
|-
| <code>geology</code> || Is the cave in [[limestone]], [[marble]], [[Dolomite (mineral)|dolomite]], [[shale]], [[conglomerate (geology)|conglomerate]],  [[basalt]] or something else. Is it a [[sea cave]], [[lava tube]], or [[karst]] cave. See the [[Cave]] article.
|-
| <code>entrance_count</code> || The number of entrances.
|-
| <code>entrance_list</code> || A list of entrances.
|-
| <code>difficulty</code> || The skill level required to explore the cave safely. Don't use a number unless you supply a link to site that explains what the number means.
|-
| <code>hazards</code> || Are there hazards such as [[sump (cave)|sumps]], flooding, strong underwater currents, rock falls, or [[histoplasmosis]].
|-
| <code>access</code> || Is access private, public, restricted, by permit only, etc.? When are tours available.
|-
| <code>show_cave</code> || See the [[show cave]] article. Give the year it was opened.
|-
| <code>show_cave_length</code> || The length of the show cave tour.
|-
| <code>lighting</code> || What kind of lighting is used in the show cave.
|-
| <code>visitors</code> || The number of visitors in a recent year if known.
|-
| <code>features</code> || Features of special interest found in the cave, which might include [[speleogen]]s such as [[boxwork]], [[anthodite]]s, [[lavacicle]]s, or [[helictite]]s.
|-
| <code>survey</code> || If a [[cave survey]] has been done, then when was it and who did it.
|-
| <code>survey_format</code> || The cave survey [[Cave survey#Surveying software|software]] package used. For example: [[Survex]].
|-
| <code>registry</code><br /><code>register</code> || The name of a cave registry. Preferably with a [[help:footnotes|footnote]] citing the register webpage.
|}

==Map display==
This template supports three different types of maps: Image-based map, pushpin location maps, and interactive mapframe maps.
===Map images===
Any image file can be displayed as a map: pass the file name (without File: or Image: prefix) to {{para|map}}.
===Location maps===
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}} 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 Canada is [[Module:Location map/data/Canada|Location map/data/Canada]]. In this case specify {{para|map|Canada}}.

{{Infobox cave
| name = Four Corners, Canada
| map = Canada
| map_caption = Example location map using geographic coordinates
| coords = {{coord|60|N|102|W|display=inline <!-- for documentation page only - not general practice --> }}
}}
<pre>
{{Infobox cave
| name = Four Corners, Canada
| map = Canada
| map_caption = Example location map using geographic coordinates
| coordinates = {{coord|60|N|102|W|display=inline <!-- for documentation page only - not general practice --> }}
}}</pre>

By default, {{tl|Coord}} displays in the infobox only in the page title. Parameter {{para|display|inline,title}} can be added to make the coordinates display at the top of the page as well.
{{clear}}

===Mapframe maps===
{{stack|1=
<br/><br/><!-- push infofox below the view-talk-edit links -->
{{Infobox cave
| name = Four Corners, Canada
| mapframe = yes
| mapframe-caption = Example mapframe map using geographic coordinates, using {{tt|{{!}}mapframe{{=}}yes}}
| mapframe-zoom = 4
| coords = {{coord|60|N|102|W|display=inline <!-- for documentation page only - not general practice --> }}
}}
}}
{{Infobox mapframe/doc/parameters}}

== Parameters for use in articles about caves of the [[British Isles]] ==

{| class="wikitable" style="width: 97%;"
! style="width: 14%" | Field name || Description
|-
|<code>grid_ref_UK</code> || If the cave is in [[Great Britain]], the [[British national grid reference system|British grid reference]].
|-
|<code>grid_ref_Ireland</code> || If the cave is in [[Ireland]] (whether [[Northern Ireland]] or the [[Republic of Ireland|Republic]]), the [[Irish national grid reference system|Irish grid reference]].
|-
|<code>grid_ref</code> || Specify a citation for the grid reference using <code><nowiki><ref>...</ref></nowiki></code> tags.
|}

=== Example of an infobox for a cave in the British Isles ===
{{Infobox cave
| name = Aveline's Hole
| photo = Avelineshole.jpg
| photo_caption = Aveline's Hole
| location = [[Mendip Hills]], [[Somerset]], [[England]]
| grid_ref_UK = ST 4761 5867
| depth = {{convert|16|m|0}}
| length = {{convert|68|m|0}}
| elevation = {{convert|99|m|0}}
| discovery = 1797
| geology = Limestone
| difficulty = 
| hazards = 
| access = 
| registry = Mendip Cave Registry<ref>{{cite mcra |id=3 |name=Aveline's Hole |accessdate=2012-03-30}}</ref>
}}

<pre style="overflow:auto; font-size: 90%;">
{{Infobox cave
| name = Aveline's Hole
| photo = Avelineshole.jpg
| photo_caption = Aveline's Hole
| location = [[Mendip Hills]], [[Somerset]], [[England]]
| grid_ref_UK = ST 4761 5867
| depth = {{convert|16|m}}
| length = {{convert|68|m}}
| elevation = {{convert|99|m}}
| discovery = 1797
| geology = Limestone
| difficulty = 
| hazards = 
| access = 
| registry = Mendip Cave Registry<ref>{{cite mcra |id=3 |name=Aveline's Hole |accessdate=2012-03-30}}</ref>
}}
</pre>

For other registries consider using {{tag|ref}} tags and {{tl|cite web}}. 

{{reflist-talk}}
{{clear}}

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

<includeonly>{{basepage subpage|
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Place infobox templates|Cave]]
[[Category:WikiProject Caves templates]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>