Template:Infobox dive site/doc

From Wikipedia, the free encyclopedia

This template can be used to create an infobox for articles about underwater dive sites.

Usage[edit]

This box includes the most often used parameters.

{{{name}}}
{{{other_name}}}
[[File:{{{photo}}}|{{{photo_width}}}|alt={{{photo_alt}}}]]
{{{photo_caption}}}
{{{map_alt}}}
{{{map_alt}}}
{{{map_caption}}}
Waterbody{{{waterbody}}}
Nearest land{{{nearest_land}}}
Coordinates0°N 0°E / 0°N 0°E / 0; 0{{{coords_ref}}}
Dive type{{{dive_type}}}
Average visibility{{{average_visibility}}}
Entry type{{{entry_type}}}
Bottom composition{{{bottom_composition}}}
Water{{{water}}}
Nearby sites{{{nearby_sites}}}
{{Infobox dive site
| name                = 
| photo               = 
| photo_width         = 
| photo_caption       = 
| map                 = <!-- See [[Template:Location map]] -->
| map_width           = 
| map_caption         = 
| location            = 
| coords              = 
| coords_ref          = 
| waterbody           = 
| nearest_land        = 
| dive_type           = <!-- For example, [[Open-water diving|Open-water]], [[Wreck diving|Wreck]], [[Altitude diving|Altitude]], etc -->
| depth_range	      = <!-- For example, {{convert|10|to|100|ft|m|abbr=on}} -->
| average_visibility  = <!-- For example, {{convert|20|m|ft|abbr=on}} -->
| entry_type          = <!-- Boat or shore -->
| bottom_composition  = <!-- Rock, coral, sand, silt -->
| water               = 
| nearby_sites        = 
}}

Parameter descriptions[edit]

This table describes all the parameters available. Many are seldom used and a functional infobox can be created using the parameters listed above.

Parameter Description
name Name of the site, the article is may be disambiguated but this name in the infobox should be the undisambiguated name. For example, Blue Hole for Blue Hole (Red Sea). This field is required.
other_name Other names by which the dive site is known.
photo Photograph of the site. Preferably an underwater shot, visibility allowing, showing its signature feature. Do not include the "Image:" prefix. If uploading a new image, please put them on Commons so they can be easily used by the other language Wikipedias.
photo_width Determines the width of the photograph. The default and maximum value is 300px. 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 map. See WP:ALT.
photo_caption Description of the photograph which is displayed below. Include the month and year if known.
map The name of the location map to be displayed. See Map display methods. 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 300px. 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 dive site on a map. The default image is Red pog.svg. For more information, see Template:Location map.
marker_width 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 Province or state first, followed by country. For USA, the county is optional but if given, be provided before the state.
coords
coordinates
For the {{Coord}} template.
coords_ref Strongly recommended. Specify a citation for the coordinates using <ref>...</ref> tags.
waterbody Name of the body of water the site is located in. Example: Bay of Biscayne. May be a reef structure, e.g. Lighthouse Reef. Use most specific name, not e.g. Atlantic Ocean.
nearest_land May be nearest settlement. May not be useful for inland diving.
dive_type Generally, open-water diving, wreck diving, cave diving, altitude diving, etc. May use technical diving in lieu of a long list.
depth_range Use {{convert}}, such as {{convert|60|to|120|ft|m|abbr=on}} → 60 to 120 ft (18 to 37 m)
average_visibility Generally, what divers should expect on a typical diving day. Use {{convert}}.
entry_type Shore, boat, or both
bottom_composition Rock, reef, sand, silt, etc
water Fresh or salt. May specify a halocline or hydrogen sulfate layer.
nearby_sites Nearby dive sites at least sometimes combined with this one as a single dive because they are close, e.g. Tokai Maru and SMS Cormoran, or they are part of a drift dive, e.g. Yellow Wall → Peleliu Express → Peleliu Corner

Example[edit]

Blue Hole[edit]

Blue Hole
Divers approaching the entry to Blue Hole
LocationGuam, USA
WaterbodyAgat Bay
Nearest landOrote Peninsula
Coordinates13°26′24″N 144°37′08″E / 13.4400°N 144.6190°E / 13.4400; 144.6190
Dive typeOpen-water
Depth range60 to 300 ft (18 to 91 m)
Average visibility100 ft (30 m)
Entry typeBoat
Bottom compositionRock
WaterSalt
{{Infobox dive site
| name = Blue Hole
| photo = SCUBA divers approaching a sinkhole on a Guamanian reef (reef317083434).jpg
| photo_caption = Divers approaching the entry to Blue Hole 
| location = [[Guam]], [[United States|USA]]
| other_name = 
| coords = {{coord|13.4400|N|144.6190|E|type:landmark_region:USA_Guam}}
| waterbody = [[Agat Bay]]
| nearest_land = [[Orote Peninsula]]
| dive_type = [[Open-water diving|Open-water]]
| depth_range = {{convert|60|to|300|ft|m|abbr=on}}
| average_visibility = {{convert|100|ft|m|abbr=on}}
| entry_type= Boat
| bottom_composition = Rock
| water = Salt
| nearby_sites = 
}}

Map display methods[edit]

Any image file can be displayed as a map: pass the file name (without File: or Image: prefix) to |map=.

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

The Manacles
Map showing the location of The Manacles
Map showing the location of The Manacles
Example using geographic coordinates
Coordinates50°02′41″N 5°02′46″W / 50.04462°N 5.04616°W / 50.04462; -5.04616
{{Infobox dive site
| name = The Manacles
| map = England
| map_caption = Example using geographic coordinates
| coordinates = {{coord|50.04462|N|5.04616|W|display=inline }}
}}

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.

Template Data[edit]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Infobox dive site in articles based on its TemplateData.

TemplateData for Infobox dive site

Template Data

No description.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
namename

no description

Unknownoptional
photophoto

no description

Unknownoptional
photo_widthphoto_width

no description

Unknownoptional
photo_captionphoto_caption

no description

Unknownoptional
mapmap

no description

Unknownoptional
map_widthmap_width

no description

Unknownoptional
map_captionmap_caption

no description

Unknownoptional
locationlocation

no description

Unknownoptional
coordscoords

no description

Unknownoptional
coords_refcoords_ref

no description

Unknownoptional
waterbodywaterbody

no description

Unknownoptional
nearest_landnearest_land

no description

Unknownoptional
dive_typedive_type

no description

Unknownoptional
depth_rangedepth_range

no description

Unknownoptional
average_visibilityaverage_visibility

no description

Unknownoptional
entry_typeentry_type

no description

Unknownoptional
bottom_compositionbottom_composition

no description

Unknownoptional
waterwater

no description

Unknownoptional
childchild

no description

Unknownoptional
other_nameother_name

no description

Unknownoptional
photo_altphoto_alt

no description

Unknownoptional
map_sizemap_size

no description

Unknownoptional
mapsizemapsize

no description

Unknownoptional
reliefrelief

no description

Unknownoptional
labellabel

no description

Unknownoptional
label_positionlabel_position

no description

Unknownoptional
map_altmap_alt

no description

Unknownoptional
markmark

no description

Unknownoptional
marker_sizemarker_size

no description

Unknownoptional
marker_widthmarker_width

no description

Unknownoptional
if emptyif empty

no description

Unknownoptional
coordinatescoordinates

no description

Unknownoptional
map_imagemap_image

no description

Unknownoptional
image_mapimage_map

no description

Unknownoptional
nearby_sitesnearby_sites

no description

Unknownoptional

Tracking category[edit]