Template:Infobox cave/sandbox

Four Corners, Canada
Four Corners, Canada
	Example location map using geographic coordinates
Coordinates	60°N 102°W / 60°N 102°W

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

{{{name}}}
{{{name}}}
{{{other_name}}}
	[[File:{{{photo}}}\|{{{photo_width}}}\|alt={{{photo_alt}}}]] {{{photo_caption}}}
	{{{map_caption}}}
Location	{{{location}}}
OS grid	{{{grid_ref_UK}}} Preview warning: Malformed NGR{{{grid_ref}}}
OSI/OSNI grid	{{{grid_ref_Ireland}}} Preview warning: Malformed NGR{{{grid_ref}}}
Coordinates	0°N 0°E / 0°N 0°E{{{coords_ref}}}
Depth	{{{depth}}}
Length	{{{length}}}
Height variation	{{{height_variation}}}
Elevation	{{{elevation}}}
Discovery	{{{discovery}}}
Geology	{{{geology}}}
Entrances	{{{entrance_count}}}
List of; entrances	{{{entrance_list}}}
Difficulty	{{{difficulty}}}
Hazards	{{{hazards}}}
Access	{{{access}}}
Show cave opened	{{{show_cave}}}
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}}}

This is the template sandbox page for Template:Infobox cave (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template uses Lua:

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

Usage

Basic usage

Full usage

{{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             = 
}}

{{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         = 
}}

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
}}

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.
`photo`	The name of an image file to be displayed. No special formatting is needed.
`photo_width`	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, `photo_width=200` and not `photo_width=200px`.
`photo_alt`	Alt text for the photo, for visually impaired readers. See WP:ALT.
`photo_caption`	The caption that will appear below the image if one is required.
`map`	The name of the location map to be displayed. See Map display. To use a static image, use `\|map_image=`
`map_image`	The file name of a static map image to be displayed. To use a location map, use `\|map=`.
`map_width`	Determines the width of the map. The default width is 220px and maximum width is 256px. For example, `map_width=180` and not `map_width=180px`.
`map_alt`	Alt text for the map. See WP:ALT.
`map_caption`	The caption that will appear below the map if one is required.
`relief`	Selects a relief map when assigned any value. This is functional when a location map template is used. See Map display methods.
`mark`	A marker which shows the location of the cave on a map. The default image is Red pog.svg. For more information, see Template:Location map.
`marker_size`	The width of the location marker image in pixels. Seldom used. The default width is 8px.
`label_position`	This seldom used parameter will generate a text label next to the a location marker. Valid values are `left`, `right`, `top` and `bottom`. If no value is assigned to the `label` parameter below, the `name` will be used.
`label`	Text that will be displayed next to the location marker. See `label_position` above.
`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.
`coords` `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.
`coords_ref` `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.
`entrance_count`	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`	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` `register`	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.

Map images

Any image file can be displayed as a map: pass the file name (without File: or Image: prefix) to |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 {{Coord}} template inside the |coordinates= parameter. See the documentation for {{Location map}}. The parameters for this template map to a subset of the parameters used by {{Location map}}. A map template can be found using these sources:

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 Location map/data/Canada. In this case specify |map=Canada.

{{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 --> }}
}}

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

Mapframe maps

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

Basic parameters:
- mapframe – Specify yes or no to show or hide the map, overriding the default. Default: no
- 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, the subsequent 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-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 from Wikidata
- mapframe-wikidata – Set to yes to show shape/line features from the wikidata item, if any, when |coord= is set. Default: not specified
Customise which features are displayed:
- mapframe-shape – Turn off display of shape feature by setting to none. Use an inverse shape (geomask) instead of a regular shape by setting to inverse. Default: not specified
- 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-line – Turn off display of line feature by setting to none. 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.5
- mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
- mapframe-stroke-width – Width of line features, and outlines of shape features; default is "5". 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: 2
- 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.5
- 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
- mapframe-frame-coordinates or mapframe-frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates

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^[1]

{{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>
}}

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

References

^ "Aveline's Hole". Mendip Cave Registry & Archive. Retrieved 2012-03-30.

Tracking category

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

The above documentation is transcluded from Template:Infobox cave/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

[1] "Aveline's Hole". Mendip Cave Registry & Archive. Retrieved 2012-03-30.

[1]