Template:Coord

From Wikibooks, open books for an open world
Jump to: navigation, search
Template documentation[edit] [history] [purge]

Quick guide

Quick how to
To add 57°18′22.5″N 4°27′32.7″W / 57.30625°N 4.459083°W / 57.30625; -4.459083 to the top of a page, use {{Coord}}, thus:
{{Coord|57|18|22.5|N|4|27|32.7|W|display=title}}

These coordinates are in degrees, minutes, and seconds of arc.

To add 44°06′43″N 87°54′47″W / 44.112°N 87.913°W / 44.112; -87.913 to the top of a page, use either
{{Coord|44.112|N|87.913|W|display=title}}

or

{{Coord|44.112|-87.913|display=title}}

These coordinates are in decimal degrees.

  • Degrees, minutes and seconds must be separated by a pipe ("|").
  • Map datum must be WGS84 (except for off-earth bodies).
  • Avoid excessive precision (0.0001° is <11 m, 1″ is <31 m).
  • Latitude (N/S) must appear before longitude (E/W).
Optional coordinate parameters follow the longitude and are separated by an underscore ("_"):

Other optional parameters are separated by a pipe ("|"):

  • display
    |display=inline (the default) to display in the body of the page only,
    |display=title to display in the title only, or
    |display=inline,title to display in both places.
  • name
    name=X to label the place on maps (default is PAGENAME)

Thus: {{Coord|44.117|-87.913|dim:30_region:US-WI_type:event

|display=inline,title|name=accident site}}

Use |display=title (or |display=inline,title) once per page, for the subject of the page, where appropriate.

Purpose

{{Coord}} provides a standard notation for encoding locations by their latitude and longitude coordinates. It is primarily for specifying the WGS84 geographic coordinates of locations on Earth, at the same time emitting a machine-readable Geo microformat. However, it can also encode locations on natural satellites, dwarf planets, and planets other than Earth.

Features

Latitude and longitude may be specified (with appropriate precision) either in decimal notation or as degrees/minutes/seconds. By default, coordinates appear in the format used to specify them. However, the format= parameter can be used to force display in a particular format.

The template displays the formatted coordinates with a hyperlink to GeoHack. GeoHack displays information customized to the location, including links to external mapping services.

For terrestrial locations, a blue globe () appears to the left of the hyperlink. Clicking on the globe activates the WikiMiniAtlas (requires JavaScript).

By default, coordinates appear "in line" with the adjacent text. However, the display= parameter can be used to move the coordinates up near the page title—or display them in both places at once.

The template outputs coordinates in three formats:

  • Degree/minutes/seconds ("DMS", precision is degrees, or degrees/minutes, or degrees/minutes/seconds, based on input precision).
  • Decimal degrees (varying the number of decimal places based on input precision)
  • A machine readable Geo microformat.

Logged-in users can customize how coordinates appear in their browsers.

Usage

{{coord|latitude|longitude|coordinate parameters|template parameters}}
{{coord|dd|N/S|dd|E/W|coordinate parameters|template parameters}}
{{coord|dd|mm|N/S|dd|mm|E/W|coordinate parameters|template parameters}}
{{coord|dd|mm|ss|N/S|dd|mm|ss|E/W|coordinate parameters|template parameters}}

The hemisphere identifiers (N/S) and (E/W), if used, must be adjacent to the enclosing pipe "|" characters, and cannot be preceded or succeeded by spaces.

There are two kinds of parameters, all optional:

  • Coordinate parameters are parameters that {{Coord}} passes to the map server. These have the format parameter:value and are separated from each other by the underscore character ( _ ). The supported coordinate parameters are dim:, globe:, region:, scale:, source:, and type:. See coordinate parameters for details and examples.
  • Template parameters are parameters used by the {{Coord}} template. These have format parameter=value and are separated from each other by the pipe character ( | ). The supported template parameters are display=, format=, name=, and notes=.
  • display= can be one of the following:
  • display=inline – Display the coordinate inline (default)
  • display=title – Display the coordinate near the page title
    • shortcut: display=t
  • display=inline,title – Display the coordinate both inline and at title
    • shortcut: display=it
  • display=title,inline has the same effect as display=inline,title
