Template:Infobox river/doc
![]() | This is a documentation subpage for Template:Infobox river. It may contain usage information, categories and other content that is not part of the original template page. |
![]() | This template is used on approximately 31,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
![]() | This template uses Lua: |
![]() | This template adds an automatically generated short description. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article. |
{{{name}}} {{{name_other}}} | |
---|---|
[[File:{{{image}}}|{{{image_size}}}|alt={{{image_alt}}}|upright=1]] {{{image_caption}}} | |
[[File:{{{map}}}|{{{map_size}}}|alt={{{map_alt}}}]] {{{map_caption}}} | |
Etymology | {{{etymology}}} |
Nickname(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
[edit]{{Infobox river
| name =
| native_name = <!-- {{native name|<tag>|<name>}} or {{native name list |tag1=<tag>|name1=<name> |tag2=<tag>|name2=<name> ... }} -->
| 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
[edit]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 | |
![]() 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 | 15°31′05″S 71°45′55″W / 15.51806°S 71.76528°W |
• elevation | 5,170 m (16,960 ft) |
Mouth | Atlantic Ocean |
• location | State of Amapá, State of Pará |
• coordinates | 00°42′28″S 50°05′22″W / 0.70778°S 50.08944°W |
• 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 | |
• right | |
Waterbodies | Lake Lawriqucha |
Waterfalls | Ahlfeld Waterfall |
Bridges | Manaus–Iranduba Bridge |
Inland ports | Port of Manaus |
Custom label | Custom data |
Example
[edit]{{Infobox river
| name = Amazon River (dummy data)
| name_native = {{Native name|pt|Amazonia}}
| 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 (Colombian 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
[edit]TemplateData for Infobox river
Template Data
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
No description.
|
Subtemplates
[edit]- {{Infobox river/discharge}}
- {{Infobox river/row-style}}
- {{Infobox river/calcunit}}
- {{Infobox river/source}}
Tracking categories
[edit]