Template:Infobox body of water/doc

From IxWiki
Jump to navigation Jump to search

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

{{{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{{{coordinates}}}
Type{{{type}}}
Native name[{{{native_name}}}] Error: {{Native name}}: unrecognized language tag: {{{native_name_lang}}} (help)  (language?)
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.
{{Infobox body of water
| name               = {{subst:PAGENAMEBASE}}
| native_name        = 
| native_name_lang   = 
| 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     = 
<!--   Below       -->  
| 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: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×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|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
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.

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

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

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.

ParameterDescriptionTypeStatus
Namename

Name of the Body of Water.

Stringrequired
Other Nameother_name

Local, Alternative or Former Names

Stringoptional
Imageimage

Image of the Body of Water

Page nameoptional
Image alternative textalt

Alt text to display if the image specified by image does not display for whatever reason

Stringoptional
Image captioncaption

Caption for the image.

Stringoptional
Image Bathymetryimage_bathymetry

Bathymetry Image

Page nameoptional
Alt Bathymetryalt_bathymetry

Alternate text to display if image_bathymetry does not display for whatever reason

Stringoptional
Caption Bathymetrycaption_bathymetry

Image caption for image_bathymetry

Stringoptional
Locationlocation

Location of the Body of Water

Stringoptional
Groupgroup

Group of lakes that the body of water belongs to

Stringoptional
Coordinatescoordinates coords

Latitude and Longitude coordinates of the body of water

Numberoptional
Typetype

Type of the Body of Water

Stringoptional
Etymologyetymology

person, event, or other entity body is named after

Stringoptional
Part ofpart_of

Name of any parent basin or hydrology system

Stringoptional
Inflowinflow

Major inflow sources — rivers, aquifers, glacial runoff, etc.

Stringoptional
Outflowoutflow

Outflow Waterway Names e.g. evaporation

Stringoptional
Catchmentcatchment

The area of catchment (in square kilometres) which includes the entire area of the drainage basin for that body of water.

Stringoptional
Basin Countriesbasin_countries

Which countries have drainage to/from or border the body of water.

Stringoptional
Date Builtdate-built

Date of construction of the body of water/reservoir started, if man-made.

Lineoptional
Date Floodeddate-flooded

Date of the body of water/reservoir was first flooded, if man-made or otherwise recent.

Lineoptional
Agencyagency

Managing or owning organisation

Stringoptional
Lengthlength

Maximum length of the body of water in km

Numberoptional
Widthwidth

Maximum width of the body of water in km

Numberoptional
Areaarea

Total area of the body of water's surface in square kilometres

Numberoptional
Depthdepth

Average depth of the body of water in metres, fathoms, and/or feet

Numberoptional
Max Depthmax-depth

Maximum depth of the body of water in metres, fathoms, and/or feet.

Numberoptional
Volumevolume

Total volume of the body of water (cubic metres, cubic kilometres, cubic miles [cu mi], and/or acre-feet)

Numberoptional
Residence Timeresidence_time

Time spent by water in the body of water.

Numberoptional
Shoreshore

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.

Numberoptional
Elevationelevation

Elevation above sea-level in meters.

Numberoptional
Frozenfrozen

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.

Stringoptional
Islandsislands

Total number of islands in the body of water

Numberoptional
Citiescities

Notable cities or settlements on or near the shore of the body of water.

Numberoptional
Referencereference

references for some or all of the values.

Stringoptional

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.

See also