Template:Infobox body of water/doc

{{{name}}}
{{{name}}}
{{{other_name}}}
{{{native_name}}} Error {{native name checker}}: parameter value is malformed (help)
	[[File:{{{image}}}\|264px\|alt={{{alt}}}\|border]] {{{caption}}}
	[[File:{{{image_bathymetry}}}\|256px\|alt={{{alt_bathymetry}}}\|border]] {{{caption_bathymetry}}}
Location	{{{location}}}
Group	{{{group}}}
Coordinates	{{{coordinates}}}
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 is a documentation subpage for Template:Infobox body of water.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 19,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template adds an automatically generated short description. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article.

This template uses Lua:

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

{{Infobox body of water
| name               = {{subst:PAGENAMEBASE}}
| native_name        = {{native name}} or {{native name list}}
| other_name         = 
<!--    Images     -->
| image              = 
| alt                = 
| caption            = 
| image_bathymetry   = 
| alt_bathymetry     = 
| caption_bathymetry = 
<!--    Stats      -->
| 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          = <!-- {{convert|VALUE|UNITS}} must be used -->
| 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             = <!-- {{convert|VALUE|UNITS}} must be used --> 
| width              = <!-- {{convert|VALUE|UNITS}} must be used -->
| area               = <!-- {{convert|VALUE|UNITS}} must be used -->
| depth              = <!-- {{convert|VALUE|UNITS}} must be used -->
| max-depth          = <!-- {{convert|VALUE|UNITS}} must be used -->
| volume             = <!-- {{convert|VALUE|UNITS}} must be used -->
| residence_time     = 
| salinity           = 
| shore              = <!-- {{convert|VALUE|UNITS}} must be used -->
| elevation          = <!-- {{convert|VALUE|UNITS}} must be used -->
| temperature_high   = <!-- {{convert|VALUE|UNITS}} must be used -->
| temperature_low    = <!-- {{convert|VALUE|UNITS}} must be used -->
| frozen             = 
| islands            = 
| islands_category   = 
| sections           = 
| trenches           = 
| benches            = 
| cities             = 
<!--      Map      -->
| pushpin_map             = 
| pushpin_label_position  = 
| pushpin_map_alt         = 
| pushpin_map_caption     = 
| mapframe       = <!-- "yes" to show an interactive map -->
<!--   Below       -->  
| website            = 
| reference          = 
}}

Parameters

name: name of the body of water. Avoid using templates, boldface or italics in this field.
native_name: name in that country's official language(s), if other than English. – use {{native name}} or, for multiple names, use {{native name list}}
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:Articles using infobox body of water 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.
If image is present and this field is empty, the article is placed in Category:Articles using infobox body of water without alt
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)
If missing, the article is placed in Category:Articles using infobox body of water without image bathymetry
alt_bathymetry: Alt text for the bathymetry (or other) image.
If image bathymetry is present and this field is empty, the article is placed in Category:Articles using infobox body of water without alt bathymetry
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.
group: Group of lakes that this body of water belongs to (e.g., Lake Erie is part of the Great Lakes)
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|type:waterbody_region:CH|display =inline,title}}
If missing, the article is placed in Category:Articles using infobox body of water without coordinates
type: type of body of water / type of lake. If it's a reservoir, add "[[reservoir]]".
For typologies of lakes, see Wikipedia_talk:WikiProject_Lakes/Archive_1#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 m (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×10⁹ m³)
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|abbr=on}}
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.
sections: names of sections of the lake, sub-basins, bays, etc.
trenches
benches
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. An existing list of map names can be found via Template:Location_map/List.
If missing, the article is placed in Category:Articles using infobox body of water without pushpin map
pushpin_label_position: Location of the label to the pushpin. One of "left", "right", "top", or "bottom".
pushpin_map_alt: Pushpin map alt text.
If pushpin map is present and this field is empty, the article is placed in Category:Articles using infobox body of water without pushpin map alt
pushpin_map_caption: Pushpin map caption.
module: Use to embed another infobox. See Firth of Tay for an example.

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)

Mapframe maps

