Fyrimynd:Infobox waterfall/doc

This Infobox template can be used in any article about a waterfall.

Usage

Most commonly used parameters:

{{Infobox waterfall
| name           = 
| photo          = 
| photo_width    = 
| photo_caption  = 
| map            = 
| map_width      = 
| lat_d  = | lat_m  = | lat_s  = | lat_NS  = 
| long_d = | long_m = | long_s = | long_EW = 
| region         = 
| source         = 
| coords_ref     = 
| location       = 
| type           = 
| elevation      = 
| height         = 
| height_longest = 
| number_drops   = 
| width          = 
| average_width  = 
| watercourse    = 
| average_flow   = 
| world_rank     = 
}}

Parameter descriptions

This table describes all parameters which can be used in building an waterfall infobox. Only the name parameter must be assigned a value. Use the {{convert}} template for units. A glossary of waterfall related terms can be found at the World Waterfall Database.

Field name	Description
name	Required. The name of the waterfall. It will be displayed at the top of the infobox. In most cases this should be the same as the article name less any disambiguation. For example, if the article title is Selfoss (waterfall) then name=Selfoss.
alt_name	If there is a common English name for the waterfall use it for the name parameter. This parameter can be used to display the name in the local language or for an alternate English name if it is commonly used. Italics should not be used. See .
photo	The name of an image file to be displayed. No special formatting is needed.
photo_width	Used to change the display width of the image. The default and maximum value is 275 pixels. Images with a horizontal orientation (landscape mode) will generally display well at the default setting. An image with vertical orientation (portrait mode) may need to be adjusted to 180 or 220. For example, photo_width=200 and not photo_width=200px.
photo_alt	Alt text for the photo, for visually impaired readers. See WP:ALT.
photo_caption	The caption that will appear below the image if one is required.
Map related parameters
map	The name of the map to be displayed. See Map display methods.
map_width	Used to change the display width of the map. The default width is 240 pixels, and the maximum width is 275 pixels. See photo_width above.
map_alt	Alt text for the map. See WP:ALT.
map_caption	The caption that appears below the map if one is required.
map_label	A text message that will be displayed next to the mark. Works with label_position below. This is not functional when using the XY coordinates method for map display.
map_label_position	Specifies the position of a label with respect to the mark. Valid values are left, right, top and bottom. See label above.
relief	Selects a relief map when assigned any value. This option is only available for a small number of location map templates and is not functional when using the XY coordinates method. See Map display methods.
mark	The image used for the mark on a map. The default is Red pog.svg. See here for other images.
x y	Specifies the position of the location marker on a map image. The coordinates of the marker in pixels based on a map with a width of 1000 pixels. The template will scale these values for proper display. See below.
x% y%	Specifies the position of the location marker on a map image. x% specifies the percentage of the distance across the image from the left edge and y% specifies the percentage of the distance down from the top edge. See below.
Coordinate related parameters
grid_ref_UK	If the waterfall is in Great Britain, the British grid reference. For waterfalls outside of Great Britain, this field is inapplicable.
grid_ref_Ireland	If the waterfall is in Ireland (whether Northern Ireland or the Republic), the Irish grid reference. For waterfalls outside Ireland, this field is inapplicable.
coords	For the {{coord}} template. Will not generate a location mark if a map template is used. When this option is used the type, region, scale, source, format and display parameters are not functional but this data can be entered in the coord template. The recommended values are type:waterbody and display=inline,title.
coords_ref	Can be used with either coordinate display method above. Strongly recommended. Specify a citation for the coordinates using <ref>...</ref> tags.
map	The area covered by a location map template.
map_caption	Caption displayed below the map if necessary.
label	A text message that will be displayed next to the marker. Works with label_position below. Seldom used.
label_position	Specifies the position of a label with respect to the marker. Valid values are left, right, top and bottom. See label above.
mark	The image to use for the marker. The default is Red pog.svg. See Template:Infobox map#Marks for more information.
marker_size	The display width of the marker image in pixels. The default is 8.
lat_d	The degrees of latitude. This value can be specified as a decimal degree and when this format is used minutes and seconds should not be specified. See below
lat_m	The minutes of latitude.
lat_s	The seconds of latitude.
lat_NS	N if north of the equator, S if south of the equator. Other values will be disregarded.
long_d	The degrees of longitude. This value can be specified as a decimal degree and when this format is used minutes and seconds should not be specified.
long_m	The minutes of longitude.
long_s	The seconds of longitude.
long_EW	E if East of the prime meridian, W if west of the prime meridian. Other values will be disregarded.
coords_type	Type is one way to specify the scale of maps generated by external map websites. See WP:COORD TYPE for valid values. The default value is landmark which is most appropriate for caves. This parameter and the three below help GeoHack in selecting suitable map resources.
scale	Determines the zoom factor for external map websites. See WP:COORD SCALE. Using scale=50000 will change the zoom factor to 1:50,000.
region	A country code. See ISO 3166-2:US, ISO 3166-2 and ISO 3166-1 alpha-2. For example, US-OR is the code for Oregon. This computer readable code is recommended. It will not be displayed. See WP:COORD REGION.
source	Source of the coordinate data. See WP:COORD SOURCE. It will not be displayed.
format	Determines the format used to the display coordinates. Valid values are dms for degrees, minutes and seconds, and dec for decimal degrees. The default is dms.
display	Determines where the coordinates will be displayed. Valid values are inline and inline,title. The default is inline,title and is recommended.
coords_ref	Necessary when this method is used to enter coordinates. Strongly recommended. specify a citation for the coordinates using <ref>...</ref> tags.
Other parameters
location	The location of the waterfall. Don't be too precise. County, state and country are good in the USA. If the waterfall is within a city specify the city, state and country. If the waterfall is in multiple counties just list the state and country. For areas in other countries adjust accordingly.
type	The type of waterfall (e.g. horsetail, tiered). See this list.
elevation	Elevation of the waterfall if it is noteworthy.
height	The elevation of the crest to the base of the lowest drop.
height_longest	The height of the longest drop.
number_drops	The number of drops or vertical segments.
width	The width of the waterfall measured at the crest.
average_width	The width of the waterfall at average flow. Measured at the crest
watercourse	The name of the river, stream, creek, etc. that the falls interrupts.
average_flow	The average flow rate of the watercourse.
world_rank	Rank in the world by height. This should be reliably sourced.
child	Used to embed this template in another. See below.
embedded	Used to embed another template in this one. See below.

