Difference between revisions of "Template:Infobox river/doc"

From blackwiki
Jump to navigation Jump to search
(interwiki)
imported>Qui1che
m (Added Category:Drainage basin succession templates to progression description)
 
(93 intermediate revisions by 39 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
+
{{Lua|Module:Check for unknown parameters|Module:Coordinates|Module:InfoboxImage|Module:String|Module:WikidataIB}}
This template is part of the [[Wikipedia:WikiProject Rivers|Rivers WikiProject]].
+
{{Tracks Wikidata|P18|cat=No local image but image on Wikidata}}
  
==Usage==
+
{{Parameter names example|_template=| basin_landmarks | basin_population | basin_size | bridges | city | country | country_type | custom_data | custom_label | depth_avg | depth_max | depth_min | discharge1 | discharge5 | discharge1_avg | discharge1_location | discharge1_max | discharge1_min | discharge5_avg | discharge5_location | discharge5_max | discharge5_min | district | district_type | embed | etymology | extra | image | image_alt | image_caption | image_size | landmark | length | length_metric | length_imperial | map | map_alt | map_caption | map_size | mouth | mouth_coord_ref | mouth_coordinates | mouth_elevation | mouth_elevation_metric | mouth_elevation_imperial | mouth_location | municipality | municipality_type | name | name_etymology | name_native | name_native_lang | name_other | native_name | nickname | parent | ports | progression | pushpin_map =| pushpin_map_alt | pushpin_map_caption | pushpin_map_size | pushpin_mapsize | pushpin_relief | region | region_type | river_system | source1 | source1_coord_ref | source1_coordinates | source1_elevation | source1_location | source5 | source5_coord_ref | source5_coordinates | source5_elevation | source5_location | state | state_type | subdivision_name1 | subdivision_name2 | subdivision_name3 | subdivision_name4 | subdivision_name5 | subdivision_type1 | subdivision_type2 | subdivision_type3 | subdivision_type4 | subdivision_type5 | tributaries_left | tributaries_right | waterbodies | waterfalls | width_avg | width_avg_metric | width_avg_imperial | width_max | width_max_metric | width_max_imperial | width_min_metric | width_min_imperial | width_min | source_confluence | source_confluence_location | source_confluence_elevation | source_confluence_coordinates }}
* All parameters are optional.
+
 
** No caption will be shown if there is no image.
+
== Usage ==
** The default image size is 288 px
+
<pre style="overflow: auto">
* Unit conversions can either be entered directly or done automatically.
+
{{Infobox river
** See below for details on automatic conversion parameters.
+
| name              =
** {{tl|Convert}} can be used for directly entered conversions.
+
| name_native        =
** Where imperial/US customary are auto-converted, these units will be displayed first.
+
| name_native_lang  =
** Please refer to [[WP:UNITS]] to decide which units should be put first.
+
| name_other        =
* There are two different types of parameter.
+
| name_etymology    =
** Auto-conversion parameters require a numerical input (without commas).
+
| nickname          =
** Other parameters will accept any normal wikitext including links.
+
<!---------------------- IMAGE-->
** Details are noted in the pale green ''Details'' boxes below.
+
| image              =
* Copy the appropriate syntax block if you prefer to cut and paste into an empty template.
+
| image_size        =
* Include the HTML comments before and following the template; they help inexperienced editors.
+
| image_caption      =
* ''Please spend some time at the [[Wikipedia:WikiProject Rivers|Rivers WikiProject]] article and its [[Wikipedia talk:WikiProject Rivers|talk page]] for standards on presenting names and other data.''
+
| image_alt          =
*The <code>progression</code> parameter (not needed on the Volga examples below) can be seen in use on [[River Penk]], and is to describe the path (in that case: [[River Sow|Sow]]—[[River Trent|Trent]]—[[Humber]]—[[North Sea]]) taken by the waters of a river which is a tributary of one or more other rivers, and does not empty directly into a sea or lake.
+
<!---------------------- MAPS -->
===Simple version===
+
| map                =
<pre >
+
| map_size          =
<!-- The following few lines create the "Infobox" table template.
+
| map_caption        =
    Please scroll down to edit the main content of the article. -->
+
| map_alt            =
{{Infobox river
+
| pushpin_map        =
| name            =  
+
| pushpin_map_size  =
| image_name      =  
+
| pushpin_map_caption=
| image_size      =  
+
| pushpin_map_alt    =
| image_alt      =
+
<!---------------------- LOCATION -->
| caption        =  
+
| subdivision_type1  =
| image_map      =  
+
| subdivision_name1  =
| map_size        =  
+
| subdivision_type2  =  
| map_alt        =
+
| subdivision_name2  =  
| map_caption     =  
+
| subdivision_type3  =
| origin          =  
+
| subdivision_name3  =  
| mouth          =  
+
| subdivision_type4  =  
| basin_countries =  
+
| subdivision_name4  =  
| progression     =  
+
| subdivision_type5  =  
| length          =  
+
| subdivision_name5  =
| elevation      =  
+
<!---------------------- PHYSICAL CHARACTERISTICS -->
| mouth_elevation =  
+
| length            =
| discharge       =  
+
| width_min          =
| watershed      =  
+
| width_avg          =  
| river_system   =
+
| width_max          =  
| left_tribs      =
+
| depth_min          =  
| right_tribs    =
+
| depth_avg          =  
 +
| depth_max          =  
 +
| discharge1_location=  
 +
| discharge1_min    =  
 +
| discharge1_avg    =  
 +
| discharge1_max     =
 +
<!---------------------- BASIN FEATURES -->
 +
| source1            =  
 +
| source1_location  =  
 +
| source1_coordinates= <!-- {{Coord|...}} -->
 +
| source1_elevation  =  
 +
| mouth              =
 +
| mouth_location     =  
 +
| mouth_coordinates  = <!-- {{Coord|...|display=inline,title}} -->
 +
| mouth_elevation    =  
 +
| progression        =  
 +
| river_system       =  
 +
| basin_size        =  
 +
| basin_landmarks   =  
 +
| basin_population  =
 +
| tributaries_left  =
 +
| tributaries_right  =
 +
| waterbodies        =
 +
| waterfalls        =
 +
| bridges            =
 +
| ports              =
 +
| custom_label      =
 +
| custom_data        =  
 +
| extra              =  
 
}}
 
}}
<!-- End Infobox template table -->
+
</pre>{{Clear}}
</pre>
 
  
{| class="wikitable collapsible collapsed" style="width:100%;"
+
== Parameter names and descriptions ==
 +
{| class="wikitable plainrowheaders"
 +
|-
 +
! scope="col" | Parameter name
 +
! scope="col" | Description
 +
|-
 +
! scope="row" | '''name'''
 +
| The [[WP:COMMONNAME|common name]] of the river.
 +
|-
 +
! scope="row" | '''name_native'''
 +
| The native/local name of the river.
 +
|-
 +
! scope="row" | '''name_native_lang'''
 +
| [[ISO 639-1]] or [[ISO 639-2]] language code of the language used in <code>name_native</code>. Used for [[Wikipedia:Manual of Style/Accessibility|accessibility]].
 +
|-
 +
! scope="row" | '''name_other'''
 +
| Other name(s) of the river. Use commas to enter multiple.
 +
|-
 +
! scope="row" | '''name_etymology'''
 +
| Person, event or other entity the body is named after
 +
|-
 +
! scope="row" | '''image'''
 +
| Image filename without the <code>File:</code> or <code>Image:</code> prefix.
 
|-
 
|-
! style="background:PaleGreen;" | Details
+
! scope="row" | '''image_size'''
 +
| Width of the image in pixels (i.e. <code>200px</code>). Common sizes are usually around <code>280px</code> to <code>300px</code>.
 
|-
 
|-
|<pre>
+
! scope="row" | '''image_caption'''
<!-- The following few lines create the "Infobox" table template.
+
| Caption for the main image.
    Please scroll down to edit the main content of the article. -->
+
|-
{{Infobox river  
+
! scope="row" | '''image_alt'''
| name            = NAME
+
| [[Wikipedia:Alternative text for images|Alt text]] for the main image.
| image_name      = IMAGE_FILE_NAME
+
|-
| image_alt      =
+
! scope="row" | '''map'''
| caption        = CAPTION
+
| Map image filename without the <code>File:</code> or <code>Image:</code> prefix.
| image_map      = MAP_FILE_NAME
+
|-
| map_alt        =
+
! scope="row" | '''map_size'''
| map_caption    = MAP_CAPTION
+
| Width of the image in pixels (i.e. <code>200px</code>). Common sizes are usually around <code>280px</code> to <code>300px</code>.
| origin          = ORIGIN
+
|-
| mouth          = MOUTH
+
! scope="row" | '''map_caption'''
| basin_countries = BASIN_COUNTRIES
+
| Caption for the map image.
| progression    = ROUTE TO THE SEA
+
|-
| length          = KILOMETERS km (MILES mi)
+
! scope="row" | '''map_alt'''
| elevation      = METERS m (FEET ft)
+
| [[Wikipedia:Alternative text for images|Alt text]] for the map image.
| mouth_elevation = METERS m (FEET ft)
+
|-
| discharge      = CUBIC METERS m³/s (CUBIC FEET cu&nbsp;ft/s)
+
! scope="row" | '''pushpin_map'''
| watershed      = SQUARE KILOMETERS km² (SQUARE MILES sq&nbsp;mi)
+
| The name of a location map to be used with {{tl|location map}}, with the pin placed at the location specified by the <code>mouth_coordinates</code> parameter, or the value from wikidata if no mouth coordinates are provided. Manually add parameter <code>pushpin_map_relief = 0</code> to disable the use of a relief location map.
| river_system    = RIVER SYSTEM
+
|-
| left_tribs      = LEFT TRIBUTARIES
+
! scope="row" | '''pushpin_map_size'''
| right_tribs    = RIGHT TRIBUTARIES
+
| The width of the location map in pixels as a raw number, without any <code>px</code> suffix
}}
+
|-
<!-- End Infobox template table -->
+
! scope="row" | '''pushpin_map_caption'''
</pre>
+
| Caption for the location map
|}
+
|-
{| class="wikitable collapsible collapsed" style="width:100%;"
+
! scope="row" | '''pushpin_map_alt'''
 +
| [[Wikipedia:Alternative text for images|Alt text]] for the location map image.
 +
|-
 +
! scope="row" | '''subdivision_type1'''
 +
| Primary political region(s), typically <code>Country</code> or <code>Countries</code>.
 +
|-
 +
! scope="row" | '''subdivision_name1'''
 +
| Used with above. The country/ies in which the river flows in/through. Use commas for multiple.
 +
|-
 +
! scope="row" | '''subdivision_type2'''
 +
| Secondary political region(s). <code>States</code>, <code>Provinces</code>, <code>Districts</code>, or <code>Regions</code>, in which the river flows through.
 +
|-
 +
! scope="row" | '''subdivision_name2'''
 +
| Used with above. The secondary political region(s) in which the river flows through. Use commas for multiple.
 +
|-
 +
! scope="row" | '''subdivision_type3'''
 +
| Tertiary political region(s), such as the <code>Cities</code> along the river.
 +
|-
 +
! scope="row" | '''subdivision_name3'''
 +
| Used with above. The tertiary political region(s) through which the river flows. Use commas for multiple.
 +
|-
 +
! scope="row" | '''subdivision_type4'''
 +
| Other types of political subdivisions.
 +
|-
 +
! scope="row" | '''subdivision_name4'''
 +
| Used with above. Other political subdivisions through which the river flows. Use commas for multiple.
 +
|-
 +
! scope="row" | '''subdivision_type5'''
 +
| Other types of political subdivisions.
 +
|-
 +
! scope="row" | '''subdivision_name5'''
 +
| Used with above. Other political subdivisions through which the river flows. Use commas for multiple.
 +
|-
 +
| colspan=2 bgcolor=#CEDEFF | '''<center>PHYSICAL CHARACTERISTICS</center>'''
 +
|-
 +
! scope="row" | '''length'''
 +
| The total length of the river's [[main stem]].<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|km|mi|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
! scope="row" | '''width_min'''
 +
| Minimum width between banks of the river. Rarely used as it is often difficult to determine the exact source of the river.<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m|ft|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
! scope="row" | '''width_avg'''
 +
| Average width of the river.<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m|ft|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
! scope="row" | '''width_max'''
 +
| Maximum width of the river before the [[river mouth|mouth]].<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m|ft|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
! scope="row" | '''depth_min'''
 +
| Minimum depth of the river. Rarely used as it is often difficult to determine the exact source of the river.<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m|ft|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
! scope="row" | '''depth_avg'''
 +
| Average depth of the river.<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m|ft|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
! scope="row" | '''depth_max'''
 +
| Maximum depth of the river before the [[river mouth|mouth]].<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m|ft|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
! scope="row" | '''discharge1_location'''
 +
| Location or gauge/sensor name at which the below details are recorded. Commonly at the <code>River mouth</code>.<br/>'''You may add up to <code>discharge5</code>'''.
 +
|-
 +
! scope="row" | '''discharge1_min'''
 +
| Minimum discharge rate. Rarely used.<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m3/s|ft3/s|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
! scope="row" | '''discharge1_avg'''
 +
| Average discharge rate.<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m3/s|ft3/s|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
! scope="row" | '''discharge1_max'''
 +
| Maximum discharge rate before flooding occurs in the surrounding areas.<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m3/s|ft3/s|abbr=on<nowiki>}}</nowiki></code>'''
 +
|-
 +
| colspan=2 bgcolor=#CEDEFF | '''<center>BASIN FEATURES</center>'''
 +
|-
 +
! scope="row" | '''source1'''
 +
| Landform or waterbody of the primary source. '''You may add up to <code>source5</code>'''. For a source that is a [[confluence]], you may add as:<br/><code><nowiki>Confluence of [[River-A]] and [[River-B]]</nowiki></code>.
 +
|-
 +
! scope="row" | '''source1_location'''
 +
| Political details of the source location, such as Province, District, State, etc.
 +
|-
 +
! scope="row" | '''source1_coordinates'''
 +
| Coordinates of the main source, using the {{tl|coord}} template.
 +
|-
 +
! scope="row" | '''source1_elevation'''
 +
| Elevation at the main source of water
 +
|-
 +
! scope="row" | '''mouth'''
 +
| Landform or waterbody of the [[river mouth]].
 +
|-
 +
! scope="row" | '''mouth_location'''
 +
| Political details of the mouth location, such as Province, District, State, etc.
 +
|-
 +
! scope="row" | '''mouth_coordinates'''
 +
| Coordinates of the river mouth, using the {{tl|coord}} template. Use {{para|display|inline,title}} if possible.
 +
|-
 +
! scope="row" | '''mouth_elevation'''
 +
| Elevation at the river mouth.
 +
|-
 +
! scope="row" | '''progression'''
 +
| Progression from the mouth of the river in the article to the sea. For example, the [[Pegnitz (river)|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 {{tl|RRegnitz}}, but could be hard-coded as <code><nowiki>[[Regnitz]]→ [[Main (river)|Main]]→ [[Rhine]]→ [[North Sea]]</nowiki></code>. These both render as [[Regnitz]]→ [[Main (river)|Main]]→ [[Rhine]]→ [[North Sea]] in the Infobox. See {{Cl|Drainage basin succession templates}} for a list of templates that can be used with this parameter.
 
|-
 
|-
! style="background:Aquamarine;" | Example
+
! scope="row" | '''river system'''
 +
| Name of the [[Drainage system (geomorphology)|river system]].
 
|-
 
|-
|<pre>
+
! scope="row" | '''basin_landmarks'''
<!-- The following few lines create the "Infobox" table template.
+
| Popular landmarks along the river. Use commas for multiple.
    Please scroll down to edit the main content of the article. -->
 
{{Infobox river
 
| name            = Volga River (Example)
 
| image_name      = Russia_River_Volga.jpg
 
| image_alt      =
 
| caption        = Volga in [[Yaroslavl]] (autumn morning)
 
| origin          = [[Valdai Hills]]
 
| mouth          = [[Caspian Sea]]
 
| basin_countries = [[Russia]]
 
| length          = approx. {{convert|3690|km|abbr=on}}
 
| elevation      = {{convert|225|m|abbr=on}}
 
| mouth_elevation = 0&amp;nbsp;m (0&amp;nbsp;ft)
 
| discharge      = Annual average:
 
:{{convert|8000|m3/s|abbr=on|lk=on}}
 
June:
 
:{{convert|9000|m3/s|abbr=on}}
 
December:
 
:{{convert|7000|m3/s|abbr=on}}
 
| watershed      = {{convert|1380000|km2|abbr=on}}
 
| river_system    =
 
| left_tribs      =
 
| right_tribs    =
 
}}
 
</pre>
 
|}
 
 
 
===Automatic conversion from SI to imperial/US customary===
 
;Note: The SI measurement will be displayed first.
 
<pre>
 
<!-- The following few lines create the "Infobox" table template.
 
    Please scroll down to edit the main content of the article. -->
 
{{Infobox river
 
| name              =
 
| image_name        =
 
| image_alt      =
 
| caption            =
 
| image_map          =
 
| map_alt        =
 
| map_caption        =
 
| origin            =
 
| mouth              =
 
| basin_countries    =
 
| progression        =
 
| length_km          =
 
| length            =
 
| elevation_m        =
 
| elevation          =
 
| mouth_elevation_m  =
 
| mouth_elevation    =
 
| discharge_m3/s    =
 
| discharge          =
 
| watershed_km2      =
 
| watershed          =
 
| river_system      =
 
| left_tribs        =
 
| right_tribs        =
 
}}
 
<!-- End Infobox template table -->
 
</pre>
 
 
 
{| class="wikitable collapsible collapsed" style="width:100%;"
 
 
|-
 
|-
! style="background:PaleGreen;" | Details
+
! scope="row" | '''basin_population'''
 +
| Population within the river basin.
 
|-
 
|-
|<pre>
+
! scope="row" | '''basin_size'''
<!-- The following few lines create the "Infobox" table template.
+
| Size of the river's [[drainage basin]].<br/>Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|km2|mi2|abbr=on<nowiki>}}</nowiki></code>'''
    Please scroll down to edit the main content of the article. -->
 
{{Infobox river
 
| name              = NAME
 
| image_name        = IMAGE_FILE_NAME
 
| image_alt      =
 
| caption            = IMAGE CAPTION
 
| image_map          = MAP_FILE_NAME
 
| map_alt        =
 
| map_caption        = MAP CAPTION
 
| origin            = ORIGIN
 
| mouth              = MOUTH
 
| basin_countries    = BASIN_COUNTRIES
 
| progression        = ROUTE TO THE SEA
 
| length_km          = KILOMETERS          <!-- must be a numerical expression -->
 
| length            = REFERENCES/DETAILS
 
| elevation_m        = METERS              <!-- must be a numerical expression -->
 
| elevation          = REFERENCES/DETAILS
 
| mouth_elevation_m  = METERS              <!-- must be a numerical expression -->
 
| mouth_elevation    = REFERENCES/DETAILS
 
| discharge_m3/s    = CUBIC METERS        <!-- must be a numerical expression -->
 
| discharge          = REFERENCES/DETAILS
 
| watershed_km2      = SQUARE KILOMETERS    <!-- must be a numerical expression -->
 
| watershed          = REFERENCES/DETAILS
 
| river_system      = REFERENCES/DETAILS
 
| left_tribs        = REFERENCES/DETAILS
 
| right_tribs        = REFERENCES/DETAILS
 
}}
 
<!-- End Infobox template table -->
 
</pre>
 
|}
 