Basic parameters:
- mapframe – Specify yes or no to show or hide the map, overriding the default. Default: no
- mapframe-caption – Caption for the map. Default: blank (or if |mapframe-geomask= is set, "Location in geomask's label")
- mapframe-custom – Use a custom map instead of the automatic mapframe. Specify either a {{maplink}} template, or another template that generates a mapframe map, or an image name. If used, the subsequent mapframe parameters will be ignored. Default: not specified
- mapframe-id or id or qid – Id (Q-number) of Wikidata item to use. Default: item for current page
- mapframe-coordinates or mapframe-coord or coordinates or coord – Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template, e.g. |coord={{Coord|12.34|N|56.78|E}}. Default: coordinates from Wikidata
- mapframe-wikidata – Set to yes to show shape/line features from the wikidata item, if any, when |coord= is set. Default: not specified
Customise which features are displayed:
- mapframe-shape – Turn off display of shape feature by setting to none. Use an inverse shape (geomask) instead of a regular shape by setting to inverse. Default: not specified
- mapframe-point – Turn off display of point feature by setting to none. Force point marker to be displayed by setting to on. Default: not specified
- mapframe-line – Turn off display of line feature by setting to none. Default: not specified
- mapframe-geomask – Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for country (P17), P131 for located in the administrative territorial entity (P131)). Default: not specified
- mapframe-switcher – set to auto or geomasks or zooms to enable Template:Switcher-style switching between multiple mapframes. Default: not specified
  - auto – switch geomasks found in location (P276) and located in the administrative territorial entity (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country.
  - geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter
  - zooms – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of 3), "zoomed out" is 1, and "zoomed midway" is the average
Other optional parameters:
- mapframe-frame-width or mapframe-width – Frame width. Default: 264
- mapframe-frame-height or mapframe-height – Frame height. Default: 200
- mapframe-shape-fill – Color used to fill shape features. Default: #606060
- mapframe-shape-fill-opacity – Opacity level of shape fill, a number between 0 and 1. Default: 0.5
- mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
- mapframe-stroke-width – Width of line features, and outlines of shape features; default is "5". Default: 5
- mapframe-marker – Marker symbol to use for coordinates; see mw:Help:Extension:Kartographer/Icons for options. Default: water
  - Can also be set to blank to override any default marker symbol
- mapframe-marker-color or mapframe-marker-colour – Background color for the marker. Default: #5E74F3
- mapframe-geomask-stroke-color or mapframe-geomask-stroke-colour – Color of outline of geomask shape. Default: #555555
- mapframe-geomask-stroke-width – Width of outline of geomask shape. Default: 2
- mapframe-geomask-fill – Color used to fill outside geomask features. Default: #606060
- mapframe-geomask-fill-opacity – Opacity level of fill outside geomask features, a number between 0 and 1. Default: 0.5
- mapframe-zoom – Set the zoom level, from "1" (map of earth) to "18" (maximum zoom in), to be used if the zoom level cannot be determined automatically from object length or area. Default: 10
- mapframe-length_km or mapframe-length_mi or mapframe-area_km2 or mapframe-area_mi2 – Determine zoom level by passing in object's length (in kilometres or miles) or area (in square kilometres or square miles). Default: not specified
- mapframe-frame-coordinates or mapframe-frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates

Tracking categories

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

Category:Articles using infobox body of water without image (7,460) – if image is missing
Category:Articles using infobox body of water without alt (9,224) – if image alt text is missing
Category:Articles using infobox body of water without image bathymetry (17,775) – if bathymetry image is missing
Category:Articles using infobox body of water without alt bathymetry (480) – if bathymetry image is present, but bathymetry image alt text is missing
Category:Articles using infobox body of water without pushpin map (735) – if no pushpin map is present
Category:Articles using infobox body of water without pushpin map alt (10,669) – if pushpin map is present, but alt text is missing
Category:Articles using infobox body of water without coordinates (122) – if coordinates are missing
Category:Wikipedia infobox body of water articles needing maintenance (3) – if specific fields are missing, or included, see category description
- Category:Pages using infobox body of water with a non-automatically converted dimension (15) - if {{convert}} is not used for measurement fields
- Category:Pages using infobox body of water with duplicate parameters (0) – if specific duplicate fields are used
- Category:Pages using infobox body of water with unknown parameters (0) - if an unknown parameter is present in the infobox template
Category:Pages using infobox body of water with auto short description (4,311) - when shortdesc is auto-generated

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

TemplateData

TemplateData documentation used by VisualEditor and other tools

See a monthly parameter usage report for Template:Infobox body of water in articles based on its TemplateData.

TemplateData for Infobox body of water

No description.

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Name	`name`	Name of the Body of Water.	String	required
Other Name	`other_name`	Local, Alternative or Former Names	String	optional
Image	`image`	Image of the Body of Water	File	optional
Image alternative text	`alt`	Alt text to display if the image specified by image does not display for whatever reason	String	optional
Image caption	`caption`	Caption for the image.	String	optional
Image Bathymetry	`image_bathymetry`	Bathymetry Image	Page name	optional
Alt Bathymetry	`alt_bathymetry`	Alternate text to display if image_bathymetry does not display for whatever reason	String	optional
Caption Bathymetry	`caption_bathymetry`	Image caption for image_bathymetry	String	optional
Location	`location`	Location of the Body of Water	String	optional
Group	`group`	Group of lakes that the body of water belongs to	String	optional
Coordinates	`coordinates` `coords`	Latitude and Longitude coordinates of the body of water	Number	optional
Type	`type`	Type of the Body of Water	String	optional
Etymology	`etymology`	person, event, or other entity body is named after	String	optional
Part of	`part_of`	Name of any parent basin or hydrology system	String	optional
Inflow	`inflow`	Major inflow sources — rivers, aquifers, glacial runoff, etc.	String	optional
Outflow	`outflow`	Outflow Waterway Names e.g. evaporation	String	optional
Catchment	`catchment`	The area of catchment (in square kilometres) which includes the entire area of the drainage basin for that body of water.	String	optional
Basin Countries	`basin_countries`	Which countries have drainage to/from or border the body of water.	String	optional
Date Built	`date-built`	Date of construction of the body of water/reservoir started, if man-made.	Line	optional
Date Flooded	`date-flooded`	Date of the body of water/reservoir was first flooded, if man-made or otherwise recent.	Line	optional
Agency	`agency`	Managing or owning organisation	String	optional
Length	`length`	Maximum length of the body of water in km	Number	optional
Width	`width`	Maximum width of the body of water in km	Number	optional
Area	`area`	Total area of the body of water's surface in square kilometres	Number	optional
Depth	`depth`	Average depth of the body of water in metres, fathoms, and/or feet	Number	optional
Max Depth	`max-depth`	Maximum depth of the body of water in metres, fathoms, and/or feet.	Number	optional
Volume	`volume`	Total volume of the body of water (cubic metres, cubic kilometres, cubic miles [cu mi], and/or acre-feet)	Number	optional
Residence Time	`residence_time`	Time spent by water in the body of water.	Number	optional
Shore	`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.	Number	optional
Elevation	`elevation`	Elevation above sea-level in meters.	Number	optional
Frozen	`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.	String	optional
Islands	`islands`	Total number of islands in the body of water	Number	optional
Cities	`cities`	Notable cities or settlements on or near the shore of the body of water.	Number	optional
Reference	`reference`	references for some or all of the values.	String	optional

Microformat

The HTML markup produced by this template includes an hCard microformat, which makes the place-name and location parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to an address book. Within the hCard is a Geo microformat, which additionally makes the coordinates (latitude & longitude) parsable, so that they can be, say, looked up on a map, or downloaded to a GPS unit. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

If the place or venue has "established", "founded", "opened" or similar dates, use {{start date}} for the earliest of those dates unless the date is before 1583 CE.

If it has a URL, use {{URL}}.

Please do not remove instances of these sub-templates.

Classes

hCard uses HTML classes including:

adr
agent
category
county-name
extended-address
fn
label
locality
nickname
note
org
region
street-address
uid
url
vcard

Geo is produced by calling {{coord}}, and uses HTML classes:

geo
latitude
longitude

Please do not rename or remove these classes nor collapse nested elements which use them.

Precision

When giving coordinates, please use an appropriate level of precision. Do not use {{coord}}'s |name= parameter.