Difference between revisions of "Template:Infobox waterfall/doc"
(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 | + | <!-- Place categories where indicated at the bottom of this page--> |
− | + | ||
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 | + | {{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= |
− | | | + | |gaelic= |
− | | | + | |greek= |
− | | | + | |irish= |
− | | | + | |scots= |
− | | | + | |welsh= |
− | | | + | |county= |
− | | | + | |county 1= |
− | | | + | |county 2= |
− | | | + | |territory= |
− | | | + | |island= |
− | | | + | |picture= |
− | | | + | |picture caption= |
− | | | + | |os grid ref= |
− | | | + | |latitude= |
− | | | + | |longitude= |
− | | | + | |map= |
− | | | + | |river= |
− | | | + | |height= |
− | | type | + | |width= |
+ | |type= | ||
+ | |average flow= | ||
}} | }} | ||
</pre> | </pre> | ||
Line 37: | Line 38: | ||
== Parameter descriptions == | == Parameter descriptions == | ||
− | This table describes | + | 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> || | + | | <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> | + | | <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> | + | | <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> | + | | <code>picture 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> | + | | <code>map</code> || Very rare, but if a map image is used, put this in as for "<code>picture</code>" above. |
|- | |- | ||
− | | <code> | + | | <code>map caption</code> || The caption that appears below the map if one is required. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
| 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> | + | | <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> | + | | <code>latitude</code> and<br /> <code>longitude</code> || The latitude and the longitude respectively, in all-numeric form. |
|- | |- | ||
− | | <code> | + | | <code>river</code> || The name of the river, burn, etc. that the falls interrupts. |
|- | |- | ||
− | + | | <code>type</code> || The type of waterfall (e.g. horsetail, tiered). | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | | <code>type</code> || The type of waterfall (e.g. horsetail, tiered) | + | |
− | + | ||
− | + | ||
|- | |- | ||
| <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>width</code> || The width of the waterfall measured at the crest. | | <code>width</code> || 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 <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.) | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | < | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | < | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | </ | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | <includeonly | + | <includeonly> |
− | + | [[Category:Infoboxes|Waterfall]]</includeonly> | |
− | [[Category: | + | |
− | + | ||
− | + | ||
− | + |
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 andlongitude |
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.)