Template:Coord/doc

From FamilySearch Wiki
Jump to navigation Jump to search

Purpose[edit source]

{{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. 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 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)
  • Geo microformat.

Logged-in users can customize how coordinates appear in their browsers.

Caveats[edit source]

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 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[edit source]

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

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 near the article title
  • display=inline,title – Display the coordinate both inline and at title
  • 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.
  • format=text display text instead of the coordinates using pre-link-text, link-text, and post-link-text 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.
The following are only used when format=text and for overriding the defaults. They allow specifying the text to be displayed in place of just the coordinates. Spaces at the beginning or end of the string requires a ' ' instead of a plain space.:
  • pre-link-text= The default is no text.
  • link-text= The default is 'Click here'
  • post-link-text= The default is ' to view information about this location'.

Examples[edit source]

{{coord|43.651234|-79.383333}} 43°39′04″N 79°23′00″W / 43.651234°N 79.383333°W / 43.651234; -79.383333 Toronto – Fully decimal – N & W
{{coord|43.65|-79.38}} 43°39′N 79°23′W / 43.65°N 79.38°W / 43.65; -79.38 Toronto – less precise
{{coord|43.6500|-79.3800}} 43°39′00″N 79°22′48″W / 43.6500°N 79.3800°W / 43.6500; -79.3800 Toronto – medium precision with trailing zeroes
{{coord|43.651234|N|79.383333|W}} 43°39′04″N 79°23′00″W / 43.651234°N 79.383333°W / 43.651234; -79.383333 Toronto – decimal with Northing & Westing
{{coord|43|29|N|79|23|W}} 43°29′N 79°23′W / 43.483°N 79.383°W / 43.483; -79.383 Toronto – degrees & minutes
{{coord|43|29|4|N|79|23|0|W}} 43°29′4″N 79°23′0″W / 43.48444°N 79.383333°W / 43.48444; -79.383333 Toronto – degrees, minutes & seconds
{{coord|43|29|4.5|N|79|23|0.5|W}} 43°29′4.5″N 79°23′0.5″W / 43.484583°N 79.383472°W / 43.484583; -79.383472 Toronto – degrees, minutes, seconds & fractions of seconds
{{coord|55.752222|N|37.615556|E}} 55°45′08″N 37°36′56″E / 55.752222°N 37.615556°E / 55.752222; 37.615556 Moscow – N & E
{{coord|55.752222|N|37.615556|E|format=dms}} 55°45′08″N 37°36′56″E / 55.752222°N 37.615556°E / 55.752222; 37.615556 Convert to dms format
{{coord|39.098095|-94.587307|format=dms}} 39°05′53″N 94°35′14″W / 39.098095°N 94.587307°W / 39.098095; -94.587307 Decimal conversion without N/S/E/W
{{coord|55.752222|N|37.615556|E|format=dec|name=Moscow}} 55°45′08″N 37°36′56″E / 55.752222°N 37.615556°E / 55.752222; 37.615556 (Moscow) Convert to decimal and label on some maps
{{coord|33|55|S|18|25|E}} 33°55′S 18°25′E / 33.917°S 18.417°E / -33.917; 18.417 Cape Town – S & E
{{coord|35|00|N|105|00|E}} 35°00′N 105°00′E / 35°N 105°E / 35; 105 People's Republic of China
{{coord|22|54|30|S|43|14|37|W}} 22°54′30″S 43°14′37″W / 22.90833°S 43.24361°W / -22.90833; -43.24361 Rio – S & W
{{coord|22|S|43|W}} 22°S 43°W / 22°S 43°W / -22; -43 A degree confluence.
{{coord|22|54|30|S|43|14|37|W|format=text}} Click here to view information about this location Rio – S & W in a text format instead of a coordinate format.
{{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}} 52°28′N 1°55′W / 52.467°N 1.917°W / 52.467; -1.917[1]Coordinates: 52°28′N 1°55′W / 52.467°N 1.917°W / 52.467; -1.917[1] Birmingham – with display, notes, and parameter settings; note display also in title of this page. NOT FULLY IMPLEMENTED. Was second to last example.

References[edit source]

Coordinate parameters[edit source]

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[edit source]

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

scale:N[edit source]

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

dim:D[edit source]

Coord-doc-dim

region:R[edit source]

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

globe:G[edit source]

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

source:S[edit source]

Coord-doc-source

Per-user display customization[edit source]

UF-coord-classes

Incorrect uses and maintenance category[edit source]

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 0 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[edit source]

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

Subtemplates[edit source]

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[edit source]

For generating PDF, printed books, and Open Office export format, two templates are substituted for the regular templates:

Samples are available at:

Class names[edit source]

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