{| class="wikitable collapsible collapsed" style="width:100%;"
 
 
|-
 
|-
! style="background:Aquamarine;" | Example
+
! scope="row" | '''tributaries_left'''
 +
| [[Tributary|Tributaries]] located on the left bank of the river flowing towards the mouth. List in order from source to mouth.
 
|-
 
|-
|<pre>
+
! scope="row" | '''tributaries_right'''
<!-- The following few lines create the "Infobox" table template.
+
| [[Tributary|Tributaries]] located on the right bank of the river flowing towards the mouth. List in order from source to mouth.
    Please scroll down to edit the main content of the article. -->
 
{{Infobox river
 
| name              = Volga River (Example)
 
| image_name        = Russia_River_Volga.jpg
 
| image_alt      =
 
| caption            = Volga in [[Yaroslavl]] (autumn morning)
 
| origin            = [[Valdai Hills]]
 
| mouth             = [[Caspian Sea]]
 
| basin_countries    = [[Russia]]
 
| length_km          = 3690
 
| length            = <ref name=volga>[www.volga.com Volga]</ref>
 
| elevation_m        = 225
 
| elevation          = &amp;nbsp;above sea level
 
| mouth_elevation_m  = 0
 
| mouth_elevation    =
 
| discharge_m3/s    = 8000
 
| discharge          = <ref name=volga/>
 
| watershed_km2      = 1380000
 
| watershed          =
 
| river_system      =
 
| left_tribs        =
 
| right_tribs        =
 
}}
 
</pre>
 
|}
 
 
 
