Difference between revisions of "Template:Infobox waterfall/doc"

From blackwiki
Jump to navigation Jump to search
imported>Jdaloner
(Linked "prime meridian" to more appropriate/specific article.)
imported>Jonesey95
(Convert coords to new parameters. See Wikipedia:Coordinates in infoboxes.)
Line 14: Line 14:
 
| map            =  
 
| map            =  
 
| map_width      =  
 
| map_width      =  
| lat_d  = | lat_m  = | lat_s  = | lat_NS  =
+
| coordinates    = <!-- {{Coord}} -->
| long_d = | long_m = | long_s = | long_EW =
 
| region        =
 
| source        =  
 
 
| coords_ref    =  
 
| coords_ref    =  
 
| location      =  
 
| location      =  
| type          =
 
 
| elevation      =  
 
| elevation      =  
 
| height        =  
 
| height        =  
Line 30: Line 26:
 
| average_flow  =  
 
| average_flow  =  
 
| world_rank    =  
 
| world_rank    =  
 +
| type          =
 
}}</pre>
 
}}</pre>
  
Line 79: Line 76:
 
| <code>grid_ref_Ireland</code> || If the waterfall is in Ireland (whether Northern Ireland or the Republic), the Irish grid reference. For waterfalls outside Ireland, this field is inapplicable.
 
| <code>grid_ref_Ireland</code> || If the waterfall is in Ireland (whether Northern Ireland or the Republic), the Irish grid reference. For waterfalls outside Ireland, this field is inapplicable.
 
|-
 
|-
| <code>coords</code> || For the {{tl|coord}} template. Will not generate a location mark if a map template is used. When this option is used the <code>type</code>, <code>region</code>, <code>scale</code>, <code>source</code>, <code>format</code> and <code>display</code> parameters are not functional but this data can be entered in the coord template. The recommended values are <code>type:waterbody</code> and <code>display=inline,title</code>.
+
| <code>coordinates</code> || Use the {{tl|Coord}} template. Will generate a location mark if a map template is used. The recommended values for {{tl|Coord}} are <code>type:waterbody</code> and <code>display=inline,title</code>.
 
|-
 
|-
| <code>coords_ref</code> || Can be used with either coordinate display method above. Strongly recommended. Specify a citation for the coordinates using {{nowrap| <code><nowiki><ref>...</ref></nowiki></code>}} tags.
+
| <code>coords_ref</code> || Strongly recommended. Specify a citation for the coordinates using {{tag|ref}} tags.
 
|-
 
|-
 
| <code>map</code> || The area covered by a location map template.
 
| <code>map</code> || The area covered by a location map template.
Line 94: Line 91:
 
|-
 
|-
 
| <code>marker_size</code> || The display width of the marker image in pixels. The default is 8.
 
| <code>marker_size</code> || The display width of the marker image in pixels. The default is 8.
|-
 
| <code>lat_d</code> || The degrees of latitude. This value can be specified as a [[Decimal degrees|decimal degree]] and when this format is used minutes and seconds should not be specified. See [[#Display a marker on a map using a template and geographic coordinates|below]]
 
|-
 
| <code>lat_m</code> || The minutes of latitude.
 
|-
 
| <code>lat_s</code> || The seconds of latitude.
 
|-
 
| <code>lat_NS</code> || N if north of the equator, S if south of the equator. Other values will be disregarded.
 
|-
 
| <code>long_d</code> || The degrees of longitude. This value can be specified as a [[Decimal degrees|decimal degree]] and when this format is used minutes and seconds should not be specified.
 
|-
 
| <code>long_m</code> || The minutes of longitude.
 
|-
 
| <code>long_s</code> || The seconds of longitude.
 
|-
 
| <code>long_EW</code> || E if East of the [[IERS Reference Meridian|prime meridian]], W if west of the prime meridian. Other values will be disregarded.
 
|-
 
| <code>coords_type</code> || 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 <code>landmark</code> which is most appropriate for caves.  This parameter and the three below help [[tswiki:GeoHack|GeoHack]] in selecting suitable map resources.
 
 
|-
 
|-
 
| <code>scale</code> || Determines the zoom factor for external map websites. See [[WP:COORD SCALE]]. Using <code>scale=50000</code> will change the zoom factor to 1:50,000.
 
| <code>scale</code> || Determines the zoom factor for external map websites. See [[WP:COORD SCALE]]. Using <code>scale=50000</code> will change the zoom factor to 1:50,000.
|-
 
| <code>region</code> || 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]].
 
