View source for Template:Inline coordinates/doc

__TOC__

==Purpose==
{{Tld|Inline coordinates}} provides a standard notation for encoding locations by their [[:en:latitude|latitude]] and [[:en:longitude|longitude]] coordinates. It is primarily for specifying the [[:en:World Geodetic System|WGS84]] geographic coordinates of locations on [[:en:Earth|Earth]].  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 <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. Use {{tl|location}} for other work.

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]].



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

There are two kinds of parameters, all optional:

*<span id="1">'''Coordinate parameters'''</span> are parameters that {{Tld|Inline coordinates}} 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 {{Tld|Inline coordinates}} template.  These have format ''parameter=value'' and are separated from each other by the pipe character ( | ). The supported template parameters are  ''format='', ''name='', and ''notes=''.
:* '''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 {{Tld|Inline coordinates}} 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>{{Inline coordinates|43.651234|-79.383333}}</nowiki></code>
| {{Inline coordinates|43.651234|-79.383333}}
| Toronto – Fully decimal – N & W
|-
| <code><nowiki>{{Inline coordinates|43.65|-79.38}}</nowiki></code>
| {{Inline coordinates|43.65|-79.38}}
| Toronto – less precise
|-
| <code><nowiki>{{Inline coordinates|43.6500|-79.3800}}</nowiki></code>
| {{Inline coordinates|43.6500|-79.3800}}
| Toronto – medium precision with trailing zeroes
|-
| <code><nowiki>{{Inline coordinates|43.651234|N|79.383333|W}}</nowiki></code>
| {{Inline coordinates|43.651234|N|79.383333|W}}
| Toronto – decimal with Northing & Westing
|-
| <code><nowiki>{{Inline coordinates|43|29|N|79|23|W}}</nowiki></code>
| {{Inline coordinates|43|29|N|79|23|W}}
| Toronto – degrees & minutes
|-
| <code><nowiki>{{Inline coordinates|43|29|4|N|79|23|0|W}}</nowiki></code>
| {{Inline coordinates|43|29|4|N|79|23|0|W}}
| Toronto – degrees, minutes & seconds
|-
| <code><nowiki>{{Inline coordinates|43|29|4.5|N|79|23|0.5|W}}</nowiki></code>
| {{Inline coordinates|43|29|4.5|N|79|23|0.5|W}}
| Toronto – degrees, minutes, seconds & fractions of seconds
|-
| <code><nowiki>{{Inline coordinates|55.752222|N|37.615556|E}}</nowiki></code>
| {{Inline coordinates|55.752222|N|37.615556|E}}
| Moscow – N & E
|-
| <code><nowiki>{{Inline coordinates|55.752222|N|37.615556|E|format=dms}}</nowiki></code>
| {{Inline coordinates|55.752222|N|37.615556|E|format=dms}}
| Convert to dms format
|-
| <code><nowiki>{{Inline coordinates|39.098095|-94.587307|format=dms}}</nowiki></code>
| {{Inline coordinates|39.098095|-94.587307|format=dms}}
| Decimal conversion without N/S/E/W
|-
| <code><nowiki>{{Inline coordinates|55.752222|N|37.615556|E|format=dec|name=Moscow}}</nowiki></code>
| {{Inline coordinates|55.752222|N|37.615556|E|format=dec|name=Moscow}}
| Convert to decimal and label on some maps
|-
| <code><nowiki>{{Inline coordinates|33|55|S|18|25|E}}</nowiki></code>
| {{Inline coordinates|33|55|S|18|25|E}}
| Cape Town – S & E
|-
| <code><nowiki>{{Inline coordinates|35|00|N|105|00|E}}</nowiki></code>
| {{Inline coordinates|35|00|N|105|00|E}}
| People's Republic of China
|-
| <code><nowiki>{{Inline coordinates|22|54|30|S|43|14|37|W}}</nowiki></code>
| {{Inline coordinates|22|54|30|S|43|14|37|W}}
| Rio – S & W
|-
| <code><nowiki>{{Inline coordinates|22|S|43|W}}</nowiki></code>
| {{Inline coordinates|22|S|43|W}}
| A [[Degree Confluence Project|degree confluence]].
|}

===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'' =====

{{:eWikipedia: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:}}

===== source:''S'' =====

{{Coord-doc-source}}

==Per-user display customization==

{{UF-coord-classes}}

==Incorrect uses and maintenance category==
The template has some input checks built in.  Most errors display a <font color=red><b>bold, red</b></font> 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]].

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