===Automatic conversion from imperial/US customary to SI===
 
;Note: The imperial/US customary measurement will be displayed first.
 
<pre>
 
<!-- The following few lines create the "Infobox" table template.
 
    Please scroll down to edit the main content of the article. -->
 
{{Infobox river
 
| name              =
 
| image_name        =
 
| image_alt      =
 
| caption            =
 
| image_map          =
 
| map_alt        =
 
| map_caption        =
 
| origin            =
 
| mouth              =
 
| basin_countries    = 
 
| progression        =
 
| length_mi          =
 
| length            =
 
| elevation_ft      =
 
| elevation          =
 
| mouth_elevation_ft =
 
| mouth_elevation    =
 
| discharge_cuft/s  =
 
| discharge          = 
 
| watershed_sqmi    =
 
| watershed          =
 
| river_system      =
 
| left_tribs        =
 
| right_tribs        =
 
}}
 
<!-- End Infobox template table -->
 
</pre>
 
 
 
{| class="wikitable collapsible collapsed" style="width:100%;"
 
 
|-
 
|-
! style="background:PaleGreen;" | Details
+
! scope="row" | '''waterbodies'''
 +
| Water bodies located along the river (such as lakes, reservoirs, etc). List in order from source to mouth.
 
|-
 
|-
|<pre>
+
! scope="row" | '''waterfalls'''
<!-- The following few lines create the "Infobox" table template.
+
| [[Waterfall]]s along the river. List in order from source to mouth.
    Please scroll down to edit the main content of the article. -->
 
{{Infobox river
 
| name              = NAME
 
| image_name        = IMAGE_FILE_NAME
 
| image_alt      =
 
| caption            = CAPTION
 
| image_map          = MAP_FILE_NAME
 
| map_alt        =
 
| map_caption        = MAP CAPTION
 
| origin            = ORIGIN
 
| mouth             = MOUTH
 
| basin_countries    = BASIN_COUNTRIES
 
| progression        = ROUTE TO THE SEA
 
| length_mi          = MILES              <!-- must be a numerical expression -->
 
| length            = REFERENCES/DETAILS
 
| elevation_ft      = FEET                <!-- must be a numerical expression -->
 
| elevation          = REFERENCES/DETAILS
 
| mouth_elevation_ft = FEET                <!-- must be a numerical expression -->
 
| mouth_elevation    = REFERENCES/DETAILS
 
| discharge_cuft/s  = CUBIC FEET          <!-- must be a numerical expression -->
 
| discharge          = REFERENCES/DETAILS
 
| watershed_sqmi    = SQUARE MILES        <!-- must be a numerical expression -->
 
| watershed          = REFERENCES/DETAILS
 
| river_system      = REFERENCES/DETAILS
 
| left_tribs        = REFERENCES/DETAILS
 
| right_tribs        = REFERENCES/DETAILS
 
}}
 
<!-- End Infobox template table -->
 
</pre>
 
|}
 
