Template:Coord/doc

Purpose
Coord provides a standard notation for encoding locations by their and  coordinates. It is primarily for specifying the geographic coordinates of locations on. However, it can also encode locations on natural satellites, dwarf planets, and planets other than Earth. GeoHack. GeoHack displays information customized to the location, including links to external mapping services. By default, coordinates appear "in line" with the adjacent text. However, the  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)

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

Usage
&#123;{coord|latitude|longitude|coordinate parameters|template parameters}&#125; &#123;{coord|dd|N/S|dd|E/W|coordinate parameters|template parameters}&#125; &#123;{coord|dd|mm|N/S|dd|mm|E/W|coordinate parameters|template parameters}&#125; &#123;{coord|dd|mm|ss|N/S|dd|mm|ss|E/W|coordinate parameters|template parameters}&#125;

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 the coordinate inline (default)
 * – Display the coordinate near the article title
 * – Display the coordinate both inline and at title
 * has the same effect as
 * Note: the  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.
 * reformats the coordinates to decimal degrees format.
 * reformats the coordinates to degrees | minutes | seconds format.
 * display text instead of the coordinates using,  , and   parameters.
 * 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.
 * pre-link-text= specifies text to be displayed in place of the coordinates. This is only used when display is set to text and for overriding the default. The default is no text.
 * link-text= specifies text to be displayed in place of the coordinates. This is only used when display is set to text and for overriding the default. The default is 'Click here'
 * post-link-text= specifies text to be displayed in place of the coordinates. This is only used when display is set to text and for overriding the default. The default is ' to view information about this location'.

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.

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  page(s) in that category. See the category description for further instructions.

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

See also: WT:GEO

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

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.