>GhostInTheMachine: add remaining parameters to template data

2023-11-07T17:56:06Z

add remaining parameters to template data

New page

{{Documentation subpage}}

{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}

This template can be used to create an [[Help:Infobox|infobox]] for articles about underwater dive sites.

==Usage==
This box includes the most often used parameters.

{{Parameter names example | child | name | other_name | photo | photo_width | photo_alt | photo_caption | map = World | map_width | relief | label | label_position =| map_caption | map_alt | mark =| marker_width  | coords = {{coord|0|0}} | waterbody | nearest_land | coords_ref | dive_type | average_visibility | entry_type | bottom_composition | water | nearby_sites | embedded }}

<syntaxhighlight lang="wikitext" style="overflow: auto;">
{{Infobox dive site
| name =
| photo =
| photo_width =
| photo_caption =
| map = 
| map_width =
| map_caption =
| location =
| coords =
| coords_ref =
| waterbody =
| nearest_land =
| dive_type = 
| depth_range = 
| average_visibility = 
| entry_type = 
| bottom_composition = 
| water =
| nearby_sites =
}}</syntaxhighlight>
{{clear}}

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

{| class="wikitable" style="margin:auto; width:100%;"
! Parameter
! Description
|-
|<code>name</code>
| 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.
|-
|<code>other_name</code>
| Other names by which the dive site is known.
|-
|<code>photo</code>
| 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 [[Wikimedia Commons|Commons]] so they can be easily used by the other language Wikipedias.
|-
|<code>photo_width</code>
| 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, <code>photo_width=200</code> and not <code>photo_width=200px</code>.
|-
|<code>photo_alt</code>
| Alt text for the map. See [[WP:ALT]].
|-
|<code>photo_caption</code>
| Description of the photograph which is displayed below. Include the month and year if known.
|-
| <code>map</code> || The name of the [[Template:location map|location map]] to be displayed. See [[#Map display methods|Map display methods]]. 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 300px. 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 dive site on a map. The default image is [[:File:Red pog.svg|Red pog.svg]]. For more information, see [[Template:Location map]].
|-
|<code>marker_width</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>
| Province or state first, followed by country. For USA, the county is optional but if given, be provided before the state.
|-
|<code>coords</code><br /><code>coordinates</code>
| For the {{tl|Coord}} template.
|-
|<code>coords_ref</code>
| Strongly recommended. Specify a citation for the coordinates using {{nowrap|<code><nowiki><ref>...</ref></nowiki></code>}} tags.
|-
|<code>waterbody</code>
| 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]].
|-
|<code>nearest_land</code>
| May be nearest settlement. May not be useful for inland diving.
|-
|<code>dive_type</code>
| Generally, [[open-water diving]], [[wreck diving]], [[cave diving]], [[altitude diving]], etc. May use [[technical diving]] in lieu of a long list.
|-
|<code>depth_range</code>
| Use {{tl|convert}}, such as <code><nowiki>{{convert|60|to|120|ft|m|abbr=on}}</nowiki></code> → {{convert|60|to|120|ft|m|abbr=on}}
|-
|<code>average_visibility</code>
| Generally, what divers should expect on a typical diving day. Use {{tl|convert}}.
|-
|<code>entry_type</code>
| Shore, boat, or both
|-
|<code>bottom_composition</code>
| Rock, reef, sand, silt, etc
|-
|<code>water</code>
| Fresh or salt. May specify a [[halocline]] or [[hydrogen sulfate]] layer.
|-
|<code>nearby_sites</code>
| 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|1909|6}}, or they are part of a drift dive, e.g. Yellow Wall → Peleliu Express → Peleliu Corner
|-
|}

== Example ==

=== Blue Hole ===

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

<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{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 =
}}
</syntaxhighlight>
{{clear}}

{{clear}}

==Map display methods==
Any image file can be displayed as a map: pass the file name (without File: or Image: prefix) to {{para|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 {{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 England is [[Module:Location map/data/England|Location map/data/England]]. In this case specify {{para|map|England}}.

{{Infobox dive site
| name = The Manacles
| map = England
| map_caption = Example using geographic coordinates
| coordinates = {{coord|50.04462|N|5.04616|W|display=inline }}
}}
<syntaxhighlight lang="wikitext">
{{Infobox dive site
| name = The Manacles
| map = England
| map_caption = Example using geographic coordinates
| coordinates = {{coord|50.04462|N|5.04616|W|display=inline }}
}}</syntaxhighlight>

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

== Template Data ==

{{TemplateData header}}
{{collapse top|bg=#ccc|title=Template Data}}
<templatedata>
{
"params": {
"name": {},
"photo": {},
"photo_width": {},
"photo_caption": {},
"map": {},
"map_width": {},
"map_caption": {},
"location": {},
"coords": {},
"coords_ref": {},
"waterbody": {},
"nearest_land": {},
"dive_type": {},
"depth_range": {},
"average_visibility": {},
"entry_type": {},
"bottom_composition": {},
"water": {},
"child": {},
"other_name": {},
"photo_alt": {},
"map_size": {},
"mapsize": {},
"relief": {},
"label": {},
"label_position": {},
"map_alt": {},
"mark": {},
"marker_size": {},
"marker_width": {},
"if empty": {},
"coordinates": {},
"map_image": {},
"image_map": {},
"nearby_sites": {}
},
"format": "block"
}
</templatedata>
{{collapse bottom}}

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

<includeonly>{{sandbox other||

[[Category:Place infobox templates|Dive site]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>

Template:Infobox dive site/doc - Revision history

>GhostInTheMachine: add remaining parameters to template data