{| class="wikitable collapsible collapsed" style="width:100%;"
 
 
|-
 
|-
! style="background:Aquamarine;" | Example
+
! scope="row" | '''bridges'''
 +
| [[Bridge]]s along the river. List in order from source to mouth.
 
|-
 
|-
|<pre>
+
! scope="row" | '''ports'''
<!-- The following few lines create the "Infobox" table template.
+
| [[Inland port]]s along the river. List in order from source to mouth.
    Please scroll down to edit the main content of the article. -->
 
{{Infobox river
 
| name              = Volga River (Example)
 
| image_name        = Russia_River_Volga.jpg
 
| image_alt      =
 
| caption            = Volga in [[Yaroslavl]] (autumn morning)
 
| origin            = [[Valdai Hills]]
 
| mouth              = [[Caspian Sea]]
 
| basin_countries    = [[Russia]]
 
| length_mi          = 2290
 
| length            = <ref name=volga>[www.volga.com Volga]</ref>
 
| elevation_ft      = 740
 
| elevation          = &amp;nbsp;above sea level
 
| mouth_elevation_ft = 0
 
| mouth_elevation    =
 
| discharge_cuft/s   = 280000
 
| discharge          = <ref name=volga/>
 
| watershed_sqmi    = 530000
 
| watershed          =
 
| river_system      =
 
| left_tribs        =
 
| right_tribs        =
 
}}
 
</pre>
 
|}
 
 
 
===Entering both SI and imperial/US customary===
 
;Note: The SI measurement will be displayed first.
 
 
 
<pre>
 
<!-- The following few lines create the "Infobox" table template.
 
    Please scroll down to edit the main content of the article. -->
 
{{Infobox river
 
| name              =
 
| image_name        =
 
| image_alt      =
 
| caption            =
 
| image_map          =
 
| map_alt        =
 
| map_caption        =
 
| origin            =
 
| mouth              =
 
| basin_countries    =
 
| progression        =
 
| length_km          =
 
| length_mi          =
 
| length            =
 
| elevation_m        =
 
| elevation_ft      =
 
| elevation          =
 
| mouth_elevation_m  =
 
| mouth_elevation_ft =
 
| mouth_elevation    =
 
| discharge_m3/s    =
 
| discharge_cuft/s  =
 
| discharge          =
 
| watershed_km2      =
 
| watershed_sqmi    =
 
| watershed          =
 
| river_system      =
 
| left_tribs        =
 
| right_tribs        =
 
}}
 
 
 
<!-- End Infobox template table -->
 
</pre>
 
 
 
{| class="wikitable collapsible collapsed" style="width:100%;"
 
 
|-
 
|-
! style="background:PaleGreen;" | Details
+
! scope="row" | '''custom_label'''
 +
| Use this to enter a custom label (such as <code>bridges</code>). To be used with the field below.
 
|-
 
|-
|<pre>
+
! scope="row" | '''custom_data'''
<!-- The following few lines create the "Infobox" table template.
+
| Custom data parameter. See above.
    Please scroll down to edit the main content of the article. -->
 
{{Infobox river
 
| name              = NAME
 
| image_name        = IMAGE_FILE_NAME
 
| image_alt      =
 
| caption            = CAPTION
 
| image_map          = MAP_FILE_NAME
 
| map_alt        =
 
| map_caption        = MAP CAPTION
 
| origin            = ORIGIN
 
| mouth              = MOUTH
 
| basin_countries    = BASIN_COUNTRIES
 
| progression        = ROUTE TO THE SEA
 
| length_km          = KILOMETERS
 
| length_mi          = MILES
 
| length            = REFERENCES/DETAILS
 
| elevation_m        = METERS
 
| elevation_ft      = FEET
 
| elevation          = REFERENCES/DETAILS
 
| mouth_elevation_m  = METERS
 
| mouth_elevation_ft = FEET
 
| mouth_elevation    = REFERENCES/DETAILS
 
| discharge_m3/s    = CUBIC METERS
 
| discharge_cuft/s  = CUBIC FEET
 
| discharge          = REFERENCES/DETAILS
 
| watershed_km2      = SQUARE KILOMETERS
 
| watershed_sqmi    = SQUARE MILES
 
| watershed          = REFERENCES/DETAILS
 
| river_system      = REFERENCES/DETAILS
 
| left_tribs        = REFERENCES/DETAILS
 
| right_tribs        = REFERENCES/DETAILS
 
}}
 
<!-- End Infobox template table -->
 
</pre>
 
|}
 
