Template:Coord/doc

{{

 {{#invoke:Namespace detect|main}}

| type = | image = 42px | imageright = | class = | style = | textstyle = | text = This template uses Module:Coordinates, a script written in the Lua programming language. Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates. | small = | smallimage = | smallimageright = | smalltext = | subst = | date = | name = }}

Quick guide

Quick how to
coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed. to the top of an article, use {{Coord}}, thus: {{Coord|57|18|22|N|4|27|32|W|display=title}} These coordinates are in degrees, minutes, and seconds of arc. 'title' means that the coordinates will be displayed next to the title.
coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed. to the top of an article, 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 ("_"): dim: dim:N (viewing diameter in metres) region: region:R (ISO 3166-1 alpha-2 or ISO 3166-2 code) type: type:T (landmark or city(30,000), for example) Other optional parameters are separated by a pipe ("|"): display |display=inline (the default) to display in the body of the article only, |display=title to display at the top of the article 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 article, for the subject of the article, where appropriate.
Per WP:ORDER, the template is placed in articles after any navigation templates, but before any Persondata or Defaultsort templates, or Categories. For full details, refer to {{Coord/doc}}. Additional guidance is available: obtaining coordinates, converting coordinates

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.

• 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 (18px) 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.

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 beside 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 at the top of the article, beside the article's title (replaces {{coor title dms}} family)
  • shortcut: display=t
• display=inline,title – Display the coordinate both inline and beside the article's 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's 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 coordinates displayed beside the title.

Displaying all coordinate links on one map

The template {{GeoGroup}} can be used in an article with coordinates. This template creates links to Google Maps and Bing which display all the coordinates on a single map, and links to other services which allow the coordinates to be used or downloaded in a variety of formats.

Examples

{{coord|43.651234|-79.383333}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Toronto – Fully decimal – western hemisphere implied by negation
{{coord|43.65|-79.38}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Toronto – low precision decimal
{{coord|43.6500|-79.3800}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Toronto – medium precision decimal with trailing zeroes
{{coord|43.651234|N|79.383333|W}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Toronto – high precision decimal with explicit hemisphere notation
{{coord|43|29|N|79|23|W}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Toronto – degrees & minutes
{{coord|43|29|4|N|79|23|0|W}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Toronto – degrees, minutes & seconds
{{coord|43|29|4.5|N|79|23|0.5|W}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Toronto – degrees, minutes, seconds & fractions of seconds
{{coord|55.752222|N|37.615556|E}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Moscow – N & E
{{coord|55.752222|N|37.615556|E|format=dms}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Convert to dms format
{{coord|39.098095|-94.587307|format=dms}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Decimal conversion without N/S/E/W
{{coord|55.752222|N|37.615556|E|format=dec|name=Moscow}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Convert to decimal and label on some maps
{{coord|33|55|S|18|25|E}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Cape Town – S & E
{{coord|35|00|N|105|00|E}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	People's Republic of China
{{coord|22|54|30|S|43|14|37|W}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Rio – S & W
{{coord|22|S|43|W}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	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}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.	Birmingham – with display, notes, and parameter settings; note that these coordinates are also displayed at the top of this page.

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

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

GeoHack uses dim: to select a map scale such that the viewing circle appears roughly 10 centimetres ({{#invoke:Math|precision_format| 3.9370078740157 | 0}} 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 kilometres (Template:Hid{{#invoke:Math|precision_format| 18.64113576712 | 1-1 }} mi).

Samples

Subject	View diameter	Markup	Result
Western Hemisphere	10,000 kilometres (Template:Hid{{#invoke:Math|precision_format| 6,213.7119223733 | 1-3 }} mi)	{{coord|0|N|90|W|dim:10000km}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.
Ohio	400 kilometres (Template:Hid{{#invoke:Math|precision_format| 248.54847689493 | 1-2 }} mi)	{{coord|40.5|-82.5|dim:400km}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.
Dresden	20,000 metres (Template:Hid{{#invoke:Math|precision_format| 12.427423844747 | 1-1 }} mi)	{{coord|51.033|13.73|dim:20000}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.
Statue of Liberty	100 metres (Template:Hid{{#invoke:Math|precision_format| 328.08398950131 | 1-2 }} ft)	{{coord|40.6892|-74.0445|dim:100}}	coord}} Fatal error: The format of the coordinate could not be determined. Parsing failed.

region:R

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

globe:G

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

source:S

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

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

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

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 Pages with malformed coordinate tags. There are currently 0 pages in that category. See the category description for further instructions.

A more thorough daily report of coordinates needing repair is at tools:~dispenser/view/File viewer.

See also: WT:GEO

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.

Template Data

This template uses overloading which does not work well with the VisualEditor/TemplateData. Consider using "Edit source" instead of the visual editor until this defect is corrected. To facilitate visual editing in the mean time, consider using {{coordDec}} for signed decimal degrees, {{coordDMS}} when degrees minutes and seconds are specified, and {{coordDM}} when just degrees and minutes are given.

This is the TemplateData documentation for the template used by the new VisualEditor.

Coord <templatedata>{

"description": "Encodes the latitude and longitude coordinates of a location, provides a link to map of the location. This template does not work well with the Visual Editor, consider using {{#invoke:coordinates|coord|||{{#invoke:join|join|_||||||}}| format=| display= | name= }}

Fatal error: The format of the coordinate could not be determined. Parsing failed.

for signed decimal degrees, {{#invoke:coordinates|coord|||||||||{{#invoke:join|join|_||||||}}| format=| display= | name= }}

Fatal error: The format of the coordinate could not be determined. Parsing failed.

when degrees minutes and seconds are specified {{#invoke:coordinates|coord|||||||{{#invoke:join|join|_||||||}}| format=| display= | name= }}

Fatal error: The format of the coordinate could not be determined. Parsing failed.

when only degrees and minutes are specified. To use this template you will need to use positional parameter following one of these schemes: {{#invoke:Coordinates|coord}}

Fatal error: The format of the coordinate could not be determined. Parsing failed.

, {{#invoke:Coordinates|coord}}

Fatal error: The format of the coordinate could not be determined. Parsing failed.

, {{#invoke:Coordinates|coord}}

Fatal error: The format of the coordinate could not be determined. Parsing failed.

{{#invoke:Coordinates|coord}}

Fatal error: The format of the coordinate could not be determined. Parsing failed.

where D is degrees, M is minutes, S seconds, sD signed decimal degrees, NS is N or S, EW is E or W, opts are named parameter and geo are the coordinate parameters described on the main doc page.",

"params": {

       "1": {
           "label": "1",
           "description": "Either degrees latitude or a signed decimal degrees latitude",
           "type": "string",
           "required": true
       },
       "2": {
           "label": "2",
           "description": "Either: minutes latitude, signed decimal degrees longitude or 'N' or 'S'.",
           "type": "string",
           "required": true
       },
       "3": {
           "label": "3",
           "description": "Either: second latitude, degrees longitude, 'N' or 'S' or GeoHack parameters",
           "type": "string",
           "required": false
       },
       "4": {
           "label": "4",
           "description": "Either: degrees longitude, 'N', 'S', 'E' or 'W' or GeoHack parameters",
           "type": "string",
           "required": false
       },
       "5": {
           "label": "5",
           "description": "Either: degrees longitude, minutes longitude or GeoHack parameters",
           "type": "string",
           "required": false
       },
       "6": {
           "label": "6",
           "description": "Either: minutes longitude, 'E' or 'W' or GeoHack parameters",
           "type": "string",
           "required": false
       },
       "7": {
           "label": "7",
           "description": "Either second longitude, or GeoHack parameters",
           "type": "string",
           "required": false
       },
       "8": {
           "label": "8",
           "description": "'E' or 'W'.",
           "type": "string",
           "required": false
       },
       "9": {
           "label": "9",
           "description": "GeoHack parameters. Example: dim:30_region:US-WI_type:event",
           "type": "string",
           "required": false
       },
 "display": {
   "label": "Display",
   "description": "Where it is displayed. Can be one of: 'inline' in the body of the article (default), 'title' at the top of the article or 'inline,title' both",
   "type": "string",  
   "required": false
 },
 "name": {
   "label": "Name",
   "description": "a label to place on maps (default is PAGENAME)",
   "type": "string",  
   "required": false
 },
 "notes": {
   "label": "Notes",
   "description": "text displayed immediately following the coordinates",
   "type": "string",  
   "required": false
 },
 "format": {
   "label": "Format",
   "description": "How the coordinates are displayed, either 'dec' or 'dms'",
   "type": "string",  
   "required": false
 }

}}</templatedata>