Misplaced Pages

Module:Coordinates: Difference between revisions

Article snapshot taken from Wikipedia with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.
Browse history interactively← Previous editContent deleted Content added
Revision as of 04:14, 5 March 2013 view sourceDragons flight (talk | contribs)Edit filter managers, Extended confirmed users, Rollbackers, Template editors25,792 edits sane vars← Previous edit Latest revision as of 00:22, 31 May 2024 view source Pppery (talk | contribs)Interface administrators, Administrators101,025 edits Switch to template gadget category per request 
(141 intermediate revisions by 20 users not shown)
Line 1: Line 1:
--[[
-- A module that mimics the functionality of Template:Coord and its sub templates
This module is intended to replace the functionality of {{Coord}} and related
-- The attempt is to actually mimic a conversion of an often used en.wp template in the way
templates. It provides several methods, including
-- that most templates will actually be converted by the wiki users.
-- Attempt is not really to write a nice and proper module from scratch :D
local math_mod = require "Module:Math";
local wikitext = require "Module:Wikitext"


{{#invoke:Coordinates | coord }} : General function formatting and displaying
globalFrame = nil
coordinate values.
coordinates = {};


{{#invoke:Coordinates | dec2dms }} : Simple function for converting decimal
--- Replacement for {{coord/display/title}}
degree values to DMS format.
function displaytitle (s)

local l = "]: " .. s
{{#invoke:Coordinates | dms2dec }} : Simple function for converting DMS format
local co = mw.text.tag({name="span",contents=l,params={id="coordinates"}})
to decimal degree format.
local p = {}

p = "small"
{{#invoke:Coordinates | link }} : Export the link used to reach the tools
return mw.text.tag({name="span",contents=co,params=p})

end
]]

require('strict')

local math_mod = require("Module:Math")
local coordinates = {};
local isSandbox = mw.getCurrentFrame():getTitle():find('sandbox', 1, true);

local current_page = mw.title.getCurrentTitle()
local page_name = mw.uri.encode( current_page.prefixedText, 'WIKI' );
local coord_link = 'https://geohack.toolforge.org/geohack.php?pagename=' .. page_name .. '&params='


--- Replacement for {{coord/display/inline}} --]
local function displaytitle(coords)
function displayinline (s)
return mw.getCurrentFrame():extensionTag{
return s
name = 'indicator',
args = { name = 'coordinates' },
content = '<span id="coordinates">]: ' .. coords .. '</span>'
}
end end


--]
--- Test if the arguments imply that DMS might be in use
local dmsTest = function(first, second) local function dmsTest(first, second)
if type(first) ~= 'string' or type(second) ~= 'string' then
local concatenated = first .. second;
return nil
end
if concatenated == "NE" or concatenated == "NW" or concatenated == "SE" or concatenated == "SW" then
local s = (first .. second):upper()
return true;
return s:find('^$') or s:find('^$')
end
return false;
end end


--- Parse the frame assuming that it is in dec format.
-- @frame
-- @returns a table with all information needed to display coordinates
function parseDec( lat, long, spec, format )
local coordinateSpec = {}
local errors = {}
if long == "" or long == nil then
return nil, {{"parseDec", "Missing longitude"}}
end
coordinateSpec = lat;
coordinateSpec = long;


--]
local mode = coordinates.determineMode( lat, long );
local function makeInvokeFunc(funcName)
coordinateSpec = convert_dec2dms( lat, "N", "S", mode) -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}
return function (frame)
coordinateSpec = convert_dec2dms( long, "E", "W", mode) -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}
local args = require('Module:Arguments').getArgs(frame, {
coordinateSpec.param = lat .."_N_" .. long .. "_E_" .. spec
wrappers = 'Template:Coord'
})
if format ~= "" then
return coordinates(args, frame)
coordinateSpec.default = format
end
else
coordinateSpec.default = "dec"
end
-- TODO refactor the validations into separate functions
if (tonumber(lat) or 0) > 90 then
table.insert(errors, {"parseDec","latd>90"})
end
if (tonumber(lat) or 0) < -90 then
table.insert(errors, {"parseDec", "latd<-90"})
end
if (tonumber(long) or 0) >= 360 then
table.insert(errors, {"parseDec", "longd>=360"})
end
if (tonumber(long) or 0) <= -360 then
table.insert(errors, {"parseDec", "longd<=-360"})
end
return coordinateSpec, errors
end end


--]
function optionalArg(arg, suplement)
local function optionalArg(arg, supplement)
if arg ~= nil and arg ~= "" then
return arg .. suplement return arg and arg .. supplement or ''
end
return ""
end end


--[[
function isEmpty(arg)
Formats any error messages generated for display
if arg == nil or arg == "" then
]]
return true
local function errorPrinter(errors)
end
local result = ""
return false
for i,v in ipairs(errors) do
result = result .. '<strong class="error">Coordinates: ' .. v .. '</strong><br />'
end
return result
end end


--[[
function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format, spec )
Determine the required CSS class to display coordinates
local coordinateSpec = {}
local errors = {}
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}}}}}
-- TODO Use loop when we know it won't break everything
coordinateSpec.param = lat_d .. "_" .. lat_m .. "_" .. lat_s .. "_" .. lat_f .. "_".. long_d .. "_" .. long_m .. "_" .. long_s .. "_" .. long_f .. "_" .. spec
if format ~= "" then
coordinateSpec.default = format
else
coordinateSpec.default = "dms"
end