{| class="wikitable collapsible collapsed" style="width:100%;"
 
 
|-
 
|-
! style="background:Aquamarine;" | Example
+
! scope="row" | '''extra'''
 +
| Use this parameter to add content to the very bottom of the infobox. Useful for adding maps, charts, and so on.
 
|-
 
|-
|<pre>
+
|}
<!-- The following few lines create the "Infobox" table template.
+
{{Infobox river
    Please scroll down to edit the main content of the article. -->
+
| name              = Amazon River (dummy data)
{{Infobox river  
+
| name_native        = Amazonia
| name              = Volga River (Example)
+
| name_native_lang  =
| image_name         = Russia_River_Volga.jpg
+
| name_other         = Apurímac, Ene, Tambo, Ucayali, Amazonas, Solimões
| image_alt       =
+
| name_etymology    = Named after the Amazon Rainforest
| caption           = Volga in [[Yaroslavl]] (autumn morning)
+
| image              = Aerial view of the Amazon Rainforest.jpg
| origin             = [[Valdai Hills]]
+
| image_size        = 300px
| mouth              = [[Caspian Sea]]
+
| image_caption      = Aerial view of the Amazon River
| basin_countries   = [[Russia]]
+
| image_alt         = Alt text for image
| length_km         = 3690
+
| map                = Amazonrivermap.svg
| length_mi          = 2290
+
| map_size          = 300px
| length            = <ref name=volga>[www.volga.com Volga]</ref>
+
| map_caption        = Map of the Amazon basin
| elevation_m        = 225
+
| map_alt           = Alt text for map
| elevation_ft      = 740
+
| pushpin_map        = Brazil
| elevation         = &amp;nbsp;above sea level
+
| pushpin_map_size  = 300
| mouth_elevation_m  = 0
+
| pushpin_map_caption= Location of the mouth in Brazil
| mouth_elevation_ft = 0
+
| pushpin_map_alt    = Map showing the location of the river mouth in Brazil
| mouth_elevation    =  
+
| subdivision_type1  = Countries
| discharge_m3/s    = 8000
+
| subdivision_name1  = [[Brazil]], [[Colombia]], [[Peru]], [[Ecuador]]
| discharge_cuft/s  = 280000
+
| subdivision_type2  = States
| discharge          = <ref name=volga/>
+
| subdivision_name2  = [[Loreto Region|Loreto]] (Peru);<br />[[Amazonas Department|Amazonas]] (Columbia);<br />[[North Region, Brazil|North Region]] (Brazil)
| watershed_km2      = 1380000
+
| subdivision_type3  = Cities
| watershed_sqmi     = 530000
+
| subdivision_name3  = [[Iquitos]] (Peru); [[Leticia, Amazonas|Leticia]] (Colombia);<br /> [[Tabatinga]] (Brazil); [[Tefé]] (Brazil);<br /> [[Itacoatiara, Amazonas|Itacoatiara]] (Brazil); [[Parintins]] (Brazil);<br /> [[Óbidos, Pará|Óbidos]] (Brazil); [[Santarém, Pará|Santarém]] (Brazil);<br /> [[Almeirim, Pará|Almeirim]] (Brazil); [[Macapá]] (Brazil)
| watershed          =  
+
<!---------------------- PHYSICAL CHARACTERISTICS -->
| river_system      =
+
| length             = {{Convert|6992|km|mi|abbr=on}}
| left_tribs         =
+
| width_min          = {{Convert|4|km|mi|abbr=on}}
| right_tribs       =
+
| width_avg          = {{Convert|6|km|mi|abbr=on}}
 +
| width_max          = {{Convert|8|km|mi|abbr=on}}
 +
| depth_min          = {{Convert|3|m|ft|abbr=on}}
 +
| depth_avg          = {{Convert|15|m|ft|abbr=on}}
 +
| depth_max          = {{Convert|30|m|ft|abbr=on}}
 +
| discharge1_location= [[Santarém, Pará]]
 +
| discharge1_min    = {{Convert|109000|m3/s|ft3/s|abbr=on}}
 +
| discharge1_avg    = {{Convert|209000|m3/s|ft3/s|abbr=on}}
 +
| discharge1_max    = {{Convert|309000|m3/s|ft3/s|abbr=on}}
 +
<!---------------------- BASIN FEATURES -->
 +
| source1            = [[Nevado Mismi]], [[Peru]]
 +
| source1_location  = [[Arequipa Region]]
 +
| source1_coordinates= {{coord|15|31|05|S|71|45|55|W}}
 +
| source1_elevation  = {{Convert|5170|m|ft|abbr=on}}
 +
| mouth              = [[Atlantic Ocean]]
 +
| mouth_location    = [[Amapá|State of Amapá]], [[Pará|State of Pará]]
 +
| mouth_coordinates  = {{coord|00|42|28|S|50|05|22|W}}
 +
| mouth_elevation    = {{Convert|0|m|ft|abbr=on}}
 +
| progression        = [[Apurímac River|Apurímac]]—[[Solimões River|Solimões]]—[[Marañón River|Marañón]]
 +
| river_system      = [[Amazon Basin]]
 +
| basin_size        = {{Convert|7050000|km2|mi2|abbr=on}}
 +
| basin_landmarks   = [[Arena da Amazônia|Amazon Arena]]
 +
| basin_population  = 1,234,567
 +
| tributaries_left  = {{hlist|[[Marañón River|Marañón]]|[[Japurá River|Japurá]]|[[Rio Negro (Amazon)|Rio Negro]]|[[Putumayo River|Putumayo]]}}
 +
| tributaries_right  = {{hlist|[[Ucayali River|Ucayali]]|[[Purus River|Purus]]|[[Madeira River|Madeira]]|[[Tapajós]]|[[Xingu River|Xingu]]}}
 +
| waterbodies        = [[Lawriqucha|Lake Lawriqucha]]
 +
| waterfalls        = [[Noel Kempff Mercado National Park|Ahlfeld Waterfall]]
 +
| bridges            = [[Manaus–Iranduba Bridge]]
 +
| ports              = [[Port of Manaus]]
 +
| custom_label      = '''''Custom label'''''
 +
| custom_data        = ''Custom data''
 +
| extra              =
 +
}}
 +
 
 +
== Example ==
 +
<pre style="overflow: auto">
 +
{{Infobox river
 +
| name              = Amazon River (dummy data)
 +
| name_native        = Amazonia
 +
| name_native_lang  =
 +
| name_other        = Apurímac, Ene, Tambo, Ucayali, Amazonas, Solimões
 +
| name_etymology    = Named after the Amazon Rainforest
 +
| image              = Aerial view of the Amazon Rainforest.jpg
 +
| image_size        = 300px
 +
| image_caption      = Aerial view of the Amazon River
 +
| image_alt         = Alt text for image
 +
| map                = Amazonrivermap.svg
 +
| map_size          = 300px
 +
| map_caption        = Map of the Amazon basin
 +
| map_alt            = Alt text for map
 +
| pushpin_map        = Brazil
 +
| pushpin_map_size  = 300
 +
| pushpin_map_caption= Location of the mouth in Brazil
 +
| pushpin_map_alt    = Map showing the location of the river mouth in Brazil
 +
| subdivision_type1  = Countries
 +
| subdivision_name1  = [[Brazil]], [[Colombia]], [[Peru]], [[Ecuador]]
 +
| subdivision_type2  = States
 +
| subdivision_name2  = [[Loreto Region|Loreto]] (Peru);<br />[[Amazonas Department|Amazonas]] (Columbia);<br />[[North Region, Brazil|North Region]] (Brazil)
 +
| subdivision_type3  = Cities
 +
| subdivision_name3  = [[Iquitos]] (Peru); [[Leticia, Amazonas|Leticia]] (Colombia);<br /> [[Tabatinga]] (Brazil); [[Tefé]] (Brazil);<br /> [[Itacoatiara, Amazonas|Itacoatiara]] (Brazil); [[Parintins]] (Brazil);<br /> [[Óbidos, Pará|Óbidos]] (Brazil); [[Santarém, Pará|Santarém]] (Brazil);<br /> [[Almeirim, Pará|Almeirim]] (Brazil); [[Macapá]] (Brazil)
 +
<!---------------------- PHYSICAL CHARACTERISTICS -->
 +
| length            = {{Convert|6992|km|mi|abbr=on}}
 +
| width_min          = {{Convert|4|km|mi|abbr=on}}
 +
| width_avg          = {{Convert|6|km|mi|abbr=on}}
 +
| width_max          = {{Convert|8|km|mi|abbr=on}}
 +
| depth_min         = {{Convert|3|m|ft|abbr=on}}
 +
| depth_avg          = {{Convert|15|m|ft|abbr=on}}
 +
| depth_max          = {{Convert|30|m|ft|abbr=on}}
 +
| discharge1_location= [[Santarém, Pará]]
 +
| discharge1_min    = {{Convert|109000|m3/s|ft3/s|abbr=on}}
 +
| discharge1_avg     = {{Convert|209000|m3/s|ft3/s|abbr=on}}
 +
| discharge1_max    = {{Convert|309000|m3/s|ft3/s|abbr=on}}
 +
<!---------------------- BASIN FEATURES -->
 +
| source1            = [[Nevado Mismi]], [[Peru]]
 +
| source1_location   = [[Arequipa Region]]
 +
| source1_coordinates= {{coord|15|31|05|S|71|45|55|W}}
 +
| source1_elevation  = {{Convert|5170|m|ft|abbr=on}}
 +
| mouth              = [[Atlantic Ocean]]
 +
| mouth_location     = [[Amapá|State of Amapá]], [[Pará|State of Pará]]
 +
| mouth_coordinates  = {{coord|00|42|28|S|50|05|22|W|display=inline,title}}
 +
| mouth_elevation    = {{Convert|0|m|ft|abbr=on}}
 +
| progression        = [[Apurímac River|Apurímac]]—[[Solimões River|Solimões]]—[[Marañón River|Marañón]]
 +
| river_system      = [[Amazon Basin]]
 +
| basin_size        = {{Convert|7050000|km2|mi2|abbr=on}}
 +
| basin_landmarks    = [[Arena da Amazônia|Amazon Arena]]
 +
| basin_population  = 1,234,567
 +
| tributaries_left  = {{hlist|[[Marañón River|Marañón]]|[[Japurá River|Japurá]]|[[Rio Negro (Amazon)|Rio Negro]]|[[Putumayo River|Putumayo]]}}
 +
| tributaries_right  = {{hlist|[[Ucayali River|Ucayali]]|[[Purus River|Purus]]|[[Madeira River|Madeira]]|[[Tapajós]]|[[Xingu River|Xingu]]}}
 +
| waterbodies        = [[Lawriqucha|Lake Lawriqucha]]
 +
| waterfalls         = [[Noel Kempff Mercado National Park|Ahlfeld Waterfall]]
 +
| bridges            = [[Manaus–Iranduba Bridge]]
 +
| ports              = [[Port of Manaus]]
 +
| custom_label      = '''''Custom label'''''
 +
| custom_data       = ''Custom data''
 +
| extra              = ''(optional content at the bottom – centred)''
 
}}
 
}}
 
</pre>
 
</pre>
|}
+
{{Clear}}
 +
 
 +