|-
 
| <code>source</code> || Source of the coordinate data. See [[WP:COORD SOURCE]]. It will not be displayed.
 
|-
 
| <code>format</code> || Determines the format used to the display coordinates. Valid values are <code>dms</code> for degrees, minutes and seconds, and <code>dec</code> for [[decimal degrees]]. The default is <code>dms</code>.
 
|-
 
| <code>display</code> || Determines where the coordinates will be displayed. Valid values are <code>inline</code> and <code>inline,title</code>. The default is <code>inline,title</code> and is recommended.
 
|-
 
| <code>coords_ref</code> || Necessary when this method is used to enter coordinates. Strongly recommended. specify a citation for the coordinates using {{nowrap| <code><nowiki><ref>...</ref></nowiki></code>}} tags.
 
 
|-
 
|-
 
| colspan="2" style="text-align: center; font-weight: bold;" | Other parameters
 
| colspan="2" style="text-align: center; font-weight: bold;" | Other parameters
Line 166: Line 135:
 
| map_width = 220
 
| map_width = 220
 
| relief = yes
 
| relief = yes
| lat_d  = 5 | lat_m  = 58 | lat_s  = 07 | lat_NS  = N
+
| coordinates = {{coord|5|58|7|N|62|32|16|W| display = inline}}
| long_d = 62 | long_m = 32 | long_s = 16 | long_EW = W
 
| display = inline
 
 
| location = [[Auyantepui]], [[Canaima National Park]], [[Venezuela]]
 
| location = [[Auyantepui]], [[Canaima National Park]], [[Venezuela]]
 
| type = Segmented Plunges
 
| type = Segmented Plunges
Line 190: Line 157:
 
| map_width = 220
 
| map_width = 220
 
| relief = yes
 
| relief = yes
| lat_d  = 5 | lat_m  = 58 | lat_s  = 07 | lat_NS  = N
+
| coordinates = {{coord|5|58|7|N|62|32|16|W| display = inline}}
| long_d = 62 | long_m = 32 | long_s = 16 | long_EW = W
 
 
| location = [[Auyantepui]], [[Canaima National Park]], [[Venezuela]]
 
| location = [[Auyantepui]], [[Canaima National Park]], [[Venezuela]]
 
| type = Segmented Plunges
 
| type = Segmented Plunges
Line 248: Line 214:
 
== Map display methods ==
 
== Map display methods ==
 
There are three methods by which maps showing a marker can be generated.  
 
There are three methods by which maps showing a marker can be generated.  
{{Infobox map/Map display methods}}
+
{{Infobox map/Map display methods|converted=1}}
  
 
== Template embedding ==
 
== Template embedding ==

Revision as of 19:52, 14 December 2016

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      = 
| coordinates    = <!-- {{Coord}} -->
| coords_ref     = 
| location       = 
| elevation      = 
| height         = 
| height_longest = 
| number_drops   = 
| width          = 
| average_width  = 
| 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.
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.
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:Infobox map#Marks for more information.
marker_size The display width of the marker image in pixels. The default is 8.
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.
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ú
Script error: No such module "If empty".
File:Salto Angel Dry Season.jpg
Angel Falls, Bolívar State, Venezuela
Lua error in Module:Location_map at line 399: Malformed coordinates value.
LocationAuyantepui, Canaima National Park, Venezuela
CoordinatesLua error: callParserFunction: function "#coordinates" was not found.
TypeSegmented Plunges
Elevation4,878 ft (1,487 m)
Total height3,212 ft (979 m)
Number of drops2
Longest drop2,648 ft (807 m)
Average width350 ft (107 m)
WatercourseRío Gauja
Average
flow rate
500 cu ft/s (14 m3/s)
World height ranking1st
{{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
Script error: No such module "If empty".
File:Kjelfossen.jpg
Kjelfossen (photo Alfred Diem)
Lua error in Module:Location_map at line 501: Unable to find the specified location map definition: "Module:Location map/data/Relief Map of Norway.png" does not exist.
LocationGudvangen, Norway
CoordinatesLua error: callParserFunction: function "#coordinates" was not found.
TypeSegmented
Total height755 m (2,477 ft)
Longest drop149 m (489 ft)
WatercourseKjelfossgrovi
World height ranking18th
{{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 = 18th
}}

Map display methods

There are three methods by which maps showing a marker can be generated. Template:Infobox map/Map display methods

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.