Template:Infobox body of water/doc

From Omniversalis
{{{name}}}
{{{native_name}}}
{{{other_name}}}
[[File:{{{image}}}|frameless|alt={{{alt}}}|border|upright=1.14]]
{{{caption}}}
[[File:{{{image_bathymetry}}}|frameless|alt={{{alt_bathymetry}}}|border|upright=1.1]]
{{{caption_bathymetry}}}
Location {{{location}}}
Group {{{group}}}
Coordinates Template:Ifempty
Type {{{type}}}
Etymology {{{etymology}}}
Part of {{{part_of}}}
Primary inflows {{{inflow}}}
River sources {{{rivers}}}
Primary outflows {{{outflow}}}
Ocean/sea sources {{{oceans}}}
Catchment area {{{catchment}}}
Basin countries {{{basin_countries}}}
Managing agency {{{agency}}}
Designation {{{designation}}}
Built {{{date-built}}}
Construction engineer {{{engineer}}}
First flooded {{{date-flooded}}}
Max. length {{{length}}}
Max. width {{{width}}}
Surface area {{{area}}}
Average depth {{{depth}}}
Max. depth {{{max-depth}}}
Water volume {{{volume}}}
Residence time {{{residence_time}}}
Salinity {{{salinity}}}
Shore length1 {{{shore}}}
Surface elevation {{{elevation}}}
Max. temperature {{{temperature_high}}}
Min. temperature {{{temperature_low}}}
Frozen {{{frozen}}}
Islands {{{islands}}}
Sections/sub-basins {{{sections}}}
Trenches {{{trenches}}}
Benches {{{benches}}}
Settlements {{{cities}}}
Website {{{website}}}
References {{{reference}}}
1 Shore length is not a well-defined measure.

This template can be used to add comparative, at-a-glance material to articles on lakes, oceans, bays, and similar water bodies. If there is a single article for the reservoir and the dam, then please use the integrated {{infobox dam}} template, instead of this template.

Usage[edit]

{{Infobox body of water
| name               = {{subst:PAGENAMEBASE}}
| native_name        = 
| native_name_lang   = 
| other_name         = 
| image              = 
| alt                = 
| caption            = 
| image_bathymetry   = 
| alt_bathymetry     = 
| caption_bathymetry = 
| location           = 
| group              = 
| coordinates        = <!-- {{coord|DD|MM|SS|N|DD|MM|SS|W|region:ZZ_type:waterbody|display =inline,title}} -->
| type               = 
| etymology          = 
| part_of            = 
| inflow             = 
| rivers             = 
| outflow            = 
| oceans             = 
| catchment          = 
| basin_countries    = 
| agency             = 
| designation        = 
| date-built         = <!-- {{Start date|YYYY|MM|DD}} For man-made and other recent bodies of water -->
| engineer           = 
| date-flooded       = <!-- {{Start date|YYYY|MM|DD}} For man-made and other recent bodies of water -->
| length             = 
| width              = 
| area               = 
| depth              = 
| max-depth          = 
| volume             = 
| residence_time     = 
| salinity           = 
| shore              = 
| elevation          = 
| temperature_high   = 
| temperature_low    = 
| frozen             = 
| islands            = 
| islands_category   = 
| sections           = 
| trenches           = 
| benches            = 
| cities             = 
| pushpin_map             = <!-- the name of a location map as per Template:Location map. Requires coordinates= parameter to display map. -->
| pushpin_label_position  = <!-- left, right, top or bottom -->
| pushpin_map_alt         = 
| pushpin_map_caption     = 
| website            = 
| reference          = 
}}

Parameters[edit]

