Jump to content

Template:Infobox cave/doc: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
tweaked the ambox
added draft of parameter descriptions
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

{{ambox
| type = content
| text = This template has been revised. This documentation is functional but incomplete. It will be updated soon. The old parameter names are [[deprecation|deprecated]] but will continue to function for the time being. Currently, they are not used in any articles.
}}



This template can be used to create an [[Help:Infobox|infobox]] for articles about [[cave]]s.
This template can be used to create an [[Help:Infobox|infobox]] for articles about [[cave]]s.
Line 75: Line 69:
}}</pre>
}}</pre>


== Parameter descriptions ==
{{ambox
| type = notice
| text = This section represents a rough draft and may lack clarity. Additional sections need to be added.
}}


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>''' || Can be used to change the display width 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 map to be displayed. See [[#Map display methods|Map display methods]].
|-
|'''<code>map_width</code>''' || Can be used change the display 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 appears below the map if one is required.
|-
|'''<code>relief</code>''' || Selects a relief map when assigned any value. This is not functional when using the XY method for map display. See [[#Map display methods|Map display methods]].
|-
|'''<code>mark</code>''' || A mark which marks which shows the location of the cave on a map. The default image is [[:File:Red pog.svg|Red pog.svg]]. For more information, go [[Template:Infobox_map#Marks|here]].
|-
|'''<code>marker_size</code>''' || The width of the marker image in pixels. The default width is 8px.
|-
|'''<code>label_position</code>''' || This seldom used parameter will generate a text label next to the map location mark. 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 value assigned to <code>name</code> will be used.
|-
|'''<code>label</code>''' || A text message that will be displayed next to the 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.
|-
|'''<code>coords</code>''' || For the {{tl|Coord}} template. This syntax will not generated a location mark on a map. When this option is used the <code>type</code>, <code>region</code>, <code>scale</code>, <code>source</code>, <code>format</code> and <code>display</code> parameters are not functional but this data can be entered in the {{tlc|Coord}} template. The defaults should be <code>type:landmark</code> and <code>display:inline,title</code>.
|-
|'''<code>lat_d</code>''' || The degrees of latitude. This value can be specified as a [[Decimal degrees|decimal degree]] and when this format is used minutes and seconds should not be specified.
|-
|'''<code>lat_m</code>''' || The minutes of latitude.
|-
|'''<code>lat_s</code>''' || The seconds of latitude.
|-
|'''<code>lat_NS</code>''' || N if north of the equator, S if south of the equator. Other values will be disregarded.
|-
|'''<code>long_d</code>''' || The degrees of longitude. This value can be specified as a [[Decimal degrees|decimal degree]] and when this format is used minutes and seconds should not be specified.
|-
|'''<code>long_m</code>''' || The minutes of longitude.
|-
|'''<code>long_s</code>''' || The seconds of longitude.
|-
|'''<code>long_EW</code>''' || E if East of the [[prime meridian]], W if west of the prime meridian. Other values will be disregarded.
|-
|'''<code>coords_ref</code>''' || Can be 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>type</code>''' || Type is one way to specify the scale of maps generated by external map websites. See [[WP:COORD TYPE]] for valid values. The default value is <code>landmark</code> which is most appropriat for caves. This parameter and the three below help [[tswiki:GeoHack|GeoHack]] in selecting suitable map resources.
|-
|'''<code>scale</code>''' || Determines the zoom factor for external map websites. See [[WP:COORD SCALE]]. The value is 1:10,000 for the default type which is <code>landmark</code>. Using <code>scale=50000</code> will change the zoom to 1:50,000.
|-
|'''<code>region</code>''' || A country code. See [[ISO 3166-2:US]], [[ISO 3166-2]] and [[ISO 3166-1 alpha-2]]. For example US-OR is the code for Oregon. This computer readable code is recommended and will . It will not be displayed. See [[WP:COORD REGION]].
|-
|'''<code>source</code>''' || Source of the coordinate data. See [[WP:COORD SOURCE]]. For example [[Geographic Names Information System|GNIS]] or [[U.S. National Geodetic Survey|NGS]], etc. It will not be displayed. Not all possible values are recognized.
|-
|'''<code>format</code>''' || Determines the format of the coordinates displayed. Valid values are <code>dms</code> for degrees, minutes and seconds, and <code>dec</code> for [[decimal degrees]]. The default value is <code>dms</code>.
|-
|'''<code>display</code>''' || Determines where the coordinates will be displayed. Valid values are <code>inline</code> and <code>inline,title</code>. The default is <code>inline,title</code> and is recommended.
|-
|'''<code>x</code><br/><code>y</code>''' || Specifies the position of a location mark on map images when the XY method for map display is used. These are the <code>x,y</code> coordinates for the marker in pixels based on a map width of 1000 pixels. The template will scale these values for proper display.
|-
|'''<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>altitude</code>''' || The elevation of the cave entrance.
|-
|'''<code>discovery</code>''' || The date the cave was discovered and who discovered it.
|-
|'''<code>geology</code>''' || Is the cave in [[limestone]], [[marble]], [[dolomite]], [[shale]], [[conglomerate (geology)|conglomerate]] or [[basalt]], ...? Is it a [[sea cave]], [[lava tube]], or [[karst]] cave. See [[Cave]].
|-
|'''<code>entrance_count</code>''' || The number of entrances.
|-
|'''<code>entrance_list</code>''' || A list of entrances.
|-
|'''<code>difficulty</code>''' || The skill level required to visit 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? 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>''' || How is the cave illuminated.
|-
|'''<code>visitors</code>''' || The number of visitors in a recent year if known.
|-
|'''<code>features</code>''' || What features are found in the cave. Are there [[speleogen]]s of interest such as [[boxwork]], [[calcite]] crystals, [[helictite]]s, etc.
|-
|'''<code>survey</code>''' || When was the [[cave survey]]ed and who did the survey.
|-
|'''<code>survey_format</code>''' || If a [[Cave survey#Surveying software|software]] package was use which one was it.
|}

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


{| class="wikitable" style="width: 97%;"
The parameters <tt>translation</tt>, <tt>language</tt> and <tt>pronunciation</tt> are [[deprecation|deprecated]]. This information should be included in the body of the article.
! 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 mountain 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>''' || Can be used with either grid reference system above. Strongly recommended. Specify a citation for the grid reference using {{nowrap|'''<code><nowiki><ref>...</ref></nowiki></code>}} tags.
|-
|'''<code>register</code>''' || The the name of a cave registry such as the [[Mendip Cave Registry and Archive]] or the [http://www.cambriancavingcouncil.org.uk/ Cambrian Cave Registry].
|-
|'''<code>register_id</code>''' ||
<!--
|-
|'''<code>bcra_grade</code>''' ||
-->
|}


==Example of a cave in the British Isles==
===Example of a cave in the British Isles===
{{Infobox cave
{{Infobox cave
| name = Aveline's Hole
| name = Aveline's Hole

Revision as of 20:18, 28 March 2012

This template can be used to create an infobox for articles about caves.

Usage

Minnetonka Cave
Minnetonka Cave, administered by the U.S. Forest Service
Lua error in Module:Location_map at line 526: Unable to find the specified location map definition: "Module:Location map/data/USA relief" does not exist.
LocationBear Lake County, Idaho, United States
Discovery1907
GeologyKarst cavern, Mississippian Limestone
Entrances1
AccessTours are available in season

This is a table of the most used parameter names.

{{Infobox cave
| name = 
| other_name = 
| photo = 
| photo_width = 
| photo_caption = 
| map = 
| map_width = 
| map_caption = 
| map_alt = 
| location = 
| coords = 
| lat_d = | lat_m = |lat_s | lat_NS = 
| long_d = | long_m = | long_s = | long_EW = 
| coords_ref = 
| grid_ref_UK = 
| grid_ref_Ireland = 
| grid_ref = 
| depth = 
| length = 
| altitude = 
| discovery = 
| geology = 
| entrance_count = 
| entrance_list = 
| difficulty = 
| hazards = 
| access = 
| show_cave = 
| show_cave_length = 
| lighting = 
| visitors = 
| features = 
| survey = 
| survey_format = 
| website = 
}}

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 Can be used to change the display width 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 map to be displayed. See Map display methods.
map_width Can be used change the display 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 appears below the map if one is required.
relief Selects a relief map when assigned any value. This is not functional when using the XY method for map display. See Map display methods.
mark A mark which marks which shows the location of the cave on a map. The default image is Red pog.svg. For more information, go here.
marker_size The width of the marker image in pixels. The default width is 8px.
label_position This seldom used parameter will generate a text label next to the map location mark. Valid values are left, right, top and bottom. If no value is assigned to the label parameter below, the value assigned to name will be used.
label A text message that will be displayed next to the 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.
coords For the {{Coord}} template. This syntax will not generated a location mark on a map. When this option is used the type, region, scale, source, format and display parameters are not functional but this data can be entered in the {{Coord}} template. The defaults should be type:landmark and display:inline,title.
lat_d The degrees of latitude. This value can be specified as a decimal degree and when this format is used minutes and seconds should not be specified.
lat_m The minutes of latitude.
lat_s The seconds of latitude.
lat_NS N if north of the equator, S if south of the equator. Other values will be disregarded.
long_d The degrees of longitude. This value can be specified as a decimal degree and when this format is used minutes and seconds should not be specified.
long_m The minutes of longitude.
long_s The seconds of longitude.
long_EW E if East of the prime meridian, W if west of the prime meridian. Other values will be disregarded.
coords_ref Can be used with either coordinate display method above. Strongly recommended. Specify a citation for the coordinates using <ref>...</ref> tags.
type Type is one way to specify the scale of maps generated by external map websites. See WP:COORD TYPE for valid values. The default value is landmark which is most appropriat for caves. This parameter and the three below help GeoHack in selecting suitable map resources.
scale Determines the zoom factor for external map websites. See WP:COORD SCALE. The value is 1:10,000 for the default type which is landmark. Using scale=50000 will change the zoom to 1:50,000.
region A country code. See ISO 3166-2:US, ISO 3166-2 and ISO 3166-1 alpha-2. For example US-OR is the code for Oregon. This computer readable code is recommended and will . It will not be displayed. See WP:COORD REGION.
source Source of the coordinate data. See WP:COORD SOURCE. For example GNIS or NGS, etc. It will not be displayed. Not all possible values are recognized.
format Determines the format of the coordinates displayed. Valid values are dms for degrees, minutes and seconds, and dec for decimal degrees. The default value is dms.
display Determines where the coordinates will be displayed. Valid values are inline and inline,title. The default is inline,title and is recommended.
x
y
Specifies the position of a location mark on map images when the XY method for map display is used. These are the x,y coordinates for the marker in pixels based on a map width of 1000 pixels. The template will scale these values for proper display.
depth The distance from the surface to the deepest portion of the cave.
length The surveyed length of the cave.
altitude The elevation of the cave entrance.
discovery The date the cave was discovered and who discovered it.
geology Is the cave in limestone, marble, dolomite, shale, conglomerate or basalt, ...? Is it a sea cave, lava tube, or karst cave. See Cave.
entrance_count The number of entrances.
entrance_list A list of entrances.
difficulty The skill level required to visit 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? 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 How is the cave illuminated.
visitors The number of visitors in a recent year if known.
features What features are found in the cave. Are there speleogens of interest such as boxwork, calcite crystals, helictites, etc.
survey When was the cave surveyed and who did the survey.
survey_format If a software package was use which one was it.

Parameters intended for use in articles about caves in 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 mountain is in Ireland (whether Northern Ireland or the Republic), the Irish grid reference.
grid_ref Can be used with either grid reference system above. Strongly recommended. Specify a citation for the grid reference using <ref>...</ref> tags.
register The the name of a cave registry such as the Mendip Cave Registry and Archive or the Cambrian Cave Registry.
register_id

Example of a cave in the British Isles

Aveline's Hole
Aveline's Hole
LocationBurrington Combe
OS gridST 4761 5867
Depth16 metres (52 ft)
Length68 metres (223 ft)
Discovery1797
GeologyLimestone
Registrymcra
{{Infobox cave
| name = Aveline's Hole
| photo = Avelineshole.jpg
| photo_caption = Aveline's Hole
| location = [[Burrington Combe]]
| grid_ref_UK = ST 4761 5867
| depth = {{convert|16|m}}
| length = {{convert|68|m}}
| altitude = {{convert|99|m}}
| discovery = 1797
| geology = Limestone
| difficulty = 
| hazards = 
| access = 
| register = mcra
| register_id = 3
}}