Template:Coord/doc

When this template is used with display=title, the template is not displayed on mobile. This template is still displayed on mobile when used with display=inline, e.g. in infoboxes.<!--

Purpose
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.
 * If the coordinates were transcluded from Wikidata, use WikidataCoord.

See also: 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  parameter can be used to force display in a particular format. The template also accepts and displays coordinates formatted as degrees and decimal minutes as found on charts and maritime references.

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  parameter can be used to move the coordinates up near the page title (in desktop view only; title coordinates do not display in mobile view)—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.

Additional features
 * Logged-in users can customize how coordinates appear in their browsers.
 * You can get coordinates from Wikidata by transcluding this template without any numbered arguments.
 * You can extract information from the Coord template for use in mathematical expressions. For details, see Module:Coordinates.
 * All coordinates used in a page through this template are registered in the geosearch API. If a coordinate is using title display, then these coordinates will be marked as the primary coordinates with regards to the page and therefore the topic of that page.

Caveats
The template must not be modified without prior discussion. External tools can depend on the format of both the wikitext and/or the generated html.

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;

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 the coordinate inline (default)
 * – Display the coordinate at the top of the article, beside the article's title (replaces coor title dms family; coordinates are displayed in desktop view only; title coordinates do not display in mobile view)
 * shortcut:
 * – Display the coordinate both inline and beside the article's title (replaces coor at dms family)
 * shortcut:
 * 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. Additionally the title option will mark the coordinates as the primary coordinates for the page (and topic of the page) in the geosearch API.
 * 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.
 * 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.
 * qid= specify Q item to display the coordinates of. Used primarily by Wikidata powered infoboxes.

Helper functions
Helper functions are available to manipulate the output from Coord when it appears in a container template such as an infobox.

To extract the latitude from a Coord template
Use:

→

and similarly to extract the longitude, use:

→


 * Note: this method removes the microformat markup, and should not be used inside templates which emit parent microformats, such as infoboxes or table-row templates.

Displaying all coordinate links on one map
The template GeoGroup can be used in an article with coordinates. This template creates links to mapping services 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.

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.

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

GeoHack uses  to select a map scale such that the viewing circle appears roughly 10 cm in diameter on a 72 dpi computer monitor. If no,  , or   parameters are provided, GeoHack uses its default viewing circle of 30 km.

Incorrect uses and maintenance categories
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 in that category. See the category description for further instructions.

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

See also: WT:GEO

Internals
This template is completely powered by the Lua.

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

History
This template used to use a lot of sub templates but these have all been replaced by.

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 meantime, consider using coordDec for signed decimal degrees, coordDMS when degrees minutes and seconds are specified, and coordDM when just degrees and minutes are given.

{	"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 for signed decimal degrees,  when degrees minutes and seconds are specified  when only degrees and minutes are specified. To use this template you will need to use positional parameter following one of these schemes: °N, °W, °N, °W, °N, °W °N, °W 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": "number", "required": false, "suggested": true },		"2": {			"label": "2", "description": "Either: minutes latitude, signed decimal degrees longitude or 'N' or 'S'.", "type": "string", "required": false, "suggested": 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 },		"qid": { "label": "Wikidata item", "description": "Retrieve coordinates from a WikiData entry instead of from this template's parameters", "type": "line", "required": false, "example": "Q513" },		"display": { "label": "Display", "description": "Where it is displayed. Can be one of: 'inline' in the body of the article, 'title' at the top of the article or 'inline,title' both", "type": "line", "default": "inline", "suggested": true, "required": false, "suggestedvalues": [ "inline", "title", "inline,title" ]		},		"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": "line", "required": false, "suggestedvalues": [ "dec", "dms" ]		},		"nosave": { "label": "Geosearch", "description": "Set to 'true' if you want to avoid this coordinate to be registered in the geosearch API.", "type": "string", "required": false }	} }