Revision as of 07:30, 7 May 2019 view sourceJonesey95 (talk | contribs)Autopatrolled, Extended confirmed users, Page movers, Mass message senders, Template editors375,767 edits Limit error checking to main (article) space← Previous edit | Revision as of 07:48, 5 July 2019 view source Johnuniq (talk | contribs)Autopatrolled, Administrators86,664 edits update from sandbox per Template talk:Coord#Support for qid: do not require current page to have an entity so qid=Qxxx will work on any page; the only pages in the category are due to mw:Extension:GeoData which cannot be controlled by the moduleNext edit → | ||
Line 34: | Line 34: | ||
--] | --] | ||
local function displayinline(s, notes) | local function displayinline(s, notes) | ||
return s .. notes |
return s .. notes | ||
end | end | ||
Line 79: | Line 79: | ||
Usually geo-nondefault is hidden by CSS, unless a user has overridden this for himself | Usually geo-nondefault is hidden by CSS, unless a user has overridden this for himself | ||
default is the mode as specificied by the user when calling the {{coord}} template | default is the mode as specificied by the user when calling the {{coord}} template | ||
mode is the display mode (dec or dms) that we will need to determine the css class for |
mode is the display mode (dec or dms) that we will need to determine the css class for | ||
]] | ]] | ||
local function displayDefault(default, mode) | local function displayDefault(default, mode) | ||
Line 85: | Line 85: | ||
default = "dec" | default = "dec" | ||
end | end | ||
if default == mode then | if default == mode then | ||
return "geo-default" | return "geo-default" | ||
Line 108: | Line 108: | ||
uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec) | uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec) | ||
end | end | ||
local geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">' | local geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">' | ||
|
.. '<span class="latitude">' .. coordinateSpec .. '</span> ' | ||
|
.. '<span class="longitude">' ..coordinateSpec .. '</span>' | ||
|
.. '</span>' | ||
local lat = tonumber( coordinateSpec ) or 0 | local lat = tonumber( coordinateSpec ) or 0 | ||
Line 127: | Line 127: | ||
if long < 0 then | if long < 0 then | ||
-- FIXME does not handle unicode minus | -- FIXME does not handle unicode minus | ||
geodeclong = tostring(coordinateSpec):sub(2) .. "°W" |
geodeclong = tostring(coordinateSpec):sub(2) .. "°W" | ||
else | else | ||
geodeclong = (coordinateSpec or 0) .. "°E" | geodeclong = (coordinateSpec or 0) .. "°E" | ||
end | end | ||
local geodechtml = '<span class="geo-dec" title="Maps, aerial photos, and other data for this location">' | local geodechtml = '<span class="geo-dec" title="Maps, aerial photos, and other data for this location">' | ||
|
.. geodeclat .. ' ' | ||
|
.. geodeclong | ||
|
.. '</span>' | ||
local geonumhtml = '<span class="geo">' | local geonumhtml = '<span class="geo">' | ||
|
.. coordinateSpec .. '; ' | ||
|
.. coordinateSpec | ||
|
.. '</span>' | ||
local inner = '<span class="' .. displayDefault(coordinateSpec, "dms" ) .. '">' .. geodmshtml .. '</span>' | local inner = '<span class="' .. displayDefault(coordinateSpec, "dms" ) .. '">' .. geodmshtml .. '</span>' | ||
Line 147: | Line 147: | ||
if not args then | if not args then | ||
inner = inner .. geodechtml |
inner = inner .. geodechtml | ||
.. '<span style="display:none"> / ' .. geonumhtml .. '</span></span>' | .. '<span style="display:none"> / ' .. geonumhtml .. '</span></span>' | ||
else | else | ||
inner = inner .. '<span class="vcard">' .. geodechtml |
inner = inner .. '<span class="vcard">' .. geodechtml | ||
.. '<span style="display:none"> / ' .. geonumhtml .. '</span>' | .. '<span style="display:none"> / ' .. geonumhtml .. '</span>' | ||
.. '<span style="display:none"> (<span class="fn org">' | .. '<span style="display:none"> (<span class="fn org">' | ||
Line 156: | Line 156: | ||
end | end | ||
return '<span class="plainlinks nourlexpansion">' .. |
return '<span class="plainlinks nourlexpansion">' .. | ||
'' .. '</span>' | '' .. '</span>' | ||
end | end | ||
Line 167: | Line 167: | ||
--] | --] | ||
local function convert_dec2dms_dm(coordinate) |
local function convert_dec2dms_dm(coordinate) | ||
coordinate = math_mod._round( coordinate * 60, 0 ); | coordinate = math_mod._round( coordinate * 60, 0 ); | ||
local m = coordinate % 60; | local m = coordinate % 60; | ||
coordinate = math.floor( (coordinate - m) / 60 ); | coordinate = math.floor( (coordinate - m) / 60 ); | ||
local d = coordinate % 360 .."°" | local d = coordinate % 360 .."°" | ||
return d .. string.format( "%02d′", m ) | return d .. string.format( "%02d′", m ) | ||
end | end | ||
Line 188: | Line 188: | ||
end | end | ||
--[[ |
--[[ | ||
Helper function, convert decimal latitude or longitude to |
Helper function, convert decimal latitude or longitude to | ||
degrees, minutes, and seconds format based on the specified precision. |
degrees, minutes, and seconds format based on the specified precision. | ||
]] | ]] | ||
local function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) | local function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) | ||
Line 218: | Line 218: | ||
local minutes = tonumber(minutes_str) or 0 | local minutes = tonumber(minutes_str) or 0 | ||
local seconds = tonumber(seconds_str) or 0 | local seconds = tonumber(seconds_str) or 0 | ||
local factor = 1 | local factor = 1 | ||
if direction == "S" or direction == "W" then | if direction == "S" or direction == "W" then | ||
factor = -1 | factor = -1 | ||
end | end | ||
local precision = 0 | local precision = 0 | ||
if seconds_str then | if seconds_str then | ||
Line 232: | Line 232: | ||
precision = math.max( math_mod._precision(degrees_str), 0 ); | precision = math.max( math_mod._precision(degrees_str), 0 ); | ||
end | end | ||
local decimal = factor * (degrees+(minutes+seconds/60)/60) |
local decimal = factor * (degrees+(minutes+seconds/60)/60) | ||
return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based. | return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based. | ||
end | end | ||
--[[ |
--[[ | ||
Checks input values to for out of range errors. | Checks input values to for out of range errors. | ||
]] | ]] | ||
Line 256: | Line 256: | ||
table.insert(errors, {source, "longitude degrees < 0 with hemisphere flag"}) | table.insert(errors, {source, "longitude degrees < 0 with hemisphere flag"}) | ||
end | end | ||
--[[ |
--[[ | ||
#coordinates is inconsistent about whether this is an error. If globe: is | #coordinates is inconsistent about whether this is an error. If globe: is | ||
specified, it won't error on this condition, but otherwise it will. | specified, it won't error on this condition, but otherwise it will. | ||
For not simply disable this check. | For not simply disable this check. | ||
if long_d > 180 then | if long_d > 180 then | ||
table.insert(errors, {source, "longitude degrees > 180 with hemisphere flag"}) | table.insert(errors, {source, "longitude degrees > 180 with hemisphere flag"}) | ||
end | end | ||
]] | ]] | ||
end |
end | ||
if lat_d > 90 then | if lat_d > 90 then | ||
table.insert(errors, {source, "latitude degrees > 90"}) | table.insert(errors, {source, "latitude degrees > 90"}) | ||
Line 304: | Line 304: | ||
table.insert(errors, {source, "longitude seconds < 0"}) | table.insert(errors, {source, "longitude seconds < 0"}) | ||
end | end | ||
return errors; | return errors; | ||
end | end | ||
Line 317: | Line 317: | ||
local coordinateSpec = {} | local coordinateSpec = {} | ||
local errors = {} | local errors = {} | ||
if not long then | if not long then | ||
return nil, {{"parseDec", "Missing longitude"}} | return nil, {{"parseDec", "Missing longitude"}} | ||
Line 323: | Line 323: | ||
return nil, {{"parseDec", "Longitude could not be parsed as a number: " .. long}} | return nil, {{"parseDec", "Longitude could not be parsed as a number: " .. long}} | ||
end | end | ||
errors = validate( lat, nil, nil, long, nil, nil, 'parseDec', false ); |
errors = validate( lat, nil, nil, long, nil, nil, 'parseDec', false ); | ||
coordinateSpec = lat; | coordinateSpec = lat; | ||
coordinateSpec = long; | coordinateSpec = long; | ||
Line 330: | Line 330: | ||
local mode = coordinates.determineMode( lat, long ); | local mode = coordinates.determineMode( lat, long ); | ||
coordinateSpec = convert_dec2dms( lat, "N", "S", mode) -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}} | coordinateSpec = convert_dec2dms( lat, "N", "S", mode) -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}} | ||
coordinateSpec = convert_dec2dms( long, "E", "W", mode) -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}} |
coordinateSpec = convert_dec2dms( long, "E", "W", mode) -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}} | ||
if format then | if format then | ||
coordinateSpec.default = format | coordinateSpec.default = format | ||
Line 344: | Line 344: | ||
parseDMS | parseDMS | ||
Transforms degrees, minutes, seconds format latitude and longitude |
Transforms degrees, minutes, seconds format latitude and longitude | ||
into the a structure to be used in displaying coordinates | into the a structure to be used in displaying coordinates | ||
]] | ]] | ||
local function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format ) | local function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format ) | ||
local coordinateSpec, errors, backward = {}, {} | local coordinateSpec, errors, backward = {}, {} | ||
lat_f = lat_f:upper(); | lat_f = lat_f:upper(); | ||
long_f = long_f:upper(); | long_f = long_f:upper(); | ||
-- Check if specified backward | -- Check if specified backward | ||
if lat_f == 'E' or lat_f == 'W' then | if lat_f == 'E' or lat_f == 'W' then | ||
lat_d, long_d, lat_m, long_m, lat_s, long_s, lat_f, long_f, backward = long_d, lat_d, long_m, lat_m, long_s, lat_s, long_f, lat_f, true; | lat_d, long_d, lat_m, long_m, lat_s, long_s, lat_f, long_f, backward = long_d, lat_d, long_m, lat_m, long_s, lat_s, long_f, lat_f, true; | ||
end |
end | ||
errors = validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, 'parseDMS', true ); | errors = validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, 'parseDMS', true ); | ||
if not long_d then | if not long_d then | ||
Line 364: | Line 364: | ||
return nil, {{"parseDMS", "Longitude could not be parsed as a number:" .. long_d }} | return nil, {{"parseDMS", "Longitude could not be parsed as a number:" .. long_d }} | ||
end | end | ||
if not lat_m and not lat_s and not long_m and not long_s and #errors == 0 then |
if not lat_m and not lat_s and not long_m and not long_s and #errors == 0 then | ||
if math_mod._precision( lat_d ) > 0 or math_mod._precision( long_d ) > 0 then | if math_mod._precision( lat_d ) > 0 or math_mod._precision( long_d ) > 0 then | ||
if lat_f:upper() == 'S' then |
if lat_f:upper() == 'S' then | ||
lat_d = '-' .. lat_d; | lat_d = '-' .. lat_d; | ||
end | end | ||
if long_f:upper() == 'W' then |
if long_f:upper() == 'W' then | ||
long_d = '-' .. long_d; | long_d = '-' .. long_d; | ||
end |
end | ||
return parseDec( lat_d, long_d, format ); | return parseDec( lat_d, long_d, format ); | ||
end |
end | ||
end |
end | ||
coordinateSpec = lat_d.."°"..optionalArg(lat_m,"′") .. optionalArg(lat_s,"″") .. lat_f | coordinateSpec = lat_d.."°"..optionalArg(lat_m,"′") .. optionalArg(lat_s,"″") .. lat_f | ||
coordinateSpec = long_d.."°"..optionalArg(long_m,"′") .. optionalArg(long_s,"″") .. long_f | coordinateSpec = long_d.."°"..optionalArg(long_m,"′") .. optionalArg(long_s,"″") .. long_f | ||
Line 387: | Line 387: | ||
else | else | ||
coordinateSpec.default = "dms" | coordinateSpec.default = "dms" | ||
end |
end | ||
return coordinateSpec, errors, backward | return coordinateSpec, errors, backward | ||
end | end | ||
--[[ |
--[[ | ||
Check the input arguments for coord to determine the kind of data being provided | Check the input arguments for coord to determine the kind of data being provided | ||
and then make the necessary processing. | and then make the necessary processing. | ||
Line 407: | Line 407: | ||
return table.concat(ret, '_') | return table.concat(ret, '_') | ||
end | end | ||
if not args then | if not args then | ||
-- no lat logic | -- no lat logic | ||
Line 424: | Line 424: | ||
-- #coordinates parserfunction doesn't support negative decimals with NSWE | -- #coordinates parserfunction doesn't support negative decimals with NSWE | ||
result.param = table.concat({ | result.param = table.concat({ | ||
math.abs(tonumber(args)), |
math.abs(tonumber(args)), | ||
((tonumber(args) or 0) < 0) and 'S' or 'N', |
((tonumber(args) or 0) < 0) and 'S' or 'N', | ||
math.abs(tonumber(args)), |
math.abs(tonumber(args)), | ||
((tonumber(args) or 0) < 0) and 'W' or 'E', |
((tonumber(args) or 0) < 0) and 'W' or 'E', | ||
args or ''}, '_') | args or ''}, '_') | ||
elseif dmsTest(args, args) then | elseif dmsTest(args, args) then | ||
-- dms logic | -- dms logic | ||
result, errors, backward = parseDMS(args, args, args, args, |
result, errors, backward = parseDMS(args, args, args, args, | ||
args, args, args, args, args.format) | args, args, args, args, args.format) | ||
if args then | if args then | ||
Line 442: | Line 442: | ||
elseif dmsTest(args, args) then | elseif dmsTest(args, args) then | ||
-- dm logic | -- dm logic | ||
result, errors, backward = parseDMS(args, args, nil, args, |
result, errors, backward = parseDMS(args, args, nil, args, | ||
args, args, nil, args, args) | args, args, nil, args, args) | ||
if args then | if args then | ||
Line 453: | Line 453: | ||
elseif dmsTest(args, args) then | elseif dmsTest(args, args) then | ||
-- d logic | -- d logic | ||
result, errors, backward = parseDMS(args, nil, nil, args, |
result, errors, backward = parseDMS(args, nil, nil, args, | ||
args, nil, nil, args, args.format) | args, nil, nil, args, args.format) | ||
if args then | if args then | ||
table.insert(errors, {'formatTest', 'Extra unexpected parameters'}) | table.insert(errors, {'formatTest', 'Extra unexpected parameters'}) | ||
end |
end | ||
if not result then | if not result then | ||
return errorPrinter(errors) | return errorPrinter(errors) | ||
Line 467: | Line 467: | ||
end | end | ||
result.name = args.name | result.name = args.name | ||
local extra_param = {'dim', 'globe', 'scale', 'region', 'source', 'type'} | local extra_param = {'dim', 'globe', 'scale', 'region', 'source', 'type'} | ||
for _, v in ipairs(extra_param) do | for _, v in ipairs(extra_param) do | ||
if args then |
if args then | ||
table.insert(errors, {'formatTest', 'Parameter: "' .. v .. '=" should be "' .. v .. ':"' }) | table.insert(errors, {'formatTest', 'Parameter: "' .. v .. '=" should be "' .. v .. ':"' }) | ||
end | end | ||
end | end | ||
local ret = specPrinter(args, result) | local ret = specPrinter(args, result) | ||
if #errors > 0 then | if #errors > 0 then | ||
⚫ | ret = ret .. ' ' .. errorPrinter(errors) .. ']' | ||
if mw.title.getCurrentTitle().namespace == 0 then | |||
⚫ | |||
end | |||
end | end | ||
return ret, backward | return ret, backward | ||
Line 520: | Line 518: | ||
Usage: | Usage: | ||
{{#invoke:Coordinates | link }} | {{#invoke:Coordinates | link }} | ||
]] | ]] | ||
function coordinates.link(frame) | function coordinates.link(frame) | ||
Line 532: | Line 530: | ||
Usage: | Usage: | ||
{{#invoke:Coordinates | dec2dms | decimal_coordinate | positive_suffix | |
{{#invoke:Coordinates | dec2dms | decimal_coordinate | positive_suffix | | ||
negative_suffix | precision }} | negative_suffix | precision }} | ||
decimal_coordinate is converted to DMS format. If positive, the positive_suffix | decimal_coordinate is converted to DMS format. If positive, the positive_suffix | ||
is appended (typical N or E), if negative, the negative suffix is appended. The | is appended (typical N or E), if negative, the negative suffix is appended. The | ||
Line 563: | Line 561: | ||
return 'dms'; | return 'dms'; | ||
end | end | ||
end |
end | ||
--[[ | --[[ | ||
Line 573: | Line 571: | ||
{{#invoke:Coordinates | dms2dec | direction_flag | degrees | | {{#invoke:Coordinates | dms2dec | direction_flag | degrees | | ||
minutes | seconds }} | minutes | seconds }} | ||
Converts DMS values specified as degrees, minutes, seconds too decimal format. | Converts DMS values specified as degrees, minutes, seconds too decimal format. | ||
direction_flag is one of N, S, E, W, and determines whether the output is |
direction_flag is one of N, S, E, W, and determines whether the output is | ||
positive (i.e. N and E) or negative (i.e. S and W). | positive (i.e. N and E) or negative (i.e. S and W). | ||
]] | ]] | ||
Line 598: | Line 596: | ||
{{#invoke:Coordinates | coord | lat | lat_flag | long | long_flag }} | {{#invoke:Coordinates | coord | lat | lat_flag | long | long_flag }} | ||
... | ... | ||
Refer to {{coord}} documentation page for many additional parameters and |
Refer to {{coord}} documentation page for many additional parameters and | ||
configuration options. | configuration options. | ||
Note: This function provides the visual display elements of {{coord}}. In | Note: This function provides the visual display elements of {{coord}}. In | ||
order to load coordinates into the database, the {{#coordinates:}} parser |
order to load coordinates into the database, the {{#coordinates:}} parser | ||
function must also be called, this is done automatically in the Lua | function must also be called, this is done automatically in the Lua | ||
version of {{coord}}. | version of {{coord}}. | ||
Line 609: | Line 607: | ||
coordinates.coord = makeInvokeFunc('_coord') | coordinates.coord = makeInvokeFunc('_coord') | ||
function coordinates._coord(args) | function coordinates._coord(args) | ||
if |
if not tonumber(args) and not args then | ||
args = args; args = nil | args = args; args = nil | ||
local entity = |
local entity = mw.wikibase.getEntityObject(args.qid) | ||
if entity |
if entity | ||
and entity.claims | and entity.claims | ||
and entity.claims.P625 | and entity.claims.P625 | ||
Line 618: | Line 616: | ||
then | then | ||
local precision = entity.claims.P625.mainsnak.datavalue.value.precision | local precision = entity.claims.P625.mainsnak.datavalue.value.precision | ||
args=entity.claims.P625.mainsnak.datavalue.value.latitude | args = entity.claims.P625.mainsnak.datavalue.value.latitude | ||
args=entity.claims.P625.mainsnak.datavalue.value.longitude | args = entity.claims.P625.mainsnak.datavalue.value.longitude | ||
if precision then | if precision then | ||
precision=-math_mod._round(math.log(precision)/math.log(10),0) | precision = -math_mod._round(math.log(precision)/math.log(10),0) | ||
args=math_mod._round(args,precision) | args = math_mod._round(args,precision) | ||
args=math_mod._round(args,precision) | args = math_mod._round(args,precision) | ||
end | end | ||
end | end | ||
end | end | ||
local contents, backward = formatTest(args) | local contents, backward = formatTest(args) | ||
local Notes = args.notes or '' | local Notes = args.notes or '' | ||
Line 640: | Line 638: | ||
return s:find('title') ~= nil or s == 't' or s == 'it' or s == 'ti' | return s:find('title') ~= nil or s == 't' or s == 'it' or s == 'ti' | ||
end | end | ||
local function coord_wrapper(in_args) | local function coord_wrapper(in_args) | ||
-- Calls the parser function {{#coordinates:}}. | -- Calls the parser function {{#coordinates:}}. | ||
return mw.getCurrentFrame():callParserFunction('#coordinates', in_args) or '' | return mw.getCurrentFrame():callParserFunction('#coordinates', in_args) or '' | ||
end | end | ||
local text = '' | local text = '' | ||
if isInline(Display) then | if isInline(Display) then | ||
Line 720: | Line 718: | ||
for i, v in ipairs(frame.args) do | for i, v in ipairs(frame.args) do | ||
if i ~= 1 then | if i ~= 1 then | ||
if not mw.ustring.find(frame.args, (mw.ustring.match(frame.args, '^(.-:)') or '')) then |
if not mw.ustring.find(frame.args, (mw.ustring.match(frame.args, '^(.-:)') or '')) then | ||
frame.args = mw.ustring.gsub(frame.args, '(params=.-)_? ', '%1_'..frame.args..' ') | frame.args = mw.ustring.gsub(frame.args, '(params=.-)_? ', '%1_'..frame.args..' ') | ||
end | end | ||
Line 728: | Line 726: | ||
if not mw.ustring.find(frame.args, '<span class="vcard">') then | if not mw.ustring.find(frame.args, '<span class="vcard">') then | ||
local namestr = frame.args.name | local namestr = frame.args.name | ||
frame.args = mw.ustring.gsub(frame.args, |
frame.args = mw.ustring.gsub(frame.args, | ||
'(<span class="geo%-default">)(<span*>*</span><span*>*<span*>*</span></span>)(</span>)', |
'(<span class="geo%-default">)(<span*>*</span><span*>*<span*>*</span></span>)(</span>)', | ||
'%1<span class="vcard">%2<span style="display:none"> (<span class="fn org">' .. namestr .. '</span>)</span></span>%3') | '%1<span class="vcard">%2<span style="display:none"> (<span class="fn org">' .. namestr .. '</span>)</span></span>%3') | ||
frame.args = mw.ustring.gsub(frame.args, '(¶ms= ]*) ', '%1&title=' .. mw.uri.encode(namestr) .. ' ') | frame.args = mw.ustring.gsub(frame.args, '(¶ms= ]*) ', '%1&title=' .. mw.uri.encode(namestr) .. ' ') |
Revision as of 07:48, 5 July 2019
Module documentation[view] [edit] [history] [purge]This Lua module is used on approximately 1,370,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 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. |
This module depends on the following other modules: |
This module uses TemplateStyles: |
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}}
→ Lua error in package.lua at line 80: module 'Module:No globals' not found.
To extract the longitude, use:
{{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|long}}
→ Lua error in package.lua at line 80: module 'Module:No globals' not found.
Modules using this module directly
Tracking categories
- Category:Pages with malformed coordinate tags (38)
- Category:Coordinates not on Wikidata (14,463)
- Category:Coordinates on Wikidata (1,205,815)
- Category:Coordinates on Wikidata set to no value (9)
- Category:Coordinates on Wikidata set to unknown value (29)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.
--[[ This module is intended to replace the functionality of {{Coord}} and related templates. It provides several methods, including {{#invoke:Coordinates | coord }} : General function formatting and displaying coordinate values. {{#invoke:Coordinates | dec2dms }} : Simple function for converting decimal degree values to DMS format. {{#invoke:Coordinates | dms2dec }} : Simple function for converting DMS format to decimal degree format. {{#invoke:Coordinates | link }} : Export the link used to reach the tools ]] require('Module:No globals') local math_mod = require("Module:Math") local coordinates = {}; local current_page = mw.title.getCurrentTitle() local page_name = mw.uri.encode( current_page.prefixedText, 'WIKI' ); local coord_link = '//tools.wmflabs.org/geohack/geohack.php?pagename=' .. page_name .. '¶ms=' --] local function displaytitle(s, notes) local l = "]: " .. s local co = '<span id="coordinates">' .. l .. notes .. '</span>'; return '<span style="font-size: small;">' .. co .. '</span>'; end --] local function displayinline(s, notes) return s .. notes end --] local function dmsTest(first, second) if type(first) ~= 'string' or type(second) ~= 'string' then return nil end local s = (first .. second):upper() return s:find('^$') or s:find('^$') end --] local function makeInvokeFunc(funcName) return function (frame) local args = require('Module:Arguments').getArgs(frame, { wrappers = 'Template:Coord' }) return coordinates(args, frame) end end --] local function optionalArg(arg, supplement) return arg and arg .. supplement or '' end --[[ Formats any error messages generated for display ]] local function errorPrinter(errors) local result = "" for i,v in ipairs(errors) do local errorHTML = '<strong class="error">Coordinates: ' .. v .. '</strong>' result = result .. errorHTML .. "<br />" end return result end --[[ Determine the required CSS class to display coordinates Usually geo-nondefault is hidden by CSS, unless a user has overridden this for himself default is the mode as specificied by the user when calling the {{coord}} template mode is the display mode (dec or dms) that we will need to determine the css class for ]] local function displayDefault(default, mode) if default == "" then default = "dec" end if default == mode then return "geo-default" else return "geo-nondefault" end end --[[ specPrinter Output formatter. Takes the structure generated by either parseDec or parseDMS and formats it for inclusion on Misplaced Pages. ]] local function specPrinter(args, coordinateSpec) local uriComponents = coordinateSpec if uriComponents == "" then -- RETURN error, should never be empty or nil return "ERROR param was empty" end if args then uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec) end local geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">' .. '<span class="latitude">' .. coordinateSpec .. '</span> ' .. '<span class="longitude">' ..coordinateSpec .. '</span>' .. '</span>' local lat = tonumber( coordinateSpec ) or 0 local geodeclat if lat < 0 then -- FIXME this breaks the pre-existing precision geodeclat = tostring(coordinateSpec):sub(2) .. "°S" else geodeclat = (coordinateSpec or 0) .. "°N" end local long = tonumber( coordinateSpec ) or 0 local geodeclong if long < 0 then -- FIXME does not handle unicode minus geodeclong = tostring(coordinateSpec):sub(2) .. "°W" else geodeclong = (coordinateSpec or 0) .. "°E" end local geodechtml = '<span class="geo-dec" title="Maps, aerial photos, and other data for this location">' .. geodeclat .. ' ' .. geodeclong .. '</span>' local geonumhtml = '<span class="geo">' .. coordinateSpec .. '; ' .. coordinateSpec .. '</span>' local inner = '<span class="' .. displayDefault(coordinateSpec, "dms" ) .. '">' .. geodmshtml .. '</span>' .. '<span class="geo-multi-punct"> / </span>' .. '<span class="' .. displayDefault(coordinateSpec, "dec" ) .. '">'; if not args then inner = inner .. geodechtml .. '<span style="display:none"> / ' .. geonumhtml .. '</span></span>' else inner = inner .. '<span class="vcard">' .. geodechtml .. '<span style="display:none"> / ' .. geonumhtml .. '</span>' .. '<span style="display:none"> (<span class="fn org">' .. args .. '</span>)</span></span></span>' end return '<span class="plainlinks nourlexpansion">' .. '' .. '</span>' end --] local function convert_dec2dms_d(coordinate) local d = math_mod._round( coordinate, 0 ) .. "°" return d .. "" end --] local function convert_dec2dms_dm(coordinate) coordinate = math_mod._round( coordinate * 60, 0 ); local m = coordinate % 60; coordinate = math.floor( (coordinate - m) / 60 ); local d = coordinate % 360 .."°" return d .. string.format( "%02d′", m ) end --] local function convert_dec2dms_dms(coordinate) coordinate = math_mod._round( coordinate * 60 * 60, 0 ); local s = coordinate % 60 coordinate = math.floor( (coordinate - s) / 60 ); local m = coordinate % 60 coordinate = math.floor( (coordinate - m) / 60 ); local d = coordinate % 360 .."°" return d .. string.format( "%02d′", m ) .. string.format( "%02d″", s ) end --[[ Helper function, convert decimal latitude or longitude to degrees, minutes, and seconds format based on the specified precision. ]] local function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) local coord = tonumber(coordinate) local postfix if coord >= 0 then postfix = firstPostfix else postfix = secondPostfix end precision = precision:lower(); if precision == "dms" then return convert_dec2dms_dms( math.abs( coord ) ) .. postfix; elseif precision == "dm" then return convert_dec2dms_dm( math.abs( coord ) ) .. postfix; elseif precision == "d" then return convert_dec2dms_d( math.abs( coord ) ) .. postfix; end end --[[ Convert DMS format into a N or E decimal coordinate ]] local function convert_dms2dec(direction, degrees_str, minutes_str, seconds_str) local degrees = tonumber(degrees_str) local minutes = tonumber(minutes_str) or 0 local seconds = tonumber(seconds_str) or 0 local factor = 1 if direction == "S" or direction == "W" then factor = -1 end local precision = 0 if seconds_str then precision = 5 + math.max( math_mod._precision(seconds_str), 0 ); elseif minutes_str and minutes_str ~= '' then precision = 3 + math.max( math_mod._precision(minutes_str), 0 ); else precision = math.max( math_mod._precision(degrees_str), 0 ); end local decimal = factor * (degrees+(minutes+seconds/60)/60) return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based. end --[[ Checks input values to for out of range errors. ]] local function validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, source, strong ) local errors = {}; lat_d = tonumber( lat_d ) or 0; lat_m = tonumber( lat_m ) or 0; lat_s = tonumber( lat_s ) or 0; long_d = tonumber( long_d ) or 0; long_m = tonumber( long_m ) or 0; long_s = tonumber( long_s ) or 0; if strong then if lat_d < 0 then table.insert(errors, {source, "latitude degrees < 0 with hemisphere flag"}) end if long_d < 0 then table.insert(errors, {source, "longitude degrees < 0 with hemisphere flag"}) end --[[ #coordinates is inconsistent about whether this is an error. If globe: is specified, it won't error on this condition, but otherwise it will. For not simply disable this check. if long_d > 180 then table.insert(errors, {source, "longitude degrees > 180 with hemisphere flag"}) end ]] end if lat_d > 90 then table.insert(errors, {source, "latitude degrees > 90"}) end if lat_d < -90 then table.insert(errors, {source, "latitude degrees < -90"}) end if lat_m >= 60 then table.insert(errors, {source, "latitude minutes >= 60"}) end if lat_m < 0 then table.insert(errors, {source, "latitude minutes < 0"}) end if lat_s >= 60 then table.insert(errors, {source, "latitude seconds >= 60"}) end if lat_s < 0 then table.insert(errors, {source, "latitude seconds < 0"}) end if long_d >= 360 then table.insert(errors, {source, "longitude degrees >= 360"}) end if long_d <= -360 then table.insert(errors, {source, "longitude degrees <= -360"}) end if long_m >= 60 then table.insert(errors, {source, "longitude minutes >= 60"}) end if long_m < 0 then table.insert(errors, {source, "longitude minutes < 0"}) end if long_s >= 60 then table.insert(errors, {source, "longitude seconds >= 60"}) end if long_s < 0 then table.insert(errors, {source, "longitude seconds < 0"}) end return errors; end --[[ parseDec Transforms decimal format latitude and longitude into the structure to be used in displaying coordinates ]] local function parseDec( lat, long, format ) local coordinateSpec = {} local errors = {} if not long then return nil, {{"parseDec", "Missing longitude"}} elseif not tonumber(long) then return nil, {{"parseDec", "Longitude could not be parsed as a number: " .. long}} end errors = validate( lat, nil, nil, long, nil, nil, 'parseDec', false ); coordinateSpec = lat; coordinateSpec = long; local mode = coordinates.determineMode( lat, long ); coordinateSpec = convert_dec2dms( lat, "N", "S", mode) -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}} coordinateSpec = convert_dec2dms( long, "E", "W", mode) -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}} if format then coordinateSpec.default = format else coordinateSpec.default = "dec" end return coordinateSpec, errors end --[[ parseDMS Transforms degrees, minutes, seconds format latitude and longitude into the a structure to be used in displaying coordinates ]] local function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format ) local coordinateSpec, errors, backward = {}, {} lat_f = lat_f:upper(); long_f = long_f:upper(); -- Check if specified backward if lat_f == 'E' or lat_f == 'W' then lat_d, long_d, lat_m, long_m, lat_s, long_s, lat_f, long_f, backward = long_d, lat_d, long_m, lat_m, long_s, lat_s, long_f, lat_f, true; end errors = validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, 'parseDMS', true ); if not long_d then return nil, {{"parseDMS", "Missing longitude" }} elseif not tonumber(long_d) then return nil, {{"parseDMS", "Longitude could not be parsed as a number:" .. long_d }} end if not lat_m and not lat_s and not long_m and not long_s and #errors == 0 then if math_mod._precision( lat_d ) > 0 or math_mod._precision( long_d ) > 0 then if lat_f:upper() == 'S' then lat_d = '-' .. lat_d; end if long_f:upper() == 'W' then long_d = '-' .. long_d; end return parseDec( lat_d, long_d, format ); end end coordinateSpec = lat_d.."°"..optionalArg(lat_m,"′") .. optionalArg(lat_s,"″") .. lat_f coordinateSpec = long_d.."°"..optionalArg(long_m,"′") .. optionalArg(long_s,"″") .. long_f coordinateSpec = convert_dms2dec(lat_f, lat_d, lat_m, lat_s) -- {{coord/dms2dec|{{{4}}}|{{{1}}}|0{{{2}}}|0{{{3}}}}} coordinateSpec = convert_dms2dec(long_f, long_d, long_m, long_s) -- {{coord/dms2dec|{{{8}}}|{{{5}}}|0{{{6}}}|0{{{7}}}}} if format then coordinateSpec.default = format else coordinateSpec.default = "dms" end return coordinateSpec, errors, backward end --[[ Check the input arguments for coord to determine the kind of data being provided and then make the necessary processing. ]] local function formatTest(args) local result, errors local backward, primary = false, false local function getParam(args, lim) local ret = {} for i = 1, lim do ret = args or '' end return table.concat(ret, '_') end if not args then -- no lat logic return errorPrinter( {{"formatTest", "Missing latitude"}} ) elseif not tonumber(args) then -- bad lat logic return errorPrinter( {{"formatTest", "Unable to parse latitude as a number:" .. args}} ) elseif not args and not args and not args then -- dec logic result, errors = parseDec(args, args, args.format) if not result then return errorPrinter(errors); end -- formatting for geohack: geohack expects D_N_D_E notation or D;D notation -- wikiminiatlas doesn't support D;D notation -- #coordinates parserfunction doesn't support negative decimals with NSWE result.param = table.concat({ math.abs(tonumber(args)), ((tonumber(args) or 0) < 0) and 'S' or 'N', math.abs(tonumber(args)), ((tonumber(args) or 0) < 0) and 'W' or 'E', args or ''}, '_') elseif dmsTest(args, args) then -- dms logic result, errors, backward = parseDMS(args, args, args, args, args, args, args, args, args.format) if args then table.insert(errors, {'formatTest', 'Extra unexpected parameters'}) end if not result then return errorPrinter(errors) end result.param = getParam(args, 9) elseif dmsTest(args, args) then -- dm logic result, errors, backward = parseDMS(args, args, nil, args, args, args, nil, args, args) if args then table.insert(errors, {'formatTest', 'Extra unexpected parameters'}) end if not result then return errorPrinter(errors) end result.param = getParam(args, 7) elseif dmsTest(args, args) then -- d logic result, errors, backward = parseDMS(args, nil, nil, args, args, nil, nil, args, args.format) if args then table.insert(errors, {'formatTest', 'Extra unexpected parameters'}) end if not result then return errorPrinter(errors) end result.param = getParam(args, 5) else -- Error return errorPrinter({{"formatTest", "Unknown argument format"}}) end result.name = args.name local extra_param = {'dim', 'globe', 'scale', 'region', 'source', 'type'} for _, v in ipairs(extra_param) do if args then table.insert(errors, {'formatTest', 'Parameter: "' .. v .. '=" should be "' .. v .. ':"' }) end end local ret = specPrinter(args, result) if #errors > 0 then ret = ret .. ' ' .. errorPrinter(errors) .. ']' end return ret, backward end --[[ Generate Wikidata tracking categories. ]] local function makeWikidataCategories(qid) local ret if mw.wikibase and current_page.namespace == 0 then local entity = qid and mw.wikibase.getEntityObject(qid) or mw.wikibase.getEntityObject() if entity and entity.claims and entity.claims.P625 and entity.claims.P625 then local snaktype = entity.claims.P625.mainsnak.snaktype if snaktype == 'value' then -- coordinates exist both here and on Wikidata, and can be compared. ret = 'Coordinates on Wikidata' elseif snaktype == 'somevalue' then ret = 'Coordinates on Wikidata set to unknown value' elseif snaktype == 'novalue' then ret = 'Coordinates on Wikidata set to no value' end else -- We have to either import the coordinates to Wikidata or remove them here. ret = 'Coordinates not on Wikidata' end end if ret then return string.format(']', ret) else return '' end end --[[ link Simple function to export the coordinates link for other uses. Usage: {{#invoke:Coordinates | link }} ]] function coordinates.link(frame) return coord_link; end --[[ dec2dms Wrapper to allow templates to call dec2dms directly. Usage: {{#invoke:Coordinates | dec2dms | decimal_coordinate | positive_suffix | negative_suffix | precision }} decimal_coordinate is converted to DMS format. If positive, the positive_suffix is appended (typical N or E), if negative, the negative suffix is appended. The specified precision is one of 'D', 'DM', or 'DMS' to specify the level of detail to use. ]] coordinates.dec2dms = makeInvokeFunc('_dec2dms') function coordinates._dec2dms(args) local coordinate = args local firstPostfix = args or '' local secondPostfix = args or '' local precision = args or '' return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) end --[[ Helper function to determine whether to use D, DM, or DMS format depending on the precision of the decimal input. ]] function coordinates.determineMode( value1, value2 ) local precision = math.max( math_mod._precision( value1 ), math_mod._precision( value2 ) ); if precision <= 0 then return 'd' elseif precision <= 2 then return 'dm'; else return 'dms'; end end --[[ dms2dec Wrapper to allow templates to call dms2dec directly. Usage: {{#invoke:Coordinates | dms2dec | direction_flag | degrees | minutes | seconds }} Converts DMS values specified as degrees, minutes, seconds too decimal format. direction_flag is one of N, S, E, W, and determines whether the output is positive (i.e. N and E) or negative (i.e. S and W). ]] coordinates.dms2dec = makeInvokeFunc('_dms2dec') function coordinates._dms2dec(args) local direction = args local degrees = args local minutes = args local seconds = args return convert_dms2dec(direction, degrees, minutes, seconds) end --[[ coord Main entry point for Lua function to replace {{coord}} Usage: {{#invoke:Coordinates | coord }} {{#invoke:Coordinates | coord | lat | long }} {{#invoke:Coordinates | coord | lat | lat_flag | long | long_flag }} ... Refer to {{coord}} documentation page for many additional parameters and configuration options. Note: This function provides the visual display elements of {{coord}}. In order to load coordinates into the database, the {{#coordinates:}} parser function must also be called, this is done automatically in the Lua version of {{coord}}. ]] coordinates.coord = makeInvokeFunc('_coord') function coordinates._coord(args) if not tonumber(args) and not args then args = args; args = nil local entity = mw.wikibase.getEntityObject(args.qid) if entity and entity.claims and entity.claims.P625 and entity.claims.P625.mainsnak.snaktype == 'value' then local precision = entity.claims.P625.mainsnak.datavalue.value.precision args = entity.claims.P625.mainsnak.datavalue.value.latitude args = entity.claims.P625.mainsnak.datavalue.value.longitude if precision then precision = -math_mod._round(math.log(precision)/math.log(10),0) args = math_mod._round(args,precision) args = math_mod._round(args,precision) end end end local contents, backward = formatTest(args) local Notes = args.notes or '' local Display = args.display and args.display:lower() or 'inline' local function isInline(s) -- Finds whether coordinates are displayed inline. return s:find('inline') ~= nil or s == 'i' or s == 'it' or s == 'ti' end local function isInTitle(s) -- Finds whether coordinates are displayed in the title. return s:find('title') ~= nil or s == 't' or s == 'it' or s == 'ti' end local function coord_wrapper(in_args) -- Calls the parser function {{#coordinates:}}. return mw.getCurrentFrame():callParserFunction('#coordinates', in_args) or '' end local text = '' if isInline(Display) then text = text .. displayinline(contents, Notes) end if isInTitle(Display) then text = text .. displaytitle(contents, Notes) .. makeWikidataCategories(args.qid) end if not args.nosave then local page_title, count = mw.title.getCurrentTitle(), 1 if backward then local tmp = {} while not string.find((args or ''), '') do tmp = (args or ''); count = count+1 end tmp.count = count; count = 2*(count-1) while count >= tmp.count do table.insert(tmp, 1, (args or '')); count = count-1 end for i, v in ipairs(tmp) do args = v end else while count <= 9 do args = (args or ''); count = count+1 end end if isInTitle(Display) and not page_title.isTalkPage and page_title.subpageText ~= 'doc' and page_title.subpageText ~= 'testcases' then args = 'primary' end args.notes, args.format, args.display = nil text = text .. coord_wrapper(args) end return text end --[[ coord2text Extracts a single value from a transclusion of {{Coord}}. IF THE GEOHACK LINK SYNTAX CHANGES THIS FUNCTION MUST BE MODIFIED. Usage: {{#invoke:Coordinates | coord2text | {{Coord}} | parameter }} Valid values for the second parameter are: lat (signed integer), long (signed integer), type, scale, dim, region, globe, source ]] function coordinates.coord2text(frame) if frame.args == '' or frame.args == '' or not frame.args then return nil end frame.args = mw.text.trim(frame.args) if frame.args == 'lat' or frame.args == 'long' then local result, negative = mw.text.split((mw.ustring.match(frame.args,'+° +°') or ''), ' ') if frame.args == 'lat' then result, negative = result, 'S' else result, negative = result, 'W' end result = mw.text.split(result, '°') if result == negative then result = '-'..result end return result else return mw.ustring.match(frame.args, 'params=.-_'..frame.args..':(.-)') end end --[[ coordinsert Injects some text into the Geohack link of a transclusion of {{Coord}} (if that text isn't already in the transclusion). Outputs the modified transclusion of {{Coord}}. IF THE GEOHACK LINK SYNTAX CHANGES THIS FUNCTION MUST BE MODIFIED. Usage: {{#invoke:Coordinates | coordinsert | {{Coord}} | parameter:value | parameter:value | … }} Do not make Geohack unhappy by inserting something which isn't mentioned in the {{Coord}} documentation. ]] function coordinates.coordinsert(frame) for i, v in ipairs(frame.args) do if i ~= 1 then if not mw.ustring.find(frame.args, (mw.ustring.match(frame.args, '^(.-:)') or '')) then frame.args = mw.ustring.gsub(frame.args, '(params=.-)_? ', '%1_'..frame.args..' ') end end end if frame.args.name then if not mw.ustring.find(frame.args, '<span class="vcard">') then local namestr = frame.args.name frame.args = mw.ustring.gsub(frame.args, '(<span class="geo%-default">)(<span*>*</span><span*>*<span*>*</span></span>)(</span>)', '%1<span class="vcard">%2<span style="display:none"> (<span class="fn org">' .. namestr .. '</span>)</span></span>%3') frame.args = mw.ustring.gsub(frame.args, '(¶ms= ]*) ', '%1&title=' .. mw.uri.encode(namestr) .. ' ') end end return frame.args end return coordinatesCategories: