Module:Coordinates/doc

This is a documentation subpage for Module:Coordinates.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 1,390,000 pages, or roughly 2% of all pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.

This module employs intricate features of the Lua scripting language whose syntax is different from that of templates.

It is recommended you first familiarise yourself with Lua by reading the reference manual and other resources before editing it.
You can conduct experiments, and should test all major changes, in either , your own user sandbox, or the general module sandbox which has a convenient template sandbox tool, before changing anything.

Note: The code which this module's main function (coord) outputs is directly parsed and/or manipulated by Module:Location map and other functions of this module itself (coord2text and coordinsert). If the structure of the output changes (for example, to use the <mapframe> and <maplink> tags), please update the aforementioned scripts as well.

Using the module with coordinsert

When using the {{Coord}} template inside another template, like an infobox, there may be parameters (like type:airport) which should be added automatically. To do so, do something like this:

{{#if:{{{coordinates|}}}|{{#invoke:Coordinates|coordinsert|{{{coordinates|}}}|parameter1:value1|parameter2:value2|parameter3:value3…}}|

Do not add more vertical bars | than necessary.

Using the module with coord2text to extract latitude or longitude

Developers maintaining legacy code may need to extract latitude or longitude to use a parameters in other code, or a mathematical expression. The module's "coord2text" function can be used to extract data from the {{Coord}} template. To extract the latitude from a Coord template, use:

{{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|lat}} → 57.30611

To extract the longitude, use:

{{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|long}} → 4.45889

Modules using this module directly

Module:HS listed building row

Tracking categories

Category:Pages with malformed coordinate tags (50)
Category:Coordinates not on Wikidata‎ (15,489)
Category:Coordinates on Wikidata‎ (1,221,795)
Category:Coordinates on Wikidata set to no value‎ (12)
Category:Coordinates on Wikidata set to unknown value‎ (49)