Usually geo-nondefault is hidden by CSS, unless a user has overridden this for himself
-- Error reporting
default is the mode as specificied by the user when calling the {{coord}} template
if isEmpty(args) then
mode is the display mode (dec or dms) that we will need to determine the css class for
table.insert(errors, {"parseDM", "Missing longitude" })
]]
end
local function displayDefault(default, mode)
if default == "" then
default = "dec"
end


if not isEmpty(args) then if default == mode then
return "geo-default"
table.insert(errors, {"parseDM", "Unexpected extra parameters"})
else
end
return "geo-nondefault"
end
if (tonumber(args) or 0) > 90 then
table.insert(errors, {"parseDMS", "latd>90"})
end
if (tonumber(args) or 0) < -90 then
table.insert(errors, {"parseDMS", "latd<-90"})
end
if (tonumber(args) or 0) >= 60 then
table.insert(errors, {"parseDMS", "latm>=60"})
end
if (tonumber(args) or 0) < 0 then
table.insert(errors, {"parseDMS", "latm<0"})
end
if (tonumber(args) or 0) >= 60 then
table.insert(errors, {"parseDMS", "lats>=60"})
end
if (tonumber(args) or 0) < 0 then
table.insert(errors, {"parseDMS", "lats<0"})
end
if (tonumber(args) or 0) >= 360 then
table.insert(errors, {"parseDMS", "longd>=360"})
end
if (tonumber(args) or 0) <= -360 then
table.insert(errors, {"parseDMS", "longd<=-360"})
end
if (tonumber(args) or 0) >= 60 then
table.insert(errors, {"parseDMS", "longm>=60"})
end
if (tonumber(args) or 0) < 0 then
table.insert(errors, {"parseDMS", "longm<0"})
end
if (tonumber(args) or 0) >= 60 then
table.insert(errors, {"parseDMS", "longs>=60"})
end
if (tonumber(args) or 0) < 0 then
table.insert(errors, {"parseDMS", "longs<0"})
end

return coordinateSpec, errors
end end


--[[
function parseDM(args)
specPrinter
local coordinateSpec = {}
local errors = {}


Output formatter. Takes the structure generated by either parseDec
coordinateSpec = args.."°"..optionalArg(args,"′") .. args
or parseDMS and formats it for inclusion on Misplaced Pages.
coordinateSpec = args.."°"..optionalArg(args,"′") .. args
]]
coordinateSpec = convert_dms2dec(args,args,args) -- {{coord/dms2dec|{{{3}}}|{{{1}}}|0{{{2}}}}}
local function specPrinter(args, coordinateSpec)
coordinateSpec = convert_dms2dec(args,args,args) -- {{coord/dms2dec|{{{6}}}|{{{4}}}|0{{{5}}}}}
local uriComponents = coordinateSpec
-- TODO Use loop when we know it won't break everything
if uriComponents == "" then
coordinateSpec.param = args .. "_" .. args .. "_" .. args .. "_" .. args .. "_".. args .. "_" .. args .. "_" .. args
-- RETURN error, should never be empty or nil
if args ~= "" then
return "ERROR param was empty"
coordinateSpec.default = args
end
else
if args then
coordinateSpec.default = "dms"
uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec)
end
end
coordinateSpec.name = args
-- Error reporting
if isEmpty(args) then
table.insert(errors, {"parseDM", "Missing longitude" })
end


local geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">'
if not (isEmpty(args) and isEmpty(args) and isEmpty(args)) then
.. '<span class="latitude">' .. coordinateSpec .. '</span> '
table.insert(errors, {"parseDM", "Unexpected extra parameters"})
.. '<span class="longitude">' ..coordinateSpec .. '</span>'
end
.. '</span>'


if (tonumber(args) or 0) > 90 then local lat = tonumber( coordinateSpec ) or 0
local geodeclat
table.insert(errors, {"parseDM", "latd>90"})
end if lat < 0 then
-- FIXME this breaks the pre-existing precision
if (tonumber(args) or 0) < -90 then
geodeclat = tostring(coordinateSpec):sub(2) .. "°S"
table.insert(errors, {"parseDM", "latd<-90"})
else
end
if (tonumber(args) or 0) >= 60 then geodeclat = (coordinateSpec or 0) .. "°N"
end
table.insert(errors, {"parseDM", "latm>=60"})
end
if (tonumber(args) or 0) < 0 then
table.insert(errors, {"parseDM", "latm<0"})
end
if (tonumber(args) or 0) >= 360 then
table.insert(errors, {"parseDM", "longd>=360"})
end
if (tonumber(args) or 0) <= -360 then
table.insert(errors, {"parseDM", "longd<=-360"})
end
if (tonumber(args) or 0) >= 60 then
table.insert(errors, {"parseDM", "longm>=60"})
end
if (tonumber(args) or 0) < 0 then
table.insert(errors, {"parseDM", "longm<0"})
end
return coordinateSpec, errors
end


local long = tonumber( coordinateSpec ) or 0
function parseD(args)
local coordinateSpec = {} local geodeclong
if long < 0 then
local errors = {}
-- 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">'
coordinateSpec = args
.. geodeclat .. ' '
if args =="S" then
.. geodeclong
coordinateSpec = "-" .. coordinateSpec
.. '</span>'
end
coordinateSpec = args
if args =="W" then
coordinateSpec = "-" .. coordinateSpec
end
coordinateSpec = args .. "°" .. args
coordinateSpec = args .. "°" .. args
local function postfixInverter(NE, latlong)
if NE == "N" and latlong == "lat" then
return "S"
elseif NE == "E" and latlong == "long" then
return "W"
elseif latlong == "lat" then
return "N"
else
return "E"
end
end


