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

Usage

{{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          = 
}}

Parameters

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.

coords

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}}
Coordinates-"Type:" for a body of water is "waterbody".
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}}

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:

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:

max-depth

Maximum depth of the body of water in metres, fathoms, and/or feet.
Sample value: {{convert|10|m|ft|abbr=on}}

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

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.

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 latd= and longd= 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.

latd = |latm = |lats = |latNS =

Latitude of pushpin for pushpin_map.

longd = |longm = |longs = |longEW =

Longitude of pushpin for pushpin_map.

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

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

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

No description.

Template parameters

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	Page name	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
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 spends 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 mark up 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 an "established", "founded", "opened" or similar date, use {{start date}} 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.

See also

• List of all subpages of this page
• Template:Infobox body of water/Bookmarklet
• Template:Infobox river