Template:Infobox river

Infobox river

Template documentationviewedithistorypurge

{{{name}}} {{{name_other}}}
[[File:{{{image}}}|{{{image_size}}}|alt={{{image_alt}}}|upright=1]] {{{image_caption}}}
[[File:{{{map}}}|{{{map_size}}}|alt={{{map_alt}}}]] {{{map_caption}}}
Etymology	{{{etymology}}}
Nickname	{{{nickname}}}
Native name	{{{native_name}}} Error {{native name checker}}: parameter value is malformed (help)
Location
{{{subdivision_type1}}}	{{{subdivision_name1}}}
{{{subdivision_type2}}}	{{{subdivision_name2}}}
{{{subdivision_type3}}}	{{{subdivision_name3}}}
{{{subdivision_type4}}}	{{{subdivision_name4}}}
{{{subdivision_type5}}}	{{{subdivision_name5}}}
Physical characteristics
Source	{{{source1}}}
• location	{{{source1_location}}}
• coordinates	{{{source1_coordinates}}}{{{source1_coord_ref}}}
• elevation	{{{source1_elevation}}}
5th source	{{{source5}}}
• location	{{{source5_location}}}
• coordinates	{{{source5_coordinates}}}{{{source5_coord_ref}}}
• elevation	{{{source5_elevation}}}
Source confluence	{{{source_confluence}}}
• location	{{{source_confluence_location}}}
• coordinates	{{{source_confluence_coordinates}}}
• elevation	{{{source_confluence_elevation}}}
Mouth	{{{mouth}}}
• location	{{{mouth_location}}}
• coordinates	{{{mouth_coordinates}}}{{{mouth_coord_ref}}}
• elevation	{{{mouth_elevation}}}
Length	{{{length}}}
Basin size	{{{basin_size}}}{{{basin_size_ref}}}
Width
• minimum	{{{width_min}}}
• average	{{{width_avg}}}
• maximum	{{{width_max}}}
Depth
• minimum	{{{depth_min}}}
• average	{{{depth_avg}}}
• maximum	{{{depth_max}}}
Discharge
• location	{{{discharge1_location}}}
• average	{{{discharge1_avg}}}
• minimum	{{{discharge1_min}}}
• maximum	{{{discharge1_max}}}
Discharge
• location	{{{discharge5_location}}}
• average	{{{discharge5_avg}}}
• minimum	{{{discharge5_min}}}
• maximum	{{{discharge5_max}}}
Basin features
Progression	{{{progression}}}
River system	{{{river_system}}}
Landmarks	{{{basin_landmarks}}}
Cities	{{{city}}}
Population	{{{basin_population}}}
Tributaries
• left	{{{tributaries_left}}}
• right	{{{tributaries_right}}}
Waterbodies	{{{waterbodies}}}
Waterfalls	{{{waterfalls}}}
Bridges	{{{bridges}}}
Inland ports	{{{ports}}}
{{{custom_label}}}	{{{custom_data}}}
{{{extra}}}

Usage

<syntaxhighlight lang="wikitext" style="overflow: auto">

Infobox river

</syntaxhighlight>

Parameter names and descriptions

