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 00:11, 24 December 2013 view sourceMr. Stradivarius (talk | contribs)Edit filter managers, Administrators59,191 edits only add Wikidata categories if coordinates are displayed in the title← Previous edit Latest revision as of 00:22, 31 May 2024 view source Pppery (talk | contribs)Interface administrators, Administrators101,023 edits Switch to template gadget category per request 
(46 intermediate revisions by 19 users not shown)
Line 3: Line 3:
templates. It provides several methods, including templates. It provides several methods, including


{{#Invoke:Coordinates | coord }} : General function formatting and displaying {{#invoke:Coordinates | coord }} : General function formatting and displaying
coordinate values. coordinate values.


{{#Invoke:Coordinates | dec2dms }} : Simple function for converting decimal {{#invoke:Coordinates | dec2dms }} : Simple function for converting decimal
degree values to DMS format. degree values to DMS format.


{{#Invoke:Coordinates | dms2dec }} : Simple function for converting DMS format {{#invoke:Coordinates | dms2dec }} : Simple function for converting DMS format
to decimal degree format. to decimal degree format.


{{#Invoke:Coordinates | link }} : Export the link used to reach the tools {{#invoke:Coordinates | link }} : Export the link used to reach the tools


]] ]]


math_mod = require( "Module:Math" ); require('strict')
globalFrame = nil
coordinates = {};


local math_mod = require("Module:Math")
current_page = mw.title.getCurrentTitle()
local coordinates = {};
page_name = mw.uri.encode( current_page.prefixedText, 'WIKI' );
local isSandbox = mw.getCurrentFrame():getTitle():find('sandbox', 1, true);
coord_link = '//tools.wmflabs.org/geohack/geohack.php?pagename=' .. page_name .. '&params='

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='


--] --]
function displaytitle (s, notes) local function displaytitle(coords)
return mw.getCurrentFrame():extensionTag{
local l = "]: " .. s
name = 'indicator',
local co = '<span id="coordinates">' .. l .. notes .. '</span>';
args = { name = 'coordinates' },
return '<span style="font-size: small;">' .. co .. '</span>';
content = '<span id="coordinates">]: ' .. coords .. '</span>'
end
}

--]
function displayinline (s, notes)
return s .. notes
end end


--] --]
local dmsTest = function(first, second) local function dmsTest(first, second)
if type(first) ~= 'string' or type(second) ~= 'string' then
local concatenated = first:upper() .. second:upper();
return nil
if concatenated == "NE" or concatenated == "NW" or concatenated == "SE" or concatenated == "SW" or
concatenated == "EN" or concatenated == "WN" or concatenated == "ES" or concatenated == "WS" then
return true;
end end
local s = (first .. second):upper()
return false;
return s:find('^$') or s:find('^$')
end end


--[[
parseDec


--]
Transforms decimal format latitude and longitude into the a
local function makeInvokeFunc(funcName)
structure to be used in displaying coordinates
return function (frame)
]]
local args = require('Module:Arguments').getArgs(frame, {
function parseDec( lat, long, format )
wrappers = 'Template:Coord'
local coordinateSpec = {}
})
local errors = {}
return coordinates(args, frame)
if long == "" or long == nil then
return nil, {{"parseDec", "Missing longitude"}}
end end
end
errors = validate( lat, nil, nil, long, nil, nil, 'parseDec', false );
coordinateSpec = lat;
coordinateSpec = long;


--]
local mode = coordinates.determineMode( lat, long );
local function optionalArg(arg, supplement)
coordinateSpec = convert_dec2dms( lat, "N", "S", mode) -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}
return arg and arg .. supplement or ''
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


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


--[[ --[[
Determine the required CSS class to display coordinates
parseDMS


Usually geo-nondefault is hidden by CSS, unless a user has overridden this for himself
Transforms degrees, minutes, seconds format latitude and longitude
default is the mode as specificied by the user when calling the {{coord}} template
into the a structure to be used in displaying coordinates
mode is the display mode (dec or dms) that we will need to determine the css class for
]] ]]
local function displayDefault(default, mode)
function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format )
if default == "" then
local coordinateSpec = {}
default = "dec"
local errors = {}
lat_f = lat_f:upper();
long_f = long_f:upper();
-- Check if specified backward
if lat_f == 'E' or lat_f == 'W' 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", "Missing longitude" })
end 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' 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 if default == mode then
coordinateSpec.default = format return "geo-default"
else else
return "geo-nondefault"
coordinateSpec.default = "dms"
end end

