Template:Wp/afb/Infobox body of water/doc
Template:Documentation subpage Template:High-use Template:Auto short description Template: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
ERROR: This page is using an unprefixed version of template {{Tl}}
{{Wp/afb/Tl}}
instead and replace all occurences of {{Tl}}
in Wp/afb/
prefixed pages by that.{{infobox dam}}
template, instead of this template.
Usage
[edit source]Template:Parameter names example
{{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
[edit source]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 Template:Tlx or, for multiple names, use Template:Tlx
other_name
- Local, alternative or former names. Separate multiple values by using Template:Tlx or Template:Tlx.
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: Template:Tlc
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: Template:Tlc 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: Template:Tlc 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: Template:Tlc 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: Template:Tlc this renders as: Template:Convert depth
- Average depth of the body of water in metres, fathoms, and/or feet
Sample conversion for imperial units: Template:Tlc this renders as: Template:Convert max-depth
- Maximum depth of the body of water in metres, fathoms, and/or feet.
Sample value: Template:Convert 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 Template:Tlc this renders as Template:Convert 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: Template:Tlc 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: Template:Tlc 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 Template:Para 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
ERROR: This page is using an unprefixed version of template {{Tl}}
{{Wp/afb/Tl}}
instead and replace all occurences of {{Tl}}
in Wp/afb/
prefixed pages by that.{{convert}}
, e.g. Template:Tlc this renders as Template:Convert
Mapframe maps
[edit source]Template:Infobox mapframe/doc/parameters
Tracking categories
[edit source]There are several tracking categories for maintenance of articles using this infobox:
- Template:Clc – if image is missing
- Template:Clc – if image alt text is missing
- Template:Clc – if bathymetry image is missing
- Template:Clc – if bathymetry image is present, but bathymetry image alt text is missing
- Template:Clc – if no pushpin map is present
- Template:Clc – if pushpin map is present, but alt text is missing
- Template:Clc – if coordinates are missing
- Template:Clc – if specific fields are missing, or included, see category description
- Template:Clc - if
ERROR: This page is using an unprefixed version of template {{Tl}}
Create {{Wp/afb/Tl}}
instead and replace all occurences of {{Tl}}
in Wp/afb/
prefixed pages by that.
{{convert}}
is not used for measurement fields
- Template:Clc – if specific duplicate fields are used
- Template:Clc - if an unknown parameter is present in the infobox template
- Template:Clc - 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
[edit source]Template:Collapse top Template:TemplateData header
No description.
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
[edit source]See also
[edit source]
- Maintenance:Pages using unprefixed templates
- Maintenance:Pages using unprefixed template Tl
- Maintenance:Templates using unprefixed templates
- Maintenance:Templates using unprefixed template Tl
- Wp/afb/Pages using unprefixed templates
- Wp/afb/Pages using unprefixed template Tl
- Wp/afb/Templates using unprefixed templates
- Wp/afb/Templates using unprefixed template Tl