View source for Template:Infobox body of water/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
{{Infobox body of water
| name               = name text
| native_name        = local name
| native_name_lang   = 
| other_name         = past or alternative names
| image              = No image.png
| alt                = Image alt text
| caption            = Image caption text
| image_bathymetry   = No image.png
| alt_bathymetry     = Bathymetry alt text
| caption_bathymetry = Bathymetry caption text
| location           = location text
| group              = group text
| coords             = coordinates in {{Tl|coord}} template format
| type               = type of lake or ocean text
| etymology          = person, event or entity named after
| part_of            = part of text
| inflow             = inflow river text
| rivers             = text
| outflow            = outflow river text
| oceans             = text
| catchment          = catchment area text
| basin_countries    = country text
| agency             = managing or owning organisation
| designation        = protection as a nature reserve, etc.
| date-built         = date built (for reservoirs; use {{Tl|Start date}})
| engineer           = text
| date-flooded       = date first flooded (for reservoirs; use {{Tl|Start date}})
| length             = length text
| width              = width text
| area               = area text
| depth              = depth text
| max-depth          = max depth text
| volume             = volume text
| residence_time     = residence time of water
| salinity           = text
| shore              = length of the shoreline
| elevation          = elevation text
| frozen             = frozen text
| islands            = islands text
| sections           = sections text
| trenches           = trenches text
| benches            = benches text
| cities             = settlement text
| website            = website
| reference          = reference text
}}

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, please use instead of this template the integrated dam infobox template ([[:template:Infobox dam]]). 

== Usage ==
<pre style="overflow:auto;">
{{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              = 
| coords             = <!-- {{coord|DD|MM|SS|N|DD|MM|SS|W|region:ZZ_type:waterbody|display =inline,title}} -->
| type               = 
| part_of            = 
| etymology          = 
| inflow             = 
| rivers             = 
| outflow            = 
| oceans             = 
| catchment          = 
| catchment_ref      =
| 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             = 
| length_ref         = 
| width              = 
| width_ref          = 
| area               = 
| area_ref           = 
| depth              = 
| depth_ref          = 
| max-depth          = 
| max-depth_ref      = 
| volume             = 
| volume_ref         = 
| residence_time     = 
| salinity           = 
| shore              = 
| shore_ref          = 
| elevation          = 
| elevation_ref      = 
| frozen             = 
| islands            = 
| sections           = 
| trenches           = 
| benches            = 
| cities             = 
| pushpin_map             = <!-- the name of a location map as per Template:Location map. Requires coordinates in latd= and longd= format -->
| pushpin_label_position  = <!-- left, right, top or bottom -->
| pushpin_map_alt         = 
| pushpin_map_caption     = 
| latd  =  |latm  =  |lats  =  |latNS  = <!-- N or S -->
| longd =  |longm =  |longs =  |longEW = <!-- E or W -->
| website            = 
| reference          = 
}}
</pre>

== Parameters ==

