Editing Template:Infobox river/doc (section)

== Parameter names and descriptions ==
{| class="wikitable plainrowheaders"
|-
! scope="col" | Parameter name
! scope="col" | Description
|-
! scope="row" | '''name'''
| The common name of the river.
|-
! scope="row" | '''native_name'''<br> or '''name_native'''
| The name in its official or de facto language. Use {{tlx|native name}} or, for multiple names, use {{tlx|native name list}}
|-
! scope="row" | '''name_other'''<br> or '''other_name'''
| Other name(s) of the river. Use commas to enter multiple. Displayed under the infobox heading.
|-
! scope="row" | '''nickname'''
| Local name(s) for the river. Use commas to enter multiple.
|-
! scope="row" | '''name_etymology'''<br> or '''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.
|-
! 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>.
|-
! scope="row" | '''image_caption'''
| Caption for the main image.
|-
! scope="row" | '''image_alt'''
| Alt text for the main image.
|-
! scope="row" | '''map'''
| Map image filename without the <code>File:</code> or <code>Image:</code> prefix.
|-
! scope="row" | '''map_size'''
| Width of the image in pixels (i.e. <code>200px</code>). Common sizes are usually around <code>280px</code> to <code>300px</code>.
|-
! scope="row" | '''map_caption'''
| Caption for the map image.
|-
! scope="row" | '''map_alt'''
| Alt text for the map image.
|-
! scope="row" | '''pushpin_map'''
| 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.
|-
! scope="row" | '''pushpin_map_size'''
| The width of the location map in pixels as a raw number, without any <code>px</code> suffix
|-
! scope="row" | '''pushpin_map_caption'''
| Caption for the location map
|-
! scope="row" | '''pushpin_map_alt'''
| Alt text for the location map image.
|-
! scope="row" | '''pushpin_map_relief'''
| A pushpin map will be displayed in relief by default. Use <code>pushpin_map_relief = 0</code> for a plain map.
|-
! scope="row" | '''mapframe'''
| A mapframe map can be enabled with this. See [[#Mapframe parameters]] below for more information.
|-
! 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}}'''
|-
! scope="row" | '''length'''
| The total length of the river's [[main stem]]. Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|km|mi|abbr=on<nowiki>}}</nowiki></code>'''
|-
! scope="row" | '''length_km'''
| Total length of the river's main stem, measured in kilometers.
|-
! scope="row" | '''length_mi'''
| Total length of the river's main stem, measured in miles.
|-
! scope="row" | '''length_ref'''
| References or other notes for length of river, used only if {{para|length_km}} or {{para|length_mi}} are used.
|-
! 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. 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. 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]]. 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. 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. 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]]. 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>.
|-
! scope="row" | '''discharge1_min'''
| Minimum discharge rate. Rarely used. 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 (also use if a source provides only one discharge rate without a minimum or maximum). 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. Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|m3/s|ft3/s|abbr=on<nowiki>}}</nowiki></code>'''
|-
! scope="row" | '''discharge2_*  &rArr;  5_*'''
| Up to four more sets of discharge parameters. '''You may add up to <code>discharge5_*</code>'''.
|-
| colspan=2 bgcolor=#CEDEFF | '''{{center|BASIN FEATURES}}'''
|-
! scope="row" | '''source1'''
| Landform or waterbody of the primary source. For a source that is a [[confluence]], you may add as: <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_elevation'''
| Elevation at the main source of water
|-
! scope="row" | '''source1_coordinates'''
| Coordinates of the main source, using the {{tl|coord}} template. Use {{para|display|inline}} only.
|-
! scope="row" | '''source1_coord_ref'''
| Reference for the coordinates of the main source.
|-
! scope="row" | '''source1_length'''
| Length from the main source<!-- to what? -->. 
|-
! scope="row" | '''source2 &rArr; source5'''
| Landform or waterbody of further sources. You may add up to '''<code>source5</code>'''. Also '''source2_location''', '''source2_elevation''', '''source2_coordinates''', '''source2_coord_ref''', '''source2_length''' etc.
|-
! 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.
|-
! scope="row" | '''river_system'''<br> or '''parent'''
| Name of the [[Drainage system (geomorphology)|river system]].
|-
! scope="row" | '''basin_landmarks'''<br> or '''landmark'''
| Popular landmarks along the river. Use commas for multiple.
|-
! scope="row" | '''basin_population'''
| Population within the river basin.
|-
! scope="row" | '''basin_size'''
| Size of the river's [[drainage basin]]. Consider using '''<code><nowiki>{{</nowiki>[[Template:Convert|Convert]]|1234|km2|mi2|abbr=on<nowiki>}}</nowiki></code>'''
|-
! scope="row" | '''basin_size_km2'''
| Size of the river's drainage basin, in square kilometers.
|-
! scope="row" | '''basin_size_mi2'''
| Size of the river's drainage basin, in square miles.
|-
! 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.
|-
! scope="row" | '''tributaries_right'''
| [[Tributary|Tributaries]] located on the right bank of the river flowing towards the mouth. List in order from source to mouth.
|-
! scope="row" | '''waterbodies'''
| Water bodies located along the river (such as lakes, reservoirs, etc). List in order from source to mouth.
|-
! scope="row" | '''waterfalls'''
| [[Waterfall]]s along the river. List in order from source to mouth.
|-
! scope="row" | '''bridges'''
| [[Bridge]]s along the river. List in order from source to mouth.
|-
! scope="row" | '''ports'''
| [[Inland port]]s along the river. List in order from source to mouth.
|-
! scope="row" | '''city''' or '''cities'''
| Cities along the river. List in order from source to mouth. Use '''city''' or '''cities''', not both.
|-
! scope="row" | '''custom_label'''
| Use this to enter a custom label (such as <code>bridges</code>). To be used with the field below.
|-
! scope="row" | '''custom_data'''
| Custom data parameter. See above.
|-
! scope="row" | '''extra'''
| Use this parameter to add content to the very bottom of the infobox. Useful for adding maps, charts, and so on.
|-
|}

===Mapframe parameters===

{{Infobox mapframe/doc/parameters
| onByDefault = yes, unless one of these parameters has a value: {{para|map}}, {{para|pushpin_map}}.
| mapframe-frame-width = 250
| mapframe-stroke-color = #0000ff
| mapframe-marker = water
| mapframe-type = river
}}

===Suppressing images ===
To completely suppress the default image in the Infobox, including any image from Wikidata, use  {{para|suppressfields|image}}.