return coordinateSpec, errors
end end


Line 154: Line 96:
or parseDMS and formats it for inclusion on Misplaced Pages. or parseDMS and formats it for inclusion on Misplaced Pages.
]] ]]
function specPrinter(args, coordinateSpec) local function specPrinter(args, coordinateSpec)
local uriComponents = coordinateSpec local uriComponents = coordinateSpec
if uriComponents == "" then if uriComponents == "" then
Line 160: Line 102:
return "ERROR param was empty" return "ERROR param was empty"
end end
if args ~= "" and args ~= nil then if args then
uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec) uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec)
end end

local geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">' local geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">'
.. '<span class="latitude">' .. coordinateSpec .. '</span> ' .. '<span class="latitude">' .. coordinateSpec .. '</span> '
.. '<span class="longitude">' ..coordinateSpec .. '</span>' .. '<span class="longitude">' ..coordinateSpec .. '</span>'
.. '</span>' .. '</span>'


local lat = tonumber( coordinateSpec ) or 0 local lat = tonumber( coordinateSpec ) or 0
local geodeclat
if lat < 0 then if lat < 0 then
-- FIXME this breaks the pre-existing precision -- FIXME this breaks the pre-existing precision
geodeclat = coordinateSpec:sub(2) .. "°S" geodeclat = tostring(coordinateSpec):sub(2) .. "°S"
else else
geodeclat = (coordinateSpec or 0) .. "°N" geodeclat = (coordinateSpec or 0) .. "°N"
Line 178: Line 121:


local long = tonumber( coordinateSpec ) or 0 local long = tonumber( coordinateSpec ) or 0
local geodeclong
if long < 0 then if long < 0 then
-- FIXME does not handle unicode minus -- FIXME does not handle unicode minus
geodeclong = coordinateSpec:sub(2) .. "°W" geodeclong = tostring(coordinateSpec):sub(2) .. "°W"
else else
geodeclong = (coordinateSpec or 0) .. "°E" geodeclong = (coordinateSpec or 0) .. "°E"
end end

local geodechtml = '<span class="geo-dec" title="Maps, aerial photos, and other data for this location">' local geodechtml = '<span class="geo-dec" title="Maps, aerial photos, and other data for this location">'
.. geodeclat .. ' ' .. geodeclat .. ' '
.. geodeclong .. geodeclong
.. '</span>' .. '</span>'


local geonumhtml = '<span class="geo">' local geonumhtml = '<span class="geo">'
.. coordinateSpec .. '; ' .. coordinateSpec .. '; '
.. coordinateSpec .. coordinateSpec
.. '</span>' .. '</span>'


local inner = '<span class="' .. displayDefault(coordinateSpec, "dms" ) .. '">' .. geodmshtml .. '</span>'
local inner;
inner = '<span class="' .. displayDefault(coordinateSpec, "dms" ) .. '">' .. geodmshtml .. '</span>'
.. '<span class="geo-multi-punct">&#xfeff; / &#xfeff;</span>' .. '<span class="geo-multi-punct">&#xfeff; / &#xfeff;</span>'
.. '<span class="' .. displayDefault(coordinateSpec, "dec" ) .. '">'; .. '<span class="' .. displayDefault(coordinateSpec, "dec" ) .. '">';


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


local stylesheetLink = 'Module:Coordinates' .. ( isSandbox and '/sandbox' or '' ) .. '/styles.css'
return '<span class="plainlinks nourlexpansion">' ..
return mw.getCurrentFrame():extensionTag{
'' .. '</span>'
name = 'templatestyles', args = { src = stylesheetLink }
} .. '<span class="plainlinks nourlexpansion">[' .. coord_link .. uriComponents ..
' ' .. inner .. ']</span>' .. ']'
end end


--]
--[[
local function convert_dec2dms_d(coordinate)
Formats any error messages generated for display
local d = math_mod._round( coordinate, 0 ) .. "°"
]]
return d .. ""
function errorPrinter(errors)
local result = ""
for i,v in ipairs(errors) do
local errorHTML = '<strong class="error">Coordinates: ' .. v .. '</strong>'
result = result .. errorHTML .. "<br />"
end
return result
end end


