Template:Coord/doc

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. However, it can also encode locations on natural satellites, dwarf planets, and planets other than Earth.

• To specify celestial coordinates, use {{sky}} instead.
• Tag articles which lack coordinates (but need them) with {{coord missing}}.
• If the subject's location is truly unknown or disputed, note this with {{coord unknown}}.

See also Wikipedia:WikiProject Geographical coordinates.

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)
• Geo microformat.

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

Caveats

The template must not be modified without prior discussion.

Tools which read Wikipedia database dumps (such as Google Earth) often ignore inline coordinates. To ensure that coordinates are seen by these tools, one set should be displayed in the title. See How do I get my Wikipedia article to show up in the Google Earth Geographic Web layer?. However, if multiple title coordinates appear on a single page, they will overlap, making them illegible.

Superseded templates

This single template supersedes {{coor d}}, (and others in that family which have since been redirected to it), plus the Geolinks and Mapit templates. Most parameters can be used as before – see Usage.

Examples:

{{coord|10.2|N|-20.3|E|type:city}}	Replaces {{coor d|10.2|N|-20.3|E|city}}
{{coord|44.4|-111.1|type:city_region:US|display=inline,title}}	Replaces {{Geolinks-US-cityscale|44.4|-111.1}}
{{coord|51.01234|-1.56789|type:landmark_region:GB|display=inline,title}}	Replaces {{Geolinks-UK-buildingscale|51.01234|-1.56789}}
{{coord|-35.5|150.1|type:landmark_region:AU|display=inline,title}}	Replaces {{Mapit-AUS-suburbscale|lat=-35.5|long=150.1}}
{{coord|12|34|12|N|45|33|45|W|display=title}}	Replaces {{CoorHeader|12|34|12|N|45|33|45|W}}

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 article title (replaces {{coor title dms}} family)
  • shortcut: display=t
• display=inline,title – Display the coordinate both inline and at title (replaces {{coor at dms}} family)
  • 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 article, 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.651234°N 79.383333°W / 43.651234; -79.383333	Toronto – Fully decimal – N & W
{{coord|43.65|-79.38}}	43.65°N 79.38°W / 43.65; -79.38	Toronto – less precise
{{coord|43.6500|-79.3800}}	43.6500°N 79.3800°W / 43.6500; -79.3800	Toronto – medium precision with trailing zeroes
{{coord|43.651234|N|79.383333|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	Toronto – degrees & minutes
{{coord|43|29|4|N|79|23|0|W}}	43°29′4″N 79°23′0″W	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	Toronto – degrees, minutes, seconds & fractions of seconds
{{coord|55.752222|N|37.615556|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	Convert to dms format
{{coord|39.098095|-94.587307|format=dms}}	39°05′53″N 94°35′14″W	Decimal conversion without N/S/E/W
{{coord|55.752222|N|37.615556|E|format=dec|name=Moscow}}	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	Cape Town – S & E
{{coord|35|00|N|105|00|E}}	35°00′N 105°00′E	People's Republic of China
{{coord|22|54|30|S|43|14|37|W}}	22°54′30″S 43°14′37″W	Rio – S & W
{{coord|22|S|43|W}}	22°S 43°W	A degree confluence.
{{coord|52|28|N|1|55|W|notes=<ref>{{cite web|url=http://www.fallingrain.com/world/UK/0/Birmingham.html|title=Birmingham}}</ref>|display=inline,title|region:GB_type:city}}	52°28′N 1°55′W[1]	Birmingham – with display, notes, and parameter settings; note display also in title of this page.

References

1. "Birmingham". 

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

{{Wikipedia:WikiProject Geographical coordinates/type:}}

scale:N

{{Wikipedia:WikiProject Geographical coordinates/scale:}}

dim:D

Template:Coord-doc-dim

region:R

{{Wikipedia:WikiProject Geographical coordinates/region:}}

globe:G

{{Wikipedia:WikiProject Geographical coordinates/globe:}}

Per-user display customization

To always display coordinates as DMS values, add this to your monobook.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 monobook.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 monobook.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 monobook.js

var wma_settings = {enabled:false}

Note that this will disable WikiMiniAtlas

See also Wikipedia:Manual of Style (dates and numbers)#Geographical coordinates.

Incorrect uses and maintenance category

The template has some input checks built in. Most errors display a bold, red message inline and categorize the article in the hidden maintenance category Coord template needing repair. There is/are currently 0 page(s) in that category. See the category description for further instructions.

A daily report of coordinates needing repair is at tools:~dispenser/view/File viewer#log:coord-enwiki.log.

See also: WT:GEO#To do

Internals

See Template:Coord/doc/internals and Category:Coord template.

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 article
{{Coord/display/title}}	displays coordinates above the article (generally to the right of the article'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/prec dec}}	selects a format for converting decimal degrees, based on the precision of the inputs

Coordinates in PDF

For generating PDF, printed books, and Open Office export format, two templates are substituted for the regular templates:

• Template:Coord/display/title/Print for {{Coord/display/title}}
• Template:Coord/link/Print for {{Coord/link}}
• Template:Coord/display/inline,title/Print for {{Coord/display/inline,title}}

Samples are available at:

• Help:Books/Feedback/Tests/coord 1
• Help:Books/Feedback/Tests/coord 2

Class names

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