Module:Coordinates/doc

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

Careful, this function is live, and called by {{Location}} template. The documentation might not be complete

This module provides most of the logic behind {{Location}} and related geolocation templates. It provides several methods visible to the templates:

• {{#Invoke:Coordinates | parseAttribute| attribute string | attribute name }} : parse {{Location}} attribute parameter attribute string and return value of the attribute name parameter

• {{#Invoke:Coordinates | getHeader| attribute string }} : parse {{Location}} attribute parameter attribute string and return the numeric value of the header attribute.

• {{#Invoke:Coordinates | GeoHack_link| lat=... | lon=... |lang=xx | site=... | globe=... }}: creates link to GeoHack tool and display location coordinates. The URLs are based on website and latitude/longitude coordinates. Language is used so it can be passes to the website. Globe parameter is used to allow specifying coordinates on planets other than earth.

• {{#Invoke:Coordinates | lat_lon| lat=... | lon=... |lang=xx }}: create coordinate location string based on decimal degrees latitude and longitude number. Language is used to localize the presentation of the numbers.

• {{#Invoke:Coordinates | deg2dms| degrees|lang=xx }}: create dms (degree/minute/second) string based on decimal degrees number. Language is used to localize the presentation of the numbers.

• {{#Invoke:Coordinates | externalLink| site=... | globe=... | lat=... | lon=... |lang=xx }}: create URLs for different sites which are used by coordinate location templates. The URLs are based on website and latitude/longitude coordinates. Language is used so it can be passes to the website. Globe parameter is used to allow specifying coordinates on planets other than earth.

Examples

Functions:

• deg2dms(degree, degree_precision, language)

• {{#invoke:Coordinates| deg2dms | 12.3456789}} will display "12° 20′ 44.44″"
• {{#invoke:Coordinates| deg2dms | 12.3456789 |1}} will display "12°"
• {{#invoke:Coordinates| deg2dms | 12.3456789 |1e-1}} will display "12° 21′"
• {{#invoke:Coordinates| deg2dms | 12.3456789 |1e-3}} will display "12° 20′ 44″"
• {{#invoke:Coordinates| deg2dms | 12.3456789 |1e-4}} will display "12° 20′ 44.4″"
• {{#invoke:Coordinates| deg2dms | 12.3456789 |1e-5}} will display "12° 20′ 44.44″"

• lat_lon

• {{#invoke:Coordinates| lat_lon | lat=51.48 | lon=0}} will display "51° 28′ 48″ N, 0° 00′ 00″ E"

• GeoHack_link

• {{#invoke:Coordinates| GeoHack_link | lat=51.48123 | lon=0}} will display 51° 28′ 52.43″ N, 0° 00′ 00″ E
• {{#invoke:Coordinates| GeoHack_link | lat=51.48123 | lon=0 | lang=en }} will display 51° 28′ 52.43″ N, 0° 00′ 00″ E
• {{#invoke:Coordinates| GeoHack_link | lat=51.48123 | lon=0 | lang=ru }} will display 51° 28′ 52,43″ с. ш., 0° 00′ 00″ в. д.
• {{#invoke:Coordinates| GeoHack_link | lat= | lon=0 | lang=ru }} (with missing latitude value) will display "latitude, longitude"

• externalLinksSection

  {{#invoke:Coordinates| externalLinksSection | globe = Earth| lat=51.48 | lon=0 | lang=en | namespace=File}} displays "OpenStreetMap"

• {{#invoke:Coordinates| externalLinksSection | globe = Earth| lat=51.48 | lon=0 | lang=en | namespace=Category}} displays "OpenStreetMap"
• {{#invoke:Coordinates| externalLinksSection | globe = Earth| lat=51.48 | lon=0 | lang=ru | namespace=Category}} displays "OpenStreetMap"
• {{#invoke:Coordinates| externalLinksSection | globe = Mars| lat=51.48 | lon=0 | lang=en | namespace=File}} displays "Google Maps"
• {{#invoke:Coordinates| externalLinksSection | globe = Moon| lat=51.48 | lon=0 | lang=en | namespace=File}} displays "Google Maps"

• LocationTemplateCore

• {{#invoke:Coordinates| LocationTemplateCore | globe = Earth| lat=51.48 | lon=0 | lang=en | namespace=File| attributes=elevation:10_heading:W | mode=camera | bare = 1| secondary=1}} displays:

51° 28′ 48″ N, 0° 00′ 00″ E

View all coordinates using: OpenStreetMap

• {{#invoke:Coordinates| LocationTemplateCore | globe = Earth| lat=51.48 | lon=0 | lang=en | namespace=File| attributes=elevation:10_heading:W | mode=camera | bare = 0| secondary=1}} displays:

Camera location	51° 28′ 48″ N, 0° 00′ 00″ E	View all coordinates using: OpenStreetMap

See testcases to see more examples.

Dependencies

Relies on Module:I18n/coordinates for all of the internationalization translations.