Parameter name	Description
name	The common name of the river.
native_name or name_native	The name in its official or de facto language. Use {{native name}} or, for multiple names, use {{native name list}}
name_other or other_name	Other name(s) of the river. Use commas to enter multiple. Displayed under the infobox heading.
nickname	Local name(s) for the river. Use commas to enter multiple.
name_etymology or etymology	Person, event or other entity the body is named after
image	Image filename without the File: or Image: prefix.
image_size	Width of the image in pixels (i.e. 200px). Common sizes are usually around 280px to 300px.
image_caption	Caption for the main image.
image_alt	Alt text for the main image.
map	Map image filename without the File: or Image: prefix.
map_size	Width of the image in pixels (i.e. 200px). Common sizes are usually around 280px to 300px.
map_caption	Caption for the map image.
map_alt	Alt text for the map image.
pushpin_map	The name of a location map to be used with {{location map}}, with the pin placed at the location specified by the mouth_coordinates parameter, or the value from wikidata if no mouth coordinates are provided. Manually add parameter pushpin_map_relief = 0 to disable the use of a relief location map.
pushpin_map_size	The width of the location map in pixels as a raw number, without any px suffix
pushpin_map_caption	Caption for the location map
pushpin_map_alt	Alt text for the location map image.
pushpin_map_relief	A pushpin map will be displayed in relief by default. Use pushpin_map_relief = 0 for a plain map.
mapframe	A mapframe map can be enabled with this. See #Mapframe parameters below for more information.
subdivision_type1	Primary political region(s), typically Country or Countries.
subdivision_name1	Used with above. The country/ies in which the river flows in/through. Use commas for multiple.
subdivision_type2	Secondary political region(s). States, Provinces, Districts, or Regions, in which the river flows through.
subdivision_name2	Used with above. The secondary political region(s) in which the river flows through. Use commas for multiple.
subdivision_type3	Tertiary political region(s), such as the Cities along the river.
subdivision_name3	Used with above. The tertiary political region(s) through which the river flows. Use commas for multiple.
subdivision_type4	Other types of political subdivisions.
subdivision_name4	Used with above. Other political subdivisions through which the river flows. Use commas for multiple.
subdivision_type5	Other types of political subdivisions.
subdivision_name5	Used with above. Other political subdivisions through which the river flows. Use commas for multiple.
PHYSICAL CHARACTERISTICS
length	The total length of the river's main stem. Consider using {{Convert|1234|km|mi|abbr=on}}
length_km	Total length of the river's main stem, measured in kilometers.
length_mi	Total length of the river's main stem, measured in miles.
length_ref	References or other notes for length of river, used only if |length_km= or |length_mi= are used.
width_min	Minimum width between banks of the river. Rarely used as it is often difficult to determine the exact source of the river. Consider using {{Convert|1234|m|ft|abbr=on}}
width_avg	Average width of the river. Consider using {{Convert|1234|m|ft|abbr=on}}
width_max	Maximum width of the river before the mouth. Consider using {{Convert|1234|m|ft|abbr=on}}
depth_min	Minimum depth of the river. Rarely used as it is often difficult to determine the exact source of the river. Consider using {{Convert|1234|m|ft|abbr=on}}
depth_avg	Average depth of the river. Consider using {{Convert|1234|m|ft|abbr=on}}
depth_max	Maximum depth of the river before the mouth. Consider using {{Convert|1234|m|ft|abbr=on}}
discharge1_location	Location or gauge/sensor name at which the below details are recorded. Commonly at the River mouth.
discharge1_min	Minimum discharge rate. Rarely used. Consider using {{Convert|1234|m3/s|ft3/s|abbr=on}}
discharge1_avg	Average discharge rate (also use if a source provides only one discharge rate without a minimum or maximum). Consider using {{Convert|1234|m3/s|ft3/s|abbr=on}}
discharge1_max	Maximum discharge rate before flooding occurs in the surrounding areas. Consider using {{Convert|1234|m3/s|ft3/s|abbr=on}}
discharge2_* ⇒ 5_*	Up to four more sets of discharge parameters. You may add up to discharge5_*.
BASIN FEATURES
source1	Landform or waterbody of the primary source. For a source that is a confluence, you may add as: Confluence of River-A and River-B.
source1_location	Political details of the source location, such as Province, District, State, etc.
source1_elevation	Elevation at the main source of water
source1_coordinates	Coordinates of the main source, using the {{coord}} template. Use |display=inline only.
source1_coord_ref	Reference for the coordinates of the main source.
source1_length	Length from the main source.
source2 ⇒ source5	Landform or waterbody of further sources. You may add up to source5. Also source2_location, source2_elevation, source2_coordinates, source2_coord_ref, source2_length etc.
mouth	Landform or waterbody of the river mouth.
mouth_location	Political details of the mouth location, such as Province, District, State, etc.
mouth_coordinates	Coordinates of the river mouth, using the {{coord}} template. Use |display=inline,title if possible.
mouth_elevation	Elevation at the river mouth.
progression	Progression from the mouth of the river in the article to the sea. For example, the Pegnitz in Germany flows into the Regnitz, which flows into the Main, which flows into the Rhine, which flows into the North Sea. This is entered into the progression field with a special template Template:RRegnitz, but could be hard-coded as Regnitz→ Main→ Rhine→ North Sea. These both render as Regnitz→ Main→ Rhine→ North Sea in the Infobox. See Category:Drainage basin succession templates for a list of templates that can be used with this parameter.
river_system or parent	Name of the river system.
basin_landmarks or landmark	Popular landmarks along the river. Use commas for multiple.
basin_population	Population within the river basin.
basin_size	Size of the river's drainage basin. Consider using {{Convert|1234|km2|mi2|abbr=on}}
basin_size_km2	Size of the river's drainage basin, in square kilometers.
basin_size_mi2	Size of the river's drainage basin, in square miles.
tributaries_left	Tributaries located on the left bank of the river flowing towards the mouth. List in order from source to mouth.
tributaries_right	Tributaries located on the right bank of the river flowing towards the mouth. List in order from source to mouth.
waterbodies	Water bodies located along the river (such as lakes, reservoirs, etc). List in order from source to mouth.
waterfalls	Waterfalls along the river. List in order from source to mouth.
bridges	Bridges along the river. List in order from source to mouth.
ports	Inland ports along the river. List in order from source to mouth.
city or cities	Cities along the river. List in order from source to mouth. Use city or cities, not both.
custom_label	Use this to enter a custom label (such as bridges). To be used with the field below.
custom_data	Custom data parameter. See above.
extra	Use this parameter to add content to the very bottom of the infobox. Useful for adding maps, charts, and so on.

