User:Droll/sandbox/doc
This Infobox template can be used in any article about a waterfall.
Usage
[edit]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
[edit]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.
|
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 mark on the map when the XY coordinates method is used. The coordinates of the mark in pixels based on a map with a width of 1000 pixels. This template will scale these values for proper display. |
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.
|
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. |
Map display methods
[edit]Display a marker on a map using a template and coordinates
[edit]A marker can be superimposed on a map using one of a set of map templates. This method requires the geographic coordinates to be entered using the parameters below and assigning map
the name of the area covered by one of a set of location map templates. The parameters for this template map to a subset of the parameters for {{Location map}} and reading the documentation for that template might be helpful.
The coordinates and related information must be entered using the of parameters below. This information is the same as that used by the {{coord}} template.
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. Default = 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. |
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.
|
Location map templates can be found using these sources:
- List of templates - 1050 templates available when the list was generated.
- Category:Location map templates - templates sorted by category.
- Special:Prefixindex/Template:Location map - a search that might help.
- Special:WhatLinksHere/Template:Location map/Info - 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 assign to the parameter, map
, is the area name. 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 for Alberta, Canada is Module:Location map/data/Canada Alberta. In this case specify map=Canada Alberta
or, in this case, map=Alberta
.
{{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 = 200 | lat_d = 5.96856 | long_d = -62.53775 | 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 }}
Coordinates method
[edit]Kjelfossen | |
---|---|
![]() Kjelfossen (photo Alfred Diem) | |
Location | Gudvangen, Norway |
Coordinates | 60°52′29″N 06°51′43″E / 60.87472°N 6.86194°E |
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,title}} | type = Segmented | height = {{convert|755|m|abbr=on}} | height_longest = {{convert|149|m|abbr=on}} | watercourse = Kjelfossgrovi | world_rank = 18th }}
Template embedding
[edit]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
[edit]The articles created using this template include an hCard microformat. For more information read this.