Module:Coordinates
Documentation for this module may be created at Module:Coordinates/doc
--[[
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
]]
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 = '//geohack.toolforge.org/geohack.php?pagename=' .. page_name .. '&language=ga¶ms='
--[[ Helper function, replacement for {{coord/display/title}} ]]
local function displaytitle (s, notes)
local l = '<span title="Coordinates geogràfiques WGS84">Coord.:</span> ' .. s
local co = '<span id="coordinates">' .. l .. notes .. '</span>'
local frame = mw.getCurrentFrame()
return frame:extensionTag( 'indicator', co, { name = 'coordinates-ind' } )
end
--[[ Helper function, Replacement for {{coord/display/inline}} ]]
local function displayinline (s, notes)
return s .. notes
end
--[[ Helper function, used in detecting DMS formatting ]]
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('^[NS][EW]$') or s:find('^[EW][NS]$')
end
--[[ Wrapper function to grab args, see Module:Arguments for this function's documentation. ]]
local function makeInvokeFunc(funcName)
return function (frame)
local args = require('Module:Arguments').getArgs(frame, {
wrappers = 'Teimpléad:Coord'
})
return coordinates[funcName](args)
end
end
--[[ Helper function, handle optional args. ]]
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">Comhordanáidí: ' .. v[2] .. '</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 = "dms"
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 Wikipedia.
]]
local function specPrinter(args, coordinateSpec)
local uriComponents = coordinateSpec["param"]
if uriComponents == "" then
-- RETURN error, should never be empty or nil
return "EARRÁID: param folamh"
end
if coordinateSpec["name"] then
uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec["name"])
end
local geodmshtml = '<span class="geo-dms" title="Léarscáileanna, grianghraif ón aer agus faisnéis eile don suíomh seo">'
.. coordinateSpec["dms-lat"] .. ', '
.. coordinateSpec["dms-long"]
.. '</span>'
local lat = tonumber( coordinateSpec["dec-lat"] ) or 0
local geodeclat
if lat < 0 then
-- FIXME this breaks the pre-existing precision
geodeclat = tostring(coordinateSpec["dec-lat"]):sub(2) .. "°S"
else
geodeclat = (coordinateSpec["dec-lat"] or 0) .. "°N"
end
local long = tonumber( coordinateSpec["dec-long"] ) or 0
local geodeclong
if long < 0 then
-- FIXME does not handle unicode minus
geodeclong = tostring(coordinateSpec["dec-long"]):sub(2) .. "°W"
else
geodeclong = (coordinateSpec["dec-long"] or 0) .. "°E"
end
local geodechtml = '<span class="geo-dec" title="Léarscáileanna, grianghraif ón aer agus faisnéis eile don suíomh seo">'
.. '<span class="latitude">' .. geodeclat .. '</span>,'
.. '<span class="longitude">' .. geodeclong .. '</span>'
.. '</span>'
local geonumhtml = '<span class="geo">'
.. coordinateSpec["dec-lat"] .. '; '
.. coordinateSpec["dec-long"]
.. '</span>'
local inner = '<span class="' .. displayDefault(coordinateSpec["default"], "dms" ) .. '">' .. geodmshtml .. '</span>'
.. '<span class="geo-multi-punct"> / </span>'
.. '<span class="' .. displayDefault(coordinateSpec["default"], "dec" ) .. '">';
if not args["name"] 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["name"] .. '</span>)</span></span></span>'
end
return '<span class="plainlinks nourlexpansion">' ..
'[' .. coord_link .. uriComponents .. ' ' .. inner .. ']' .. '</span>'
end
--[[ Helper function, convert decimal to degrees ]]
local function convert_dec2dms_d(coordinate)
local d = math_mod._round( coordinate, 0 ) .. "°"
return d .. ""
end
--[[ Helper function, convert decimal to degrees and minutes ]]
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
--[[ Helper function, convert decimal to degrees, minutes, and seconds ]]
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) or 0
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) or 0
local minutes = tonumber(minutes_str) or 0
local seconds = tonumber(seconds_str) or 0
local factor = 1
direction = direction:gsub('^ *(.-) *$', '%1');
if direction == "S" or direction == "W" or direction == "O" then
factor = -1
end
local precision = 0
if seconds_str then
precision = 5 + math.max( math_mod._precision(seconds_str), 0 );
elseif 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, "domhanleithead agus treo diúltach"})
end
if long_d < 0 then
table.insert(errors, {source, "fad diúltach agus le treo"})
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, "Céimeanna domhanleithead > 90"})
end
if lat_d < -90 then
table.insert(errors, {source, "Céimeanna domhanleithead < -90"})
end
if lat_m >= 60 then
table.insert(errors, {source, "Nóiméíd domhanleithead >= 60"})
end
if lat_m < 0 then
table.insert(errors, {source, "Nóiméíd domhanleithead < 0"})
end
if lat_s >= 60 then
table.insert(errors, {source, "Soicind domhanleithead >= 60"})
end
if lat_s < 0 then
table.insert(errors, {source, "Soicind domhanleithead < 0"})
end
if long_d >= 360 then
table.insert(errors, {source, "Céimeanna domhanfhad >= 360"})
end
if long_d <= -360 then
table.insert(errors, {source, "Céimeanna domhanfhad <= -360"})
end
if long_m >= 60 then
table.insert(errors, {source, "Nóiméíd domhanfhad >= 60"})
end
if long_m < 0 then
table.insert(errors, {source, "Nóiméíd domhanfhad < 0"})
end
if long_s >= 60 then
table.insert(errors, {source, "Soicind domhanfhad >= 60"})
end
if long_s < 0 then
table.insert(errors, {source, "Soicind domhanfhad < 0"})
end
return errors;
end
--[[
parseDec
Transforms decimal format latitude and longitude into the a
structure to be used in displaying coordinates
]]
local function parseDec( lat, long, format )
local coordinateSpec = {}
local errors = {}
if not long then
return nil, {{"parseDec", "fad in easnamh"}}
elseif not tonumber(long) then
return nil, {{"parseDec", "Níl an fad uimhriúil: " .. long}}
end
errors = validate( lat, nil, nil, long, nil, nil, 'parseDec', false );
coordinateSpec["dec-lat"] = lat;
coordinateSpec["dec-long"] = long;
local mode = coordinates.determineMode( lat, long );
coordinateSpec["dms-lat"] = convert_dec2dms( lat, "N", "S", mode) -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}
coordinateSpec["dms-long"] = convert_dec2dms( long, "E", "O", mode) -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}
if format then
coordinateSpec.default = format
else
coordinateSpec.default = "dms" -- a diferència de l'anglesa, per defecte sempre dms
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 = {}
local errors = {}
lat_f = lat_f:upper();
long_f = long_f:upper();
-- Check if specified backward
if lat_f == 'E' or lat_f == 'W' or lat_f == "O" then
local t_d, t_m, t_s, t_f;
t_d = lat_d;
t_m = lat_m;
t_s = lat_s;
t_f = lat_f;
lat_d = long_d;
lat_m = long_m;
lat_s = long_s;
lat_f = long_f;
long_d = t_d;
long_m = t_m;
long_s = t_s;
long_f = t_f;
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", "Fad in easnamh"}}
elseif not tonumber(long_d) then
return nil, {{"parseDMS", "Níl an fad uimhriúil:" .. 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' or long_f:upper() == 'O' then
long_d = '-' .. long_d;
end
return parseDec( lat_d, long_d, format );
end
end
if long_f == "W" then
long_f = "O" -- direcció a mostrar, excepte a coordinateSpec["param"]
end
coordinateSpec["dms-lat"] = lat_d.."° "..optionalArg(lat_m,"′ ") .. optionalArg(lat_s,"″ ") .. lat_f
coordinateSpec["dms-long"] = long_d.."° "..optionalArg(long_m,"′ ") .. optionalArg(long_s,"″ ") .. long_f
coordinateSpec["dec-lat"] = convert_dms2dec(lat_f, lat_d, lat_m, lat_s) -- {{coord/dms2dec|{{{4}}}|{{{1}}}|0{{{2}}}|0{{{3}}}}}
coordinateSpec["dec-long"] = 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
end
--[[ Funció auxiliar per convertir coma decimal a punt decimal ]]
local function formatPunt(num)
return mw.ustring.gsub(num, ",", ".")
end
--[[ Funció auxilar per convertir longitud O a W ]]
local function formatLongW(dir)
if dir:upper() == "O" then
return "W"
end
return dir
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 primary = false
if not args[1] then
-- no lat logic
return errorPrinter( {{"formatTest", "Domhanleithead in easnamh"}} )
elseif not tonumber(args[1]) then
-- bad lat logic
return errorPrinter( {{"formatTest", "Níl an Domhanleithead uimhriúil:" .. args[1]}} )
elseif not args[4] and not args[5] and not args[6] then
-- dec logic
result, errors = parseDec(formatPunt(args[1]), formatPunt(args[2]), args.format)
if not result then
return errorPrinter( errors );
end
result.param = table.concat({formatPunt(args[1]), 'N', formatPunt(args[2]) or '', 'E', args[3] or ''}, '_')
elseif dmsTest(args[4], args[8]) then
-- dms logic
result, errors = parseDMS(args[1], args[2], formatPunt(args[3]), args[4],
args[5], args[6], formatPunt(args[7]), args[8], args.format)
if args[10] then
table.insert(errors, {'formatTest', 'paraiméadair fágtha'})
end
if not result then
return errorPrinter(errors)
end
result.param = table.concat({args[1], args[2], formatPunt(args[3]), args[4], args[5],
args[6], formatPunt(args[7]), formatLongW(args[8]), args[9]}, '_')
elseif dmsTest(args[3], args[6]) then
-- dm logic
result, errors = parseDMS(args[1], formatPunt(args[2]), nil, args[3],
args[4], formatPunt(args[5]), nil, args[6], args['format'])
if args[8] then
table.insert(errors, { 'formatTest', 'paraiméadair fágtha' })
end
if not result then
return errorPrinter(errors)
end
result.param = table.concat({args[1], formatPunt(args[2]), args[3], args[4], formatPunt(args[5]),
formatLongW(args[6]), args[7]}, '_')
elseif dmsTest(args[2], args[4]) then
-- d logic
result, errors = parseDMS(formatPunt(args[1]), nil, nil, args[2],
formatPunt(args[3]), nil, nil, args[4], args['format'])
if args[6] then
table.insert(errors, {'formatTest', 'paraiméadair fágtha' })
end
if not result then
return errorPrinter(errors)
end
result.param = table.concat({formatPunt(args[1]), args[2], formatPunt(args[3]), formatLongW(args[4]), args[5]}, '_')
else
-- Error
return errorPrinter({{"formatTest", "formáid neamhaitheanta"}})
end
result.name = args.name or args.nom
local extra_param = {'dim', 'globe', 'scale', 'region', 'source', 'type'}
for _, v in ipairs(extra_param) do
if args[v] then
table.insert(errors, {'formatTest', 'Paraiméadar: "' .. v .. '=" chóir go mbeadh "' .. v .. ':"'})
end
end
local ret = specPrinter(args, result)
if #errors > 0 then
ret = ret .. " " .. errorPrinter(errors) .. '[[Catagóir:Teimpléad cothabhála comhoird]]'
end
return ret
end
--[[
Generate Wikidata tracking categories.
Aquesta funció no s'està utilitzant. Pendent de revisar les categories de seguiment necessàries.
]]
local function makeWikidataCategories()
local ret
if mw.wikibase and current_page.namespace == 0 then
local entity = mw.wikibase.getEntityObject()
if entity and entity.claims and entity.claims.P625 and entity.claims.P625[1] then
local snaktype = entity.claims.P625[1].mainsnak.snaktype
if snaktype == 'value' then
-- coordinates exist both here and on Wikidata, and can be compared.
ret = 'Airteagail le Comhordanáidí'
elseif snaktype == 'somevalue' then
ret = 'Comhordaíonn Wikidata le luach anaithnid'
elseif snaktype == 'novalue' then
ret = 'Comhordanáidí Wikidata gan aon luach sainithe'
end
else
-- We have to either import the coordinates to Wikidata or remove them here.
ret = 'Ailt le Comhordanáidí gan Comhordanáidí sa Wikidata'
end
end
if ret then
return string.format('[[Catagóir:%s]]', 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[1]
local firstPostfix = args[2] or ''
local secondPostfix = args[3] or ''
local precision = args[4] 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[1]
local degrees = args[2]
local minutes = args[3]
local seconds = args[4]
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)
--[[ Intent de carregar de Wikidata. Pendent de solucionar {{#coordinates:}} afegit per la plantilla, no el mòdul
if not args[1] and not args[2] and mw.wikibase.getEntityObject() then
local entity = mw.wikibase.getEntityObject()
if entity
and entity.claims
and entity.claims.P625
and entity.claims.P625[1].mainsnak.snaktype == 'value'
then
local precision = entity.claims.P625[1].mainsnak.datavalue.value.precision
args[1]=entity.claims.P625[1].mainsnak.datavalue.value.latitude
args[2]=entity.claims.P625[1].mainsnak.datavalue.value.longitude
if precision then
precision=-math_mod._round(math.log(precision)/math.log(10),0)
args[1]=math_mod._round(args[1],precision)
args[2]=math_mod._round(args[2],precision)
end
end
end
]]
local contents = 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 text = ''
if isInline(Display) then
text = text .. displayinline(contents, Notes)
end
if isInTitle(Display) then
text = text
.. displaytitle(contents, Notes)
-- .. makeWikidataCategories()
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[1] == '' or frame.args[2] == '' or not frame.args[2] then return nil end
frame.args[2] = mw.text.trim(frame.args[2])
if frame.args[2] == 'lat' or frame.args[2] == 'long' then
local coord_text = string.gsub(frame.args[1], "<s.->(.-)</span>", "%1") -- remove spans
local coord_text = string.gsub(coord_text, ',', ' ') -- change default separator
local result, positive = mw.text.split((mw.ustring.match(coord_text,'[%.%d]+°[NS] [%.%d]+°[EWO]') or ''), ' ')
if frame.args[2] == 'lat' then
result, positive = result[1], 'N'
else
result, positive = result[2], 'E'
end
result = mw.text.split(result, '°')
if result[2] ~= positive then result[1] = '-' .. result[1] end
return result[1]
else
return mw.ustring.match(frame.args[1], 'params=.-_'..frame.args[2]..':(.-)[ _]')
end
end
return coordinates