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

From Wikishire
Jump to: navigation, search
(Created page with "{{Documentation subpage}} <!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia:Wikidata) --> {{Lua|Module:Infobox|Module:...")
 
 
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
−
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia:Wikidata) -->
+
<!-- Place categories where indicated at the bottom of this page-->
−
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Coordinates|Module:Check for unknown parameters}}
+
  
 
This Infobox template can be used in any article about a waterfall.
 
This Infobox template can be used in any article about a waterfall.
Line 8: Line 7:
 
Most commonly used parameters:
 
Most commonly used parameters:
  
−
{{Parameter names example <!-- | child | embed --> | name | alt_name | nativename | native_name | image | image_size | alt | caption | map_image | map_alt | map_size | map_caption | relief | mark | mark_width | map_label | map_label_position | coordinates | coords | location | grid_ref_UK | grid_ref_Ireland | coords_ref | type | elevation | height | number_drops | height_longest | width | average_width | run | watercourse | average_flow | world_rank | embedded }}
+
{{Parameter names example | name | welsh | county | island | picture | picture caption | os grid ref | latitude | longitude | river | height | width | drops | average flow }}
  
 
<pre style="overflow: auto;">
 
<pre style="overflow: auto;">
 
{{Infobox waterfall
 
{{Infobox waterfall
−
| name           =  
+
|name=
−
| image          =  
+
|gaelic=
−
| image_size    =  
+
|greek=
−
| caption        =  
+
|irish=
−
| map_image      =  
+
|scots=
−
| map_size      =  
+
|welsh=
−
| coordinates    = <!-- use {{Coord}} -->
+
|county=
−
| coords_ref    =  
+
|county 1=
−
| location      =  
+
|county 2=
−
| elevation      =  
+
|territory=
−
| height        =  
+
|island=
−
| height_longest =  
+
|picture=
−
| number_drops  =  
+
|picture caption=
−
| width          =  
+
|os grid ref=
−
| average_width  =  
+
|latitude=
−
| run            =  
+
|longitude=
−
| watercourse    =  
+
|map=
−
| average_flow  =  
+
|river=
−
| world_rank    =  
+
|height=
−
| type           =  
+
|width=
 +
|type=
 +
|average flow=
 
}}
 
}}
 
</pre>
 
</pre>
Line 37: Line 38:
  
 
== Parameter descriptions ==
 
== Parameter descriptions ==
−
This table describes all parameters which can be used in building an waterfall infobox. Only the <code>name</code> parameter must be assigned a value. Use the {{tl|convert}} template for units. A glossary of waterfall related terms can be found at the [http://www.worldwaterfalldatabase.com/blog/articles-and-information/glossary-of-related-terms/ World Waterfall Database].
+
This table describes the parameters which can be used in building an waterfall infobox. Some are alternatives: the language parameters for example and use <u>either</u> <code>county</code> or <code>territory</code> or <code>county 1</code> and <code>county 2</code>: one version of these parameters must be assigned a value.
  
 
{| class="wikitable" style="width: 97%;"
 
{| class="wikitable" style="width: 97%;"
 
! style="width: 14%" | Field name || Description
 
! style="width: 14%" | Field name || Description
 
|-
 
|-
−
| <code>name</code> || 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 <code>name=Selfoss</code>.
+
| <code>name</code> || 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 [[Grey Mare's Tail, Kinlochmore]] then <code>name=Grey Mare's Tail</code>.
 
|-
 
|-
−
| <code>alt_name</code> || If there is a common English name for the waterfall use it for the <code>name</code> 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]].
+
| <code>welsh</code><br />- or other language || If there is a common English name for the waterfall use that for the <code>name</code> parameter, and if it is given a different name in Welsh, Gaelic etc then that parameter is used to display the name in that language. Italics should not be used: the template handles the display styling.
 
|-
 
|-
−
| <code>image</code> || The name of an image file to be displayed. No special formatting is needed.
+
| <code>picture</code> || The name of an image file to be displayed. Just use the file name and extension without "File:" and without sizing codes.
 
|-
 
|-
−
| <code>image_size</code> || Used to change the display width of the image. The default and maximum value is 275 [[pixel]]s. 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, <code>photo_width=200</code> and not <code>photo_width=200px</code>.
+
| <code>picture caption</code> || The caption that will appear below the image if one is required.
−
|-
+
−
| <code>alt</code> || Alt text for the photo, for visually impaired readers. See [[WP:ALT]].
+
−
|-
+
−
| <code>caption</code> || The caption that will appear below the image if one is required.
+
 
|-
 
|-
 
| colspan="2" style="text-align: center; font-weight: bold;" |Map related parameters
 
| colspan="2" style="text-align: center; font-weight: bold;" |Map related parameters
 
|-
 
|-
−
| <code>map_image</code> or <code>map</code> || The name of the map to be displayed. See [[#Map display methods|Map display methods]].
+
| <code>map</code> || Very rare, but if a map image is used, put this in as for "<code>picture</code>" above.
 
|-
 
|-
−
| <code>map_size</code> or <code>map_width</code>|| Used to change the display width of the map. The default width is 240 pixels, and the maximum width is 275 pixels. See <code>image_size</code> above.
+
| <code>map caption</code> || The caption that appears below the map if one is required.
−
|-
+
−
| <code>map_alt</code> || Alt text for the map. See [[WP:ALT]].
+
−
|-
+
−
| <code>map_caption</code> || The caption that appears below the map if one is required.
+
−
|-
+
−
| <code>map_label</code> || A text message that will be displayed next to the mark. Works with <code>label_position</code> below. This is not functional when using the XY coordinates method for map display.
+
−
|-
+
−
| <code>map_label_position</code> || Specifies the position of a label with respect to the mark. Valid values are <code>left</code>, <code>right</code>, <code>top</code> and <code>bottom</code>. See <code>label</code> above.
+
−
|-
+
−
| <code>relief</code> || 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|Map display methods]].
+
−
|-
+
−
| <code>mark</code> || The image used for the mark on a map. The default is [[:file:Red pog.svg|Red pog.svg]]. See [[Template:Location map]] for other images.
+
 
|-
 
|-
 
| colspan="2" style="text-align: center; font-weight: bold;" |Coordinate related parameters
 
| colspan="2" style="text-align: center; font-weight: bold;" |Coordinate related parameters
 
|-
 
|-
−
| <code>grid_ref_UK</code> || If the waterfall is in Great Britain, the British grid reference. For waterfalls outside of Great Britain, this field is inapplicable.
+
| <code>os grid ref</code> || If the waterfall is in the United Kingdom, Isle of Man of Republic of Ireland, the grid reference (GB grid or Irish grid). For waterfalls in the Channel Islands or territories, 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>latitude</code> and<br /> <code>longitude</code> || The latitude and the longitude respectively, in all-numeric form.
 
|-
 
|-
−
| <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>river</code> || The name of the river, burn, etc. that the falls interrupts.
 
|-
 
|-
−
| <code>coords_ref</code> || Strongly recommended. Specify a citation for the coordinates using {{tag|ref}} tags.
+
| <code>type</code> || The type of waterfall (e.g. horsetail, tiered).
−
|-
+
−
| <code>map</code> || The area covered by a location map template.
+
−
|-
+
−
| <code>map_caption</code> || Caption displayed below the map if necessary.
+
−
|-
+
−
| <code>label</code> || A text message that will be displayed next to the marker. Works with <code>label_position</code> below. Seldom  used.
+
−
|-
+
−
| <code>label_position</code> || Specifies the position of a label with respect to the marker. Valid values are <code>left</code>, <code>right</code>, <code>top</code> and <code>bottom</code>. See <code>label</code> above.
+
−
|-
+
−
| <code>mark</code> || The image to use for the marker. The default is Red pog.svg. See [[Template:Location map]] for more information.
+
−
|-
+
−
| <code>marker_size</code> || The display width of the marker image in pixels. The default is 8.
+
−
|-
+
−
| colspan="2" style="text-align: center; font-weight: bold;" | Other parameters
+
−
|-
+
−
| <code>location</code> || 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.
+
−
|-
+
−
| <code>type</code> || The type of waterfall (e.g. horsetail, tiered). See [[Waterfall#Types|this list]].
+
−
|-
+
−
| <code>elevation</code> || Elevation of the waterfall if it is noteworthy.
+
 
|-
 
|-
 
| <code>height</code> || The elevation of the crest to the base of the lowest drop.
 
| <code>height</code> || The elevation of the crest to the base of the lowest drop.
−
|-
 
−
| <code>height_longest</code> || The height of the longest drop.
 
−
|-
 
−
| <code>number_drops</code> || The number of drops or vertical segments.
 
 
|-
 
|-
 
| <code>width</code> || The width of the waterfall measured at the crest.
 
| <code>width</code> || The width of the waterfall measured at the crest.
−
|-
 
−
| <code>average_width</code> || The width of the waterfall at average flow. Measured at the crest
 
−
|-
 
−
| <code>run</code> || The length of the [[Run (waterfalls)|waterfall run]]
 
−
|-
 
−
| <code>watercourse</code> || The name of the river, stream, creek, etc. that the falls interrupts.
 
−
|-
 
−
| <code>average_flow</code> || The average flow rate of the watercourse.
 
−
|-
 
−
| <code>world_rank</code> || Rank in the world by height. This should be reliably sourced.
 
−
|-
 
−
| <code>child</code> || Used to embed this template in another. See [[#Template embedding|below]].
 
−
|-
 
−
| <code>embedded</code> || Used to embed another template in this one. See [[#Template embedding|below]].
 
 
|}
 
|}
  
−
== Examples ==
+
== Automatic categorisation ==
−
 
+
The infobox will automatically categorise the article using the parameters given. Firstly they will be categorised according to county / territory, using the <code>county</code> etc parameter(s). This is the same system as is used in just about every other infobox on Wikishire. Also certain rivers are well known or known for their waterfalls, and if <code>river</code> is one of these in the embedded list, then the fall will be categorised as for example 'Waterfalls on the River Tees'. (The list does not include rivers bereft of waterfalls, however large the river, so the Thames and the Trent are not included.)
−
=== Kerepakupai Merú ===
+
−
<!-- Data is from http://www.worldwaterfalldatabase.com/waterfall/Kerepakupai-Meru-1/ -->
+
−
{{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|0|abbr=on}}
+
−
| height = {{convert|3212|ft|0|abbr=on}}
+
−
| height_longest = {{convert|2648|ft|0|abbr=on}}
+
−
| number_drops = 2
+
−
| average_width = {{convert|350|ft|0|abbr=on}}
+
−
| average_flow = {{convert|500|ft3/s|0|abbr=on}}
+
−
| watercourse = [[Río Gauja]]
+
−
| world_rank = 1st
+
−
}}
+
−
 
+
−
<pre style="overflow:auto;">
+
−
{{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
+
−
}}
+
−
</pre>
+
−
{{clear}}
+
−
 
+
−
=== Kjelfossen ===
+
−
{{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
+
−
}}
+
−
 
+
−
<pre style="overflow:auto;">
+
−
{{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
+
−
}}
+
−
</pre>
+
−
{{clear}}
+
−
 
+
−
== 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 {{tl|Coord}} template inside the {{para|coordinates}} parameter. See the documentation for {{tl|Location map}}. The parameters for this template map to a subset of the parameters used by {{tlf|Location map}}. A map template can be found using these sources:
+
−
:[[Template:Location map/List|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 [[Module:Location map/data/Canada|Location map/data/Canada]]. In this case specify {{para|map|Canada}}.
+
−
 
+
−
{{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 --> }}
+
−
}}
+
−
<pre>
+
−
{{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 --> }}
+
−
}}</pre>
+
−
 
+
−
By default, {{tl|Coord}} displays in the infobox only in the page title. Parameter {{para|display|inline,title}} can be added to make the coordinates display at the top of the page as well.
+
−
{{clear}}
+
−
 
+
−
== Template embedding ==
+
−
This template can be embedding in another infobox template by adding the code <code><nowiki>|child=yes</nowiki></code>. To embed another template in this one use <code><nowiki>|embedded={{Infobox ...</nowiki></code>.
+
−
 
+
−
== Microformats ==
+
−
The articles created using this template include an hCard microformat. For more information read [[:Template:UF-hcard-place|this]].
+
−
 
+
−
== Tracking category ==
+
−
* {{clc|Pages using infobox waterfall with unknown parameters}}
+
  
−
<includeonly>{{sandbox other||
+
<includeonly>
−
<!-- Categories below this line, please; interwikis at Wikidata -->
+
[[Category:Infoboxes|Waterfall]]</includeonly>
−
[[Category:Geography infobox templates|Waterfall]]
+
−
[[Category:Embeddable templates]]
+
−
[[Category:Templates that add a tracking category]]
+
−
}}</includeonly>
+

Latest revision as of 14:50, 26 August 2019


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

Usage

Most commonly used parameters: 


{{Infobox waterfall
|name=
|gaelic=
|greek=
|irish=
|scots=
|welsh=
|county=
|county 1=
|county 2=
|territory=
|island=
|picture=
|picture caption=
|os grid ref=
|latitude=
|longitude=
|map=
|river=
|height=
|width=
|type=
|average flow=
}}

Parameter descriptions

This table describes the parameters which can be used in building an waterfall infobox. Some are alternatives: the language parameters for example and use either county or territory or county 1 and county 2: one version of these parameters must be assigned a value.

Field name Description
name 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 Grey Mare's Tail, Kinlochmore then name=Grey Mare's Tail.
welsh
- or other language 		If there is a common English name for the waterfall use that for the name parameter, and if it is given a different name in Welsh, Gaelic etc then that parameter is used to display the name in that language. Italics should not be used: the template handles the display styling.
picture The name of an image file to be displayed. Just use the file name and extension without "File:" and without sizing codes.
picture caption The caption that will appear below the image if one is required.
Map related parameters
map Very rare, but if a map image is used, put this in as for "picture" above.
map caption The caption that appears below the map if one is required.
Coordinate related parameters
os grid ref If the waterfall is in the United Kingdom, Isle of Man of Republic of Ireland, the grid reference (GB grid or Irish grid). For waterfalls in the Channel Islands or territories, this field is inapplicable.
latitude and
longitude 		The latitude and the longitude respectively, in all-numeric form.
river The name of the river, burn, etc. that the falls interrupts.
type The type of waterfall (e.g. horsetail, tiered).
height The elevation of the crest to the base of the lowest drop.
width The width of the waterfall measured at the crest.

Automatic categorisation

The infobox will automatically categorise the article using the parameters given. Firstly they will be categorised according to county / territory, using the county etc parameter(s). This is the same system as is used in just about every other infobox on Wikishire. Also certain rivers are well known or known for their waterfalls, and if river is one of these in the embedded list, then the fall will be categorised as for example 'Waterfalls on the River Tees'. (The list does not include rivers bereft of waterfalls, however large the river, so the Thames and the Trent are not included.)


Retrieved from "https://wikishire.co.uk/w/index.php?title=Template:Infobox_waterfall/doc&oldid=64973"