== Template Data ==
 +
{{TemplateData header}}
 +
{{collapse top|bg=#ccc|title=Template Data}}
 +
<templatedata>
 +
{
 +
"params": {
 +
"embed": {},
 +
"name": {},
 +
"qid": {},
 +
"suppressfields": {},
 +
"fetchwikidata": {},
 +
"image": {},
 +
"image_size": {},
 +
"image_upright": {},
 +
"image_alt": {},
 +
"image_caption": {},
 +
"map": {},
 +
"map_size": {},
 +
"map_alt": {},
 +
"map_caption": {},
 +
"pushpin_map": {},
 +
"mouth_coordinates": {},
 +
"pushpin_map_alt": {},
 +
"pushpin_map_size": {},
 +
"pushpin_map_relief": {},
 +
"pushpin_map_caption": {},
 +
"name_native": {},
 +
"native_name": {},
 +
"name_native_lang": {},
 +
"name_other": {},
 +
"etymology": {},
 +
"name_etymology": {},
 +
"subdivision_type1": {},
 +
"country_type": {},
 +
"subdivision_name1": {},
 +
"country": {},
 +
"subdivision_type2": {},
 +
"state_type": {},
 +
"subdivision_name2": {},
 +
"state": {},
 +
"subdivision_type3": {},
 +
"region_type": {},
 +
"subdivision_name3": {},
 +
"region": {},
 +
"subdivision_type4": {},
 +
"district_type": {},
 +
"subdivision_name4": {},
 +
"district": {},
 +
"subdivision_type5": {},
 +
"municipality_type": {},
 +
"subdivision_name5": {},
 +
"municipality": {},
 +
"source1": {},
 +
"source1_location": {},
 +
"source1_elevation": {},
 +
"source1_coordinates": {},
 +
"source2": {},
 +
"source2_location": {},
 +
"source2_elevation": {},
 +
"source2_coordinates": {},
 +
"source3": {},
 +
"source3_location": {},
 +
"source3_elevation": {},
 +
"source3_coordinates": {},
 +
"source4": {},
 +
"source4_location": {},
 +
"source4_elevation": {},
 +
"source4_coordinates": {},
 +
"source5": {},
 +
"source5_location": {},
 +
"source5_elevation": {},
 +
"source5_coordinates": {},
 +
"mouth": {},
 +
"mouth_location": {},
 +
"mouth_elevation": {},
 +
"length": {},
 +
"width_min": {},
 +
"width_avg": {},
 +
"width_max": {},
 +
"depth_min": {},
 +
"depth_avg": {},
 +
"depth_max": {},
 +
"discharge1_location": {},
 +
"discharge1_min": {},
 +
"discharge1_avg": {},
 +
"discharge1_max": {},
 +
"mouth_elevation_metric": {},
 +
"mouth_elevation_imperial": {},
 +
"mouth_coord_ref": {},
 +
"length_metric": {},
 +
"length_imperial": {},
 +
"width_min_metric": {},
 +
"width_min_imperial": {},
 +
"width_avg_metric": {},
 +
"width_avg_imperial": {},
 +
"width_max_metric": {},
 +
"width_max_imperial": {},
 +
"discharge1": {},
 +
"discharge1_min_metric": {},
 +
"discharge1_min_imperial": {},
 +
"discharge1_avg_metric": {},
 +
"discharge1_avg_imperial": {},
 +
"discharge1_max_metric": {},
 +
"discharge1_max_imperial": {},
 +
"discharge2": {},
 +
"discharge2_location": {},
 +
"discharge2_min": {},
 +
"discharge2_avg": {},
 +
"discharge2_max": {},
 +
"discharge3": {},
 +
"discharge3_location": {},
 +
"discharge3_min": {},
 +
"discharge3_avg": {},
 +
"discharge3_max": {},
 +
"discharge4": {},
 +
"discharge4_location": {},
 +
"discharge4_min": {},
 +
"discharge4_avg": {},
 +
"discharge4_max": {},
 +
"discharge5": {},
 +
"discharge5_location": {},
 +
"discharge5_min": {},
 +
"discharge5_avg": {},
 +
"discharge5_max": {},
 +
"progression": {},
 +
"river_system": {},
 +
"basin_size": {},
 +
"basin_landmarks": {},
 +
"basin_population": {},
 +
"tributaries_left": {},
 +
"tributaries_right": {},
 +
"waterbodies": {},
 +
"waterfalls": {},
 +
"bridges": {},
 +
"ports": {},
 +
"custom_data": {},
 +
"parent": {},
 +
"landmark": {},
 +
"cities": {},
 +
"city": {},
 +
"custom_label": {},
 +
"extra": {}
 +
}
 +
}
 +
</templatedata>
 +
{{collapse bottom}}
 +
 
 +
== Tracking categories ==
 +
* {{clc|Pages using infobox river with unknown parameters}}
  
<includeonly>
+
{{When on basepage|
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS HERE, INSIDE INCLUDEONLY TAGS, THANK YOU. -->
+
<!--Categories below this line, please; interwikis at Wikidata-->
<!-- CATEGORIES -->
+
[[Category:Place infobox templates|River]]
[[Category:Geography infobox templates|River]]
 
 
[[Category:WikiProject Rivers]]
 
[[Category:WikiProject Rivers]]
 
[[Category:WikiProject Rivers templates]]
 
[[Category:WikiProject Rivers templates]]
 
+
[[Category:Embeddable templates]]
<!-- INTERWIKIS -->
+
[[Category:Templates that add a tracking category]]
[[af:Sjabloon:Rivier]]
+
}}
[[ar:قالب:أنهار]]
 
[[an:Plantilla:Río]]
 
[[be:Шаблон:Рака]]
 
[[bn:Template:তথ্যছক নদী]]
 
[[bs:Šablon:Infokutija rijeka]]
 
[[ca:Plantilla:Riu]]
 
[[cs:Šablona:Infobox řeka]]
 
[[da:Skabelon:Infoboks flod]]
 
[[de:Vorlage:Infobox_Fluss]]
 
[[es:Plantilla:Río]]
 
[[eo:Ŝablono:Riveroj]]
 
[[fr:Modèle:Infobox Cours d'eau]]
 
[[hr:Predložak:Rijeka]]
 
[[hsb:Předłoha:Infokašćik rěka]]
 
[[ku:Şablon:Infobox çem]]
 
[[lv:Veidne:Infobox upe]]
 
[[hu:Sablon:Folyó infobox]]
 
[[ja:Template:Infobox 河川]]
 
[[ka:თარგი:ინფოდაფა მდინარე]]
 
[[ko:틀:강 정보]]
 
[[ml:ഫലകം:Infobox River]]
 
[[ms:Templat:Infobox River]]
 
[[nl:Sjabloon:Infobox_rivier]]
 
[[no:Mal:Infoboks elv]]
 
[[nn:Mal:Infoboks elv]]
 
[[os:Шаблон:Цæугæдон]]
 
[[pl:Szablon:Rzeka infobox]]
 
[[pt:Predefinição:Info/Rio]]
 
[[ro:Format:Infobox River]]
 
[[ru:Шаблон:Река]]
 
[[sl:Predloga:Infopolje Reka]]
 
[[fi:Malline:Joki]]
 
[[sv:Mall:Vattendrag]]
 
[[ur:سانچہ:Infobox river]]
 
[[zh:Template:Infobox River]]
 
</includeonly>
 

Latest revision as of 23:12, 22 January 2021

Template:Tracks Wikidata

Template:Parameter names example

Usage

{{Infobox river
| name               = 
| name_native        = 
| name_native_lang   = 
| name_other         = 
| name_etymology     = 
| nickname           =
<!---------------------- IMAGE-->
| image              = 
| image_size         = 
| image_caption      = 
| image_alt          =
<!---------------------- MAPS -->
| map                = 
| map_size           = 
| map_caption        = 
| map_alt            = 
| pushpin_map        = 
| pushpin_map_size   = 
| pushpin_map_caption= 
| pushpin_map_alt    = 
<!---------------------- LOCATION -->
| subdivision_type1  = 
| subdivision_name1  = 
| subdivision_type2  = 
| subdivision_name2  = 
| subdivision_type3  = 
| subdivision_name3  = 
| subdivision_type4  = 
| subdivision_name4  = 
| subdivision_type5  = 
| subdivision_name5  = 
<!---------------------- PHYSICAL CHARACTERISTICS -->
| length             = 
| width_min          = 
| width_avg          = 
| width_max          = 
| depth_min          = 
| depth_avg          = 
| depth_max          = 
| discharge1_location= 
| discharge1_min     = 
| discharge1_avg     = 
| discharge1_max     = 
<!---------------------- BASIN FEATURES -->
| source1            = 
| source1_location   = 
| source1_coordinates= <!-- {{Coord|...}} -->
| source1_elevation  = 
| mouth              = 
| mouth_location     = 
| mouth_coordinates  = <!-- {{Coord|...|display=inline,title}} -->
| mouth_elevation    = 
| progression        = 
| river_system       = 
| basin_size         = 
| basin_landmarks    = 
| basin_population   = 
| tributaries_left   = 
| tributaries_right  = 
| waterbodies        = 
| waterfalls         = 
| bridges            = 
| ports              = 
| custom_label       = 
| custom_data        = 
| extra              = 
}}

Parameter names and descriptions

Parameter name Description
name The common name of the river.
name_native The native/local name of the river.
name_native_lang ISO 639-1 or ISO 639-2 language code of the language used in name_native. Used for accessibility.
name_other Other name(s) of the river. Use commas to enter multiple.
name_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.
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.
You may add up to discharge5.
discharge1_min Minimum discharge rate. Rarely used.
Consider using {{Convert|1234|m3/s|ft3/s|abbr=on}}
discharge1_avg Average discharge rate.
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}}
BASIN FEATURES
source1 Landform or waterbody of the primary source. You may add up to source5. 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_coordinates Coordinates of the main source, using the {{coord}} template.
source1_elevation Elevation at the main source of water
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 RegnitzMainRhineNorth Sea in the Infobox. See Category:Drainage basin succession templates for a list of templates that can be used with this parameter.
river system Name of the river system.
basin_landmarks 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.
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
Alt text for image
Aerial view of the Amazon River
Alt text for map
Map of the Amazon basin
Lua error in Module:Location_map at line 399: Malformed coordinates value.
EtymologyNamed after the Amazon Rainforest
Native nameTemplate:Native name
Location
CountriesBrazil, Colombia, Peru, Ecuador
StatesLoreto (Peru);
Amazonas (Columbia);
North Region (Brazil)
CitiesIquitos (Peru); Leticia (Colombia);
Tabatinga (Brazil); Tefé (Brazil);
Itacoatiara (Brazil); Parintins (Brazil);
Óbidos (Brazil); Santarém (Brazil);
Almeirim (Brazil); Macapá (Brazil)
Physical characteristics
SourceNevado Mismi, Peru
 • locationArequipa Region
 • coordinatesLua error: callParserFunction: function "#coordinates" was not found.
 • elevation5,170 m (16,960 ft)
MouthAtlantic Ocean
 • location
State of Amapá, State of Pará
 • coordinates
Lua error: callParserFunction: function "#coordinates" was not found.
 • elevation
0 m (0 ft)
Length6,992 km (4,345 mi)
Basin size7,050,000 km2 (2,720,000 sq mi)
Width 
 • minimum4 km (2.5 mi)
 • average6 km (3.7 mi)
 • maximum8 km (5.0 mi)
Depth 
 • minimum3 m (9.8 ft)
 • average15 m (49 ft)
 • maximum30 m (98 ft)
Discharge 
 • locationSantarém, Pará
 • average209,000 m3/s (7,400,000 cu ft/s)
 • minimum109,000 m3/s (3,800,000 cu ft/s)
 • maximum309,000 m3/s (10,900,000 cu ft/s)
Basin features
ProgressionApurímacSolimõesMarañón
River systemAmazon Basin
LandmarksAmazon Arena
Population1,234,567
Tributaries 
 • left
 • right
WaterbodiesLake Lawriqucha
WaterfallsAhlfeld Waterfall
BridgesManaus–Iranduba Bridge
Inland portsPort of Manaus
Custom labelCustom data

Example

{{Infobox river
| name               = Amazon River (dummy data)
| name_native        = Amazonia
| name_native_lang   = 
| name_other         = Apurímac, Ene, Tambo, Ucayali, Amazonas, Solimões
| name_etymology     = Named after the Amazon Rainforest
| image              = Aerial view of the Amazon Rainforest.jpg
| image_size         = 300px
| image_caption      = Aerial view of the Amazon River
| image_alt          = Alt text for image
| map                = Amazonrivermap.svg
| map_size           = 300px
| map_caption        = Map of the Amazon basin
| map_alt            = Alt text for map
| pushpin_map        = Brazil
| pushpin_map_size   = 300
| pushpin_map_caption= Location of the mouth in Brazil
| pushpin_map_alt    = Map showing the location of the river mouth in Brazil
| subdivision_type1  = Countries
| subdivision_name1  = [[Brazil]], [[Colombia]], [[Peru]], [[Ecuador]]
| subdivision_type2  = States
| subdivision_name2  = [[Loreto Region|Loreto]] (Peru);<br />[[Amazonas Department|Amazonas]] (Columbia);<br />[[North Region, Brazil|North Region]] (Brazil)
| subdivision_type3  = Cities
| subdivision_name3  = [[Iquitos]] (Peru); [[Leticia, Amazonas|Leticia]] (Colombia);<br /> [[Tabatinga]] (Brazil); [[Tefé]] (Brazil);<br /> [[Itacoatiara, Amazonas|Itacoatiara]] (Brazil); [[Parintins]] (Brazil);<br /> [[Óbidos, Pará|Óbidos]] (Brazil); [[Santarém, Pará|Santarém]] (Brazil);<br /> [[Almeirim, Pará|Almeirim]] (Brazil); [[Macapá]] (Brazil)
<!---------------------- PHYSICAL CHARACTERISTICS -->
| length             = {{Convert|6992|km|mi|abbr=on}}
| width_min          = {{Convert|4|km|mi|abbr=on}}
| width_avg          = {{Convert|6|km|mi|abbr=on}}
| width_max          = {{Convert|8|km|mi|abbr=on}}
| depth_min          = {{Convert|3|m|ft|abbr=on}}
| depth_avg          = {{Convert|15|m|ft|abbr=on}}
| depth_max          = {{Convert|30|m|ft|abbr=on}}
| discharge1_location= [[Santarém, Pará]]
| discharge1_min     = {{Convert|109000|m3/s|ft3/s|abbr=on}}
| discharge1_avg     = {{Convert|209000|m3/s|ft3/s|abbr=on}}
| discharge1_max     = {{Convert|309000|m3/s|ft3/s|abbr=on}}
<!---------------------- BASIN FEATURES -->
| source1            = [[Nevado Mismi]], [[Peru]]
| source1_location   = [[Arequipa Region]]
| source1_coordinates= {{coord|15|31|05|S|71|45|55|W}}
| source1_elevation  = {{Convert|5170|m|ft|abbr=on}}
| mouth              = [[Atlantic Ocean]]
| mouth_location     = [[Amapá|State of Amapá]], [[Pará|State of Pará]]
| mouth_coordinates  = {{coord|00|42|28|S|50|05|22|W|display=inline,title}}
| mouth_elevation    = {{Convert|0|m|ft|abbr=on}}
| progression        = [[Apurímac River|Apurímac]]—[[Solimões River|Solimões]]—[[Marañón River|Marañón]]
| river_system       = [[Amazon Basin]]
| basin_size         = {{Convert|7050000|km2|mi2|abbr=on}}
| basin_landmarks    = [[Arena da Amazônia|Amazon Arena]]
| basin_population   = 1,234,567
| tributaries_left   = {{hlist|[[Marañón River|Marañón]]|[[Japurá River|Japurá]]|[[Rio Negro (Amazon)|Rio Negro]]|[[Putumayo River|Putumayo]]}}
| tributaries_right  = {{hlist|[[Ucayali River|Ucayali]]|[[Purus River|Purus]]|[[Madeira River|Madeira]]|[[Tapajós]]|[[Xingu River|Xingu]]}}
| waterbodies        = [[Lawriqucha|Lake Lawriqucha]]
| waterfalls         = [[Noel Kempff Mercado National Park|Ahlfeld Waterfall]]
| bridges            = [[Manaus–Iranduba Bridge]]
| ports              = [[Port of Manaus]]
| custom_label       = '''''Custom label'''''
| custom_data        = ''Custom data''
| extra              = ''(optional content at the bottom – centred)''
}}

Template Data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Infobox river

Template Data

No description.

Template parameters

ParameterDescriptionTypeStatus
Embedembed

no description

Unknownoptional
Namename

no description

Unknownoptional
Qidqid

no description

Unknownoptional
Suppressfieldssuppressfields

no description

Unknownoptional
Fetchwikidatafetchwikidata

no description

Unknownoptional
Imageimage

no description

Unknownoptional
Image_sizeimage_size

no description

Unknownoptional
Image_uprightimage_upright

no description

Unknownoptional
Image_altimage_alt

no description

Unknownoptional
Image_captionimage_caption

no description

Unknownoptional
Mapmap

no description

Unknownoptional
Map_sizemap_size

no description

Unknownoptional
Map_altmap_alt

no description

Unknownoptional
Map_captionmap_caption

no description

Unknownoptional
Pushpin_mappushpin_map

no description

Unknownoptional
Mouth_coordinatesmouth_coordinates

no description

Unknownoptional
Pushpin_map_altpushpin_map_alt

no description

Unknownoptional
Pushpin_map_sizepushpin_map_size

no description

Unknownoptional
Pushpin_map_reliefpushpin_map_relief

no description

Unknownoptional
Pushpin_map_captionpushpin_map_caption

no description

Unknownoptional
Name_nativename_native

no description

Unknownoptional
Native_namenative_name

no description

Unknownoptional
Name_native_langname_native_lang

no description

Unknownoptional
Name_othername_other

no description

Unknownoptional
Etymologyetymology

no description

Unknownoptional
Name_etymologyname_etymology

no description

Unknownoptional
Subdivision_type1subdivision_type1

no description

Unknownoptional
Country_typecountry_type

no description

Unknownoptional
Subdivision_name1subdivision_name1

no description

Unknownoptional
Countrycountry

no description

Unknownoptional
Subdivision_type2subdivision_type2

no description

Unknownoptional
State_typestate_type

no description

Unknownoptional
Subdivision_name2subdivision_name2

no description

Unknownoptional
Statestate

no description

Unknownoptional
Subdivision_type3subdivision_type3

no description

Unknownoptional
Region_typeregion_type

no description

Unknownoptional
Subdivision_name3subdivision_name3

no description

Unknownoptional
Regionregion

no description

Unknownoptional
Subdivision_type4subdivision_type4

no description

Unknownoptional
District_typedistrict_type

no description

Unknownoptional
Subdivision_name4subdivision_name4

no description

Unknownoptional
Districtdistrict

no description

Unknownoptional
Subdivision_type5subdivision_type5

no description

Unknownoptional
Municipality_typemunicipality_type

no description

Unknownoptional
Subdivision_name5subdivision_name5

no description

Unknownoptional
Municipalitymunicipality

no description

Unknownoptional
Source1source1

no description

Unknownoptional
Source1_locationsource1_location

no description

Unknownoptional
Source1_elevationsource1_elevation

no description

Unknownoptional
Source1_coordinatessource1_coordinates

no description

Unknownoptional
Source2source2

no description

Unknownoptional
Source2_locationsource2_location

no description

Unknownoptional
Source2_elevationsource2_elevation

no description

Unknownoptional
Source2_coordinatessource2_coordinates

no description

Unknownoptional
Source3source3

no description

Unknownoptional
Source3_locationsource3_location

no description

Unknownoptional
Source3_elevationsource3_elevation

no description

Unknownoptional
Source3_coordinatessource3_coordinates

no description

Unknownoptional
Source4source4

no description

Unknownoptional
Source4_locationsource4_location

no description

Unknownoptional
Source4_elevationsource4_elevation

no description

Unknownoptional
Source4_coordinatessource4_coordinates

no description

Unknownoptional
Source5source5

no description

Unknownoptional
Source5_locationsource5_location

no description

Unknownoptional
Source5_elevationsource5_elevation

no description

Unknownoptional
Source5_coordinatessource5_coordinates

no description

Unknownoptional
Mouthmouth

no description

Unknownoptional
Mouth_locationmouth_location

no description

Unknownoptional
Mouth_elevationmouth_elevation

no description

Unknownoptional
Lengthlength

no description

Unknownoptional
Width_minwidth_min

no description

Unknownoptional
Width_avgwidth_avg

no description

Unknownoptional
Width_maxwidth_max

no description

Unknownoptional
Depth_mindepth_min

no description

Unknownoptional
Depth_avgdepth_avg

no description

Unknownoptional
Depth_maxdepth_max

no description

Unknownoptional
Discharge1_locationdischarge1_location

no description

Unknownoptional
Discharge1_mindischarge1_min

no description

Unknownoptional
Discharge1_avgdischarge1_avg

no description

Unknownoptional
Discharge1_maxdischarge1_max

no description

Unknownoptional
Mouth_elevation_metricmouth_elevation_metric

no description

Unknownoptional
Mouth_elevation_imperialmouth_elevation_imperial

no description

Unknownoptional
Mouth_coord_refmouth_coord_ref

no description

Unknownoptional
Length_metriclength_metric

no description

Unknownoptional
Length_imperiallength_imperial

no description

Unknownoptional
Width_min_metricwidth_min_metric

no description

Unknownoptional
Width_min_imperialwidth_min_imperial

no description

Unknownoptional
Width_avg_metricwidth_avg_metric

no description

Unknownoptional
Width_avg_imperialwidth_avg_imperial

no description

Unknownoptional
Width_max_metricwidth_max_metric

no description

Unknownoptional
Width_max_imperialwidth_max_imperial

no description

Unknownoptional
Discharge1discharge1

no description

Unknownoptional
Discharge1_min_metricdischarge1_min_metric

no description

Unknownoptional
Discharge1_min_imperialdischarge1_min_imperial

no description

Unknownoptional
Discharge1_avg_metricdischarge1_avg_metric

no description

Unknownoptional
Discharge1_avg_imperialdischarge1_avg_imperial

no description

Unknownoptional
Discharge1_max_metricdischarge1_max_metric

no description

Unknownoptional
Discharge1_max_imperialdischarge1_max_imperial

no description

Unknownoptional
Discharge2discharge2

no description

Unknownoptional
Discharge2_locationdischarge2_location

no description

Unknownoptional
Discharge2_mindischarge2_min

no description

Unknownoptional
Discharge2_avgdischarge2_avg

no description

Unknownoptional
Discharge2_maxdischarge2_max

no description

Unknownoptional
Discharge3discharge3

no description

Unknownoptional
Discharge3_locationdischarge3_location

no description

Unknownoptional
Discharge3_mindischarge3_min

no description

Unknownoptional
Discharge3_avgdischarge3_avg

no description

Unknownoptional
Discharge3_maxdischarge3_max

no description

Unknownoptional
Discharge4discharge4

no description

Unknownoptional
Discharge4_locationdischarge4_location

no description

Unknownoptional
Discharge4_mindischarge4_min

no description

Unknownoptional
Discharge4_avgdischarge4_avg

no description

Unknownoptional
Discharge4_maxdischarge4_max

no description

Unknownoptional
Discharge5discharge5

no description

Unknownoptional
Discharge5_locationdischarge5_location

no description

Unknownoptional
Discharge5_mindischarge5_min

no description

Unknownoptional
Discharge5_avgdischarge5_avg

no description

Unknownoptional
Discharge5_maxdischarge5_max

no description

Unknownoptional
Progressionprogression

no description

Unknownoptional
River_systemriver_system

no description

Unknownoptional
Basin_sizebasin_size

no description

Unknownoptional
Basin_landmarksbasin_landmarks

no description

Unknownoptional
Basin_populationbasin_population

no description

Unknownoptional
Tributaries_lefttributaries_left

no description

Unknownoptional
Tributaries_righttributaries_right

no description

Unknownoptional
Waterbodieswaterbodies

no description

Unknownoptional
Waterfallswaterfalls

no description

Unknownoptional
Bridgesbridges

no description

Unknownoptional
Portsports

no description

Unknownoptional
Custom_datacustom_data

no description

Unknownoptional
Parentparent

no description

Unknownoptional
Landmarklandmark

no description

Unknownoptional
Citiescities

no description

Unknownoptional
Citycity

no description

Unknownoptional
Custom_labelcustom_label

no description

Unknownoptional
Extraextra

no description

Unknownoptional

Tracking categories