Examples

Kerepakupai Merú

Kerepakupai Merú
Angel Falls Kerepakupai Vená
Angel Falls, Bolívar State, Venezuela
Mynd:Venezuela
Staður	Auyantepui, Canaima National Park, Venezuela
Koordinatir	5°58′07″N 62°32′16″W
Slag	Segmented Plunges
Hædd	4.878 ft (1.487 m)
Hædd tilsamans	3.212 ft (979 m)
Tal av fossum	2
Longsta fallið	2.648 ft (807 m)
Vatnræsi	Río Gauja
Miðal vatnfloymur	500 cu ft/s (14 m3/s)
Nr. av heimsins størstu	1st

{{Infobox waterfall
| name = Kerepakupai Merú
| alt_name = Angel Falls<br />Kerepakupai Vená
| photo = Salto Angel Dry Season.jpg
| photo_caption = Angel Falls, Bolívar State, Venezuela
| map = Venezuela
| map_width = 220
| relief = yes
| lat_d  = 5 | lat_m  = 58 | lat_s  = 07 | lat_NS  = N
| long_d = 62 | long_m = 32 | long_s = 16 | long_EW = W
| location = [[Auyantepui]], [[Canaima National Park]], [[Venezuela]]
| type = Segmented Plunges
| elevation = {{convert|4878|ft|abbr=on}}
| height = {{convert|3212|ft|abbr=on}}
| height_longest = {{convert|2648|ft|abbr=on}}
| number_drops = 2
| average_width = {{convert|350|ft|abbr=on}}
| average_flow = {{convert|500|ft3/s|abbr=on}}
| watercourse = [[Río Gauja]]
| world_rank = 1st
}}

Kjelfossen

