Template:Infobox body of water/doc

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.

Parameters
If missing, the article is added to Category:Articles using infobox body of water without image see also: WikiProject Lakes/Galleries If image is present and this field is empty, the article is placed in Category:Articles using infobox body of water without alt If missing, the article is placed in Category:Articles using infobox body of water without image bathymetry 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 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. Sample coordinates: If missing, the article is placed in Category:Articles using infobox body of water without coordinates For typologies of lakes, see Wikipedia_talk:WikiProject_Lakes/Archive_1 and Lake Samples values with wikimarkup (only one or a few may apply): periglacial, subglacial lake, artificial lake reservoir, endorheic, meromictic, oxbow lake, rift lake, underground lake, crater lake, intermittent lake, former lake, shrunken lake; oligotrophic, mesotropic, eutrophic lake, hypertrophic Use italics for any terms that are not place names, e.g. none If evaporation or seepage are notable outflows, they may be included. Use italics for any terms that are not place names, e.g. evaporation Sample value: Countries are listed in unwikified form, without flags. For Antarctica, use "(Antarctica)". Sample value: Sample value: Sample conversion for imperial units: this renders as: 1234 acre Sample conversion for imperial units: this renders as: 123 ft Sample value: 10 m Sample value: 11.8 km³ To convert acre-feet, use this renders as 1234567 acre.ft Sample value: Sample value: If missing, the article is placed in Category:Articles using infobox body of water without pushpin map 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
 * : name of the body of water. Avoid using templates, boldface or italics in this field.
 * :  name in that country's official language(s), if other than English. – use  or, for multiple names, use
 * : Local, alternative or former names. Separate multiple values by using or.
 * : characteristic_image.png Please avoid sunset pictures or maps (For maps, use image_bathymetry).
 * : Alt text describing the image, for visually impaired readers and other applications where the image cannot be seen.
 * : Text about the image; avoid repeating the name of the body of water, it's already in the first field of the infobox.
 * : bathymetry_image.png (or other image, avoid maps showing only the location of the body of water)
 * : Alt text for the bathymetry (or other) image.
 * : Text about the bathymetry (or other) image
 * : 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.
 * : Group of lakes that this body of water belongs to (e.g., Lake Erie is part of the Great Lakes)
 * : 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
 * : type of body of water / type of lake. If it's a reservoir, add " reservoir ".
 * : name of any parent basin or hydrology system
 * : person, event or other entity the body is named after
 * : major inflow sources — rivers, aquifers, glacial runoff, etc.
 * : outflow waterway names.
 * : 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.
 * : 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.
 * : managing or owning organisation
 * : protected status as a nature reserve, etc.
 * : date construction the body of water/reservoir started, if man-made.
 * : date the body of water/reservoir was first flooded, if man-made or otherwise recent.
 * : 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.
 * : maximum width of the body of water in km, statute mile, and/or nautical miles; perpendicular to the angle used to calculate length.
 * : 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.
 * : 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.
 * : Average depth of the body of water in metres, fathoms, and/or feet
 * : Maximum depth of the body of water in metres, fathoms, and/or feet.
 * : total volume of the body of water (cubic metres, cubic kilometres, cubic miles [cu&thinsp;mi], and/or acre-feet)
 * : 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.
 * : 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 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.
 * : 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.
 * : 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.
 * : notable cities or settlements on or near the shore of the body of water.
 * : 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.
 * : references for some or all of the values. Rather than including full references in any of the previous fields, should be used in this field and cross-referenced in the other fields with . See Help:Footnotes on how to use the tags.
 * : "align =left" allows to align the infobox left (default is right). This avoids collision with another infobox.
 * : The name of a location map as per Template:Location map. Requires coordinates in coordinates format. An existing list of map names can be found via Template:Location_map/List.
 * : references for some or all of the values. Rather than including full references in any of the previous fields, should be used in this field and cross-referenced in the other fields with . See Help:Footnotes on how to use the tags.
 * : "align =left" allows to align the infobox left (default is right). This avoids collision with another infobox.
 * : The name of a location map as per Template:Location map. Requires coordinates in coordinates format. An existing list of map names can be found via Template:Location_map/List.
 * : Location of the label to the pushpin. One of "left", "right", "top", or "bottom".
 * : Pushpin map alt text.
 * : Pushpin map caption.
 * : 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. this renders as 1234 acre

Tracking categories
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).
 * – if image is missing
 * – if image alt text is missing
 * – if bathymetry image is missing
 * – if bathymetry image is present, but bathymetry image alt text is missing
 * – if no pushpin map is present
 * – if pushpin map is present, but alt text is missing
 * – if coordinates are missing
 * – if specific fields are missing, or included, see category description
 * - if convert is not used for measurement fields
 * – if specific duplicate fields are used
 * - if an unknown parameter is present in the infobox template
 * - when shortdesc is auto-generated

TemplateData
{	"format": "\n", "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-file-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" },		"group": { "required": false, "label": "Group", "type": "string", "description": "Group of lakes that the body of water belongs to" },		"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." }	} }