; <code>name</code>: name of the body of water. Avoid using templates, boldface or italics in this field.
; <code>native_name</code>: name in local language. If more than one, separate using {{tl|Plain list}}
; <code>native_name_lang</code>: ISO 639-2 code e.g. "fr" for French. If more than one, use {{tl|lang}} instead
; <code>other_name</code>: Local, alternative or former names. Separate multiple values by using {{tlx|plainlist}} or {{tlx|unbulleted list}}.
; <code>image</code>: characteristic_image.png Please avoid sunset pictures or maps (For maps, use image_bathymetry). <br>If missing, the article is added to [[:Category:Wikipedia infobox body of water articles without image]]<br> ''see also:'' [[Wikipedia:WikiProject Lakes/Galleries]]
; <code>alt</code>: [[WP:ALT|Alt text]] describing the image, for visually impaired readers and other applications where the image cannot be seen
; <code>caption</code>: Text about the image; avoid repeating the name of the body of water, it's already in the first field of the infobox.
; <code>image_bathymetry</code>: bathymetry_image.png (or other image, avoid maps showing only the location of the body of water)
; <code>alt_bathymetry</code>: Alt text for the bathymetry (or other) image
; <code>caption_bathymetry</code>: Text about the [[bathymetry]] (or other) image
; <code>location</code>: 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. <br>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.
; <code>coords</code>: 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]]<br>Sample coordinates: <nowiki>{{coord|47|01|10|N|8|24|04|E|type:waterbody_region:CH|display =inline,title}}</nowiki><br>[[WP:GEO#type:T|Coordinates-"Type:"]] for a body of water is "waterbody".<br>If missing, the article is placed in [[:Category:Wikipedia infobox body of water articles without coordinates]]
; <code>type</code>: type of lake. If it's a reservoir, add "<nowiki>[[reservoir]]</nowiki>". <br> For typologies, see [[Wikipedia_talk:WikiProject_Lakes#Lake_types]] and [[Lake#Types_of_lakes]]<br> Samples values with wikimarkup (only one or a few may apply): <nowiki> [[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]]</nowiki>
; <code>part_of</code>: name of any parent basin or hydrology system
; <code>etymology</code>: person, event or other entity the body is named after
; <code>inflow</code>: major inflow sources&nbsp;— rivers, aquifers, glacial runoff, etc. <br>Use italics for any terms that are not place names, e.g. ''none''
; <code>outflow</code>: outflow waterway names.  <br> If [[evaporation]] or [[seepage]] are notable outflows, they may be included. <br>Use italics for any terms that are not place names, e.g. ''evaporation''
; <code>catchment</code>: 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.<br>Sample value: <nowiki>{{convert|2124|km2|sqmi|abbr=on}}</nowiki>
; <code>basin_countries</code>: 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.<br>Countries are listed in unwikified form, without flags. For Antarctica, use "(Antarctica)".
; <code>agency</code>: managing or owning organisation
; <code>designation</code>: protected status as a nature reserve, etc.
; <code>date-built</code>: date construction the body of water/reservoir started, if man-made.
; <code>date-flooded</code>: date the body of water/reservoir was first flooded, if man-made or otherwise recent.
; <code>length</code>: 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.<br>Sample value: <nowiki>{{convert|100|km|mi|abbr=on}}</nowiki>
; <code>width</code>: maximum width of the body of water in km, statute mile, and/or nautical miles; perpendicular to the angle used to calculate ''length''.<br>Sample value: <nowiki>{{convert|50|km|mi|abbr=on}}</nowiki>
; <code>area</code>: 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. <br>Sample conversion for imperial units: <nowiki>{{convert|1234|acre|abbr=on}}</nowiki> this renders as: {{convert|1234|acre|abbr=on}}
; <code>depth</code>: Average depth of the body of water in metres, fathoms, and/or feet<br>Sample conversion for imperial units: <nowiki>{{convert|123|ft|abbr=on}}</nowiki> this renders as: {{convert|123|ft|abbr=on}}
; <code>max-depth</code>: Maximum depth of the body of water in metres, fathoms, and/or feet.<br>Sample value: <nowiki>{{convert|10|m|ft|abbr=on}}</nowiki>
; <code>volume</code>: total volume of the body of water (cubic metres, cubic kilometres, cubic miles [cu&thinsp;mi], and/or acre-feet)<br>Sample value: 11.8 km³<br>To convert acre-feet, use <nowiki>{{convert|1234567|acre.ft|abbr=on}}</nowiki> this renders as {{convert|1234567|acre.ft|abbr=on}}
; <code>residence_time</code>: [[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.
; <code>shore</code>: 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.<br>Sample value: <nowiki>{{convert|75|km|mi|abbr=on}}</nowiki>
; <code>elevation</code>: 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.<br>Sample value: <nowiki>{{convert|150|m|ft|abbr=on}}</nowiki>
; <code>islands</code>: 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.
; <code>islands_category</code>: if there is a specific category for articles about islands in the body of water, it can be added in this field (e.g., [[:Category:Islands of the Caspian Sea|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]].
; <code>cities</code>: notable cities or settlements on or near the shore of the body of water.
; <code>frozen</code>: 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.
; <code>reference</code>: references for some or all of the values. Rather than including full references in any of the previous fields, <nowiki><ref name ="multiple"> and </ref></nowiki> should be used in this field and cross-referenced in the other fields with <nowiki><ref name ="multiple"/></nowiki>. See [[Help:Footnotes]] on how to use the tags.
; <code>align</code>: "align =left" allows to align the infobox left (default is right). This avoids collision with another infobox.
; <code>pushpin_map</code>: The name of a location map as per [[:Template:Location map]]. Requires coordinates in latd= and longd= format.
; <code>pushpin_label_position</code>: Location of the label to the pushpin. One of "left", "right", "top", or "bottom".
; <code>pushpin_map_alt</code>: Pushpin map alt text.
; <code>pushpin_map_caption</code>: Pushpin map caption.
; <code>latd  =  |latm  =  |lats  =  |latNS  = </code>: Latitude of pushpin for <code>pushpin_map</code>.
; <code>longd =  |longm =  |longs =  |longEW = </code>: Longitude of pushpin for <code>pushpin_map</code>.

Imperial units should be converted to metric units, preferably using {{tl|convert}}, e.g. <nowiki>{{convert|1234|acre|abbr=on}}</nowiki> this renders as {{convert|1234|acre|abbr=on}}

== Maintenance categories ==

The infobox has several maintenance categories connected to it:
* [[:Category:Wikipedia infobox body of water articles without image]] (if image is missing)
* [[:Category:Wikipedia infobox body of water articles without coordinates]] (if coords is missing)
* [[:Category:Wikipedia infobox body of water articles using duplicate parameters]] (if specific duplicate fields are used)
* [[:Category:Wikipedia infobox body of water articles using deprecated parameters]] (if purely numeric values are used with non-numeric fields)
* [[:Category:Wikipedia infobox body of water articles needing maintenance]] (if specific fields are missing, or included, see category description)

The categories are hidden, i.e. the aren't visible in the standard display of the articles (see [[WP:Hidden_categories]]).

==TemplateData==

{{TemplateDataHeader}}
<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"
		},
		"coords": {
			"required": false,
			"label": "Coordinates",
			"type": "number",
			"description": "Latitude and Longitude coordinates of the body of water"
		},
		"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 spends 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."
		}
	}
}
</templatedata>

== Microformat ==
{{UF-hcard-geo}}

== See also ==
* List of {{subpages|page=Template:{{BASEPAGENAME}}}}
* [[Template:Infobox body of water/Bookmarklet]]
* [[Template:Infobox river]]

<includeonly>
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Lake templates| ]]
[[Category:Geography infobox templates|Body Of Water]]
[[Category:WikiProject Oceans|Infobox Body Of Water]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>