ሞድዩል:Coordinates
Documentation for this module may be created at ሞድዩል: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.
]]
math_mod = require( "Module:Math" );
globalFrame = nil
coordinates = {};
--[[ Helper function, replacement for {{coord/display/title}} ]]
function displaytitle (s, notes)
local htmlTitle = mw.html.create('span')
:attr{ id = 'coordinates' }
:css( 'font-size', 'small' )
:node( "[[ጂኦግራፍያዊ መስተማእዛኒታት|መስተማእዛኒታት]]፦ " .. s .. notes )
local frame = mw.getCurrentFrame()
frame:extensionTag( 'indicator', tostring(htmlTitle), { name = 'coordinates' } )
return ''
end
--[[ Helper function, replacement for {{coord/display/inline}} ]]
function displayinline (s, notes)
return s .. notes
end
--[[ Helper function, used in detecting DMS formatting]]
local dmsTest = function(first, second)
local concatenated = first:upper() .. second:upper();
if concatenated == "NE" or concatenated == "NW" or concatenated == "SE" or concatenated == "SW" or
concatenated == "EN" or concatenated == "WN" or concatenated == "ES" or concatenated == "WS" or
concatenated == "NO" or concatenated == "SO" or concatenated == "ON" or concatenated == "OS" then
return true;
end
return false;
end
--[[
parseDec
Transform latitude and longitude into decimal format in the structure
used by the coordinate viewer
]]
function parseDec( lat, long, format )
local coordinateSpec = {}
local errors = {}
if long == "" or long == nil then
return nil, {{"parseDec", "ዝጠፍአ ዝንግሪር"}}
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, "ሰ", "ደ", mode) -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}
coordinateSpec["dms-long"] = convert_dec2dms( long, "ምብ", "ምዕ", mode) -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}
if format ~= "" then
coordinateSpec.default = format
else
coordinateSpec.default = "dec" -- by default the given format
end
return coordinateSpec, errors
end
--[[ Helper function, handle optional args. ]]
function optionalArg(arg, suplement)
if arg ~= nil and arg ~= "" then
return arg .. suplement
end
return ""
end
--[[
parseDMS
Transform the degrees, minutes and seconds format of latitude and longitude
in the structure to be used in coordinate display
]]
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 E, O position is 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 long_d == nil or long_d == "" then
table.insert(errors, {"parseDMS", "ዝጠፍአ ዝንግሪር" })
end
if lat_m == nil and lat_s == nil and long_m == nil and long_s == nil 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" -- address to display, except with 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
--[[
specPrinter
Output formatter. Takes the structure generated by either parseDec
or parseDMS and formats it for inclusion on Wikipedia.
]]
function specPrinter(args, coordinateSpec)
local uriComponents = coordinateSpec["param"]
if uriComponents == "" then
-- RETURN error, should never be empty or nil
return "ERROR: param was empty"
end
if coordinateSpec["name"] ~= "" and coordinateSpec["name"] ~= nil then
uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec["name"])
end
local geodmshtml = '<span class="geo-dms" title="ካርታታት፣ ስእልታትን ካልኦት ሓበሬታታትን ካብ ' .. coordinateSpec["dms-lat"] .. ' ' .. coordinateSpec["dms-long"] .. '">'
.. '<span class="latitude">'.. coordinateSpec["dms-lat"] .. ' </span>'
.. '<span class="longitude">'..coordinateSpec["dms-long"] .. '</span>'
.. '</span>'
local geodechtml = '<span class="geo-dec" title="ካርታታት፣ ስእልታትን ካልኦት ሓበሬታታትን ካብ ' .. coordinateSpec["dec-lat"] .. ' ' .. coordinateSpec["dec-long"] .. '">'
.. '<span class="geo">'
.. '<span class="latitude">' .. coordinateSpec["dec-lat"] .. ', </span>'
.. '<span class="longitude">' .. coordinateSpec["dec-long"] .. '</span>'
.. '</span></span>'
local inner;
inner = '<span class="' .. displayDefault(coordinateSpec["default"], "dms" ) .. '">' .. geodmshtml .. '</span>'
.. '<span class="geo-multi-punct"> / </span>'
.. '<span class="' .. displayDefault(coordinateSpec["default"], "dec" ) .. '">';
if coordinateSpec["name"] == "" or coordinateSpec["name"] == nil then
inner = inner .. geodechtml .. '</span>'
else
inner = inner .. '<span class="vcard">' .. geodechtml
.. '<span style="display:none"> (<span class="fn org">'
.. coordinateSpec["name"] .. '</span>)</span></span></span>'
end
--return '<span class="plainlinksneverexpand">'
return '<span class="plainlinks nourlexpansion">'.. globalFrame:preprocess(
'[http://tools.wmflabs.org/geohack/geohack.php?language=ti&pagename={{FULLPAGENAMEE}}¶ms=' ..
uriComponents .. ' ' .. inner .. ']') .. '</span>'
end
--http://tools.wmflabs.org/geohack/geohack.php?language=fr&pagename=Communaut%C3%A9_forale_de_Navarre¶ms=42.816666666667_N_1.65_W_type:city_globe:earth&title=
--[[
Formats any error messages generated for display
]]
function errorPrinter(errors)
local result = ""
for i,v in ipairs(errors) do
local errorHTML = '<small><strong class="error">መስተማእዛኒታት፦ ' .. v[2] .. '</strong></small>'
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
]]
function displayDefault(default, mode)
if default == "" then
default = "dec"
end
if default == mode then
return "geo-default"
else
return "geo-nondefault"
end
end
--[[
Check the input arguments for coord to determine the kind of data being provided
and then make the necessary processing.
]]
function formatTest(args)
local result, errors;
local primary = false;
if args[1] == "" then
-- no lat logic
return errorPrinter( {{"formatTest", "ዝጠፍአ ማእገር"}} )
elseif args[4] == "" and args[5] == "" and args[6] == "" then
-- dec logic
result, errors = parseDec( formatPunt(args[1]), formatPunt(args[2]), args['format'] )
if result == nil then
return errorPrinter( errors );
end
result.param = table.concat( {formatPunt(args[1]), "_N_", formatPunt(args[2]), "_E_", args[3] } );
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'] )
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] } , '_' );
if args[10] ~= '' then
table.insert( errors, { 'formatTest', 'Extra unexpected parameters' } );
end
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'] )
result.param = table.concat( { args[1], formatPunt(args[2]), args[3], args[4], formatPunt(args[5]),
formatLongW(args[6]), args[7] } , '_' );
if args[8] ~= '' then
table.insert( errors, { 'formatTest', 'Extra unexpected parameters' } );
end
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'] )
result.param = table.concat( { formatPunt(args[1]), args[2], formatPunt(args[3]), formatLongW(args[4]), args[5] } , '_' );
if args[6] ~= '' then
table.insert( errors, { 'formatTest', 'Extra unexpected parameters' } );
end
else
-- Error
return errorPrinter( {{"formatTest", "Unknown argument format"}} )
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] or '') ~= '' then
table.insert( errors, {'formatTest', 'Parameter: "' .. v .. '=" should be "' .. v .. ':"' } );
end
end
if #errors == 0 then
return specPrinter( args, result )
else
return specPrinter( args, result ) .. " " .. errorPrinter(errors) .. '[[Category:Pages with malformed coordinate tags]]';
end
end
--[[ Helper function to convert decimal point to decimal point ]]
function formatPunt(num)
return mw.ustring.gsub(num, ",", ".")
end
--[[ Helper function to convert length O to W ]]
function formatLongW(dir)
if dir:upper() == "O" then
return "W"
end
return dir
end
--[[
Helper function, convert latitude or longitude to decimal format
degrees, minutes, and seconds in a format based on the specified precision.
]]
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
--[[ Helper function, convert decimals to degrees ]]
function convert_dec2dms_d(coordinate)
local d = math_mod._round( coordinate, 0 ) .. "°"
return d .. ""
end
--[[ Helper function, convert decimals to degrees and minutes ]]
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 decimals to degrees, minutes and seconds ]]
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
--[[
Converts the DMS format with a N or E to decimal coordinates
]]
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
direction = mw.ustring.gsub(direction, '^[ ]*(.-)[ ]*$', '%1');
if direction == "N" or direction == "E" then
factor = 1
else
factor = -1
end
local precision = 0
if seconds_str ~= nil and seconds_str ~= '' then
precision = 5 + math.max( math_mod._precision(seconds_str), 0 );
elseif minutes_str ~= nil 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 on the number where the string is based.
end
--[[
Checks for input values and out of range errors.
]]
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, "Negative latitude and N direction"})
end
if long_d < 0 then
table.insert(errors, {source, "Negative latitude and E direction"})
end
--[[
#coordinates is conflicting as to whether this is a bug. If "globe" is
specified, it will not be an error in this condition, but otherwise it will be.
just for not disabling 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
--[[
dec2dms
Wrapper to allow templates to call dec2dms directly.
Usage:
{{ #Invoke:Coordinates | dec2dms | <decimal_coordinates> | <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.
]]
function coordinates.dec2dms(frame)
globalFrame = frame
local coordinate = frame.args[1]
local firstPostfix = frame.args[2]
local secondPostfix = frame.args[3]
local precision = frame.args[4]
return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)
end
--[[
Helper function to determine whether to use D, DM, or DMS format
in the "precision" function 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 indicator> | degress |
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).
]]
function coordinates.dms2dec(frame)
globalFrame = frame
local direction = frame.args[1]
local degrees = frame.args[2]
local minutes = frame.args[3]
local seconds = frame.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_direction> | <long> | <long_direction> }}
...
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}}.
]]
function coordinates.coord(frame)
globalFrame = frame
local args = frame.args
if args[1] == nil then
local pFrame = frame:getParent();
args = pFrame.args;
for k,v in pairs( frame.args ) do
args[k] = v;
end
end
for i=1,10 do
if args[i] == nil then
args[i] = ""
else
args[i] = args[i]:match( '^%s*(.-)%s*$' ); --remove blank spaces
end
end
args['format'] = args['ቅርጺ'] or args['format'] or '';
local contents = formatTest(args)
local Notes = args.notes or ""
local Display = string.lower(args.display or "inline")
if Display == '' then
Display = 'inline';
end
local text = ''
if string.find( Display, 'inline' ) ~= nil or Display == 'i' or
Display == 'it' or Display == 'ti' then
text = displayinline(contents, Notes)
end
if string.find( Display, 'title' ) ~= nil or Display == 't' or
Display == 'it' or Display == 'ti' then
text = text .. displaytitle(contents, Notes)
end
return text
end
function coordinates.coord2(frame)
globalFrame = frame.args.gf
local origArgs = {}
if frame == mw.getCurrentFrame() then
origArgs = frame:getParent().args
else
origArgs = frame.args
end
args = {}
for k, v in pairs(origArgs) do
args[k] = v
end
for i=1,10 do
if args[i] == nil then
args[i] = ""
else
args[i] = args[i]:match( '^%s*(.-)%s*$' ); --remove blank spaces
end
end
args['format'] = args['format'] or '';
local contents = formatTest(args)
local Notes = args.notes or ""
local Display = string.lower(args.display or "inline")
if Display == '' then
Display = 'inline';
end
local text = ''
if string.find( Display, 'inline' ) ~= nil or Display == 'i' or
Display == 'it' or Display == 'ti' then
text = displayinline(contents, Notes)
end
if string.find( Display, 'title' ) ~= nil or Display == 't' or
Display == 'it' or Display == 'ti' then
text = text .. displaytitle(contents, Notes)
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 result, negative = mw.text.split((mw.ustring.match(frame.args[1],'[%.%d]+°[NS] [%.%d]+°[EW]') or ''), ' ')
if frame.args[2] == 'lat' then
result, negative = result[1], 'S'
else
result, negative = result[2], 'W'
end
result = mw.text.split(result, '°')
if result[2] == negative then result[1] = '-'..result[1] end
return result[1]
else
return mw.ustring.match(frame.args[1], 'params=.-_'..frame.args[2]..':(.-)[ _]')
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[1], (mw.ustring.match(frame.args[i], '^(.-:)') or '')) then
frame.args[1] = mw.ustring.gsub(frame.args[1], '(params=.-)_? ', '%1_'..frame.args[i]..' ')
end
end
end
if frame.args.name then
if not mw.ustring.find(frame.args[1], '<span class="vcard">') then
local namestr = frame.args.name
frame.args[1] = mw.ustring.gsub(frame.args[1],
'(<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[1] = mw.ustring.gsub(frame.args[1], '(¶ms=[^&"<>%[%] ]*) ', '%1&title=' .. mw.uri.encode(namestr) .. ' ')
end
end
return frame.args[1]
end
return coordinates