Template:Infobox protected area/sandbox/doc
| This is a documentation subpage for Template:Infobox protected area/sandbox. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
This template is part of the Protected Areas WikiProject.
Template blank
These selected fields can be used to form a completely functional Infobox. The template can be pasted into a new article. See below for a working examples.
{{Infobox Protected area
| name =
| iucn_category =
| photo =
| photo_caption =
| photo_width =
| map =
| map_caption =
| map_width =
| location =
| nearest_city =
| lat_d =
| lat_m =
| lat_s =
| lat_NS =
| long_d =
| long_m =
| long_s =
| long_EW =
| coords_ref =
| region =
| area =
| established =
| visitation_num =
| visitation_year =
| governing_body =
| world_heritage_site =
| url =
}}
Field descriptions
Version 2.0 fields
This table describes fields that are of general use in building infoboxes. There are other fields listed below that are for compatibility with infoboxes that existed before this template was updated.
| Field name | Description |
|---|---|
name |
Required. The official name of the protected area which 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 Mount Washington (New Hampshire) then name = Mount Washington,
|
width |
Sets the overall width of the infobox. The default width is 305 pixels. This value value should seldom be changed. |
native_name |
The name of the protected place in the local language. |
iucn_category |
Strongly recommended. The IUCN category associated with the protected place. Valid values are Ia, Ib, II, III, IV, V, or VI. See IUCN Categories. |
photo |
The name of a photographic file to be displayed. No special formatting is needed |
photo_caption |
A caption that will appear below the photograph if one is required. |
photo_width |
Specifies the desired width of the photo if it appears out of proportion to the rest of the infobox. The default value is 288 pixels. Photographs with a horizontal orientation (landscape mode) will generally display well at the default setting. A phonograph with vertical orientation (portrait mode) may need to be adjusted to 180 to 220 pixels. For example photo_width = 200.
|
map |
The name of the map to be displayed. See Map display methods. |
map_caption |
A caption that appears below the map if one is required. |
map_width |
Changes the display width the map if it appears out of proportion to the rest of the infobox. The default width is 288 pixels. A display error will occur in compatibility mode when the following two fields have assigned values. |
locator_xlocator_y |
These two fields are seldom used when building new infoboxes. They specify the position of the location marker on some types of maps. They specify the coordinates of the marker in pixels. |
label |
Text that will display when the mouse pointer is over the marker. A text message will be displayed next to the marker if label_position is assigned a valid value other than none. If label is not specified then name is used.
|
label_position |
Specifies the position of the label with respect to the marker. This is not currently functional in compatibility mode. Valid values are left, right, top, bottom and none. The default value is none which prevents the label from being displayed as visible text. See label.
|
location |
The location of the protected place. Don't be too precise. County, state and country are good in the USA. If the place is in multiple counties just list the state and country. |
nearest_city |
Recommended if the city is not mentioned in the location field. It could be a city with a major airport or a large gateway town where supplies and lodging are available. |
coords |
For the {{Coord}} template. Will not generate a location marker if a map is used. See below. When this option is used region, scale, source, format and display fields are none functional but this data can be entered in the Coord template. type should be mountain and display should be inline,title.
|
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. See below. |
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. See below. |
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_ref |
Used with the lat and long fields above. Strongly recommended. Specify the citation reference for the coordinates using <ref>...</ref> tags.
|
region |
A location 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 region. |
scale |
This value determines the zoom factor for external map websites. See scale. The default is 1:10,000. |
source |
Source of the data. See source. For example GNIS or NGS or GNSS. |
format |
Determines the format of the coordinate display. Valid values are dms for degrees, minutes and seconds, and dec for decimal degrees. The default is dms and is recommended.
|
display |
Determines where the coordinates will be displayed. Valid values are inline and inline,title and their variants. The default is inline,title and is recommended.
|
area |
Area of the protected place. Usually in acres or square miles for US locations and square kilometres or hectares elsewhere. The {{Convert}} template should be used. |
established |
The date the protected area was established. For example congress established Yosemite National Park on October 1, 1890. |
visitation_num |
The annual number of visitors in a recent year if known. |
visitation_year |
The year during which the number of visitors was counted. |
governing_body |
The agency or organization which owns or controls the protected area. |
world_heritage_site |
The year the protected area was designated a World Heritage Site. Few areas have this designation |
website |
The URL of the official website for the protected area. The url field below is recommended. This field should be formatted as an external link. For example: [http://www.example.org/ www.example.org].
|
url |
The preferred method of entry. The full URL should be given with no formatting. For example: http://www.example.org/.
|
Compatibility fields
These fields files should not be used if the updated syntax for photographs and maps is used. It is strongly recommended that new infoboxes use the new field names although these fields function in the same way they did before the template was updated. Note that the compatibility coordinate fields are simple aliases for the new field names. There is now an attempt to standardize such names across templates to avoid confusion.
| Field name | Description |
|---|---|
image |
If location_x and location_y this field can be used to display a map. Without x and y it can be used to display and image.
|
base_width |
Specifies the width of the image or map displayed. The default width is 288 pixels. A display error will occur when location_x and location_y have assigned values and the size of the map is changed.
|
caption |
A caption that appears below the image or map if one is required. |
lat_degrees |
Alias for lat_d above.
|
lat_minutes |
Alias for lat_m above.
|
lat_seconds |
Alias for lat_s above.
|
lat_direction |
Alias for lat_NS above.
|
long_degrees |
Alias for long_d above.
|
long_minutes |
Alias for long_m above.
|
long_seconds |
Alias for long_s above.
|
long_direction |
Alias for long_EW above.
|
IUCN Categories
Depending on the value of the iucn_category field, one of the following banners will be displayed below the area name. Valid values are Ia, Ib, II, III, IV, V and VI. For more information read the World Commission on Protected Areas article,
IUCN Category Ia (Strict Nature Reserve)
|
IUCN Category II (National Park)
|
IUCN Category III (Natural Monument)
|
IUCN Category IV (Habitat/Species Management Area)
|
IUCN Category V (Protected Landscape/Seascape)
|
IUCN Category VI (Managed Resource Protected Area)
|
Map display methods
There are two mechanisms by which maps can be displayed.
Compatibility method
This method is maintained primarily for backward compatibility. It requires the user to determine x and y coordinates in pixels that determine the location of the marker on the map. The sub-template {{Superimpose}} uses these special coordinates to superimpose the marker image on the map image.
locator_xis distance to offset the marker from the left edge of the map image in pixels.locator_xis distance to offset the marker from the top edge of the map image in pixels.
The default width is 288 pixels but can be changed by setting map_width to a different value. The height of the map can most easily be determined by right clicking on a displayed map image and choosing properties from the drop down menu.
{{user:Droll/sandbox
| name = Yosemite National Park
| iucn_category = Ib
| map = US_Locator_Blank.svg
| map_width = 288
| map_caption = Map of the USA
| locator_x = 20
| locator_y = 84
| location = [[California]], [[United States]]
| nearest_city = [[Mariposa, California|Mariposa]]
| lat_d = 37.8499232
| long_d = -119.5676663
| region = US-CA
| scale = 300000
| area = {{convert|761266|acres|km2}}
| established = October 1, 1890
| visitation_num = 3,280,911
| visitation_year = 2004
| governing_body = [[National Park Service]]
| world_heritage_site = 1984
| website = [http://www.nps.gov/yose/ www.nps.gov/yose]
}}
In this example the width of the map image is 288px in width and 187px in height. Yosemite National Park is located about 20px from the left of the image and 84px from the top. The only way to obtain values for x and y is by guess, trial and error. You can experiment by pasting this example code into a sandbox and substituting your own values.
Notice that changing the width of the map image will require new values for x and y to be calculated. This can be done using the following method.
new x = (new width * old x) / old widthnew y = (new height * old y) / old height
Version 2.0 method
If values for locator_x and locator_y are not specified and geographical coordinates are specified without the use of the {{Coord}} template then the this template will determine the marker location on the map using the geographical coordinates. A set of equirectangular projection map templates are used. This map type looks different than those with which most are familiar. Most maps use some other method of projection. Compare the two maps bellow. The second uses equirectangular projection.
For technical reasons it is much easier for the template to use the second map. The distortion of the of the 49th parallel north which defines most of the US - Canadian border can be clearly seen. If the first map were to be used the marker would not appear in the proper location. In maps of smaller areas this difference is less critical.
Templates for use with this method can be found at Location maps. Select the template you wish to use and click on the template name. Information about the map will be displayed including the border coordinates of the map and the name of the area covered. The name displayed on the template page is the value used when specifying the value of the map field. A map template for the Alberta, Canada can be found at Template:Location map Canada Alberta and the name given on that page is "Canada Alberta". For example:
{{user:Droll/sandbox
| name = Dry Island Buffalo Jump Provincial Park
| iucn_category = III
| map = Canada Alberta
| map_caption = Map of Alberta, Canada
| map_width = 175
| location = [[Alberta, Canada|Alberta]], [[Canada]]
| nearest_city = [[Three Hills, Alberta|Three Hills]]
| lat_d = 51.9438889
| long_d = -112.9636110
| region = CA
| area = {{convert|34.5|km2|sqmi|abbr=on}}
| established = December 15, 1970
| governing_body = [[Alberta Tourism, Parks, Recreation and Culture]]
}}
Coordinate syntax
Coordinates can be entered in decimal digit or using degrees, minutes and second. There is also the option of using the {{Coord}} template but this is not recommended since it does not allow for map functionality. If no map is to be displayed then the Coord template will work fine.
| lat_d = 33 | lat_m = 39 | lat_s = 3.6 | lat_NS = S | long_d = 151 | long_m = 12 | long_s = 04 | long_EW = E
| lat_d = 33 | lat_m = 39 | lat_NS = S | long_d = 151 | long_m = 12 | long_EW = E
| lat_d = 33 | lat_NS = S | long_d = 151 | long_EW = E
| lat_d = 33.65100 | lat_NS = S | long_d = 51.20100 | long_EW = E
| lat_d = -33.65100 | long_d = 51.20100
The coord template can be used with the following syntax. More information can be found at Template:Coord.
{{coord|33|39|03.6|S|151|12|03.6|E|format=dms|region:AU_type:landmark|display=inline,title}}
For additional examples see Coordinate examples.
The coordinates for Canadian places can be found using Geographical Name Search Service (GNSS). Coordinates for United States places can be found using Geographic Names Information System (GNIS). Another tool that will supply coordinates for many locations around the world can be found at univers immedia which uses Google Maps. These sites and many others supply coordinates using decimal degreess which are used in the example above. Using decimal degrees simplifies data entry and accuracy. By default the coordinates are displayed in degree, minute, second format since that is generally expected. This can be changed by setting format=dec.
Infobox examples
With map only
{{user:Droll/sandbox
| name = Ku-ring-gai Chase National Park
| iucn_category = II
| map = Australia
| map_width = 200
| location = [[New South Wales]]. [[Australia]]
| nearest_city = [[Sydney]]
| lat_d = 33
| lat_m = 39
| lat_s = 3.6
| lat_NS = S
| long_d = 151
| long_m = 12
| long_s = 3.6
| long_EW = E
| region = AU
| area = {{convert|154|km2|acre|abbr=on}}
| established = October 1, 1967
| visitation_num = 2 Million
| visitation_year = 2001
| governing_body = [[Department of Environment and Climate Change (New South Wales)|Department of Environment and Climate Change]]
}}
With photograph only
{{user:Droll/sandbox
| name = Yosemite National Park
| iucn_category = Ib
| photo = 100 1325.JPG
| photo_caption = Yosemite Valley from Tunnel View
| location = [[California]], [[United States]]
| nearest_city = [[Mariposa, California|Mariposa]]
| lat_d = 37.8499232
| long_d = -119.5676663
| region = US-CA
| scale = 300000
| area = {{convert|761266|acres|km2}}
| established = October 1, 1890
| visitation_num = 3,280,911
| visitation_year = 2004
| governing_body = [[National Park Service]]
| world_heritage_site = 1984
| url = http://www.nps.gov/yose/
}}
With no photograph or map
{{Infobox Protected area/sandbox
| name = Harz National Park
| native_name = Nationalparkverwaltung Harz
| iucn_category = II
| location = [[Lower Saxony]] and [[Saxony-Anhalt]], [[Germany]]
| nearest_city =
| coords = {{coord|51|47|00|N|10|34|00|E|region:DE_type:landmark|display=inline}}
| area = {{convert|8900|ha|acre}}
| established = 1990, 1994, 2006
| visitation_num =
| visitation_year =
| governing_body = Nationalparkverwaltung Harz
}}
With photograph and map
{{user:Droll/sandbox
| name = Dry Island Buffalo Jump Provincial Park
| photo = Dry Island Provincial Park2.jpg
| photo_caption = Panoramic view
| iucn_category = III
| map = Canada Alberta
| map_caption = Map of Alberta, Canada
| map_width = 175
| location = [[Alberta, Canada|Alberta]], [[Canada]]
| nearest_city = [[Three Hills, Alberta|Three Hills]]
| lat_d = 51
| lat_m = 56
| lat_s = 10
| lat_NS = N
| long_d = 112
| long_m = 57
| long_s = 41
| long_EW = W
| coords_ref = <ref name=gnss>
{{cite web
| url = http://gnss.nrcan.gc.ca/gnss-srt/searchName.jsp?language=en
| title = Geographical Name Search Service
| publisher = Natural Resources Canada
| accessdate = 2009-04-26 }}</ref>
| region = CA
| area = {{convert|34.5|km2|sqmi|abbr=on}}
| established = December 15, 1970
| governing_body = [[Alberta Tourism, Parks and Recreation]]
}}
Microformat
The HTML mark up produced by this template includes an hCard microformat, which makes the place-name and location parsable by computers, either acting automatically to catalogue article across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to an address book. Within the hCard is a Geo microformat, which additionally makes the coordinates (latitude & longitude) parsable, so that they can be, say, looked up on a map, or downloaded to a GPS unit. For more information about the use of microformats on Wikipedia, please see the microformat project.
For more information on microformats please visit WikiProject Microformats.