name
name of the body of water. Avoid using templates, boldface or italics in this field.
native_name
name in local language. If more than one, separate using {{Plain list}}
native_name_lang
ISO 639-2 code e.g. "fr" for French. If more than one, use {{lang}} instead
other_name
Local, alternative or former names. Separate multiple values by using {{plainlist}} or {{unbulleted list}}.
image
characteristic_image.png Please avoid sunset pictures or maps (For maps, use image_bathymetry).
If missing, the article is added to Category:Wikipedia infobox body of water articles without image
see also: Wikipedia:WikiProject Lakes/Galleries
alt
Alt text describing the image, for visually impaired readers and other applications where the image cannot be seen
caption
Text about the image; avoid repeating the name of the body of water, it's already in the first field of the infobox.
image_bathymetry
bathymetry_image.png (or other image, avoid maps showing only the location of the body of water)
alt_bathymetry
Alt text for the bathymetry (or other) image
caption_bathymetry
Text about the bathymetry (or other) image
location
Text about the body of water's location. Note the town/state/region in which the body water is located. Names are listed in wikified form, without flags.
Add the country only if the body of water is located in several countries or if there are several basin countries, but only one country in which the body of water is located.
coordinates
Latitude and Longitude coordinates of the body of water. It is common to use the approximate center of the body of water, or simply any notable portion of the body of water, for the coordinates. Coordinates are generally displayed in the infobox and on the top corner of the articles. For more, see WP:GEO and WP:Obtaining geographic coordinates
Sample coordinates: {{coord|47|01|10|N|8|24|04|E}}
If missing, the article is placed in Category:Wikipedia infobox body of water articles without coordinates
type
type of lake. If it's a reservoir, add "[[reservoir]]".
For typologies, see Wikipedia talk:WikiProject Lakes#Lake types and Lake#Types of lakes
Samples values with wikimarkup (only one or a few may apply): [[periglacial]], [[subglacial lake]], [[artificial lake]] [[reservoir (water)|reservoir]], [[endorheic]], [[meromictic]], [[oxbow lake]], [[rift lake]], [[underground lake]], [[crater lake]], [[intermittent lake]], [[:Category:Former lakes|former lake]], [[:Category:Shrunken lakes|shrunken lake]]; [[oligotrophic]], [[mesotropic]], [[eutrophic lake]], [[hypertrophic]]
part_of
name of any parent basin or hydrology system
etymology
person, event or other entity the body is named after
inflow
major inflow sources — rivers, aquifers, glacial runoff, etc.
Use italics for any terms that are not place names, e.g. none
outflow
outflow waterway names.
If evaporation or seepage are notable outflows, they may be included.
Use italics for any terms that are not place names, e.g. evaporation
catchment
the area of catchment (in square kilometres) which includes the entire area of the drainage basin for that body of water. This may include rivers and other bodies of water. If this can be accompanied with a map or drawing, include it with the article.
Sample value: {{convert|2124|km2|sqmi|abbr=on}}
basin_countries
which countries have drainage to/from or border the body of water. To conform a standard, this should include all countries that are directly involved with the body of water's ecology; this would include inflows, outflows, or physically contact the body of water.
Countries are listed in unwikified form, without flags. For Antarctica, use "(Antarctica)".
agency
managing or owning organisation
designation
protected status as a nature reserve, etc.
date-built
date construction the body of water/reservoir started, if man-made.
date-flooded
date the body of water/reservoir was first flooded, if man-made or otherwise recent.
length
maximum length of the body of water in km, statute mile, and/or nautical miles; the length of the body of water at its longest dimension.
Sample value: {{convert|100|km|mi|abbr=on}}
width
maximum width of the body of water in km, statute mile, and/or nautical miles; perpendicular to the angle used to calculate length.
Sample value: {{convert|50|km|mi|abbr=on}}
min_width
minimum width of the strait in km, statute mile, and/or nautical miles; perpendicular to the angle used to calculate length. Note: do not use this parameter for lakes, bays, or other bodies of water.
area
total area of the body of water's surface in square kilometres, square miles, acres, or hectares; if this value varies drastically (due to evaporation or changes in flow), attempt to find a documented average value.
Sample conversion for imperial units: {{convert|1234|acre|abbr=on}} this renders as: 1,234 acres (499 ha)
depth
Average depth of the body of water in metres, fathoms, and/or feet
Sample conversion for imperial units: {{convert|123|ft|abbr=on}} this renders as: 123 ft (37 m)
max-depth
Maximum depth of the body of water in metres, fathoms, and/or feet.
Sample value: 10 metres (33 ft)
volume
total volume of the body of water (cubic metres, cubic kilometres, cubic miles [cu mi], and/or acre-feet)
Sample value: 11.8 km³
To convert acre-feet, use {{convert|1234567|acre.ft|abbr=on}} this renders as 1,234,567 acre·ft (1.522816×109 m3)
residence_time
residence time of the body of water or lake retention time (generally in years). This is the mean time water spends in the body of water.
shore
length of the shoreline in kilometres and statute miles; this should not include values for waterways directly connected to the body of water, and should reflect the shore at average surface area.
Sample value: {{convert|75|km|mi}}
elevation
elevation above sea-level in meters; again, if this value varies due to variable inflow or outflow, attempt to use a documented average value. If at all possible, state the date at which the elevation was measured.
Sample value: {{convert|150|m|ft|abbr=on}}
islands
total number of islands in the body of water; it is common practice to also include the names of any notable islands in the body of water.
islands_category
if there is a specific category for articles about islands in the body of water, it can be added in this field (e.g., Islands of the Caspian Sea, Category:Lake islands or Category:Islands by ocean or sea). "Islands" in the infobox then links to one of these categories instead of Category:Islands by body of water.
cities
notable cities or settlements on or near the shore of the body of water.
frozen
Information about freezing: e.g. usual freezing date, months the body of water is frozen, last years the body of water was frozen, never, etc.
reference
references for some or all of the values. Rather than including full references in any of the previous fields, <ref name ="multiple"> and </ref> should be used in this field and cross-referenced in the other fields with <ref name ="multiple"/>. See Help:Footnotes on how to use the tags.
align
"align =left" allows to align the infobox left (default is right). This avoids collision with another infobox.
pushpin_map
The name of a location map as per Template:Location map. Requires coordinates in |coordinates={{coord|...}} format.
pushpin_label_position
Location of the label to the pushpin. One of "left", "right", "top", or "bottom".
pushpin_map_alt
Pushpin map alt text.
pushpin_map_caption
Pushpin map caption.

Imperial units should be converted to metric units, preferably using {{convert}}, e.g. {{convert|1234|acre|abbr=on}} this renders as 1,234 acres (499 ha)

Tracking categories[edit]

There are several tracking categories for maintenance of articles using this infobox:

The categories are hidden, i.e. they are not visible in the standard display of the articles (see WP:Hidden categories).

TemplateData[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Infobox body of water

<templatedata> { "params": { "name": { "required": true, "label": "Name", "type": "string", "description": "Name of the Body of Water." }, "other_name": { "required": false, "label": "Other Name", "type": "string", "description": "Local, Alternative or Former Names" }, "image": { "required": false, "label": "Image", "type": "wiki-page-name", "description": "Image of the Body of Water" }, "alt": { "required": false, "label": "Image alternative text", "type": "string", "description": "Alt text to display if the image specified by image does not display for whatever reason" }, "caption": { "required": false, "label": "Image caption", "type": "string", "description": "Caption for the image." }, "image_bathymetry": { "required": false, "label": "Image Bathymetry", "type": "wiki-page-name", "description": "Bathymetry Image" }, "alt_bathymetry": { "required": false, "label": "Alt Bathymetry", "type": "string", "description": "Alternate text to display if image_bathymetry does not display for whatever reason" }, "caption_bathymetry": { "required": false, "label": "Caption Bathymetry", "type": "string", "description": "Image caption for image_bathymetry" }, "location": { "required": false, "label": "Location", "type": "string", "description": "Location of the Body of Water" }, "coordinates": { "required": false, "label": "Coordinates", "type": "number", "description": "Latitude and Longitude coordinates of the body of water", "aliases": ["coords"] }, "type": { "required": false, "label": "Type", "type": "string", "description": "Type of the Body of Water" }, "etymology": { "required": false, "label": "Etymology", "type": "string", "description": "person, event, or other entity body is named after" }, "part_of": { "required": false, "label": "Part of", "type": "string", "description": "Name of any parent basin or hydrology system" }, "inflow": { "required": false, "label": "Inflow", "type": "string", "description": "Major inflow sources — rivers, aquifers, glacial runoff, etc." }, "outflow": { "required": false, "label": "Outflow", "type": "string", "description": "Outflow Waterway Names e.g. evaporation" }, "catchment": { "required": false, "label": "Catchment", "type": "string", "description": "The area of catchment (in square kilometres) which includes the entire area of the drainage basin for that body of water." }, "basin_countries": { "required": false, "label": "Basin Countries", "type": "string", "description": "Which countries have drainage to/from or border the body of water." }, "date-built": { "required": false, "label": "Date Built", "type": "line", "description": "Date of construction of the body of water/reservoir started, if man-made." }, "date-flooded": { "required": false, "label": "Date Flooded", "type": "line", "description": "Date of the body of water/reservoir was first flooded, if man-made or otherwise recent." }, "agency": { "required": false, "label": "Agency", "type": "string", "description": "Managing or owning organisation" }, "length": { "required": false, "label": "Length", "type": "number", "description": "Maximum length of the body of water in km" }, "width": { "required": false, "label": "Width", "type": "number", "description": "Maximum width of the body of water in km" }, "area": { "required": false, "label": "Area", "type": "number", "description": "Total area of the body of water's surface in square kilometres" }, "depth": { "required": false, "label": "Depth", "type": "number", "description": "Average depth of the body of water in metres, fathoms, and/or feet" }, "max-depth": { "required": false, "label": "Max Depth", "type": "number", "description": "Maximum depth of the body of water in metres, fathoms, and/or feet." }, "volume": { "required": false, "label": "Volume", "type": "number", "description": "Total volume of the body of water (cubic metres, cubic kilometres, cubic miles [cu mi], and/or acre-feet)" }, "residence_time": { "required": false, "label": "Residence Time", "type": "number", "description": "Time spent by water in the body of water." }, "shore": { "required": false, "label": "Shore", "type": "number", "description": "Length of the shoreline in kilometres and statute miles this should not include values for waterways directly connected to the body of water, and should reflect the shore at average surface area." }, "elevation": { "required": false, "label": "Elevation", "type": "number", "description": "Elevation above sea-level in meters." }, "frozen": { "required": false, "label": "Frozen", "type": "string", "description": "Information about freezing: e.g. usual freezing date, months the body of water is frozen, last years the body of water was frozen, never, etc." }, "islands": { "required": false, "label": "Islands", "type": "number", "description": "Total number of islands in the body of water" }, "cities": { "required": false, "label": "Cities", "type": "number", "description": "Notable cities or settlements on or near the shore of the body of water." }, "reference": { "required": false, "label": "Reference", "type": "string", "description": "references for some or all of the values." } }, "format": "block" } </templatedata>

Microformat[edit]

Template:UF-hcard-geo

See also[edit]