Template:Infobox waterfall/doc
This is a documentation subpage for Template:Infobox waterfall. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This Infobox template can be used in any article about a waterfall.
Usage
Most commonly used parameters:
{{{name}}} | |
---|---|
{{{alt_name}}} | |
[[File:{{{image}}}|{{{image_size}}}|alt={{{alt}}}]] | |
[[File:{{{map_image}}}|{{{map_size}}}|alt={{{map_alt}}}]] | |
Location | {{{location}}} |
OS grid | {{{grid_ref_UK}}} |
OSI/OSNI grid | {{{grid_ref_Ireland}}} |
Coordinates | {{{coordinates}}}{{{coords_ref}}} |
Type | {{{type}}} |
Elevation | {{{elevation}}} |
Total height | {{{height}}} |
Number of drops | {{{number_drops}}} |
Longest drop | {{{height_longest}}} |
Total width | {{{width}}} |
Average width | {{{average_width}}} |
Run | {{{run}}} |
Watercourse | {{{watercourse}}} |
Average flow rate | {{{average_flow}}} |
World height ranking | {{{world_rank}}} |
{{{embedded}}} |
{{Infobox waterfall | name = | image = | image_size = | caption = | map_image = | map_size = | coordinates = <!-- use {{Coord}} --> | coords_ref = | location = | elevation = | height = | height_longest = | number_drops = | width = | average_width = | run = | watercourse = | average_flow = | world_rank = | type = }}
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 MOS:ITALIC.
|
image |
The name of an image file to be displayed. No special formatting is needed. |
image_size |
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 .
|
alt |
Alt text for the photo, for visually impaired readers. See WP:ALT. |
caption |
The caption that will appear below the image if one is required. |
Map related parameters | |
map_image or map |
The name of the map to be displayed. See Map display methods. |
map_size or 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 image_size 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 Template:Location map for other images. |
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. |
coordinates |
Use the {{Coord}} template. Will generate a location mark if a map template is used. The recommended values for {{Coord}} are type:waterbody and display=inline,title .
|
coords_ref |
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:Location map for more information. |
marker_size |
The display width of the marker image in pixels. The default is 8. |
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 |
run |
The length of the waterfall run |
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á | |
Lua error in Module:Location_map at line 399: Malformed coordinates value. | |
Location | Auyantepui, Canaima National Park, Venezuela |
Coordinates | Lua error: callParserFunction: function "#coordinates" was not found. |
Type | Segmented Plunges |
Elevation | 4,878 ft (1,487 m) |
Total height | 3,212 ft (979 m) |
Number of drops | 2 |
Longest drop | 2,648 ft (807 m) |
Average width | 350 ft (107 m) |
Watercourse | Río Gauja |
Average flow rate | 500 cu ft/s (14 m3/s) |
World height ranking | 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 | coordinates = {{coord|5|58|7|N|62|32|16|W| display = inline}} | 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 | |
---|---|
Lua error in Module:Location_map at line 399: Malformed coordinates value. | |
Location | Gudvangen, Norway |
Coordinates | Lua error: callParserFunction: function "#coordinates" was not found. |
Type | Segmented |
Total height | 755 m (2,477 ft) |
Longest drop | 149 m (489 ft) |
Watercourse | Kjelfossgrovi |
World height ranking | 18th |
{{Infobox waterfall | name = Kjelfossen | photo = Kjelfossen.jpg | photo_width = | photo_caption = Kjelfossen (photo Alfred Diem) | map =Norway | relief = 1 | map_width = 200 | location = [[Gudvangen]], [[Norway]] | coords = {{coord|60|52|29|N|06|51|43|E|region:NO_type:waterbody|display=inline}} | type = Segmented | height = {{convert|755|m|0|abbr=on}} | height_longest = {{convert|149|m|0|abbr=on}} | watercourse = Kjelfossgrovi | world_rank = 18th }}
Map display methods
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 {{Coord}} template inside the |coordinates=
parameter. 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/Module:Location map/data/ – another 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 Canada is Location map/data/Canada. In this case specify |map=Canada
.
Four Corners, Canada | |
---|---|
Lua error in Module:Location_map at line 399: Malformed coordinates value. | |
Coordinates | Lua error: callParserFunction: function "#coordinates" was not found. |
{{Infobox waterfall | name = Four Corners, Canada | map = Canada | map_caption = Example using geographic coordinates | coordinates = {{coord|60|N|102|W|display=inline <!-- for documentation page only - not general practice --> }} }}
By default, {{Coord}} displays in the infobox only in the page title. Parameter |display=inline,title
can be added to make the coordinates display at the top of the page as well.
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.
Tracking category