Kjelfossen
Kjelfossen (photo Alfred Diem)
Staður	Gudvangen, Norway
Koordinatir	60°52′29″N 06°51′43″E
Slag	Segmented
Hædd tilsamans	755 m (2.477 ft)
Longsta fallið	149 m (489 ft)
Vatnræsi	Kjelfossgrovi
Nr. av heimsins størstu	18th

{{Infobox waterfall
| name = Kjelfossen
| photo = Kjelfossen.jpg
| photo_width = 
| photo_caption = Kjelfossen (photo Alfred Diem)
| map = Relief Map of Norway.png
| map_width = 200
| x = 100
| y = 810
| location = [[Gudvangen]], [[Norway]]
| coords = {{coord|60|52|29|N|06|51|43|E|region:NO_type:waterbody|display=inline,title}}
| type = Segmented
| height = {{convert|755|m|abbr=on}}
| height_longest = {{convert|149|m|abbr=on}}
| watercourse = Kjelfossgrovi
| world_rank = 18.
}}

Map display methods

There are three methods by which maps showing a marker can be generated.

Display a marker on a map using a template and geographic coordinates

A marker can be superimposed on a map using one of a set of special map templates. To display a marker the geographic coordinates must be specified using the parameters lat_d, long_d, etc. See the documentation for {{Location map}}. The parameters for this template map to a subset of the parameters used by {{Location map}}. A map template can be found using these sources:

List of templates - Many of the listed items are redirects and a few templates may not function as expected.

Category:Location map templates - templates sorted by category.

Special:WhatLinksHere/Template:Location map/Info - a search that might help.

Special:Prefixindex/Template:Location map - another search that might help.

All of the names begin with the words "Location map" followed by the area covered. The value you need to specify is the area name. The map template for the Canada is Location map Canada. In this case specify map=Canada.

Four Corners, Canada
Mynd:Canada Example using geographic coordinates
Koordinatir	60°00′00″N 102°00′00″W

{{Infobox waterfall
| name = Four Corners, Canada
| map = Canada
| map_caption = Example using geographic coordinates
| lat_d = 60 | lat_m = 00 | lat_s = 00 | lat_NS = N
| long_d = 102 | long_m = 00 | long_s = 00 | long_EW = W
}}

Display a marker on any map image using the x and y parameters

The values for the x and y parameters are the pixel coordinates of the location mark when the image is scaled to a width of 1000 pixels.

x is the pixel offset for the mark from the left edge of an image 1000px wide.

y is the pixel offset for the mark from the top edge of an image 1000px wide.

There are at least two ways of obtaining these values:

1. Download the image from the image's file page to your computer. Open the image in a graphics editor, such as GIMP or XnView. Scale (resize) the image to a width of 1000px and then note the x, y coordinates when the cursor points to the desired location. Use these values directly.
2. Download the image from the image's file page to your computer. Open the image in any image viewer that displays the coordinates of the cursor position, such as Paint from Microsoft. Note the x, y coordinates when the cursor points to the location. Then:

1000 · x'/w = x  and  1000 · y'/w = y

where x' and y' are the cursor coordinates, w is the width of the image displayed on your computer and x and y are the values to assign to the x and y parameters.

Four Corners, Canada
Example using the x and y parameters

{{Infobox waterfall
| name = Four Corners, Canada
| map = Canada location map.svg
| map_caption = Example using the x and y parameters
| x = 369
| y = 487
}}

Display a marker on any map image using the x% and y% parameters

x% specifies the percent of the distance across the image from the left edge.

y% specifies the percent of the distance down from the top edge.

In the following example the marker is 36.9% of the way across and 57.4% of the way down.

Four Corners, Canada
Example using the x% and y% parameters

{{Infobox waterfall
| name = Four Corners, Canada
| map = Relief map of Canada.png
| map_caption = Example using the x% and y% parameters
| x% = 36.9
| y% = 57.4
}}

Template embedding

This template can be embedding in another infobox template by adding the code |child=yes. To embed another template in this one use |embedded={{Infobox ....

Microformats

The articles created using this template include an hCard microformat. For more information read this.