--]
--[[
local function convert_dec2dms_dm(coordinate)
Determine the required CSS class to display coordinates
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 )
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


--]
--[[
local function convert_dec2dms_dms(coordinate)
Check the input arguments for coord to determine the kind of data being provided
coordinate = math_mod._round( coordinate * 60 * 60, 0 );
and then make the necessary processing.
local s = coordinate % 60
]]
coordinate = math.floor( (coordinate - s) / 60 );
function formatTest(args)
local result, errors; local m = coordinate % 60
coordinate = math.floor( (coordinate - m) / 60 );
local primary = false;
local d = coordinate % 360 .."°"

if args == "" then
return d .. string.format( "%02d′", m ) .. string.format( "%02d″", s )
-- no lat logic
return errorPrinter( {{"formatTest", "Missing latitude"}} )
elseif args == "" and args == "" and args == "" then
-- dec logic
result, errors = parseDec( args, args, args )
if result == nil then
return errorPrinter( errors );
end
result.param = table.concat( {args, "_N_", args, "_E_", args } );
elseif dmsTest(args, args) then
-- dms logic
result, errors = parseDMS( args, args, args, args,
args, args, args, args, args )
result.param = table.concat( { args, args, args, args, args,
args, args, args, args } , '_' );
if args ~= '' then
table.insert( errors, { 'formatTest', 'Extra unexpected parameters' } );
end
elseif dmsTest(args, args) then
-- dm logic
result, errors = parseDMS( args, args, nil, args,
args, args, nil, args, args )
result.param = table.concat( { args, args, args, args, args,
args, args } , '_' );
if args ~= '' then
table.insert( errors, { 'formatTest', 'Extra unexpected parameters' } );
end
elseif dmsTest(args, args) then
-- d logic
result, errors = parseDMS( args, nil, nil, args,
args, nil, nil, args, args )
result.param = table.concat( { args, args, args, args, args } , '_' );
if args ~= '' then
table.insert( errors, { 'formatTest', 'Extra unexpected parameters' } );
end
else
-- Error
return errorPrinter( {{"formatTest", "Unknown argument format"}} )
end
result.name = args
local extra_param = {'dim', 'globe', 'scale', 'region', 'source', 'type'}
for _, v in ipairs( extra_param ) do
if (args 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) .. ']';
end
end end


--[[ --[[
Helper function, convert decimal latitude or longitude to Helper function, convert decimal latitude or longitude to
degrees, minutes, and seconds format based on the specified precision. degrees, minutes, and seconds format based on the specified precision.
]] ]]
function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) local function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)
local coord = tonumber(coordinate) or 0 local coord = tonumber(coordinate)
local postfix local postfix
if coord >= 0 then if coord >= 0 then
Line 330: Line 209:
return convert_dec2dms_d( math.abs( coord ) ) .. postfix; return convert_dec2dms_d( math.abs( coord ) ) .. postfix;
end end
end

--]
function convert_dec2dms_d(coordinate)
local d = math_mod._round( coordinate, 0 ) .. "°"
return d .. ""
end

--]
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

--]
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 end


Line 363: Line 214:
Convert DMS format into a N or E decimal coordinate Convert DMS format into a N or E decimal coordinate
]] ]]
function convert_dms2dec(direction, degrees_str, minutes_str, seconds_str) local function convert_dms2dec(direction, degrees_str, minutes_str, seconds_str)
local degrees = tonumber(degrees_str) or 0 local degrees = tonumber(degrees_str)
local minutes = tonumber(minutes_str) or 0 local minutes = tonumber(minutes_str) or 0
local seconds = tonumber(seconds_str) or 0 local seconds = tonumber(seconds_str) or 0

local factor = 1 local factor = 1
direction = mw.ustring.gsub(direction, '^*(.-)*$', '%1');
if direction == "S" or direction == "W" then if direction == "S" or direction == "W" then
factor = -1 factor = -1
end end

local precision = 0 local precision = 0
if seconds_str ~= nil and seconds_str ~= '' then if seconds_str then
precision = 5 + math.max( math_mod._precision(seconds_str), 0 ); precision = 5 + math.max( math_mod._precision(seconds_str), 0 );
elseif minutes_str ~= nil and minutes_str ~= '' then elseif minutes_str and minutes_str ~= '' then
precision = 3 + math.max( math_mod._precision(minutes_str), 0 ); precision = 3 + math.max( math_mod._precision(minutes_str), 0 );
else else
precision = math.max( math_mod._precision(degrees_str), 0 ); precision = math.max( math_mod._precision(degrees_str), 0 );
end end

