Difference between revisions of "Module:Coordinates/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Jonesey95
(add info about coordinsert and coord2text (rough draft))
Line 4: Line 4:
  
 
'''Note:''' The code which this module's main function (<code>coord</code>) outputs is directly parsed and/or manipulated by [[Module:Location map]] and other functions of this module itself (<code>coord2text</code> and <code>coordinsert</code>). If the structure of the output changes (for example, to use [[:mw:Help:Extension:Kartographer|the <code><nowiki><mapframe></nowiki></code> and <code><nowiki><maplink></nowiki></code> tags]]), please update the aforementioned scripts as well.
 
'''Note:''' The code which this module's main function (<code>coord</code>) outputs is directly parsed and/or manipulated by [[Module:Location map]] and other functions of this module itself (<code>coord2text</code> and <code>coordinsert</code>). If the structure of the output changes (for example, to use [[:mw:Help:Extension:Kartographer|the <code><nowiki><mapframe></nowiki></code> and <code><nowiki><maplink></nowiki></code> tags]]), please update the aforementioned scripts as well.
 +
 +
==Using the module with coordinsert==
 +
When using the {{tl|Coord}} template inside another template, like an infobox, there may be parameters (like <code><var>type</var>:<var>airport</var></code>) which should be added automatically. To do so, do something like this:
 +
<code>&#123;&#123;#if:&#123;&#123;&#123;coordinates&#124;&#125;&#125;&#125;&#124;&#123;&#123;#invoke:Coordinates&#124;coordinsert&#124;&#123;&#123;&#123;coordinates&#124;&#125;&#125;&#125;&#124;<var>parameter1:value1&#124;parameter2:value2&#124;parameter3:value3…</var>&#125;&#125;&#124;</code>
 +
 +
Do not add more vertical bars <code>&#124;</code> than necessary.
 +
 +
==Using the module with coord2text==
 +
The module's "coord2text" function can be used to extract data from the {{tl|Coord}} template. For example, to extract the latitude from a Coord template, use:
 +
 +
<code><nowiki>{{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|lat}}</nowiki></code> &rarr; {{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|lat}}
 +
 +
To extract the longitude, use:
 +
 +
<code><nowiki>{{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|long}}</nowiki></code> &rarr; {{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|long}}
 +
 +
This can be useful if you want to use the latitude or longitude in a mathematical expression.
 +
  
 
== Modules using this module directly ==
 
== Modules using this module directly ==

Revision as of 22:05, 25 January 2017

  1. REDIRECT Template:High-use

Template:Uses Wikidata Template:Tracks Wikidata

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

The module's "coord2text" function can be used to extract data from the {{Coord}} template. For example, to extract the latitude from a Coord template, use:

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

To extract the longitude, use:

{{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|long}}Lua error in mw.text.lua at line 219: bad argument #1 to 'len' (string expected, got nil).

This can be useful if you want to use the latitude or longitude in a mathematical expression.


Modules using this module directly

Tracking categories