Template:Infobox river/doc

{{{name}}} {{{name_other}}}
{{{image_caption}}}
[[File:{{{map}}}|{{{map_size}}}|alt={{{map_alt}}}]] {{{map_caption}}}
Etymology	{{{etymology}}}
Nickname(s)	{{{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}}}
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">

</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.
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}}
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 {{RRegnitz}}, but could be hard-coded as [[Regnitz]]→ [[Main (river)|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}}
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.

Amazon River (dummy data) Apurímac, Ene, Tambo, Ucayali, Amazonas, Solimões
Aerial view of the Amazon River
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

Example

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

Amazon River (dummy data) Apurímac, Ene, Tambo, Ucayali, Amazonas, Solimões
Aerial view of the Amazon River
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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Infobox river in articles based on its TemplateData.

TemplateData for Infobox river

Template Data

No description. Template parameters This template prefers block formatting of parameters. Parameter Description Type Status embed embed no description Unknown optional name name no description Unknown optional qid qid no description Unknown optional suppressfields suppressfields no description Unknown optional fetchwikidata fetchwikidata no description Unknown optional image image no description File optional image_size image_size no description Unknown optional image_upright image_upright no description Unknown optional image_alt image_alt no description Unknown optional image_caption image_caption no description Unknown optional map map no description Unknown optional map_size map_size no description Unknown optional map_alt map_alt no description Unknown optional map_caption map_caption no description Unknown optional mouth_coordinates mouth_coordinates no description Unknown optional pushpin_map pushpin_map no description Unknown optional pushpin_map_alt pushpin_map_alt no description Unknown optional pushpin_map_size pushpin_map_size no description Unknown optional pushpin_map_relief pushpin_map_relief no description Unknown optional pushpin_map_caption pushpin_map_caption no description Unknown optional name_native name_native no description Unknown optional native_name native_name no description Unknown optional name_other name_other no description Unknown optional other_name other_name no description Unknown optional nickname nickname no description Unknown optional etymology etymology no description Unknown optional name_etymology name_etymology no description Unknown optional subdivision_type1 subdivision_type1 no description Unknown optional country_type country_type no description Unknown optional subdivision_name1 subdivision_name1 no description Unknown optional country country no description Unknown optional subdivision_type2 subdivision_type2 no description Unknown optional state_type state_type no description Unknown optional subdivision_name2 subdivision_name2 no description Unknown optional state state no description Unknown optional subdivision_type3 subdivision_type3 no description Unknown optional region_type region_type no description Unknown optional subdivision_name3 subdivision_name3 no description Unknown optional region region no description Unknown optional subdivision_type4 subdivision_type4 no description Unknown optional district_type district_type no description Unknown optional subdivision_name4 subdivision_name4 no description Unknown optional district district no description Unknown optional subdivision_type5 subdivision_type5 no description Unknown optional municipality_type municipality_type no description Unknown optional subdivision_name5 subdivision_name5 no description Unknown optional municipality municipality no description Unknown optional cities cities no description Unknown optional city city no description Unknown optional source1 source1 no description Unknown optional source1_location source1_location no description Unknown optional source1_length source1_length no description Unknown optional source1_elevation source1_elevation no description Unknown optional source1_coordinates source1_coordinates no description Unknown optional source1_coord_ref source1_coord_ref no description Unknown optional source2 source2 no description Unknown optional source2_location source2_location no description Unknown optional source2_length source2_length no description Unknown optional source2_elevation source2_elevation no description Unknown optional source2_coordinates source2_coordinates no description Unknown optional source2_coord_ref source2_coord_ref no description Unknown optional source3 source3 no description Unknown optional source3_location source3_location no description Unknown optional source3_length source3_length no description Unknown optional source3_elevation source3_elevation no description Unknown optional source3_coordinates source3_coordinates no description Unknown optional source3_coord_ref source3_coord_ref no description Unknown optional source4 source4 no description Unknown optional source4_location source4_location no description Unknown optional source4_length source4_length no description Unknown optional source4_elevation source4_elevation no description Unknown optional source4_coordinates source4_coordinates no description Unknown optional source4_coord_ref source4_coord_ref no description Unknown optional source5 source5 no description Unknown optional source5_location source5_location no description Unknown optional source5_length source5_length no description Unknown optional source5_elevation source5_elevation no description Unknown optional source5_coordinates source5_coordinates no description Unknown optional source5_coord_ref source5_coord_ref no description Unknown optional source_confluence source_confluence no description Unknown optional source_confluence_location source_confluence_location no description Unknown optional source_confluence_elevation source_confluence_elevation no description Unknown optional source_confluence_coordinates source_confluence_coordinates no description Unknown optional source_confluence_coord_ref source_confluence_coord_ref no description Unknown optional mouth mouth no description Unknown optional mouth_location mouth_location no description Unknown optional mouth_elevation mouth_elevation no description Unknown optional mouth_elevation_metric mouth_elevation_metric no description Unknown optional mouth_elevation_imperial mouth_elevation_imperial no description Unknown optional mouth_coord_ref mouth_coord_ref no description Unknown optional length length no description Unknown optional length_metric length_metric no description Unknown optional length_imperial length_imperial no description Unknown optional width_min width_min no description Unknown optional width_min_metric width_min_metric no description Unknown optional width_min_imperial width_min_imperial no description Unknown optional width_avg width_avg no description Unknown optional width_avg_metric width_avg_metric no description Unknown optional width_avg_imperial width_avg_imperial no description Unknown optional width_max width_max no description Unknown optional width_max_metric width_max_metric no description Unknown optional width_max_imperial width_max_imperial no description Unknown optional depth_min depth_min no description Unknown optional depth_avg depth_avg no description Unknown optional depth_max depth_max no description Unknown optional discharge1_location discharge1_location no description Unknown optional discharge1_min discharge1_min no description Unknown optional discharge1_avg discharge1_avg no description Unknown optional discharge1_max discharge1_max no description Unknown optional discharge1 discharge1 no description Unknown optional discharge1_min_metric discharge1_min_metric no description Unknown optional discharge1_min_imperial discharge1_min_imperial no description Unknown optional discharge1_avg_metric discharge1_avg_metric no description Unknown optional discharge1_avg_imperial discharge1_avg_imperial no description Unknown optional discharge1_max_metric discharge1_max_metric no description Unknown optional discharge1_max_imperial discharge1_max_imperial no description Unknown optional discharge2 discharge2 no description Unknown optional discharge2_location discharge2_location no description Unknown optional discharge2_min discharge2_min no description Unknown optional discharge2_avg discharge2_avg no description Unknown optional discharge2_max discharge2_max no description Unknown optional discharge3 discharge3 no description Unknown optional discharge3_location discharge3_location no description Unknown optional discharge3_min discharge3_min no description Unknown optional discharge3_avg discharge3_avg no description Unknown optional discharge3_max discharge3_max no description Unknown optional discharge4 discharge4 no description Unknown optional discharge4_location discharge4_location no description Unknown optional discharge4_min discharge4_min no description Unknown optional discharge4_avg discharge4_avg no description Unknown optional discharge4_max discharge4_max no description Unknown optional discharge5 discharge5 no description Unknown optional discharge5_location discharge5_location no description Unknown optional discharge5_min discharge5_min no description Unknown optional discharge5_avg discharge5_avg no description Unknown optional discharge5_max discharge5_max no description Unknown optional progression progression no description Unknown optional river_system river_system no description Unknown optional basin_size basin_size no description Unknown optional basin_landmarks basin_landmarks no description Unknown optional basin_population basin_population no description Unknown optional tributaries_left tributaries_left no description Unknown optional tributaries_right tributaries_right no description Unknown optional waterbodies waterbodies no description Unknown optional waterfalls waterfalls no description Unknown optional bridges bridges no description Unknown optional ports ports no description Unknown optional landmark landmark no description Unknown optional custom_data custom_data no description Unknown optional parent parent no description Unknown optional custom_label custom_label no description Unknown optional extra extra no description Unknown optional

Subtemplates

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

Tracking categories

• Category:Pages using infobox river with unknown parameters (0)