Note: the title attribute indicates that the coordinates apply to the entire page, and not just one of (perhaps many) places mentioned in it — so it should only be omitted in the latter case.
  • format= can be used to force dec or dms coordinate display.
  • format=dec reformats the coordinates to decimal degrees format.
  • format=dms reformats the coordinates to degrees | minutes | seconds format.
  • name= can be used to annotate inline coordinates for display in map services such as the WikiMiniAtlas. If omitted, the article title (PAGENAME) is assumed.
Note: a name= parameter causes {{Coord}} to emit an hCard microformat using that name, even if used within an existing hCard. Do not use when the name is that of a person (e.g for a gravesite), as the generated hCard would be invalid. Also, do not use square brackets in names.
  • notes= specifies text to be displayed immediately following the coordinates. This is primarily intended for adding footnotes to title coordinates.

Examples

{{coord|43.651234|-79.383333}} 43°39′04″N 79°23′00″W / 43.651234°N 79.383333°W / 43.651234; -79.383333 Toronto – Fully decimal – N & W
{{coord|43.65|-79.38}} 43°39′N 79°23′W / 43.65°N 79.38°W / 43.65; -79.38 Toronto – less precise
{{coord|43.6500|-79.3800}} 43°39′00″N 79°22′48″W / 43.6500°N 79.3800°W / 43.6500; -79.3800 Toronto – medium precision with trailing zeroes
{{coord|43.651234|N|79.383333|W}} 43°39′04″N 79°23′00″W / 43.651234°N 79.383333°W / 43.651234; -79.383333 Toronto – decimal with Northing & Westing
{{coord|43|29|N|79|23|W}} 43°29′N 79°23′W / 43.483°N 79.383°W / 43.483; -79.383 Toronto – degrees & minutes
{{coord|43|29|4|N|79|23|0|W}} 43°29′4″N 79°23′0″W / 43.48444°N 79.383333°W / 43.48444; -79.383333 Toronto – degrees, minutes & seconds
{{coord|43|29|4.5|N|79|23|0.5|W}} 43°29′4.5″N 79°23′0.5″W / 43.484583°N 79.383472°W / 43.484583; -79.383472 Toronto – degrees, minutes, seconds & fractions of seconds
{{coord|55.752222|N|37.615556|E}} 55°45′08″N 37°36′56″E / 55.752222°N 37.615556°E / 55.752222; 37.615556 Moscow – N & E
{{coord|55.752222|N|37.615556|E|format=dms}} 55°45′08″N 37°36′56″E / 55.752222°N 37.615556°E / 55.752222; 37.615556 Convert to dms format
{{coord|39.098095|-94.587307|format=dms}} 39°05′53″N 94°35′14″W / 39.098095°N 94.587307°W / 39.098095; -94.587307 Decimal conversion without N/S/E/W
{{coord|55.752222|N|37.615556|E|format=dec|name=Moscow}} 55°45′08″N 37°36′56″E / 55.752222°N 37.615556°E / 55.752222; 37.615556 (Moscow) Convert to decimal and label on some maps
{{coord|33|55|S|18|25|E}} 33°55′S 18°25′E / 33.917°S 18.417°E / -33.917; 18.417 Cape Town – S & E
{{coord|35|00|N|105|00|E}} 35°00′N 105°00′E / 35°N 105°E / 35; 105 People's Republic of China
{{coord|22|54|30|S|43|14|37|W}} 22°54′30″S 43°14′37″W / 22.90833°S 43.24361°W / -22.90833; -43.24361 Rio – S & W
{{coord|22|S|43|W}} 22°S 43°W / 22°S 43°W / -22; -43 A degree confluence.
{{coord|52|28|N|1|55|W|region:GB_type:city|notes=<ref>{{cite web|url=http://www.fallingrain.com/world/UK/0/Birmingham.html|title=Birmingham}}</ref>|display=inline,title}} 52°28′N 1°55′W / 52.467°N 1.917°W / 52.467; -1.917[1]Coordinates: 52°28′N 1°55′W / 52.467°N 1.917°W / 52.467; -1.917[1] Birmingham – with display, notes, and parameter settings; note display also in title of this page.

References

Coordinate parameters

The first unnamed parameter following the longitude is an optional string of coordinate parameters, separated by underscores. These parameters help GeoHack select suitable map resources, and they will become more important when Wikimaps becomes fully functional.

type:T

The type: parameter specifies the type of location for reverse mapping (for instance, to select a marker icon in the WikiMiniAtlas).

It also sets the map scale, which can however be overridden by dim: or scale:.

Valid types are:

T Description Map scale
country (e.g. "type:country") 1:10,000,000
satellite geo-stationary satellites 1:10,000,000
adm1st Administrative unit of country, 1st level (province, state), see table, e.g. U.S. states 1:1,000,000
adm2nd Administrative unit of country, 2nd level, see table, e.g. County 1:300,000
adm3rd Administrative unit of country, 3rd level, see table 1:100,000
city(pop) cities, towns, villages, hamlets, suburbs, subdivisions, neighborhoods, and other human settlements (including unincorporated and/or abandoned ones) with known population
Please replace pop with a number. Commas in pop will be ignored. There should be no blanks.
1:30,000 ... 1:300,000
city cities, towns, villages, hamlets, suburbs, subdivisions, neighborhoods, and other human settlements (including unincorporated and/or abandoned ones) with unspecified population
These are treated as minor cities.
1:100,000
airport airports and airbases 1:30,000
mountain peaks, mountain ranges, hills, submerged reefs, and seamounts 1:100,000
isle islands and isles 1:100,000
waterbody bays, fjords, lakes, reservoirs, ponds, lochs, loughs, meres, lagoons, estuaries, inland seas, and waterfalls 1:100,000
forest forests and woodlands 1:50,000
river rivers, canals, creeks, brooks, and streams, including intermittent ones 1:100,000
glacier glaciers and icecaps 1:50,000
event one-time or regular events and incidents that occurred at a specific location, including battles, earthquakes, festivals, and shipwrecks 1:50,000
edu schools, colleges, and universities 1:10,000
pass mountain passes 1:10,000
railwaystation stations, stops, and maintenance areas of railways and trains, including railroad, metro, rapid transit, underground, subway, elevated railway, etc. 1:10,000
landmark buildings (including churches, factories, museums, theatres, and power plants but excluding schools and railway stations), caves, cemeteries, cultural landmarks, geologic faults, headlands, intersections, mines, ranches, roads, structures (including antennas, bridges, castles, dams, lighthouses, monuments, and stadiums), tourist attractions, valleys, and other points of interest 1:10,000
Default scale: if no type is used or the type is not defined in the geohack extension 1:300,000
Samples
T Markup Result
waterbody {{coord|46|43|N|7|58|E|type:waterbody}} 46°43′N 7°58′E / 46.717°N 7.967°E / 46.717; 7.967

scale:N

The scale: parameter specifies the desired map scale as 1:N, overriding the scale implied by any type: parameter.

GeoHack uses scale: to select a map scale for a 72 dpi computer monitor. If no dim:, type:, or scale: parameters are provided, GeoHack uses its default scale of 1:300,000.

Samples
Subject Scale Markup Result
Big Ben 1:500 {{coord|51.500611|N|0.124611|W|scale:500}} 51°30′02″N 0°07′29″W / 51.500611°N 0.124611°W / 51.500611; -0.124611
Palace of Westminster 1:5,000 {{coord|51.5006|N|0.1246|W|scale:5000}} 51°30′02″N 0°07′29″W / 51.5006°N 0.1246°W / 51.5006; -0.1246
City of Westminster 1:50,000 {{coord|51.501|N|0.125|W|scale:50000}} 51°30′04″N 0°07′30″W / 51.501°N 0.125°W / 51.501; -0.125
Greater London 1:500,000 {{coord|51.50|N|0.12|W|scale:500000}} 51°30′N 0°07′W / 51.50°N 0.12°W / 51.50; -0.12

dim:D

The dim: parameter defines the diameter of a viewing circle centered on the coordinate. While the default unit of measurement is meters, the km suffix may be appended to indicate kilometers.

GeoHack uses dim: to select a map scale such that the viewing circle appears roughly 10 centimeters (4 in) in diameter on a 72 dpi computer monitor. If no dim:, type:, or scale: parameters are provided, GeoHack uses its default viewing circle of 30 kilometers (19 mi).

Samples
Subject View diameter Markup Result
Western Hemisphere 10,000 kilometers (6,200 mi) {{coord|0|N|90|W|dim:10000km}} 0°N 90°W / 0°N 90°W / 0; -90
Ohio 400 kilometers (250 mi) {{coord|40.5|-82.5|dim:400km}} 40°30′N 82°30′W / 40.5°N 82.5°W / 40.5; -82.5
Dresden 20,000 meters (12 mi) {{coord|51.033|13.73|dim:20000}} 51°01′59″N 13°43′48″E / 51.033°N 13.73°E / 51.033; 13.73
Statue of Liberty 100 meters (330 ft) {{coord|40.6892|-74.0445|dim:100}} 40°41′21″N 74°02′40″W / 40.6892°N 74.0445°W / 40.6892; -74.0445

region:R

The region: parameter specifies the political region for terrestrial coordinates. It is used to select appropriate map resources. If no region: parameter is provided, GeoHack attempts to determine the region from the coordinates.

The region should be supplied as either a two character ISO 3166-1 alpha-2 country code or an ISO 3166-2 region code.

Examples of ISO 3166-1 alpha-2 codes:

Examples of ISO 3166-2 codes:

The oceans have the following Wiki assigned code elements:

  • XN Arctic Ocean
  • XA Atlantic Ocean
  • XI Indian Ocean
  • XP Pacific Ocean
  • XS Southern Ocean

In addition, two Wiki assigned code elements can be used with {{coord}}:

  • XZ for objects in or above international waters (similar to UN/LOCODE).
  • ZZ for use in examples.
Samples
Focus region Region Markup Result
Switzerland CH  {{coord|46.9524|N|7.4396|E|region:CH}}  46°57′09″N 7°26′23″E / 46.9524°N 7.4396°E / 46.9524; 7.4396
Berlin, Germany DE-BE  {{coord|52.5164|N|13.3775|E|region:DE-BE}}  52°30′59″N 13°22′39″E / 52.5164°N 13.3775°E / 52.5164; 13.3775

globe:G

The globe: parameter specifies the planet, dwarf planet, asteroid, or natural satellite upon which the coordinates reside. Apart from earth (the default), recognized values are: mercury, venus, moon, mars, phobos, deimos, ceres, vesta, ganymede, callisto, io, europa, mimas, enceladus, tethys, dione, rhea, titan, hyperion, iapetus, phoebe, miranda, ariel, umbriel, titania, oberon, triton, and pluto.

Samples
Subject G Markup Result
Kittu Crater ganymede {{coord|0.4|N|334.6|W|globe:ganymede}} 0°24′N 334°36′W / 0.4°N 334.6°W / 0.4; -334.6
Viking 2 lander mars {{coord|48.269|N|225.990|W|globe:mars}} 48°16′08″N 225°59′24″W / 48.269°N 225.990°W / 48.269; -225.990
Mozart Crater mercury {{coord|8|N|190.5|W|globe:mercury}} 8°00′N 190°30′W / 8°N 190.5°W / 8; -190.5
Apollo 11 lander moon {{coord|0|40|26.69|N|23|28|22.69|E|globe:moon}} 0°40′26.69″N 23°28′22.69″E / 0.6740806°N 23.4729694°E / 0.6740806; 23.4729694
Ksa Crater titan {{coord|14.0|N|65.4|W|globe:titan}} 14°00′N 65°24′W / 14.0°N 65.4°W / 14.0; -65.4
Venera 13 lander venus {{coord|7.5|S|303|E|globe:venus}} 7°30′S 303°00′E / 7.5°S 303°E / -7.5; 303
Stickney Crater phobos {{coord|1|N|49|W|globe:phobos}} 1°N 49°W / 1°N 49°W / 1; -49

For globes other than Earth, {{coord}} does not assume a specific reference system (in contrast with Earth's WGS84). Since the template defaults to east longitude, the |W| direction must be specified for globes that measure longitude westward. At the present time, only limited mapping is available for Mars and the Moon and none for other extraterrestrial bodies.

source:S

Specifies, where present, the data source and data source format/datum, and optionally the original data, presented in parentheses. This is initially primarily intended for use by geotagging robots, so that data is not blindly repeatedly copied from format to format and Wikibooks to Wikibooks, with progressive loss of precision and attributability.

Examples:

  • A lat/long geotag derived from a Ordnance Survey National Grid Reference NM 435 355 found in the English-language Wikibooks would be tagged as "source:enwikibooks-osgb36(NM435355)"
  • A latitude-longitude location sourced from data taken from the German-language Wikibooks would be tagged as "source:dewikibooks" – and so on, for other language codes;
  • A location sourced from the public domain GeoNet Names Server database would be tagged as "source:GNS". No datum or format information is needed, since by default all Wikibooks coordinates are in latitude/longitude format based on the WGS84 datum. Similarly, US locations sourced from the similar public domain GNIS database would be tagged as "source:GNIS".

Per-user display customization

To always display coordinates as DMS values, add this to your common.css:

.geo-default { display: inline }
.geo-nondefault { display: inline }
.geo-dec { display: none }
.geo-dms { display: inline }

To always display coordinates as decimal values, add this to your common.css:

.geo-default { display: inline }
.geo-nondefault { display: inline }
.geo-dec { display: inline }
.geo-dms { display: none }

To display coordinates in both formats, add this to your common.css:

.geo-default { display: inline }
.geo-nondefault { display: inline }
.geo-dec { display: inline }
.geo-dms { display: inline }
.geo-multi-punct { display: inline }

If CSS is disabled, or you have an old copy of MediaWiki:Common.css cached, you will see both formats. (You can either clear your cache or manually refresh this URL: [1].)

To disable display of the blue globe adjacent to coordinates, add this to your common.js

var wma_settings = {enabled:false}

Note that this will disable WikiMiniAtlas.

Internals

Subtemplates

The following templates are "subroutines" of {{Coord}}. Separating them out drastically reduces the pre-expand size of {{Coord}}. They shouldn't be invoked directly.

name function
{{Coord/display/inline}} displays coordinates inline
{{Coord/display/inline,title}} displays coordinates inline and above the page
{{Coord/display/title}} displays coordinates above the page (generally to the right of the page's title)
{{Coord/link}} generates microformats and link to GeoHack
{{Coord/input/dec}} reads coordinates in decimal degrees {{coord|12|-12}}
{{Coord/input/d}} reads coordinates in decimal degrees with directional letters {{coord|12|N|12|W}}
{{Coord/input/dm}} reads coordinates in degrees/minutes format {{coord|12|12|N|12|12|W}}
{{Coord/input/dms}} reads coordinates in degrees/minutes/seconds format {{coord|12|12|12|N|12|12|12|W}}
{{Coord/input/ERROR}} generates error message if the inputs do not match any of the above formats
{{Coord/input/error2}} generates error message for range checks and such
{{Coord/input/nolat}} generates error message for missing latitude
{{Coord/negzeropad}} pads a positive number with trailing zeroes until it matches the precision of a negative number
{{Coord/dec2dms}} takes a decimal coordinate and two cardinal directions and renders a coordinate in degrees/minutes/seconds
{{Coord/dms2dec}} converts cardinal direction and degree/minutes/seconds to decimal coordinate
{{Coord/prec dec}} selects a format for converting decimal degrees, based on the precision of the inputs

Class names

The class names geo, latitude and longitude are used to generate the microformat and MUST NOT be changed.