local geonumhtml = '<span class="geo">'
local mode = coordinates.determineMode( args, args )
.. coordinateSpec .. '; '
coordinateSpec = convert_dec2dms(args, args, postfixInverter(args,"lat"), mode) -- {{coord/dec2dms|{{{1}}}|{{{2}}}|{{#ifeq:{{{2}}}|N|S|N}}|{{coord/prec dec|{{{1}}}|{{{3}}}}}}}
.. coordinateSpec
coordinateSpec = convert_dec2dms(args, args, postfixInverter(args,"long"), mode) -- {{coord/dec2dms|{{{3}}}|{{{4}}}|{{#ifeq:{{{4}}}|E|W|E}}|{{coord/prec dec|{{{1}}}|{{{3}}}}}}}
.. '</span>'


local inner = '<span class="' .. displayDefault(coordinateSpec, "dms" ) .. '">' .. geodmshtml .. '</span>'
-- TODO Use loop when we know it won't break everything
.. '<span class="geo-multi-punct">&#xfeff; / &#xfeff;</span>'
coordinateSpec.param = args .. "_" .. args .. "_" .. args .. "_" .. args .. "_".. args
.. '<span class="' .. displayDefault(coordinateSpec, "dec" ) .. '">';
if args ~= "" then
coordinateSpec.default = args
else
-- {{#ifeq:{{coord/prec dec|{{{1}}}|{{{3}}}}}|d|dms|dec}}
if precision == "d" then
coordinateSpec.default = "dms"
else
coordinateSpec.default = "dec"
end
end
coordinateSpec.name = args
-- Error reporting
if isEmpty(args) then
table.insert(errors, {"parseD", "Missing longitude" })
args = 0 -- to avoid error in tonumber() later on
end


if not args then
if not (isEmpty(args) and isEmpty(args) and isEmpty(args) and isEmpty(args) and isEmpty(args)) then
inner = inner .. geodechtml
table.insert(errors, {"parseD", "Unexpected extra parameters"})
.. '<span style="display:none">&#xfeff; / ' .. geonumhtml .. '</span></span>'
end
else
inner = inner .. '<span class="vcard">' .. geodechtml
.. '<span style="display:none">&#xfeff; / ' .. geonumhtml .. '</span>'
.. '<span style="display:none">&#xfeff; (<span class="fn org">'
.. args .. '</span>)</span></span></span>'
end


local stylesheetLink = 'Module:Coordinates' .. ( isSandbox and '/sandbox' or '' ) .. '/styles.css'
if (tonumber(args) or 0) > 90 then
return mw.getCurrentFrame():extensionTag{
table.insert(errors, {"parseD", "latd>90"})
name = 'templatestyles', args = { src = stylesheetLink }
end
} .. '<span class="plainlinks nourlexpansion">[' .. coord_link .. uriComponents ..
if (tonumber(args) or 0) < -90 then
' ' .. inner .. ']</span>' .. ']'
table.insert(errors, {"parseD", "latd<-90"})
end
if (tonumber(args) or 0) >= 360 then
table.insert(errors, {"parseD", "longd>=360"})
end
if (tonumber(args) or 0) <= -360 then
table.insert(errors, {"parseD", "longd<=-360"})
end

return coordinateSpec, errors
end end


--]
--- BAD BAD URL escape
local function convert_dec2dms_d(coordinate)
-- replace this later with the actual helper template
local d = math_mod._round( coordinate, 0 ) .. "°"
function urlEscape(arg)
return d .. ""
return arg:gsub("%s+", '%%20'):gsub("%<", "%%3C"):gsub("%>", "%%3E")
end end


--- A function that prints a table of coordinate specifications to HTML --]
local function convert_dec2dms_dm(coordinate)
function specPrinter(args, coordinateSpec)
coordinate = math_mod._round( coordinate * 60, 0 );
local uriComponents = coordinateSpec
local m = coordinate % 60;
if uriComponents == "" then
coordinate = math.floor( (coordinate - m) / 60 );
-- RETURN error, should never be empty or nil
local d = coordinate % 360 .."°"
return "ERROR param was empty"
end
if args ~= "" and args ~= nil then
uriComponents = uriComponents .. "&title=" .. urlEscape(coordinateSpec)
end
-- TODO i18n
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>'


return d .. string.format( "%02d′", m )
local geodeclat = coordinateSpec
if geodeclat == nil then
local lat = tonumber( coordinateSpec ) or 0
if lat < 0 then
-- FIXME this breaks the pre-existing precision
geodeclat = coordinateSpec:sub(2) .. "°S"
else
geodeclat = (coordinateSpec or 0) .. "°N"
end
end
-- FIXME ugly code duplication, but lazy :D
local geodeclong = coordinateSpec
if geodeclong == nil then
local long = tonumber( coordinateSpec ) or 0
if long < 0 then
-- FIXME does not handle unicode minus
geodeclong = coordinateSpec:sub(2) .. "°W"
else
geodeclong = (coordinateSpec or 0) .. "°E"
end
end
-- TODO requires DEC formatting
-- TODO requires vcard
local geodechtml = '<span class="geo-dec" title="Maps, aerial photos, and other data for this location">'
.. '<span class="latitude">' .. geodeclat .. '</span> '
.. '<span class="longitude">' .. geodeclong .. '</span>'
.. '</span>'
local inner = '<span class="' .. displayDefault(coordinateSpec, "dms" ) .. '">' .. geodmshtml .. '</span>'
.. '<span class="geo-multi-punct">&#xfeff; / &#xfeff;</span>'
.. '<span class="' .. displayDefault(coordinateSpec, "dec" ) .. '">' .. geodechtml .. '</span>'
return '<span class="plainlinks nourlexpansion">' .. globalFrame:preprocess('') .. '</span>'
end end


--]
function errorPrinter(errors)
local function convert_dec2dms_dms(coordinate)
local result = ""
coordinate = math_mod._round( coordinate * 60 * 60, 0 );
for i,v in ipairs(errors) do
local s = coordinate % 60
local errorHTML = '<strong class="error">' .. v .. ' in Module:Coordinates.' .. v .."()" .. '</strong>'
coordinate = math.floor( (coordinate - s) / 60 );
result = result .. errorHTML .. "<br />"
local m = coordinate % 60
end
coordinate = math.floor( (coordinate - m) / 60 );
return result
local d = coordinate % 360 .."°"
end


return d .. string.format( "%02d′", m ) .. string.format( "%02d″", s )
--- 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 end


--[[
--- Check the arguments to determine what type of coordinates has been input
Helper function, convert decimal latitude or longitude to
function formatTest(args)
degrees, minutes, and seconds format based on the specified precision.
local result, errors;
]]
local function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)
if args == "" then
local coord = tonumber(coordinate)
-- no lat logic
local postfix
return errorPrinter( {{"formatTest", "Missing latitude"}} )
if coord >= 0 then
elseif args == "" and args == "" and args == "" then
postfix = firstPostfix
-- dec logic
else
result, errors = parseDec( args, args, args, args )
postfix = secondPostfix
elseif dmsTest(args, args) then
end
-- dms logic

result, errors = parseDMS(args)
precision = precision:lower();
elseif dmsTest(args, args) then
if precision == "dms" then
-- dm logic
return convert_dec2dms_dms( math.abs( coord ) ) .. postfix;
result, errors = parseDM(args)
elseif precision == "dm" then
elseif dmsTest(args, args) then
return convert_dec2dms_dm( math.abs( coord ) ) .. postfix;
-- d logic
elseif precision == "d" then
result, errors = parseD(args)
return convert_dec2dms_d( math.abs( coord ) ) .. postfix;
else
end
-- Error
return errorPrinter( {{"formatTest", "Unknown argument format"}} )
end
result.name = args
return specPrinter( args, result ) .. " " .. errorPrinter(errors)
end end


--[[
function convert_dec2dms_d(coordinate)
local d = math_mod._round( coordinate, 0 ) .. "°" Convert DMS format into a N or E decimal coordinate
]]
return d .. ""
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 end


--[[
function convert_dec2dms_dm(coordinate)
Checks input values to for out of range errors.
-- {{#expr:{{{1}}} mod 360}}°{{padleft:{{#expr:({{{1}}} * 600 round 0) mod 600 / 10 round 0}}|2|0}}′
]]
local d = math.floor(coordinate % 360) .."°"
local function validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, source, strong )
local m = string.format( "%02d′", math_mod._round( math_mod._round(coordinate * 600, 0) % 600 / 10, 0 ) )
local errors = {};
lat_d = tonumber( lat_d ) or 0;
return d .. m
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 end


--[[
function convert_dec2dms_dms(coordinate)
parseDec
--{{#expr:(((({{{1|0}}}) * 3600) round 0) / 3600) mod 360}}°{{padleft:{{#expr:(((3600 * ({{{1|0}}})) round 0) / 60) mod 60}}|2|0}}′{{padleft:{{#expr:((360000 * ({{{1|0}}})) round -2) mod 6000 div 100}}|2|0}}″
local d = math.floor(coordinate % 360) .. "°"
local m = string.format( "%02d′", math.floor(60 * coordinate) % 60 )
local s = string.format( "%02d″", (math_mod._round( 360000 * coordinate, -2 ) % 6000) / 100 )


Transforms decimal format latitude and longitude into the
return d .. m .. s
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 end


--[[
--- Convert a latitude or longitude to the DMS format
parseDMS
function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)
-- {{Coord/dec2dms/{{{4}}}|{{#ifexpr:{{{1}}} >= 0||-}}{{{1}}}}}{{#ifexpr:{{{1}}} >= 0|{{{2}}}|{{{3}}}}}
local coord = tonumber(coordinate) or 0
local postfix
if coord >= 0 then
postfix = firstPostfix
else
postfix = secondPostfix
end


Transforms degrees, minutes, seconds format latitude and longitude
if precision == "dms" then
into the a structure to be used in displaying coordinates
return convert_dec2dms_dms( math.abs( coord ) ) .. postfix;
]]
elseif precision == "dm" then
local function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format )
return convert_dec2dms_dm( math.abs( coord ) ) .. postfix;
local coordinateSpec, errors, backward = {}, {}
elseif precision == "d" then

return convert_dec2dms_d( math.abs( coord ) ) .. postfix;
lat_f = lat_f:upper();
end
long_f = long_f:upper();

-- return "" .. globalFrame:expandTemplate{ title = 'coord/dec2dms', args = {coordinate, firstPostfix, secondPostfix, precision}}
-- 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 end


--[[
--- Convert DMS into a N or E decimal coordinate
Check the input arguments for coord to determine the kind of data being provided
-- @param coordinate direction. either "N" "S" "E" or "W"
and then make the necessary processing.
-- @param degrees: string or number
]]
-- @param minutes: string or number
local function formatTest(args)
-- @param seconds: string or number
local result, errors
-- @return a number with the N or E normalized decimal coordinate of the input
local backward, primary = false, false
function convert_dms2dec(direction, degrees_str, minutes_str, seconds_str)

local degrees = tonumber(degrees_str) or 0
local function getParam(args, lim)
local minutes = tonumber(minutes_str) or 0
local ret = {}
local seconds = tonumber(seconds_str) or 0
for i = 1, lim do
-- {{#expr:{{#switch:{{{1}}}|N|E=1|S|W=-1}}*({{{2|0}}}+({{{3|0}}}+{{{4|0}}}/60)/60) round {{{precdec|{{#if:{{{4|}}}|5|{{#if:{{{3|}}}|3|0}}}}+{{precision1|{{{4|{{{3|{{{2}}}}}}}}}}}}}}}}
ret = args or ''
end
local factor
return table.concat(ret, '_')
if direction == "N" or direction == "E" then
end
factor = 1

else
if not args then
factor = -1
-- no lat logic
end
return errorPrinter( {{"formatTest", "Missing latitude"}} )
elseif not tonumber(args) then
local precision = 0
-- bad lat logic
if not isEmpty(seconds_str) then
return errorPrinter( {{"formatTest", "Unable to parse latitude as a number:" .. args}} )
precision = 5 + math_mod._precision(seconds_str)
elseif not isEmpty(minutes_str) then elseif not args and not args and not args then
-- dec logic
precision = 3 + math_mod._precision(minutes_str)
result, errors = parseDec(args, args, args.format)
else
if not result then
precision = math_mod._precision(degrees_str)
return errorPrinter(errors);
end
end
-- formatting for geohack: geohack expects D_N_D_E notation or D;D notation
-- nil -> 0
-- wikiminiatlas doesn't support D;D notation
local decimal = factor * (degrees+(minutes+seconds/60)/60)
-- #coordinates parserfunction doesn't support negative decimals with NSWE
return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based.
result.param = table.concat({
math.abs(tonumber(args)),
--return "" .. globalFrame:expandTemplate{ title = 'coord/dms2dec', args = {direction, degrees, minutes, seconds}}
((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 end


--[[
--- TODO not yet in use
Generate Wikidata tracking categories.
function validateDegreesLatitude(degrees)
]]
if 0+tonumber(degrees) > 90 then
local function makeWikidataCategories(qid)
return "latd>90"
local ret
end
local qid = qid or mw.wikibase.getEntityIdForCurrentPage()
if 0+tonumber(degrees) < -90 then
if mw.wikibase and current_page.namespace == 0 then
return "latd<-90"
if qid and mw.wikibase.entityExists(qid) and mw.wikibase.getBestStatements(qid, "P625") and mw.wikibase.getBestStatements(qid, "P625") then
end
local snaktype = mw.wikibase.getBestStatements(qid, "P625").mainsnak.snaktype
return true
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 end


--[[
--- TODO not yet in use
link
function validateDegreesLongtitude(degrees)

if 0+tonumber(degrees) >= 360 then
Simple function to export the coordinates link for other uses.
return "longd>=360"

end
Usage:
if 0+tonumber(degrees) <= -360 then
{{#invoke:Coordinates | link }}
return "longd<=-360"

end
]]
return true
function coordinates.link(frame)
return coord_link;
end end


--[[
--- TODO not yet in use
dec2dms
function validateMinutes(minutes)

if 0+tonumber(minutes) >= 60 then
Wrapper to allow templates to call dec2dms directly.
return "m>=60"

end
Usage:
if 0+tonumber(minutes) < 0 then
{{#invoke:Coordinates | dec2dms | decimal_coordinate | positive_suffix |
return "m<0"
negative_suffix | precision }}
end

return true
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 end


--[[
--- TODO not yet in use
Helper function to determine whether to use D, DM, or DMS
function validateSeconds(seconds)
format depending on the precision of the decimal input.
if 0+tonumber(seconds) >= 60 then
]]
return "s>=60"
function coordinates.determineMode( value1, value2 )
end
local precision = math.max( math_mod._precision( value1 ), math_mod._precision( value2 ) );
if 0+tonumber(seconds) < 0 then
if precision <= 0 then
return "s<0"
return 'd'
end
elseif precision <= 2 then
return true
return 'dm';
else
return 'dms';
end
end end


--[[
--- The display function we exposed to Module:Coordinates
dms2dec
function coordinates.input(frame)

globalFrame = frame;
Wrapper to allow templates to call dms2dec directly.
return formatTest(frame.args)

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 end


--[[
--- The dec2dms function exposed to Module:Coordinates
coord
function coordinates.dec2dms(frame)
globalFrame = frame
local coordinate = frame.args
local firstPostfix = frame.args
local secondPostfix = frame.args
local precision = frame.args


Main entry point for Lua function to replace {{coord}}
return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)

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'

-- it and ti are short for inline,title and title,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 .. '<span class="geo-inline">' .. contents .. Notes .. '</span>'
end
if isInTitle(Display) then
-- Add to output since indicator content is invisible to Lua later on
if not isInline(Display) then
text = text .. '<span class="geo-inline-hidden noexcerpt">' .. contents .. Notes .. '</span>'
end
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 end


--[[
function coordinates.determineMode( value1, value2 )
coord2text
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


Extracts a single value from a transclusion of {{Coord}}.
--- The dec2dms function exposed to Module:Coordinates
IF THE GEOHACK LINK SYNTAX CHANGES THIS FUNCTION MUST BE MODIFIED.
function coordinates.dms2dec(frame)
globalFrame = frame
local direction = frame.args
local degrees = frame.args
local minutes = frame.args
local seconds = frame.args


Usage:
return convert_dms2dec(direction, degrees, minutes, seconds)

{{#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(coord,type)
if coord == '' or type == '' or not type then return nil end
type = mw.text.trim(type)
if type == 'lat' or type == 'long' then
local result, negative = mw.text.split((mw.ustring.match(coord,'+° +°') or ''), ' ')
if type == '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(coord, 'params=.-_' .. type .. ':(.-)')
end
end end


function coordinates.coord2text(frame)
--- This is used by {{coord}}.
function coordinates.coord(frame) return coordinates._coord2text(frame.args,frame.args)
end
globalFrame = frame

local args = frame.args
--[[
for i=1,10 do
coordinsert
if ( nil == args ) then args = "" end

end
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}}.
args = args or '';
IF THE GEOHACK LINK SYNTAX CHANGES THIS FUNCTION MUST BE MODIFIED.

local contents = formatTest(args)
Usage:
local Notes = args.notes or ""

local Display = args.display or "inline"
{{#invoke:Coordinates | coordinsert | {{Coord}} | parameter:value | parameter:value | … }}
local text

if ( "title" ~= Display ) then
Do not make Geohack unhappy by inserting something which isn't mentioned in the {{Coord}} documentation.
text = displayinline(contents)

else
]]
text = displaytitle(contents)
function coordinates.coordinsert(frame)
end
-- for the 2nd or later integer parameter (the first is the coord template, as above)
return text .. Notes
for i, v in ipairs(frame.args) do
if i ~= 1 then
-- if we cannot find in the coord_template the i_th coordinsert parameter e.g. region
if not mw.ustring.find(frame.args, (mw.ustring.match(frame.args, '^(.-:)') or '')) then
-- find from the params= up to the first possibly-present underscore
-- and append the i_th coordinsert parameter and a space
-- IDK why we're adding a space but it does seem somewhat convenient
frame.args = mw.ustring.gsub(frame.args, '(params=.-)_? ', '%1_'..frame.args..' ')
end
end
end
if frame.args.name then
-- if we can't find the vcard class
if not mw.ustring.find(frame.args, '<span class="vcard">') then
-- take something that looks like a coord template and add the vcard span with class and fn org class
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">&#xfeff; (<span class="fn org">' .. namestr .. '</span>)</span></span>%3'
)
-- then find anything from coordinates parameters to the 'end' and attach the title parameter
frame.args = mw.ustring.gsub(
frame.args,
'(&params= ]*) ',
'%1&title=' .. mw.uri.encode(namestr) .. ' '
)
end
end
-- replace the existing indicator with a new indicator using the modified content
frame.args = mw.ustring.gsub(
frame.args,
'(<span class="geo%-inline*">(.+)</span>)\127*UNIQ%-%-indicator%-%x+%-%-?QINU*\127',
function (inline, coord) return inline .. displaytitle(coord) end
)

return frame.args
end end



Latest revision as of 00:22, 31 May 2024

Module documentation[view] [edit] [history] [purge]
WarningThis 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.
ProtectedThis 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:
CSSThis 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}} → 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

Tracking categories

The above documentation is transcluded from Module:Coordinates/doc. (edit | history)
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('strict')

local math_mod = require("Module:Math")
local coordinates = {};
local isSandbox = mw.getCurrentFrame():getTitle():find('sandbox', 1, true);

local current_page = mw.title.getCurrentTitle()
local page_name = mw.uri.encode( current_page.prefixedText, 'WIKI' );
local coord_link = 'https://geohack.toolforge.org/geohack.php?pagename=' .. page_name .. '&params='

--]
local function displaytitle(coords)
	return mw.getCurrentFrame():extensionTag{
		name = 'indicator',
		args = { name = 'coordinates' },
		content = '<span id="coordinates">]: ' .. coords .. '</span>'
	}
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
		result = result .. '<strong class="error">Coordinates: ' .. v .. '</strong><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">&#xfeff; / &#xfeff;</span>'
				.. '<span class="' .. displayDefault(coordinateSpec, "dec" ) .. '">';

	if not args then
		inner = inner .. geodechtml
				.. '<span style="display:none">&#xfeff; / ' .. geonumhtml .. '</span></span>'
	else
		inner = inner .. '<span class="vcard">' .. geodechtml
				.. '<span style="display:none">&#xfeff; / ' .. geonumhtml .. '</span>'
				.. '<span style="display:none">&#xfeff; (<span class="fn org">'
				.. args .. '</span>)</span></span></span>'
	end

    local stylesheetLink = 'Module:Coordinates' .. ( isSandbox and '/sandbox' or '' ) .. '/styles.css'
	return mw.getCurrentFrame():extensionTag{
		name = 'templatestyles', args = { src = stylesheetLink }
	} .. '<span class="plainlinks nourlexpansion">[' .. coord_link .. uriComponents ..
	' ' .. inner .. ']</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
	local qid = qid or mw.wikibase.getEntityIdForCurrentPage()
	if mw.wikibase and current_page.namespace == 0 then
		if qid and mw.wikibase.entityExists(qid) and mw.wikibase.getBestStatements(qid, "P625") and mw.wikibase.getBestStatements(qid, "P625") then
			local snaktype = mw.wikibase.getBestStatements(qid, "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'

	-- it and ti are short for inline,title and title,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 .. '<span class="geo-inline">' .. contents .. Notes .. '</span>'
	end
	if isInTitle(Display) then
		-- Add to output since indicator content is invisible to Lua later on
		if not isInline(Display) then
			text = text .. '<span class="geo-inline-hidden noexcerpt">' .. contents .. Notes .. '</span>'
		end
		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(coord,type)
	if coord == '' or type == '' or not type then return nil end
	type = mw.text.trim(type)
	if type == 'lat' or type == 'long' then
		local result, negative = mw.text.split((mw.ustring.match(coord,'+° +°') or ''), ' ')
		if type == '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(coord, 'params=.-_' .. type .. ':(.-)')
	end
end

function coordinates.coord2text(frame)
	return coordinates._coord2text(frame.args,frame.args)
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 the 2nd or later integer parameter (the first is the coord template, as above)
	for i, v in ipairs(frame.args) do
		if i ~= 1 then
			-- if we cannot find in the coord_template the i_th coordinsert parameter e.g. region
			if not mw.ustring.find(frame.args, (mw.ustring.match(frame.args, '^(.-:)') or '')) then
				-- find from the params= up to the first possibly-present underscore
				-- and append the i_th coordinsert parameter and a space
				-- IDK why we're adding a space but it does seem somewhat convenient
				frame.args = mw.ustring.gsub(frame.args, '(params=.-)_? ', '%1_'..frame.args..' ')
			end
		end
	end
	if frame.args.name then
		-- if we can't find the vcard class
		if not mw.ustring.find(frame.args, '<span class="vcard">') then
			-- take something that looks like a coord template and add the vcard span with class and fn org class
			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">&#xfeff; (<span class="fn org">' .. namestr .. '</span>)</span></span>%3'
			)
			-- then find anything from coordinates parameters to the 'end' and attach the title parameter
			frame.args = mw.ustring.gsub(
				frame.args,
				'(&params= ]*) ',
				'%1&title=' .. mw.uri.encode(namestr) .. ' '
			)
		end
	end
	
	-- replace the existing indicator with a new indicator using the modified content
	frame.args = mw.ustring.gsub(
		frame.args,
		'(<span class="geo%-inline*">(.+)</span>)\127*UNIQ%-%-indicator%-%x+%-%-?QINU*\127',
		function (inline, coord) return inline .. displaytitle(coord) end
	)

	return frame.args
end

return coordinates
Categories: