Revision as of 05:29, 5 March 2013 view sourceDragons flight (talk | contribs)Edit filter managers, Extended confirmed users, Rollbackers, Template editors25,792 editsNo edit summary← 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 | ||
(127 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 .. '¶ms=' | |||
-- |
--] | ||
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 |
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, 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, { | |||
wrappers = 'Template:Coord' | |||
if format ~= "" then | |||
}) | |||
coordinateSpec.default = format | |||
return coordinates(args, frame) | |||
else | |||
end | |||
coordinateSpec.default = "dec" | |||
end | |||
--] | |||
errors = validate( lat, nil, nil, long, nil, nil, 'parseDec' ); | |||
local function optionalArg(arg, supplement) | |||
return coordinateSpec, errors | |||
return arg and arg .. supplement or '' | |||
end | end | ||
--[[ | |||
function optionalArg(arg, suplement) | |||
Formats any error messages generated for display | |||
if arg ~= nil and arg ~= "" then | |||
]] | |||
return arg .. suplement | |||
local function errorPrinter(errors) | |||
end | |||
local result = "" | |||
return "" | |||
for i,v in ipairs(errors) do | |||
result = result .. '<strong class="error">Coordinates: ' .. v .. '</strong><br />' | |||
end | |||
return result | |||
end | end | ||
--[[ | |||
function isEmpty(arg) | |||
Determine the required CSS class to display coordinates | |||
if arg == nil or arg == "" then | |||
return true | |||
Usually geo-nondefault is hidden by CSS, unless a user has overridden this for himself | |||
end | |||
default is the mode as specificied by the user when calling the {{coord}} template | |||
return false | |||
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 | end | ||
--[[ | |||
function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format ) | |||
specPrinter | |||
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}}}}} | |||
Output formatter. Takes the structure generated by either parseDec | |||
if format ~= "" then | |||
or parseDMS and formats it for inclusion on Misplaced Pages. | |||
coordinateSpec.default = format | |||
]] | |||
else | |||
|
local function specPrinter(args, coordinateSpec) | ||
local uriComponents = coordinateSpec | |||
end | |||
if uriComponents == "" then | |||
-- RETURN error, should never be empty or nil | |||
errors = validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, 'parseDMS' ); | |||
return "ERROR param was empty" | |||
if isEmpty(long_d) then | |||
end | |||
table.insert(errors, {"parseDMS", "Missing longitude" }) | |||
if args then | |||
end | |||
uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec) | |||
end | |||
local geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">' | |||
return coordinateSpec, errors | |||
.. '<span class="latitude">' .. coordinateSpec .. '</span> ' | |||
.. '<span class="longitude">' ..coordinateSpec .. '</span>' | |||
.. '</span>' | |||
local lat = tonumber( coordinateSpec ) or 0 | |||
local geodeclat | |||
if lat < 0 then | |||
-- FIXME this breaks the pre-existing precision | |||
geodeclat = tostring(coordinateSpec):sub(2) .. "°S" | |||
else | |||
geodeclat = (coordinateSpec or 0) .. "°N" | |||
end | |||
local long = tonumber( coordinateSpec ) or 0 | |||
local geodeclong | |||
if long < 0 then | |||
-- FIXME does not handle unicode minus | |||
geodeclong = tostring(coordinateSpec):sub(2) .. "°W" | |||
else | |||
geodeclong = (coordinateSpec or 0) .. "°E" | |||
end | |||
local geodechtml = '<span class="geo-dec" title="Maps, aerial photos, and other data for this location">' | |||
.. geodeclat .. ' ' | |||
.. geodeclong | |||
.. '</span>' | |||
local geonumhtml = '<span class="geo">' | |||
.. coordinateSpec .. '; ' | |||
.. coordinateSpec | |||
.. '</span>' | |||
local inner = '<span class="' .. displayDefault(coordinateSpec, "dms" ) .. '">' .. geodmshtml .. '</span>' | |||
.. '<span class="geo-multi-punct"> / </span>' | |||
.. '<span class="' .. displayDefault(coordinateSpec, "dec" ) .. '">'; | |||
if not args then | |||
inner = inner .. geodechtml | |||
.. '<span style="display:none"> / ' .. geonumhtml .. '</span></span>' | |||
else | |||
inner = inner .. '<span class="vcard">' .. geodechtml | |||
.. '<span style="display:none"> / ' .. geonumhtml .. '</span>' | |||
.. '<span style="display:none"> (<span class="fn org">' | |||
.. args .. '</span>)</span></span></span>' | |||
end | |||
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 | 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 | ||
-- |
--] | ||
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 | |||
local geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">' | |||
-- .. coordinateSpec .. ' ' | |||
-- .. coordinateSpec | |||
.. '<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">' | |||
.. geodeclat .. ' ' | |||
.. geodeclong | |||
-- .. '<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"> / </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 .."°" | |||
return d .. string.format( "%02d′", m ) .. string.format( "%02d″", s ) | |||
end | end | ||
--[[ | |||
--- Determine the required CSS class to display coordinates | |||
Helper function, convert decimal latitude or longitude to | |||
-- Usually geo-nondefault is hidden by CSS, unless a user has overridden this for himself | |||
degrees, minutes, and seconds format based on the specified precision. | |||
-- 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 convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) | |||
function displayDefault(default, mode) | |||
local coord = tonumber(coordinate) | |||
if default == "" then | |||
local postfix | |||
default = "dec" | |||
|
if coord >= 0 then | ||
postfix = firstPostfix | |||
else | |||
if default == mode then | |||
postfix = secondPostfix | |||
return "geo-default" | |||
end | |||
else | |||
return "geo-nondefault" | |||
precision = precision:lower(); | |||
end | |||
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 | end | ||
--[[ | |||
--- Check the arguments to determine what type of coordinates has been input | |||
Convert DMS format into a N or E decimal coordinate | |||
function formatTest(args) | |||
]] | |||
local result, errors; | |||
local function convert_dms2dec(direction, degrees_str, minutes_str, seconds_str) | |||
local degrees = tonumber(degrees_str) | |||
if args == "" then | |||
local minutes = tonumber(minutes_str) or 0 | |||
-- no lat logic | |||
local seconds = tonumber(seconds_str) or 0 | |||
return errorPrinter( {{"formatTest", "Missing latitude"}} ) | |||
elseif args == "" and args == "" and args == "" then | |||
local factor = 1 | |||
-- dec logic | |||
if direction == "S" or direction == "W" then | |||
result, errors = parseDec( args, args, args ) | |||
factor = -1 | |||
result.param = table.concat( {args, "_N_", args, "_E_", args } ); | |||
end | |||
elseif dmsTest(args, args) then | |||
-- dms logic | |||
local precision = 0 | |||
result, errors = parseDMS( args, args, args, args, | |||
if seconds_str then | |||
args, args, args, args, args ) | |||
precision = 5 + math.max( math_mod._precision(seconds_str), 0 ); | |||
result.param = table.concat( { args, args, args, args, args, | |||
elseif minutes_str and minutes_str ~= '' then | |||
args, args, args, args } , '_' ); | |||
precision = 3 + math.max( math_mod._precision(minutes_str), 0 ); | |||
elseif dmsTest(args, args) then | |||
else | |||
-- dm logic | |||
precision = math.max( math_mod._precision(degrees_str), 0 ); | |||
result, errors = parseDMS( args, args, nil, args, | |||
end | |||
args, args, nil, args, args ) | |||
result.param = table.concat( { args, args, args, args, args, | |||
local decimal = factor * (degrees+(minutes+seconds/60)/60) | |||
args, args } , '_' ); | |||
return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based. | |||
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 } , '_' ); | |||
else | |||
-- Error | |||
return errorPrinter( {{"formatTest", "Unknown argument format"}} ) | |||
end | |||
result.name = args | |||
return specPrinter( args, result ) .. " " .. errorPrinter(errors) | |||
end | end | ||
--[[ | |||
function convert_dec2dms_d(coordinate) | |||
Checks input values to for out of range errors. | |||
local d = math_mod._round( coordinate, 0 ) .. "°" | |||
]] | |||
return d .. "" | |||
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 | end | ||
--[[ | |||
function convert_dec2dms_dm(coordinate) | |||
parseDec | |||
-- {{#expr:{{{1}}} mod 360}}°{{padleft:{{#expr:({{{1}}} * 600 round 0) mod 600 / 10 round 0}}|2|0}}′ | |||
local d = math.floor(coordinate % 360) .."°" | |||
Transforms decimal format latitude and longitude into the | |||
local m = string.format( "%02d′", math_mod._round( math_mod._round(coordinate * 600, 0) % 600 / 10, 0 ) ) | |||
structure to be used in displaying coordinates | |||
]] | |||
return d .. m | |||
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 | ||
--[[ | |||
function convert_dec2dms_dms(coordinate) | |||
parseDMS | |||
--{{#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 degrees, minutes, seconds format latitude and longitude | |||
return d .. m .. s | |||
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 | end | ||
--[[ | |||
--- Convert a latitude or longitude to the DMS format | |||
Check the input arguments for coord to determine the kind of data being provided | |||
function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) | |||
and then make the necessary processing. | |||
-- {{Coord/dec2dms/{{{4}}}|{{#ifexpr:{{{1}}} >= 0||-}}{{{1}}}}}{{#ifexpr:{{{1}}} >= 0|{{{2}}}|{{{3}}}}} | |||
]] | |||
local coord = tonumber(coordinate) or 0 | |||
local function formatTest(args) | |||
local postfix | |||
local result, errors | |||
if coord >= 0 then | |||
local backward, primary = false, false | |||
postfix = firstPostfix | |||
else | |||
local function getParam(args, lim) | |||
postfix = secondPostfix | |||
local ret = {} | |||
end | |||
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 precision == "dms" then | |||
if #errors > 0 then | |||
return convert_dec2dms_dms( math.abs( coord ) ) .. postfix; | |||
ret = ret .. ' ' .. errorPrinter(errors) .. ']' | |||
elseif precision == "dm" then | |||
end | |||
return convert_dec2dms_dm( math.abs( coord ) ) .. postfix; | |||
return ret, backward | |||
elseif precision == "d" then | |||
return convert_dec2dms_d( math.abs( coord ) ) .. postfix; | |||
end | |||
-- return "" .. globalFrame:expandTemplate{ title = 'coord/dec2dms', args = {coordinate, firstPostfix, secondPostfix, precision}} | |||
end | end | ||
--[[ | |||
--- Convert DMS into a N or E decimal coordinate | |||
Generate Wikidata tracking categories. | |||
-- @param coordinate direction. either "N" "S" "E" or "W" | |||
]] | |||
-- @param degrees: string or number | |||
local function makeWikidataCategories(qid) | |||
-- @param minutes: string or number | |||
local ret | |||
-- @param seconds: string or number | |||
local qid = qid or mw.wikibase.getEntityIdForCurrentPage() | |||
-- @return a number with the N or E normalized decimal coordinate of the input | |||
if mw.wikibase and current_page.namespace == 0 then | |||
function convert_dms2dec(direction, degrees_str, minutes_str, seconds_str) | |||
if qid and mw.wikibase.entityExists(qid) and mw.wikibase.getBestStatements(qid, "P625") and mw.wikibase.getBestStatements(qid, "P625") then | |||
local degrees = tonumber(degrees_str) or 0 | |||
local snaktype = mw.wikibase.getBestStatements(qid, "P625").mainsnak.snaktype | |||
local minutes = tonumber(minutes_str) or 0 | |||
if snaktype == 'value' then | |||
local seconds = tonumber(seconds_str) or 0 | |||
-- coordinates exist both here and on Wikidata, and can be compared. | |||
-- {{#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 = 'Coordinates on Wikidata' | |||
elseif snaktype == 'somevalue' then | |||
local factor | |||
ret = 'Coordinates on Wikidata set to unknown value' | |||
if direction == "N" or direction == "E" then | |||
elseif snaktype == 'novalue' then | |||
factor = 1 | |||
ret = 'Coordinates on Wikidata set to no value' | |||
else | |||
end | |||
factor = -1 | |||
else | |||
end | |||
-- We have to either import the coordinates to Wikidata or remove them here. | |||
ret = 'Coordinates not on Wikidata' | |||
local precision = 0 | |||
end | |||
if not isEmpty(seconds_str) then | |||
end | |||
precision = 5 + math.max( math_mod._precision(seconds_str), 0 ); | |||
if ret then | |||
elseif not isEmpty(minutes_str) then | |||
return string.format(']', ret) | |||
precision = 3 + math.max( math_mod._precision(minutes_str), 0 ); | |||
else | |||
return '' | |||
precision = math.max( math_mod._precision(degrees_str), 0 ); | |||
end | |||
-- nil -> 0 | |||
local decimal = factor * (degrees+(minutes+seconds/60)/60) | |||
return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based. | |||
--return "" .. globalFrame:expandTemplate{ title = 'coord/dms2dec', args = {direction, degrees, minutes, seconds}} | |||
end | end | ||
--[[ | |||
function validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, source ) | |||
link | |||
local errors = {}; | |||
Simple function to export the coordinates link for other uses. | |||
if (tonumber(lat_d) or 0) > 90 then | |||
table.insert(errors, {source, "latd>90"}) | |||
end | |||
if (tonumber(lat_d) or 0) < -90 then | |||
table.insert(errors, {source, "latd<-90"}) | |||
end | |||
if (tonumber(lat_m) or 0) >= 60 then | |||
table.insert(errors, {source, "latm>=60"}) | |||
end | |||
if (tonumber(lat_m) or 0) < 0 then | |||
table.insert(errors, {source, "latm<0"}) | |||
end | |||
if (tonumber(lat_s) or 0) >= 60 then | |||
table.insert(errors, {source, "lats>=60"}) | |||
end | |||
if (tonumber(lat_s) or 0) < 0 then | |||
table.insert(errors, {source, "lats<0"}) | |||
end | |||
if (tonumber(long_d) or 0) >= 360 then | |||
table.insert(errors, {source, "longd>=360"}) | |||
end | |||
if (tonumber(long_d) or 0) <= -360 then | |||
table.insert(errors, {source, "longd<=-360"}) | |||
end | |||
if (tonumber(long_m) or 0) >= 60 then | |||
table.insert(errors, {source, "longm>=60"}) | |||
end | |||
if (tonumber(long_m) or 0) < 0 then | |||
table.insert(errors, {source, "longm<0"}) | |||
end | |||
if (tonumber(long_s) or 0) >= 60 then | |||
table.insert(errors, {source, "longs>=60"}) | |||
end | |||
if (tonumber(long_s) or 0) < 0 then | |||
table.insert(errors, {source, "longs<0"}) | |||
end | |||
return errors; | |||
end | |||
Usage: | |||
{{#invoke:Coordinates | link }} | |||
]] | |||
--- The display function we exposed to Module:Coordinates | |||
function coordinates. |
function coordinates.link(frame) | ||
return coord_link; | |||
globalFrame = frame; | |||
return formatTest(frame.args) | |||
end | end | ||
--[[ | |||
--- The dec2dms function exposed to Module:Coordinates | |||
dec2dms | |||
function coordinates.dec2dms(frame) | |||
globalFrame = frame | |||
local coordinate = frame.args | |||
local firstPostfix = frame.args | |||
local secondPostfix = frame.args | |||
local precision = frame.args | |||
Wrapper to allow templates to call dec2dms directly. | |||
return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) | |||
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 | 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 ) | 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 |
end | ||
--[[ | |||
--- The dec2dms function exposed to Module:Coordinates | |||
dms2dec | |||
function coordinates.dms2dec(frame) | |||
globalFrame = frame | |||
local direction = frame.args | |||
local degrees = frame.args | |||
local minutes = frame.args | |||
local seconds = frame.args | |||
Wrapper to allow templates to call dms2dec directly. | |||
return convert_dms2dec(direction, degrees, minutes, seconds) | |||
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 | ||
--[[ | |||
--- This is used by {{coord}}. | |||
coord | |||
function coordinates.coord(frame) | |||
globalFrame = frame | |||
Main entry point for Lua function to replace {{coord}} | |||
local args = frame.args | |||
for i=1,10 do | |||
Usage: | |||
if ( nil == args ) then args = "" end | |||
{{#invoke:Coordinates | coord }} | |||
end | |||
{{#invoke:Coordinates | coord | lat | long }} | |||
args = args or ''; | |||
{{#invoke:Coordinates | coord | lat | lat_flag | long | long_flag }} | |||
... | |||
local contents = formatTest(args) | |||
local Notes = args.notes or "" | |||
Refer to {{coord}} documentation page for many additional parameters and | |||
local Display = args.display or "inline" | |||
configuration options. | |||
local text | |||
if ( "title" ~= Display ) then | |||
Note: This function provides the visual display elements of {{coord}}. In | |||
text = displayinline(contents) | |||
order to load coordinates into the database, the {{#coordinates:}} parser | |||
else | |||
function must also be called, this is done automatically in the Lua | |||
text = displaytitle(contents) | |||
version of {{coord}}. | |||
end | |||
]] | |||
return text .. Notes | |||
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"> (<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, | |||
'(¶ms= ]*) ', | |||
'%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]This Lua module is used on approximately 1,370,000 pages, or roughly 2% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This module depends on the following other modules: |
This module uses TemplateStyles: |
Note: The code which this module's main function (coord
) outputs is directly parsed and/or manipulated by Module:Location map and other functions of this module itself (coord2text
and coordinsert
). If the structure of the output changes (for example, to use the <mapframe>
and <maplink>
tags), please update the aforementioned scripts as well.
Using the module with coordinsert
When using the {{Coord}} template inside another template, like an infobox, there may be parameters (like type:airport
) which should be added automatically. To do so, do something like this:
{{#if:{{{coordinates|}}}|{{#invoke:Coordinates|coordinsert|{{{coordinates|}}}|parameter1:value1|parameter2:value2|parameter3:value3…}}|
Do not add more vertical bars |
than necessary.
Using the module with coord2text to extract latitude or longitude
Developers maintaining legacy code may need to extract latitude or longitude to use a parameters in other code, or a mathematical expression. The module's "coord2text" function can be used to extract data from the {{Coord}} template. To extract the latitude from a Coord template, use:
{{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|lat}}
→ 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
- Category:Pages with malformed coordinate tags (38)
- Category:Coordinates not on Wikidata (14,473)
- Category:Coordinates on Wikidata (1,205,815)
- Category:Coordinates on Wikidata set to no value (9)
- Category:Coordinates on Wikidata set to unknown value (29)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.
--[[ This module is intended to replace the functionality of {{Coord}} and related templates. It provides several methods, including {{#invoke:Coordinates | coord }} : General function formatting and displaying coordinate values. {{#invoke:Coordinates | dec2dms }} : Simple function for converting decimal degree values to DMS format. {{#invoke:Coordinates | dms2dec }} : Simple function for converting DMS format to decimal degree format. {{#invoke:Coordinates | link }} : Export the link used to reach the tools ]] require('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 .. '¶ms=' --] 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"> / </span>' .. '<span class="' .. displayDefault(coordinateSpec, "dec" ) .. '">'; if not args then inner = inner .. geodechtml .. '<span style="display:none"> / ' .. geonumhtml .. '</span></span>' else inner = inner .. '<span class="vcard">' .. geodechtml .. '<span style="display:none"> / ' .. geonumhtml .. '</span>' .. '<span style="display:none"> (<span class="fn org">' .. args .. '</span>)</span></span></span>' end 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"> (<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, '(¶ms= ]*) ', '%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 coordinatesCategories: