Template:Infobox cave/doc

This template can be used to create an infobox for articles about caves. See the section about caves of the British Isles.

Usage

{{{name}}}
{{{other_name}}}
[[File:{{{image}}}|{{{image_size}}}|alt={{{alt}}}|upright=1.15]] {{{caption}}}
Location within Earth
Location	{{{location}}}
OS grid	{{{grid_ref_UK}}}{{{grid_ref}}}
OSI/OSNI grid	{{{grid_ref_Ireland}}}{{{grid_ref}}}
Coordinates	0°N 0°E / 0; 0{{{coordinates_ref}}}
Depth	{{{depth}}}
Length	{{{length}}}
Height variation	{{{height_variation}}}
Elevation	{{{elevation}}}
Discovery	{{{discovery}}}
Geology	{{{geology}}}
Entrances	{{{entrances}}}
Entrances list	{{{entrance_list}}}
Difficulty	{{{difficulty}}}
Hazards	{{{hazards}}}
Access	{{{access}}}
Show cave opened	{{{show_cave_opened}}}
Show cave length	{{{show_cave_length}}}
Lighting	{{{lighting}}}
Visitors	{{{visitors}}}
Features	{{{features}}}
Translation	{{{translation}}} ({{{language}}})
Pronunciation	{{{pronunciation}}}
Cave survey	{{{survey}}} (in {{{survey_format}}})
BRAC grade	{{{BCRA_GRADE}}}
Registry	{{{registry}}}
{{{free_label_1}}}	{{{free_data_1}}}
{{{free_label_2}}}	{{{free_data_2}}}
Website	{{{website}}}
{{{embedded}}}

{{Infobox cave
| embed            = 
| name             = 
| other_name       = 
<!--    Image    -->
| image            = 
| image_size       = 
| alt              = 
| caption          = 
<!--    Map      -->
| pushpin_map      = 
| location         = 
| grid_ref_UK      = 
| grid_ref_Ireland = 
| grid_ref         = 
| coordinates      = 
| coordinates_ref  = 
| mapframe         = <!-- set to "yes" to show an interactive map -->
<!--    Stats    -->
| depth            = 
| length           = 
| height_variation = 
| elevation        = 
| discovery        = 
| geology          = 
| entrances        = 
| entrance_list    = 
| difficulty       = 
| hazards          = 
| access           = 
| show_cave_opened = 
| 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         = 
}}

Example

Minnetonka Cave
Minnetonka Cave, administered by the U.S. Forest Service
Location within the United States
Location	Bear Lake County, Idaho, United States
Coordinates	42°5′14″N 111°31′7″W
Discovery	1907
Geology	Karst cavern, Mississippian Limestone
Entrances	1
Access	Tours are available in season

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

Parameter descriptions

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

Parameter	Description
name	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 name=Blue Grotto.
other_name	If there is a common English name for the cave use it for the name 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.
image	The name of an image file to be displayed. No special formatting is needed.
image_size	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, image_size=200 and not image_size=200px.
alt	Alt text for the image, for visually impaired readers. See WP:ALT.
caption	The caption that will appear below the image if one is required.
pushpin_map	The name of the location map to be displayed. See Map display. To use a static image, use |image_map=
image_map	The file name of a static map image to be displayed. To use a location map, use |pushpin_map=.
map_alt	Alt text for the map. See WP:ALT.
map_caption	The caption that will appear below the map if one is required.
location	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.
coordinates	For the {{Coord}} template. Will generate a location marker if a map is used. See the Coord template documentation for information on adding type, source, format, region, and display data. Using display:inline,title is recommended.
coordinates_ref	Used with either coordinate display method above. Strongly recommended. Specify a citation for the coordinates using <ref>...</ref> tags.
land_registry_number	Reference number of the cave in the relevant land registry.
depth	The distance from the surface to the deepest portion of the cave.
length	The surveyed length of the cave.
height_variation	The variation in height of the [show] cave passageway, e.g. 5m (+2m, -3m)
elevation	The elevation of the cave entrance above sea level.
discovery	The date the cave was discovered and who discovered it.
geology	Is the cave in limestone, marble, dolomite, shale, conglomerate, basalt or something else. Is it a sea cave, lava tube, or karst cave. See the Cave article.
entrances	The number of entrances.
entrance_list	A list of entrances.
difficulty	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.
hazards	Are there hazards such as sumps, flooding, strong underwater currents, rock falls, or histoplasmosis.
access	Is access private, public, restricted, by permit only, etc.? When are tours available.
show_cave_opened	See the show cave article. Give the year it was opened.
show_cave_length	The length of the show cave tour.
lighting	What kind of lighting is used in the show cave.
visitors	The number of visitors in a recent year if known.
features	Features of special interest found in the cave, which might include speleogens such as boxwork, anthodites, lavacicles, or helictites.
survey	If a cave survey has been done, then when was it and who did it.
survey_format	The cave survey software package used. For example: Survex.
registry	The name of a cave registry. Preferably with a 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.

Pushpin map

Below are the parameters used by Module:Location map to produce the pushpin map in this Infobox. These parameters are available for editors to set in articles that use this infobox.

Parameter	Description	Default
|pushpin_map=	The map(s) to display. For example, specifying England will use the values for England in Module:Location map/data/England.Multiple maps can be shown by providing a list of map names separated by #. For multiple maps, the first is shown by default. A reader can select the others with radio buttons.	N/A
|pushpin_caption=	The text of a caption to be displayed below the map. If not provided a default caption will be generated. Multiple captions can be shown when separated by ## (that's two).	Location within MAPNAME
|pushpin_relief=	0/false/off will cause the template to display the map defined as image (generally not a relief map). 1/true/on will cause the template to display the map defined as image1 (generally a relief map). Any non-zero numeric value such as 2 or 3 will display image2 or image3, if those images are defined. Any other non-empty value will cause display of image1. See the example at Location map+/relief.	0
|pushpin_label=	The text of the label to display next to the identifying mark; a wikilink can be used. You can enclose the label inside of {{nowrap}} if you want to make sure that it stays on a single line.	N/A
|pushpin_label_size=	The font size to use for the label, given as a percentage of the normal font size (<100=smaller, >100=larger); the default size is 90. Do not include %. For example, use |pushpin_label_size=80, not |pushpin_label_size=80%. If set to 0, the label is only displayed when the user hovers over the mark.	90
|pushpin_label_position=	The position of the label relative to the identifying mark; valid values are left, right, top, bottom and none. This defaults to either left or right, depending on the coordinates of the marker and its position relative to the right border of the map image. When |pushpin_label_position=none, any defined label will not be displayed with the mark, but it will be used to create the default caption.	N/A
|pushpin_mark=	The name of an image file to display as the identifying mark; the default is Red pog.svg . See examples at Commons:Location markers and Commons:Category:Map icons.	Red pog.svg
|pushpin_mark_size=	The size of the identifying mark in pixels. Do not include px	8
|pushpin_alt=	Alt text for map; used by screen readers. See WP:ALT.	N/A
|pushpin_background=	The background color to use for the label; see Web colors. The default is no background color, which shows the map image behind the label.	N/A
|pushpin_map_size=	Determines the width of the map in pixels, overriding any default values; do not include px.	N/A

Mapframe maps

Four Corners, Canada
Example mapframe map using geographic coordinates, using |mapframe=yes
Coordinates	60°N 102°W

• Basic {{Infobox mapframe}} parameters:
  • mapframe – Specify yes or no to show or hide the map, overriding the default. Default: no, but also modified by onByDefault
    • Internal onByDefault parameter: yes, unless any of these are present: |pushpin_map= or |image_map=
  • mapframe-coordinates or mapframe-coord or coordinates or coord – Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template, e.g. |coord={{Coord|12.34|N|56.78|E}}. Default: |coordinates=
  • mapframe-caption – Caption for the map. Default: blank (or if |mapframe-geomask= is set, "Location in geomask's label")
  • mapframe-custom – Use a custom map instead of the automatic mapframe. Specify either a {{maplink}} template, or another template that generates a mapframe map, or an image name. If used, most mapframe parameters will be ignored. Default: not specified
  • mapframe-id or id or qid – Id (Q-number) of Wikidata item to use. Default: item for current page
  • mapframe-wikidata – Set to yes to show all shape/line features from OpenStreetMap. Default: not specified
• Customise which features are displayed:
  • mapframe-point – Turn off display of point feature by setting to none. Force point marker to be displayed by setting to on. Default: not specified
  • mapframe-shape – Turn off display of shape feature by setting to none. Force display of shape by setting to on. Use an inverse shape (geomask) instead of a regular shape by setting to inverse. Default: not specified
  • mapframe-line – Turn off display of line feature by setting to none. Force display of line by setting to on. Default: not specified
  • mapframe-geomask – Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for country (P17), P131 for located in the administrative territorial entity (P131)). Default: not specified
  • mapframe-switcher – set to auto or geomasks or zooms to enable Template:Switcher-style switching between multiple mapframes. Default: not specified
    • auto – switch geomasks found in location (P276) and located in the administrative territorial entity (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country.
    • geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter
    • zooms – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of 3), "zoomed out" is 1, and "zoomed midway" is the average
• Other optional parameters:
  • mapframe-frame-width or mapframe-width – Frame width. Default: 270
  • mapframe-frame-height or mapframe-height – Frame height. Default: 200
  • mapframe-shape-fill – Color used to fill shape features. Default: #606060
  • mapframe-shape-fill-opacity – Opacity level of shape fill, a number between 0 and 1. Default: 0.1
  • mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
    • mapframe-line-stroke-color or mapframe-line-stroke-colour – Color of line features. Default: #ff0000
    • mapframe-shape-stroke-color or mapframe-shape-stroke-colour – Color of outlines of shape features. Default: #ff0000
  • mapframe-stroke-width – Width of line features, and outlines of shape features. Default: 2
    • mapframe-shape-stroke-width – Width of outlines of shape features. Default: 2
    • mapframe-line-stroke-width – Width of line features. Default: 5
  • mapframe-marker – Marker symbol to use for coordinates; see mw:Help:Extension:Kartographer/Icons for options. Default: not specified (i.e. blank)
    • Can also be set to blank to override any default marker symbol
  • mapframe-marker-color or mapframe-marker-colour – Background color for the marker. Default: #5E74F3
  • mapframe-geomask-stroke-color or mapframe-geomask-stroke-colour – Color of outline of geomask shape. Default: #555555
  • mapframe-geomask-stroke-width – Width of outline of geomask shape. Default: 1
  • mapframe-geomask-fill – Color used to fill outside geomask features. Default: #606060
  • mapframe-geomask-fill-opacity – Opacity level of fill outside geomask features, a number between 0 and 1. Default: 0.25
  • mapframe-zoom – Set the zoom level, from "1" (map of earth) to "18" (maximum zoom in), to be used if the zoom level cannot be determined automatically from object length or area. Default: 10
  • mapframe-length_km or mapframe-length_mi or mapframe-area_km2 or mapframe-area_mi2 – Determine zoom level by passing in object's length (in kilometres or miles) or area (in square kilometres or square miles). Default: not specified / not specified / not specified / not specified
  • mapframe-frame-coordinates or mapframe-frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates
  • mapframe-type – Set the type of the object, with the same usage as {{coord}}. Default: not specified
  • mapframe-population – Set the population, useful with type="city", for {{Infobox dim}}. Default: not specified

Parameters for use in articles about caves of the British Isles

Field name	Description
grid_ref_UK	If the cave is in Great Britain, the British grid reference.
grid_ref_Ireland	If the cave is in Ireland (whether Northern Ireland or the Republic), the Irish grid reference.
grid_ref	Specify a citation for the grid reference using <ref>...</ref> tags.

Example of an infobox for a cave in the British Isles

Aveline's Hole
Aveline's Hole
Location	Mendip Hills, Somerset, England
OS grid	ST 4761 5867
Depth	16 metres (52 ft)
Length	68 metres (223 ft)
Elevation	99 metres (325 ft)
Discovery	1797
Geology	Limestone
Registry	Mendip Cave Registry

{{Infobox cave
| name = Aveline's Hole
| image = Avelineshole.jpg
| 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>
}}

For other registries consider using <ref>...</ref> tags and {{cite web}}.

References

Tracking categories

• Category:Pages using infobox cave with unknown parameters (0)