Mapframe parameters

• Basic Infobox mapframe parameters:
  • mapframe – Specify yes or no to show or hide the map, overriding the default. Default: no, but also modified by onByDefault
    • Internal onByDefault parameter: yes, unless one of these parameters has a value: |map=, |pushpin_map=.
  • mapframe-coordinates or mapframe-coord or coordinates or coord – Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template, e.g. |coord={{Coord|12.34|N|56.78|E}}. Default: coordinates from Wikidata P625
  • mapframe-caption – Caption for the map. Default: blank (or if |mapframe-geomask= is set, "Location in geomask's label")
  • mapframe-custom – Use a custom map instead of the automatic mapframe. Specify either a template, or another template that generates a mapframe map, or an image name. If used, most mapframe parameters will be ignored. Default: not specified
  • mapframe-id or id or qid – Id (Q-number) of Wikidata item to use. Default: item for current page
  • mapframe-wikidata – Set to <syntaxhighlight lang="text" class="" style="" inline="1">yes</syntaxhighlight> to show all shape/line features from OpenStreetMap. Default: not specified
• Customise which features are displayed:
  • mapframe-point – Turn off display of point feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Force point marker to be displayed by setting to <syntaxhighlight lang="text" class="" style="" inline="1">on</syntaxhighlight>. Default: not specified
  • mapframe-shape – Turn off display of shape feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Force display of shape by setting to <syntaxhighlight lang="text" class="" style="" inline="1">on</syntaxhighlight>. Use an inverse shape (geomask) instead of a regular shape by setting to <syntaxhighlight lang="text" class="" style="" inline="1">inverse</syntaxhighlight>. Default: not specified
  • mapframe-line – Turn off display of line feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Force display of line by setting to <syntaxhighlight lang="text" class="" style="" inline="1">on</syntaxhighlight>. Default: not specified
  • mapframe-geomask – Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for (P17), P131 for (P131)). Default: not specified
  • mapframe-switcher – set to <syntaxhighlight lang="text" class="" style="" inline="1">auto</syntaxhighlight> or <syntaxhighlight lang="text" class="" style="" inline="1">geomasks</syntaxhighlight> or <syntaxhighlight lang="text" class="" style="" inline="1">zooms</syntaxhighlight> to enable Switcher-style switching between multiple mapframes. Default: not specified
    • <syntaxhighlight lang="text" class="" style="" inline="1">auto</syntaxhighlight> – switch geomasks found in (P276) and (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country.
    • <syntaxhighlight lang="text" class="" style="" inline="1">geomasks</syntaxhighlight> – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter
    • <syntaxhighlight lang="text" class="" style="" inline="1">zooms</syntaxhighlight> – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of <syntaxhighlight lang="text" class="" style="" inline="1">3</syntaxhighlight>), "zoomed out" is <syntaxhighlight lang="text" class="" style="" inline="1">1</syntaxhighlight>, and "zoomed midway" is the average
