View source for Template:Coord/doc

{{documentation subpage}} 

==Quick guide==
<!-- 
{{coord how-to}} -->

__TOC__

==Purpose==
{{Tld|Coord}} provides a standard notation for encoding locations by their [[latitude]] and [[longitude]] coordinates. It is primarily for specifying the [[World Geodetic System|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 {{tl|sky}} instead.
* Tag articles which lack coordinates (but need them) with {{tl|coord missing}}.
* If the subject's location is truly unknown or disputed, note this with {{tl|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 <code>format=</code> parameter can be used to force display in a particular format. 

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

For [[terrestrial]] locations, a blue globe ([[Image:Erioll_world.svg|18px]]) appears to the left of the hyperlink.  Clicking on the globe activates the [[:meta:WikiMiniAtlas|WikiMiniAtlas]] (requires [[JavaScript]]).

By default, coordinates appear "in line" with the adjacent text.  However, the <code>display=</code> 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)|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 [http://earth.google.com/userguide/v4/geoweb_faq.html 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 {{tl|coor d}}, (and others in that family which have since been redirected to it), plus the [{{fullurl:Special:PrefixIndex|from=Geolinks&namespace=10}} Geolinks] and [{{fullurl:Special:PrefixIndex|from=Mapit&namespace=10}} Mapit] templates. Most parameters can be used as before – see [[#Usage|Usage]].

Examples:
<table class="wikitable">
<tr><td>&#123;{coord|10.2|N|-20.3|E|'''type:'''city}&#125;</td><td>Replaces &#123;{coor d|10.2|N|-20.3|E|city}&#125;</td></tr>

<tr><td>&#123;{coord|44.4|-111.1|'''type:city_region:US'''|display=inline,title}&#125;</td><td>Replaces &#123;{Geolinks-'''US-cityscale'''|44.4|-111.1}&#125;</td></tr>

<tr><td>&#123;{coord|51.01234|-1.56789|'''type:landmark_region:GB'''|display=inline,title}&#125;</td><td>Replaces &#123;{Geolinks-'''UK-buildingscale'''|51.01234|-1.56789}&#125;</td></tr>

<tr><td>&#123;{coord|-35.5|150.1|'''type:landmark_region:AU'''|display=inline,title}&#125;</td><td>Replaces &#123;{Mapit-'''AUS-suburbscale'''|lat=-35.5|long=150.1}&#125;</td></tr>

<tr><td>&#123;{coord|12|34|12|N|45|33|45|W|'''display=title'''}&#125;</td><td>Replaces &#123;{'''CoorHeader'''|12|34|12|N|45|33|45|W}&#125;</td></tr>

</table>

== Usage ==
 '''&#123;{coord|'''''latitude'''''|'''''longitude'''''|'''''[[#1|coordinate parameters]]'''''|'''''[[#2|template parameters]]'''''}&#125;'''
 '''&#123;{coord|'''''dd'''''|'''''N/S'''''|'''''dd'''''|'''''E/W'''''|'''''[[#1|coordinate parameters]]'''''|'''''[[#2|template parameters]]'''''}&#125;'''
 '''&#123;{coord|'''''dd'''''|'''''mm'''''|'''''N/S'''''|'''''dd'''''|'''''mm'''''|'''''E/W'''''|'''''[[#1|coordinate parameters]]'''''|'''''[[#2|template parameters]]'''''}&#125;'''
 '''&#123;{coord|'''''dd'''''|'''''mm'''''|'''''ss'''''|'''''N/S'''''|'''''dd'''''|'''''mm'''''|'''''ss'''''|'''''E/W'''''|'''''[[#1|coordinate parameters]]'''''|'''''[[#2|template parameters]]'''''}&#125;'''

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

There are two kinds of parameters, all optional:

*<span id="1">'''Coordinate parameters'''</span> are parameters that {{tl|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|coordinate parameters]] for details and examples.

*<span id="2">'''Template parameters'''</span> are parameters used by the {{tl|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:
::* <code>display=inline</code> – Display the coordinate inline (default)
::* <code>display=title</code> – Display the coordinate near the article title (replaces {{tl|coor title dms}} family)
::** shortcut: <code>display=t</code>
::* <code>display=inline,title</code> – Display the coordinate both inline and at title (replaces {{tl|coor at dms}} family)
::** shortcut: <code>display=it</code>
::* <code>display=title,inline</code> has the same effect as <code>display=inline,title</code>
::Note: the <code>title</code> attribute indicates that the coordinates apply to the entire article, and not just one of (perhaps many) places mentioned in it &mdash; so it should only be omitted in the latter case. 
:* '''format=''' can be used to force ''dec'' or ''dms'' coordinate display.
::* <code>format=dec</code> reformats the coordinates to <span style="text-decoration:underline;">decimal degrees</span> format.
::* <code>format=dms</code> reformats the coordinates to <span style="text-decoration:underline;">degrees | minutes | seconds</span> format.
:* '''name=''' can be used to annotate inline coordinates for display in map services such as the [[:meta:WikiMiniAtlas|WikiMiniAtlas]]. If omitted, the article title (PAGENAME) is assumed.
::Note: a ''name='' parameter causes {{tl|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 ==
{| class="wikitable"
| <code><nowiki>{{coord|43.651234|-79.383333}}</nowiki></code>
| {{coord|43.651234|-79.383333}}
| Toronto – Fully decimal – N & W
|-
| <code><nowiki>{{coord|43.65|-79.38}}</nowiki></code>
| {{coord|43.65|-79.38}}
| Toronto – less precise
|-
| <code><nowiki>{{coord|43.6500|-79.3800}}</nowiki></code>
| {{coord|43.6500|-79.3800}}
| Toronto – medium precision with trailing zeroes
|-
| <code><nowiki>{{coord|43.651234|N|79.383333|W}}</nowiki></code>
| {{coord|43.651234|N|79.383333|W}}
| Toronto – decimal with Northing & Westing
|-
| <code><nowiki>{{coord|43|29|N|79|23|W}}</nowiki></code>
| {{coord|43|29|N|79|23|W}}
| Toronto – degrees & minutes
|-
| <code><nowiki>{{coord|43|29|4|N|79|23|0|W}}</nowiki></code>
| {{coord|43|29|4|N|79|23|0|W}}
| Toronto – degrees, minutes & seconds
|-
| <code><nowiki>{{coord|43|29|4.5|N|79|23|0.5|W}}</nowiki></code>
| {{coord|43|29|4.5|N|79|23|0.5|W}}
| Toronto – degrees, minutes, seconds & fractions of seconds
|-
| <code><nowiki>{{coord|55.752222|N|37.615556|E}}</nowiki></code>
| {{coord|55.752222|N|37.615556|E}}
| Moscow – N & E
|-
| <code><nowiki>{{coord|55.752222|N|37.615556|E|format=dms}}</nowiki></code>
| {{coord|55.752222|N|37.615556|E|format=dms}}
| Convert to dms format
|-
| <code><nowiki>{{coord|39.098095|-94.587307|format=dms}}</nowiki></code>
| {{coord|39.098095|-94.587307|format=dms}}
| Decimal conversion without N/S/E/W
|-
| <code><nowiki>{{coord|55.752222|N|37.615556|E|format=dec|name=Moscow}}</nowiki></code>
| {{coord|55.752222|N|37.615556|E|format=dec|name=Moscow}}
| Convert to decimal and label on some maps
|-
| <code><nowiki>{{coord|33|55|S|18|25|E}}</nowiki></code>
| {{coord|33|55|S|18|25|E}}
| Cape Town – S & E
|-
| <code><nowiki>{{coord|35|00|N|105|00|E}}</nowiki></code>
| {{coord|35|00|N|105|00|E}}
| People's Republic of China
|-
| <code><nowiki>{{coord|22|54|30|S|43|14|37|W}}</nowiki></code>
| {{coord|22|54|30|S|43|14|37|W}}
| Rio – S & W
|-
| <code><nowiki>{{coord|22|S|43|W}}</nowiki></code>
| {{coord|22|S|43|W}}
| A [[Degree Confluence Project|degree confluence]].
|-
| <code><nowiki>{{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}}</nowiki></code>
| {{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}}
| Birmingham – with display, notes, and parameter settings; note display also in title of this page.
|}

===References===
{{reflist}}

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

===== type:''T'' =====

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

===== scale:''N'' =====

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

===== dim:''D'' =====

{{Coord-doc-dim}}

===== region:''R'' =====

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

===== globe:''G'' =====

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


==Per-user display customization==

{{UF-coord-classes}}

==Incorrect uses and maintenance category==
The template has some input checks built in.  Most errors display a <span style+"color:red;"><b>bold, red</b></span> message inline and categorize the article in the [[Wikipedia:Hidden category|hidden]] [[Wikipedia:Categorization#Non-article and maintenance categories|maintenance category]] '''[[:Category:Coord template needing repair|Coord template needing repair]]'''. There is/are currently '''{{PAGESINCATEGORY:Coord_template_needing_repair}}''' 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===
{{Coord/sub doc}}

===Coordinates in PDF===
For generating PDF, printed books, and Open Office export format, two templates are [[Help:Books/for_experts#Improving_the_book_layout|substituted for the regular templates]]:
*[[Template:Coord/display/title/Print]] for {{tl|Coord/display/title}}
*[[Template:Coord/link/Print]] for {{tl|Coord/link}}
*[[Template:Coord/display/inline,title/Print]] for {{tl|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.

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->

[[Category:Coord template]]
[[Category:Coordinates templates]]
[[Category:Templates generating Geo]]
[[Category:Title templates]]