Template:Divesitelisting/doc

Documentation
This template is used for implementing dive site listings.

Dive sites may be described in stand-alone articles if there is sufficient information, or as listings in regional dive guides. If you can't find a suitable dive guide article, you can create one or you can add a dive site listing in the Do section of a destination article. Someone else can move the listing to a more appropriate article later. (the template will add a maintenance category to the article to notify the janitorial staff)

We have a standardized format for dive site listings, and a template, Template:Divesitelisting, to help you format them.

Formatting listings
When listing dive site options within a regional diving article (or temporarily in a destination article), use the following format.

Here's the Wiki markup:

The fields used in this template are:


 * name : The name of the dive site. Required.
 * region :The reion in which the dive site is located. Required.
 * site-image : Image file of something characteristic of the site. To display as right aligned thumbnail. Optional
 * site-map : Image file of a map of the site. To display as right aligned thumbnail with optional size parameter. Optional
 * ecology-image : Image file of a notable animal or plant photographed at the site. To display as right aligned thumbnail. Optional
 * feature-image : Image file of a notable feature of the site. To display as right aligned thumbnail. Optional
 * alt : If the dive site has a different name in the local language, add it here. Non-Latin scripts like Japanese, Devanagari, Cyrillic etc can be used. Optional
 * location : location of the dive site relative to easily recognizable landmarks. Abbreviate "Road", "Street", "Avenue", etc.
 * directions : Additional (local) directions for how to find the dive site (if useful). Do not include directions to the (article) destination.
 * lat : Latitude. Recommended.
 * long : Longitude. Recommended.
 * locationtype : Location type - Offshore, inshore, shoreline, or inland. Recommended
 * access : Access mode - Liveaboard, day boat or shore access. Recommended
 * altitude : Altitude of the water surface above sea level. Leave out for sea dives. Recommended for high altitudes
 * maxdepth : Maximum depth of water at the dive site. Recommended
 * mindepth : Minimum depth of water at the dive site. Recommended
 * divedepth : Maximum depth of a typical dive at the site. Optional
 * visibility : Typical range of underwater visibility at the site in conditions suitable for diving. Optional
 * temperature : Typical range of water temperature at the site in conditions suitable for diving. Optional
 * type : Coral reef, Rocky reef, Wreck, Muck, Lake, Quarry, River etc. Recommended
 * topography : Geographical layout of the site. Text description. Paragraph. Optional
 * ecology : Marine/aquatic organisms likely to be seen or for which the site is known. Paragraph. Optional
 * features : Notable permanent natural or artificial features at the site. Paragraph. Optional
 * hazards : Site specific hazards (not general hazards of diving or ubiquitous in the region) Paragraph. Optional
 * equipment : Special equipment needed or strongly recommended at the site, but not in general use in the region. Paragraph. Optional
 * skills : Special skills required to dive at the site. Paragraph. Optional
 * permits : Special permits, conditions of use or taxes related to the site. Paragraph. Optional.
 * respect :
 * other : Any other information you think should be added. Paragraph. Optional

All fields above are optional except for "name". If you don't know some information, just leave that field empty, then somebody else can add those details later. Please do not delete any unused listing fields, change the name of the fields or add any extra ones. Doing so may create display irregularities and will certainly frustrate future edits and the addition of extra information to the listing.

Examples
Full listing:

...shows up like this:



Minimal listing:

...shows up like this:



Images
Images of dive sites are encouraged, provided the photo was actually taken at that site, and shows something characteristic of the site. Photos of yourself, your dive buddy or the dive leader are not appropriate unless they show something of interest to other divers who may wish to dive there. Photos of the dive shop are almost never appropriate.

Avoid long lists
If there are more than 9 dive sites listed in a regular destination article, it qualifies for a regional diving article. Consider writing one, or leave a message on the talk page suggesting that someone should write one. You can also leave a note at the Travellers' pub or on the talk page of Scuba diving.

Listing order
Alphabetical order should be the norm within each section. If another standard is used, it should be clearly stated so any new listing can be added to the appropriate place. Leading articles, such as "The", or "A", in the accommodation name should be ignored for the purposes of determining the order.

Template Data
{ "description": "Standard format listings for dive sites", "params": { "name": { "label": "Name", "description": "The name of the dive site.", "type": "string", "required": true }, "site-type": { "label": "Site type", "description": "Coral reef, Rocky reef, Sand, Wreck, Muck, Lake, Quarry, River, Cavern, Cave, Ice, Drift, Aquarium etc. As many as appropriate.", "type": "string", "required": true }, "region": { "label": "Region", "description": "Region in which the dive site is located.", "type": "string", "required": true }, "site-image": { "label": "Site image", "description": "Image file of something characteristic of the site, do not include the 'File:' part of the image file name. (To display as right aligned thumbnail.)", "type": "wiki-file-name", "required": false }, "site-image_width": { "label": "Site image width", "description": "Width to display the site image at. Should not normally be set. e.g. 320px", "type": "string", "required": false }, "site-image_alt": { "label": "Site image alt text", "description": "Alt text which describes the site image to someone who can't see it", "type": "string", "required": false }, "site-image_caption": { "label": "Site image caption", "description": "Caption displayed under the site image", "type": "string", "required": false }, "site-map": { "label": "Site map", "description": "Map of dive site. Do not include the 'File:' part of the image file name. (To display as right aligned thumbnail.)", "type": "wiki-file-name", "required": false }, "site-map_width": { "label": "Site map width", "description": "Width to display site map. Set if necessary for legibility. Should not normally be set. e.g. 320px", "type": "string", "required": false }, "site-map_alt": { "label": "Site map alt text", "description": "Alt text describing the site map", "type": "string", "required": false }, "site-map_caption": { "label": "Site map caption", "description": "Caption for the site map", "type": "string", "required": false },  "alt": { "label": "Alternative name", "description": "If the dive site has a different name in the local language, add it here. Non-Latin scripts like Japanese, Devanagari, Cyrillic etc can be used.", "type": "string", "required": false }, "location": { "label": "Site location", "description": "Location of the dive site relative to easily recognizable landmarks. Abbreviate 'Road', 'Street', 'Avenue', etc", "type": "string", "required": false }, "directions": { "label": "Directions", "description": "Additional (local) directions for how to find the dive site (if useful). Do not include directions to the (article) destination.", "type": "string", "required": false }, "lat": { "label": "Latitude", "description": "Latitude of the usual entry point. Format to suit geo-tagging.", "type": "string", "aliases": [ "latitude" ], "required": false }, "long": { "label": "Longitude", "description": "Longitude of the usual entry point. Format to suit geo-tagging.", "type": "string", "aliases": [ "longitude" ], "required": false }, "location-type": { "label": "Location type", "description": "Offshore, inshore, shoreline, or inland.", "type": "string", "required": false }, "access": { "label": "Access options", "description": "Live-aboard, day boat or shore entry.", "type": "string", "required": false }, "altitude": { "label": "Altitude", "description": "Altitude of the water surface for inland dive sites.", "type": "string", "required": false }, "max-depth": { "label": "Maximum depth", "description": "Maximum depth of water at the site", "type": "string", "required": false }, "min-depth": { "label": "Minimum depth", "description": "Minimum depth of water at the site. For shoreline dives minimum depth = 0.", "type": "string", "required": false }, "dive-depth": { "label": "Dive depth", "description": "Maximum depth usually reached during a dive at this site.", "type": "string", "required": false }, "visibility": { "label": "Visibility", "description": "Normal range of underwater visibility when conditions are suitable for diving at the site.", "type": "string", "required": false }, "temperature": { "label": "Temperature", "description": "Normal range of water temperature when conditions are suitable for diving at the site.", "type": "string", "required": false },  "topography": { "label": "Site topography", "description": "Describe the layout and profile of the bottom.", "type": "string", "required": false }, "ecology": { "label": "Ecology", "description": "Habitat and life forms likely to be seen, or for which the site is notable.", "type": "string", "required": false }, "features": { "label": "Features", "description": "Noteworthy permanent natural and artificial features at the site.", "type": "string", "required": false }, "hazards": { "label": "Site specific hazards", "description": "Hazards which are specific to this site, not necessarily the whole region and not general diving hazards.", "type": "string", "required": false }, "equipment": { "label": "Special equipment", "description": "Equipment not normally used in the region which is strongly recommended for this site.", "type": "string", "required": false }, "skills": { "label": "Skills", "description": "Skills beyond normal recreational diving level which are necessary to dive safely at this site", "type": "string", "required": false }, "permits": { "label": "Permits and fees", "description": "Permits, licences, special permission, fees or taxes payable to access this site", "type": "string", "required": false }, "respect": { "label": "Respect", "description": "Special cultural or ecological values to be considered. War graves, sacred places, fragile features or sensitive habitat etc.", "type": "string", "required": false }, "other": { "label": "Other comments", "description": "Anything else of value to someone planning to dive at the site.", "type": "string", "required": false } }}