local decimal = factor * (degrees+(minutes+seconds/60)/60) local decimal = factor * (degrees+(minutes+seconds/60)/60)
return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based. return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based.
end end


--[[ --[[
Checks input values to for out of range errors. Checks input values to for out of range errors.
]] ]]
function validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, source, strong ) local function validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, source, strong )
local errors = {}; local errors = {};
lat_d = tonumber( lat_d ) or 0; lat_d = tonumber( lat_d ) or 0;
Line 406: Line 256:
table.insert(errors, {source, "longitude degrees < 0 with hemisphere flag"}) table.insert(errors, {source, "longitude degrees < 0 with hemisphere flag"})
end end
--[[ --[[
#coordinates is inconsistent about whether this is an error. If globe: is #coordinates is inconsistent about whether this is an error. If globe: is
specified, it won't error on this condition, but otherwise it will. specified, it won't error on this condition, but otherwise it will.

For not simply disable this check. For not simply disable this check.

if long_d > 180 then if long_d > 180 then
table.insert(errors, {source, "longitude degrees > 180 with hemisphere flag"}) table.insert(errors, {source, "longitude degrees > 180 with hemisphere flag"})
end end
]] ]]
end end

if lat_d > 90 then if lat_d > 90 then
table.insert(errors, {source, "latitude degrees > 90"}) table.insert(errors, {source, "latitude degrees > 90"})
Line 454: Line 304:
table.insert(errors, {source, "longitude seconds < 0"}) table.insert(errors, {source, "longitude seconds < 0"})
end end

return errors; 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 end


Line 464: Line 517:


Usage: Usage:
{{ Invoke:Coordinates | link }} {{#invoke:Coordinates | link }}

]] ]]
function coordinates.link(frame) function coordinates.link(frame)
Line 477: Line 530:


Usage: Usage:
{{ Invoke:Coordinates | dec2dms | decimal_coordinate | positive_suffix | {{#invoke:Coordinates | dec2dms | decimal_coordinate | positive_suffix |
negative_suffix | precision }} negative_suffix | precision }}

decimal_coordinate is converted to DMS format. If positive, the positive_suffix decimal_coordinate is converted to DMS format. If positive, the positive_suffix
is appended (typical N or E), if negative, the negative suffix is appended. The is appended (typical N or E), if negative, the negative suffix is appended. The
Line 485: Line 538:
to use. to use.
]] ]]
function coordinates.dec2dms(frame) coordinates.dec2dms = makeInvokeFunc('_dec2dms')
function coordinates._dec2dms(args)
globalFrame = frame
local coordinate = frame.args local coordinate = args
local firstPostfix = frame.args local firstPostfix = args or ''
local secondPostfix = frame.args local secondPostfix = args or ''
local precision = frame.args local precision = args or ''


return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)
Line 508: Line 561:
return 'dms'; return 'dms';
end end
end end


--[[ --[[
Line 516: Line 569:


Usage: Usage:
{{ Invoke:Coordinates | dms2dec | direction_flag | degrees | {{#invoke:Coordinates | dms2dec | direction_flag | degrees |
minutes | seconds }} minutes | seconds }}

Converts DMS values specified as degrees, minutes, seconds too decimal format. Converts DMS values specified as degrees, minutes, seconds too decimal format.
direction_flag is one of N, S, E, W, and determines whether the output is direction_flag is one of N, S, E, W, and determines whether the output is
positive (i.e. N and E) or negative (i.e. S and W). positive (i.e. N and E) or negative (i.e. S and W).
]] ]]
function coordinates.dms2dec(frame) coordinates.dms2dec = makeInvokeFunc('_dms2dec')
function coordinates._dms2dec(args)
globalFrame = frame
local direction = frame.args local direction = args
local degrees = frame.args local degrees = args
local minutes = frame.args local minutes = args
local seconds = frame.args local seconds = args


return convert_dms2dec(direction, degrees, minutes, seconds) return convert_dms2dec(direction, degrees, minutes, seconds)
Line 539: Line 592:


Usage: Usage:
{{ Invoke:Coordinates | coord }} {{#invoke:Coordinates | coord }}
{{ Invoke:Coordinates | coord | lat | long }} {{#invoke:Coordinates | coord | lat | long }}
{{ Invoke:Coordinates | coord | lat | lat_flag | long | long_flag }} {{#invoke:Coordinates | coord | lat | lat_flag | long | long_flag }}
... ...

Refer to {{coord}} documentation page for many additional parameters and Refer to {{coord}} documentation page for many additional parameters and
configuration options. configuration options.

Note: This function provides the visual display elements of {{coord}}. In Note: This function provides the visual display elements of {{coord}}. In
order to load coordinates into the database, the {{#coordinates:}} parser order to load coordinates into the database, the {{#coordinates:}} parser
function must also be called, this is done automatically in the Lua function must also be called, this is done automatically in the Lua
version of {{coord}}. version of {{coord}}.
]] ]]
function coordinates.coord(frame) coordinates.coord = makeInvokeFunc('_coord')
function coordinates._coord(args)
globalFrame = frame
local args = frame.args if not tonumber(args) and not args then
if args == nil then args = args; args = nil
local pFrame = frame:getParent(); local entity = mw.wikibase.getEntityObject(args.qid)
if entity
args = pFrame.args;
and entity.claims
for k,v in pairs( frame.args ) do
and entity.claims.P625
args = v;
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
end end

local contents, backward = formatTest(args)
for i=1,10 do
local Notes = args.notes or ''
if args == nil then
local Display = args.display and args.display:lower() or 'inline'
args = ""

else
-- it and ti are short for inline,title and title,inline
args = args:match( '^%s*(.-)%s*$' ); --remove whitespace
local function isInline(s)
end
-- Finds whether coordinates are displayed inline.
return s:find('inline') ~= nil or s == 'i' or s == 'it' or s == 'ti'
end end
local function isInTitle(s)
args = args or '';
-- Finds whether coordinates are displayed in the title.
return s:find('title') ~= nil or s == 't' or s == 'it' or s == 'ti'
local contents = formatTest(args)
local Notes = args.notes or ""
local Display = string.lower(args.display or "inline")
if Display == '' then
Display = 'inline';
end end

local function coord_wrapper(in_args)
-- Calls the parser function {{#coordinates:}}.
return mw.getCurrentFrame():callParserFunction('#coordinates', in_args) or ''
end

local text = '' local text = ''
if string.find( Display, 'inline' ) ~= nil if isInline(Display) then
text = text .. '<span class="geo-inline">' .. contents .. Notes .. '</span>'
or Display == 'i'
or Display == 'it'
or Display == 'ti'
then
-- Coordinates are displayed inline.
text = displayinline(contents, Notes)
end end
if string.find( Display, 'title' ) ~= nil if isInTitle(Display) then
-- Add to output since indicator content is invisible to Lua later on
or Display == 't'
if not isInline(Display) then
or Display == 'it'
text = text .. '<span class="geo-inline-hidden noexcerpt">' .. contents .. Notes .. '</span>'
or Display == 'ti'
end
then
text = text .. displaytitle(contents .. Notes) .. makeWikidataCategories(args.qid)
-- Coordinates are displayed in the title.
end
text = text .. displaytitle(contents, Notes)
if not args.nosave then
-- Add a Wikidata category for mainspace pages.
local page_title, count = mw.title.getCurrentTitle(), 1
if mw.wikibase and current_page.namespace == 0 then
if backward then
local wikidata_cat
local entity = mw.wikibase.getEntity() local tmp = {}
while not string.find((args or ''), '') do tmp = (args or ''); count = count+1 end
if entity and entity.claims and entity.claims.p625 then
tmp.count = count; count = 2*(count-1)
local snaktype = entity.claims.p625.mainsnak.snaktype
while count >= tmp.count do table.insert(tmp, 1, (args or '')); count = count-1 end
if snaktype == 'value' then
for i, v in ipairs(tmp) do args = v end
wikidata_cat = ']' -- coordinates exist both here and on Wikidata, and can be compared
else
elseif snaktype == 'somevalue' then
while count <= 9 do args = (args or ''); count = count+1 end
wikidata_cat = ']'
end
elseif snaktype == 'novalue' then
if isInTitle(Display) and not page_title.isTalkPage and page_title.subpageText ~= 'doc' and page_title.subpageText ~= 'testcases' then args = 'primary' end
wikidata_cat = ']'
args.notes, args.format, args.display = nil
end
text = text .. coord_wrapper(args)
else
end
wikidata_cat = ']' -- we have to either import the coordinates to Wikidata or remove them here
return text
end
end
if wikidata_cat then

text = text .. wikidata_cat
--[[
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 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 text 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: