Cithakan:Geobox River

All Geoboxes in this series have been superseded by Geoboxes 2. These old Geoboxes are still functional but all development has been moved to the new series.

Not much changes for the common user, most field names, logic, functionality are kept. However, the Geoboxes offer more functions and versatility. There are no more specific templates for each feature but just one master template that can handle all type data. Nonetheless, the code is much more efficient and the Geoboxes render much faster (the average pre-expand size is 3-4 times smaller) and thus the switch is highly recommended.

To convert from Geobox 1 to Geobox 2 simply replace the template call, e.g. {{Geobox Settlement becomes {{Geobox|Settlement. Or there is a semi-automatic tool.

{{Geobox River}}

This is an infobox template for rivers, creeks, brooks and streams. It belongs to the Geobox series of templates, which are designated to be used for various geography related articles. They all use the same layout, internal logic and coherently named fields and provide some automated tasks such as unit conversion and automated located dot placement into a blank map. All templates can have a name on top, picture below, then section on Country, Region etc. followed by fields which are specific for every geographic feature, with a map at the bottom.

General instructions

How to fill out

• Copy the appropriate blank template into the edited page and fill in appropriate fields. Do not re-use a template from another page.
• Do not erase empty fields, other editors might supply the missing data. The empty fields are not displayed and don't hinder anything.

General field behavior

• There exist base fields whose output can be modified or extended by adding additional fields, these always bear the name of the base field plus the name of the additional field starting with an underscore ("_"). The additional fields are not present in the blank templates, their existence is nonetheless marked in the field list of every Geobox. Following additional fields are defined for all base fields:

• _type - for redefining the default label, e.g. the default label for the region field is Region, adding region_type it can be changed to display Province, Department …. N.B.: keep the text short, it is always displayed on one line, if it is too long, the left column of the geobox is too wide.

• _note - any sort of note which is printed after the field value, it can be even a reference, though the author of Geoboxes discourages from doing so as the implementation of <ref></ref> tags is very poor. The note is printed in a bit different font, currently implemented as 90% italics.

• _label : puts the HTML title property on the item (the text displays on hover).

• Some fields might contain multiple values, these are not to be put in a single field and separated by commas but using numbered additional fields (e.g. for the country field there also exist country1, country2, country3 …. The additional "indexed" fields are usually not present in the blank templates.

• The fields that link to existing articles don't need to be put between [[ and ]] markup, this is added automatically if the page exists. However, the markup can be used when the text of the link is different form the link itself, e.g. [[Amazon|Solimões]].

• All figures can be in either metric (default) or imperial (miles, feet etc.) units; the Geoboxes display both, automatically calculating imperial figures from metric or metric from imperial ones. Unformated numbers (i.e. without commas) must be entered, otherwise the auto-conversion produces an error. The output is "nicely" formatted. Following additional fields can be used:
  • _imperial - for input in imperial/customary units
  • _round - for changing the rounding precision of auto-conversion, it's the position from the decimal point to which the figure is rounded, negative values can be used when the input figure is rounded/approximate, default value is 0
  • _unit - for changing the default unit, appropropriate unit abbreviation should be used; the default unit for e.g. area is usually square kilometre (or square mile respectively), this can be changed to ha for hectare, acre for acre etc.

The last two additional fields are defined for every field using any units, if there is a set of similar fields, e.g. for area (area, area_land, area_water etc., the _round and _unit fields of the basic one are applied on all of them if they aren't specifically set)

• geobox_width - width of the Geobox in pixels (without px, just the figure), it can be used when there are more Geoboxes or images stacked below each other and the same width is desirable; not in blank templates

Specific fields

• Coordinates can be entered in two ways:

1. using separate _d, _m, _s…fields, _s and _m can be dropped out, the coordinate display template is adjusted accordingly
2. using just _d field and a decimal number, the hemispehere can be defined by either _NS, _EW fields or by using negative figures for western and southern hemisphere (these two systems mustn't be combined)

• For every location type which can be described in coordinates, there exist two additional fields
  • _type (named coordinates_type for the main location), which can contain any paramteres that are passed to the mapping service, especially the scale of the map, the possible parameters are described here: Wikipedia:WikiProject_Geographical_coordinates#Parameters.
  • _format (named coordinates_format for the main location) to override how the coordinates are displayed, if the input is decimal the output is decimal too, if the input is DMS so is the output, the possible values are self-explanatory dms and dec

Both _type and _format fields can be defined for every location with coordinates separately or by the general coordinates_type and coordinates_format fields

• The map field should be used for a location map of the feature, i.e. where it is located within a country. The location map can be of three types:

1. Self-contained location map. As in e.g. Greater Fatra.
2. Semi-automated locator dot. The map field contains background map, whereas locator_x and locator_y contain relative coordinates of the locator dot (as a percent of the map width, inserted without the % symbol), this system can be used when the map is not (or cannnot be) calibrated for the automated locator dot.
3. Fully automated locator dot. If coordinates of the location are defined in the Geobox and a calibrated map exists the locator dot is placed automatically based on the coordinates (map_locator field defines the appropriate map calibration). As in e.g. Ostrá. The same locator calibration can be used for all maps derived form one base map, e.g. Lysá hora and Plasy share the same calibration though the background map is different. The existing calibrations are listed here: Geobox locator.

Help

• If anything doesn't work as it should, feel free to contact me, the author of the Geobox system, either on my userpage or here at the talkpage or at the appropriate Geobox talkpage. Caroig 22:40, 2 March 2007 (UTC)

Legend

field	explanation	additional fields
Name section
name	name of the river
native_name	native name of the river if different from the English one, it is printed in brackets on the same line as name
other_name, other_name1 …	other names of the river, it can be used for rivers with various names along their run
Image
image	a photograph of the river
image_size	photograph size in pixels (set to 256 if left blank)
image_caption	photograph caption
Etymology
etymology	etymology (origin) of the river name, do not enter lengthy prose, examples: terre bonne, French for good earth Penn, William Penn and sylvania, Latin for woods Thomas Jefferson, when named for a person, add etymology_type = Named for Red River, when named for a place, add etymology_type = Named for	_type (Name origin), _label, _note
Country etc.
country, country1 …	country in/through which the river runs
state, state1 …	state in/through which the river runs, to be used when the river belongs in one country only, and more info might be helpful, e.g. in the USA, Brazil
region, region1 …	region in/through which the river runs, to be used when the river belongs in one country only, and more info might be helpful
district, district1 …	district in/through which the river runs, to be used when the river belongs in one country only, and more info might be helpful
city, city1 …	major city/seat in/through which the river runs
landmark, landmark1 …	landmarks on the river (lakes, waterfalls …)
country_type state_type region_type district_type city_type landmark_type	Text to be displayed instead of the default category name, e.g. it can be region_type = County for the USA, or city_type = Villages. These can contain wikilinks too, e.g. state_type = [[States of Germany|Bundesland]].
Geography
length(_imperial)	length of the river in kilometers (miles)	length_note
watershed(_imperial)	watershed (discharge basin) area in square kilometers (miles)	watershed_note
discharge_location	location where the following figures come from, typically mouth	discharge_location_note
discharge(_imperial)	average discharge in m³/s (ft³/s)	discharge_average_note
discharge_max(_imperial)	maximum discharge in m³/s (ft³/s)	discharge_max_note
discharge_min(_imperial)	minimum discharge in m³/s (ft³/s)	discharge_min_note
discharge1_location …	additional location where average discharge is provided	dicharge1_location_note …
discharge1(_imperial) …	additional location average discharge in m³/s (ft³/s)	discharge1_average_note …
Source
source_name, source1_name	source name, no need to set it if the river doesn't change names	source_name_note, source1_name_note
source_location, source1_location *	source location, should be the name of the mountain range or a text description, etc.	source_location_note, source1_location_note
source_lat_d …, source1_lat_d … **	source latitude and longitude in degrees, minutes, seconds and hemispheres (use N or S and W or E)	source_coordinates_note, source1_coordinates_note
source_elevation(_imperial), source1_elevation(_imperial)	source elevation in meters (feet)	source_elevation_note, source1_elevation_note
source_length(_imperial), source1_length(_imperial)	source length in kilometers (miles), until it becomes the main river	source_length_note, source1_length_note
source_confluence_location *	location of the two sources' confluence	source_confluence_location_note
source_confluence_lat_d **	sources' confluence latitude and longitude in degrees, minutes, seconds and hemispheres (use N or S and W or E)	source_confluence_coordinates_note
source_confluence_elevation(_imperial)	sources' confluence elevation in meters (feet)	source_confluence_elevation_note
Mouth
mouth_name	mouth name, if any (can be Mekong Delta etc.), or the name of the river or sea into which this one flows	mouth_name_note
mouth_location *	mouth location	mouth_location_note
mouth_lat_d **	sources latitude and longitude in degrees, minutes, seconds and hemispheres (use N or S and W or E), for a note use mouth_coordinates_note	mouth_coordinates_note
mouth_elevation(_imperial)	mouth elevation in meters (feet)	mouth_elevation_note
Tributaries
tributary_left, tributary_left1 …	major left tributary or tributaries, from the perspective of looking downstream and starting with tributaries closest to the source
tributary_right, tributary_right1 …	major right tributary or tributaries, from the perspective of looking downstream and starting with tributaries closest to the source
Free fields
free_name, free1_name …	free field name	free_name_note, fre1e_value_note …
free_value, free1_value …	free field value	free_value_note, free1_value_note …
Map section
mapm map1	map showing river, its basin, tributaries etc.
map_size, map1_size	map size in pixels (set to 256 if left blank)
map_caption, map1_caption	map caption
map_first	whether the map should be displayed on top, instead of the photograph on top
* All locations can have additional fields: field_district, field_district1 …, field_region, field_region1 …, field_state, field_state1 …, field_country, field_country1 …
** Coordinates are defined as field_lat_d, field_lat_m, field_lat_s, field_lat_NS, field_long_d, field_long_m, field_long_s, field_long_EW

Blank

Metric values, 1 source	Imperial values, 1 source
{{Geobox River <!-- *** Name section *** --> | name = | native_name = | other_name = | other_name1 = <!-- *** Image *** ---> | image = | image_size = | image_caption = <!-- *** Etymology *** ---> | etymology = <!-- *** Country etc. *** --> | country = | country1 = | state = | state1 = | region = | region1 = | district = | district1 = | city = | city1 = | landmark = | landmark1 = <!-- *** Geography *** --> | length = | watershed = | discharge_location = | discharge = | discharge_max = | discharge_min = | discharge1_location = | discharge1 = <!-- *** Source *** --> | source_name = | source_location = | source_district = | source_region = | source_state = | source_country = | source_lat_d = | source_lat_m = | source_lat_s = | source_lat_NS = | source_long_d = | source_long_m = | source_long_s = | source_long_EW = | source_elevation = | source_length = <!-- *** Mouth *** --> | mouth_name = | mouth_location = | mouth_district = | mouth_region = | mouth_state = | mouth_country = | mouth_lat_d = | mouth_lat_m = | mouth_lat_s = | mouth_lat_NS = | mouth_long_d = | mouth_long_m = | mouth_long_s = | mouth_long_EW = | mouth_elevation = <!-- *** Tributaries *** --> | tributary_left = | tributary_left1 = | tributary_right = | tributary_right1 = <!-- *** Free fields *** --> | free_name = | free_value = <!-- *** Map section *** --> | map = | map_size = | map_caption = }}	{{Geobox River <!-- *** Name section *** --> | name = | native_name = | other_name = | other_name1 = <!-- *** Image *** ---> | image = | image_size = | image_caption = <!-- *** Etymology *** ---> | etymology = <!-- *** Country etc. *** --> | country = | country1 = | state = | state1 = | region = | region1 = | district = | district1 = | city = | city1 = | landmark = | landmark1 = <!-- *** Geography *** --> | length_imperial = | watershed_imperial = | discharge_location = | discharge_imperial = | discharge_max_imperial = | discharge_min_imperial = | discharge1_location = | discharge1_imperial = <!-- *** Source *** --> | source_name = | source_location = | source_district = | source_region = | source_state = | source_country = | source_lat_d = | source_lat_m = | source_lat_s = | source_lat_NS = | source_long_d = | source_long_m = | source_long_s = | source_long_EW = | source_elevation_imperial = | source_length_imperial = <!-- *** Mouth *** --> | mouth_name = | mouth_location = | mouth_district = | mouth_region = | mouth_state = | mouth_country = | mouth_lat_d = | mouth_lat_m = | mouth_lat_s = | mouth_lat_NS = | mouth_long_d = | mouth_long_m = | mouth_long_s = | mouth_long_EW = | mouth_elevation_imperial = <!-- *** Tributaries *** --> | tributary_left = | tributary_left1 = | tributary_right = | tributary_right1 = <!-- *** Free fields *** --> | free_name = | free_value = <!-- *** Map section *** --> | map = | map_size = | map_caption = }}
Metric values, 2 sources	Imperial values, 2 sources
{{Geobox River <!-- *** Name section *** --> | name = | native_name = | other_name = | other_name1 = <!-- *** Image *** ---> | image = | image_size = | image_caption = <!-- *** Etymology *** ---> | etymology = <!-- *** Country etc. *** --> | country = | country1 = | state = | state1 = | region = | region1 = | district = | district1 = | city = | city1 = | landmark = | landmark1 = <!-- *** Geography *** --> | length = | watershed = | discharge_location = | discharge = | discharge_max = | discharge_min = | discharge1_location = | discharge1 = <!-- *** Source *** --> | source_name = | source_location = | source_district = | source_region = | source_state = | source_country = | source_lat_d = | source_lat_m = | source_lat_s = | source_lat_NS = | source_long_d = | source_long_m = | source_long_s = | source_long_EW = | source_elevation = | source_length = | source1_name = | source1_location = | source1_district = | source1_region = | source1_state = | source1_country = | source1_lat_d = | source1_lat_m = | source1_lat_s = | source1_lat_NS = | source1_long_d = | source1_long_m = | source1_long_s = | source1_long_EW = | source1_elevation = | source1_length = | source_confluence_location = | source_confluence_district = | source_confluence_region = | source_confluence_state = | source_confluence_country = | source_confluence_lat_d = | source_confluence_lat_m = | source_confluence_lat_s = | source_confluence_lat_NS = | source_confluence_long_d = | source_confluence_long_m = | source_confluence_long_s = | source_confluence_long_EW = | source_confluence_elevation = <!-- *** Mouth *** --> | mouth_name = | mouth_location = | mouth_district = | mouth_region = | mouth_state = | mouth_country = | mouth_lat_d = | mouth_lat_m = | mouth_lat_s = | mouth_lat_NS = | mouth_long_d = | mouth_long_m = | mouth_long_s = | mouth_long_EW = | mouth_elevation = <!-- *** Tributaries *** --> | tributary_left = | tributary_left1 = | tributary_right = | tributary_right1 = <!-- *** Free fields *** --> | free_name = | free_value = <!-- *** Map section *** --> | map = | map_size = | map_caption = }}	{{Geobox River <!-- *** Name section *** --> | name = | native_name = | other_name = | other_name1 = <!-- *** Image *** ---> | image = | image_size = | image_caption = <!-- *** Etymology *** ---> | etymology = <!-- *** Country etc. *** --> | country = | country1 = | state = | state1 = | region = | region1 = | district = | district1 = | city = | city1 = | landmark = | landmark1 = <!-- *** Geography *** --> | length_imperial = | watershed_imperial = | discharge_location = | discharge_imperial = | discharge_max_imperial = | discharge_min_imperial = | discharge1_location = | discharge1_imperial = <!-- *** Source *** --> | source_name = | source_location = | source_district = | source_region = | source_state = | source_country = | source_lat_d = | source_lat_m = | source_lat_s = | source_lat_NS = | source_long_d = | source_long_m = | source_long_s = | source_long_EW = | source_elevation_imperial = | source_length_imperial = | source1_name = | source1_location = | source1_district = | source1_region = | source1_state = | source1_country = | source1_lat_d = | source1_lat_m = | source1_lat_s = | source1_lat_NS = | source1_long_d = | source1_long_m = | source1_long_s = | source1_long_EW = | source1_elevation_imperial = | source1_length_imperial = | source_confluence_location = | source_confluence_district = | source_confluence_region = | source_confluence_state = | source_confluence_country = | source_confluence_lat_d = | source_confluence_lat_m = | source_confluence_lat_s = | source_confluence_lat_NS = | source_confluence_long_d = | source_confluence_long_m = | source_confluence_long_s = | source_confluence_long_EW = | source_confluence_elevation_imperial = <!-- *** Mouth *** --> | mouth_name = | mouth_location = | mouth_district = | mouth_region = | mouth_state = | mouth_country = | mouth_lat_d = | mouth_lat_m = | mouth_lat_s = | mouth_lat_NS = | mouth_long_d = | mouth_long_m = | mouth_long_s = | mouth_long_EW = | mouth_elevation_imperial = <!-- *** Tributaries *** --> | tributary_left = | tributary_left1 = | tributary_right = | tributary_right1 = <!-- *** Free fields *** --> | free_name = | free_value = <!-- *** Map section *** --> | map = | map_size = | map_caption = }}