• Other optional parameters:
  • mapframe-frame-width or mapframe-width – Frame width. Default: 250
  • mapframe-frame-height or mapframe-height – Frame height. Default: 200
  • mapframe-shape-fill – Color used to fill shape features. Default: #606060
  • mapframe-shape-fill-opacity – Opacity level of shape fill, a number between 0 and 1. Default: 0.1
  • mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #0000ff
    • mapframe-line-stroke-color or mapframe-line-stroke-colour – Color of line features. Default: #ff0000
    • mapframe-shape-stroke-color or mapframe-shape-stroke-colour – Color of outlines of shape features. Default: #ff0000
  • mapframe-stroke-width – Width of line features, and outlines of shape features. Default: 2
    • mapframe-shape-stroke-width – Width of outlines of shape features. Default: 2
    • mapframe-line-stroke-width – Width of line features. Default: 5
  • mapframe-marker – Marker symbol to use for coordinates; see mw:Help:Extension:Kartographer/Icons for options. Default: water
    • Can also be set to <syntaxhighlight lang="text" class="" style="" inline="1">blank</syntaxhighlight> to override any default marker symbol
  • mapframe-marker-color or mapframe-marker-colour – Background color for the marker. Default: #5E74F3
  • mapframe-geomask-stroke-color or mapframe-geomask-stroke-colour – Color of outline of geomask shape. Default: #555555
  • mapframe-geomask-stroke-width – Width of outline of geomask shape. Default: 1
  • mapframe-geomask-fill – Color used to fill outside geomask features. Default: #606060
  • mapframe-geomask-fill-opacity – Opacity level of fill outside geomask features, a number between 0 and 1. Default: 0.25
  • mapframe-zoom – Set the zoom level, from "1" (map of earth) to "18" (maximum zoom in), to be used if the zoom level cannot be determined automatically from object length or area. Default: 10
  • mapframe-length_km or mapframe-length_mi or mapframe-area_km2 or mapframe-area_mi2 – Determine zoom level by passing in object's length (in kilometres or miles) or area (in square kilometres or square miles). Default: not specified / not specified / not specified / not specified
  • mapframe-frame-coordinates or mapframe-frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates
  • mapframe-type – Set the type of the object, with the same usage as {{coord}}. Default: river
  • mapframe-population – Set the population, useful with type="city", for Infobox dim. Default: not specified

Suppressing images

To completely suppress the default image in the Infobox, including any image from Wikidata, use |suppressfields=image.

Example

Amazon River (dummy data) Apurímac, Ene, Tambo, Ucayali, Amazonas, Solimões
Alt text for image Satellite image of the Amazon Delta
Alt text for map Map of the Amazon basin
Etymology	Named after the Amazon Rainforest
Native name	Amazonia (Portuguese)
Location
Countries	Brazil, Colombia, Peru, Ecuador
States	Loreto (Peru); Amazonas (Columbia); North Region (Brazil)
Cities	Iquitos (Peru); Leticia (Colombia); Tabatinga (Brazil); Tefé (Brazil); Itacoatiara (Brazil); Parintins (Brazil); Óbidos (Brazil); Santarém (Brazil); Almeirim (Brazil); Macapá (Brazil)
Physical characteristics
Source	Nevado Mismi, Peru
• location	Arequipa Region
• coordinates
• elevation	5,170 m (16,960 ft)
Mouth	Atlantic Ocean
• location	State of Amapá, State of Pará
• coordinates
• elevation	0 m (0 ft)
Length	6,992 km (4,345 mi)
Basin size	7,050,000 km2 (2,720,000 sq mi)
Width
• minimum	4 km (2.5 mi)
• average	6 km (3.7 mi)
• maximum	8 km (5.0 mi)
Depth
• minimum	3 m (9.8 ft)
• average	15 m (49 ft)
• maximum	30 m (98 ft)
Discharge
• location	Santarém, Pará
• average	209,000 m3/s (7,400,000 cu ft/s)
• minimum	109,000 m3/s (3,800,000 cu ft/s)
• maximum	309,000 m3/s (10,900,000 cu ft/s)
Basin features
Progression	Apurímac—Solimões—Marañón
River system	Amazon Basin
Landmarks	Amazon Arena
Population	1,234,567
Tributaries
• left	Marañón Japurá Rio Negro Putumayo
• right	Ucayali Purus Madeira Tapajós Xingu
Waterbodies	Lake Lawriqucha
Waterfalls	Ahlfeld Waterfall
Bridges	Manaus–Iranduba Bridge
Inland ports	Port of Manaus
Custom label	Custom data

<syntaxhighlight lang="wikitext" style="overflow: auto">

Amazon River (dummy data) Apurímac, Ene, Tambo, Ucayali, Amazonas, Solimões
Alt text for image Satellite image of the Amazon Delta
Alt text for map Map of the Amazon basin
Etymology	Named after the Amazon Rainforest
Native name	Amazonia (Portuguese)
Location
Countries	Brazil, Colombia, Peru, Ecuador
States	Loreto (Peru); Amazonas (Columbia); North Region (Brazil)
Cities	Iquitos (Peru); Leticia (Colombia); Tabatinga (Brazil); Tefé (Brazil); Itacoatiara (Brazil); Parintins (Brazil); Óbidos (Brazil); Santarém (Brazil); Almeirim (Brazil); Macapá (Brazil)
Physical characteristics
Source	Nevado Mismi, Peru
• location	Arequipa Region
• coordinates
• elevation	5,170 m (16,960 ft)
Mouth	Atlantic Ocean
• location	State of Amapá, State of Pará
• coordinates
• elevation	0 m (0 ft)
Length	6,992 km (4,345 mi)
Basin size	7,050,000 km2 (2,720,000 sq mi)
Width
• minimum	4 km (2.5 mi)
• average	6 km (3.7 mi)
• maximum	8 km (5.0 mi)
Depth
• minimum	3 m (9.8 ft)
• average	15 m (49 ft)
• maximum	30 m (98 ft)
Discharge
• location	Santarém, Pará
• average	209,000 m3/s (7,400,000 cu ft/s)
• minimum	109,000 m3/s (3,800,000 cu ft/s)
• maximum	309,000 m3/s (10,900,000 cu ft/s)
Basin features
Progression	Apurímac—Solimões—Marañón
River system	Amazon Basin
Landmarks	Amazon Arena
Population	1,234,567
Tributaries
• left	Marañón Japurá Rio Negro Putumayo
• right	Ucayali Purus Madeira Tapajós Xingu
Waterbodies	Lake Lawriqucha
Waterfalls	Ahlfeld Waterfall
Bridges	Manaus–Iranduba Bridge
Inland ports	Port of Manaus
Custom label	Custom data
(optional content at the bottom – centred)

</syntaxhighlight>

Template Data

Template Data

Subtemplates

• {{Infobox river/discharge}}
• {{Infobox river/row-style}}
• {{Infobox river/calcunit}}
• {{Infobox river/source}}

Tracking categories

• Category:Pages using infobox river with mapframe (0)

The above documentation is transcluded from Template:Infobox river/doc. (edit | history)

Add categories to the /doc subpage. Subpages of this template.