Module:Settlement short description: Difference between revisions
From The Kodiak Republic Wiki
Content added Content deleted
(Created page with "--[[ 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 }...") |
(Commented out broken script.) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
--generates auto short description for use in infobox settlement |
|||
--[[ |
|||
local p = {} |
|||
This module is intended to replace the functionality of {{Coord}} and related |
|||
p.categories = "" |
|||
templates. It provides several methods, including |
|||
local plain = require('Module:Plain text')._main |
|||
local getArgs = require('Module:Arguments').getArgs |
|||
local tableTools = require ('Module:TableTools') |
|||
function p.reverseTable (init) |
|||
{{#invoke:Coordinates | coord }} : General function formatting and displaying |
|||
init[1], init[3] = init[3], init[1] |
|||
coordinate values. |
|||
return init |
|||
{{#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 current_page = mw.title.getCurrentTitle() |
|||
local page_name = mw.uri.encode( current_page.prefixedText, 'WIKI' ); |
|||
local coord_link = '//geohack.toolforge.org/geohack.php?pagename=' .. page_name .. '¶ms=' |
|||
local templatestyles = 'Module:Coordinates/styles.css' |
|||
--[[ Helper function, replacement for {{coord/display/title}} ]] |
|||
local function displaytitle(s, notes) |
|||
local l = "[[Geographic coordinate system|Coordinates]]: " .. s |
|||
local co = '<span id="coordinates">' .. l .. notes .. '</span>'; |
|||
return '<span style="font-size: small;">' .. co .. '</span>'; |
|||
end |
end |
||
function p.assign (args, argname, num) |
|||
--[[ Helper function, Replacement for {{coord/display/inline}} ]] |
|||
local val |
|||
local function displayinline(s, notes) |
|||
local var = {} |
|||
return s .. notes |
|||
for i = 0,num do |
|||
end |
|||
--handle initial "subdivision_foo" without number |
|||
if i == 0 then |
|||
--[[ Helper function, used in detecting DMS formatting ]] |
|||
val = "" |
|||
local function dmsTest(first, second) |
|||
else |
|||
if type(first) ~= 'string' or type(second) ~= 'string' then |
|||
val = tostring(i) |
|||
return nil |
|||
end |
|||
var[i+1] = p.validate(plain(args[argname..val])) |
|||
end |
end |
||
return var |
|||
local s = (first .. second):upper() |
|||
return s:find('^[NS][EW]$') or s:find('^[EW][NS]$') |
|||
end |
end |
||
--Display short description using {{short description}} |
|||
function p.shortdesc(text, frame) |
|||
--[[ Wrapper function to grab args, see Module:Arguments for this function's documentation. ]] |
|||
return frame:expandTemplate{title = 'Short description', args = {text, 'noreplace'}} |
|||
local function makeInvokeFunc(funcName) |
|||
return function (frame) |
|||
local args = require('Module:Arguments').getArgs(frame, { |
|||
wrappers = 'Template:Coord' |
|||
}) |
|||
return coordinates[funcName](args, frame) |
|||
end |
|||
end |
end |
||
function p.category (cattype) |
|||
--[[ Helper function, handle optional args. ]] |
|||
local category = string.format('[[Category:Pages using infobox settlement with bad %s]]', cattype) |
|||
local function optionalArg(arg, supplement) |
|||
if category then p.categories = p.categories..category end --categorize |
|||
return arg and arg .. supplement or '' |
|||
end |
end |
||
--sanity and other checks |
|||
--[[ |
|||
function p.validate (parameter, cat) |
|||
Formats any error messages generated for display |
|||
if not parameter then return nil end |
|||
]] |
|||
parameter = parameter:gsub('%b()', '') --remove things in brackets as extraneous information |
|||
local function errorPrinter(errors) |
|||
:gsub('%s+', ' ') --fix possible extra spaces from previous cleanup |
|||
local result = "" |
|||
:gsub('^%s+', '') --trim spaces from beginning |
|||
for i,v in ipairs(errors) do |
|||
:gsub('%s+$', '') --trim spaces from end |
|||
local errorHTML = '<strong class="error">Coordinates: ' .. v[2] .. '</strong>' |
|||
if parameter:match("[,;]") or not parameter:match("%a") then --must have some letters, ignore if multiple types/subdivisions |
|||
result = result .. errorHTML .. "<br />" |
|||
if cat then p.category (cat) end |
|||
return nil |
|||
end |
end |
||
if (parameter == "") then return nil end |
|||
return result |
|||
return parameter |
|||
end |
end |
||
--removes redundancy like "England, United Kingdom" and fixes issues like "Foo in United States" (to "Foo in the United States") |
|||
--[[ |
|||
--also used in Module:Type in location |
|||
Determine the required CSS class to display coordinates |
|||
function p.cleanupLoc (location) |
|||
if location == "" then return nil end |
|||
Usually geo-nondefault is hidden by CSS, unless a user has overridden this for himself |
|||
local replacements = { |
|||
default is the mode as specificied by the user when calling the {{coord}} template |
|||
["England, United Kingdom"] = "England", |
|||
mode is the display mode (dec or dms) that we will need to determine the css class for |
|||
["Scotland, United Kingdom"] = "Scotland", |
|||
]] |
|||
["Wales, United Kingdom"] = "Wales", |
|||
local function displayDefault(default, mode) |
|||
["New York City, New York, United States"] = "New York City", |
|||
if default == "" then |
|||
["^United States$"] = "the United States", |
|||
default = "dec" |
|||
["London, United Kingdom"] = "London, England" |
|||
end |
|||
} |
|||
for i, v in pairs(replacements) do |
|||
if default == mode then |
|||
location = location:gsub(i, v) --series of replacements |
|||
return "geo-default" |
|||
else |
|||
return "geo-nondefault" |
|||
end |
end |
||
return location |
|||
end |
end |
||
function p.main(frame) |
|||
--[[ |
|||
local categories = "" |
|||
specPrinter |
|||
local subdivision_types = {} |
|||
local subdivision_names = {} |
|||
Output formatter. Takes the structure generated by either parseDec |
|||
local args = getArgs (frame, {parentOnly = true}) |
|||
or parseDMS and formats it for inclusion on Wikipedia. |
|||
local settlement_type = p.validate(plain(args.settlement_type or args.type), "settlement type") or "Place" |
|||
]] |
|||
local |
local short_description = plain(args.short_description) |
||
subdivision_types = p.assign(args, "subdivision_type", 2) |
|||
local uriComponents = coordinateSpec["param"] |
|||
subdivision_names = p.assign(args, "subdivision_name", 2) |
|||
if uriComponents == "" then |
|||
-- RETURN error, should never be empty or nil |
|||
if short_description then |
|||
return "ERROR param was empty" |
|||
if (short_description == 'no') then |
|||
end |
|||
return |
|||
if args["name"] then |
|||
else |
|||
uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec["name"]) |
|||
local language = mw.language.getContentLanguage() |
|||
end |
|||
return p.shortdesc(language:ucfirst(short_description), frame) |
|||
local geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">' |
|||
.. '<span class="latitude">' .. coordinateSpec["dms-lat"] .. '</span> ' |
|||
.. '<span class="longitude">' ..coordinateSpec["dms-long"] .. '</span>' |
|||
.. '</span>' |
|||
local lat = tonumber( coordinateSpec["dec-lat"] ) or 0 |
|||
local geodeclat |
|||
if lat < 0 then |
|||
-- FIXME this breaks the pre-existing precision |
|||
geodeclat = tostring(coordinateSpec["dec-lat"]):sub(2) .. "°S" |
|||
else |
|||
geodeclat = (coordinateSpec["dec-lat"] or 0) .. "°N" |
|||
end |
|||
local long = tonumber( coordinateSpec["dec-long"] ) or 0 |
|||
local geodeclong |
|||
if long < 0 then |
|||
-- FIXME does not handle unicode minus |
|||
geodeclong = tostring(coordinateSpec["dec-long"]):sub(2) .. "°W" |
|||
else |
|||
geodeclong = (coordinateSpec["dec-long"] or 0) .. "°E" |
|||
end |
|||
local geodechtml = '<span class="geo-dec" title="Maps, aerial photos, and other data for this location">' |
|||
.. geodeclat .. ' ' |
|||
.. geodeclong |
|||
.. '</span>' |
|||
local geonumhtml = '<span class="geo">' |
|||
.. coordinateSpec["dec-lat"] .. '; ' |
|||
.. coordinateSpec["dec-long"] |
|||
.. '</span>' |
|||
local inner = '<span class="' .. displayDefault(coordinateSpec["default"], "dms" ) .. '">' .. geodmshtml .. '</span>' |
|||
.. '<span class="geo-multi-punct"> / </span>' |
|||
.. '<span class="' .. displayDefault(coordinateSpec["default"], "dec" ) .. '">'; |
|||
if not args["name"] then |
|||
inner = inner .. geodechtml |
|||
.. '<span style="display:none"> / ' .. geonumhtml .. '</span></span>' |
|||
else |
|||
inner = inner .. '<span class="vcard">' .. geodechtml |
|||
.. '<span style="display:none"> / ' .. geonumhtml .. '</span>' |
|||
.. '<span style="display:none"> (<span class="fn org">' |
|||
.. args["name"] .. '</span>)</span></span></span>' |
|||
end |
|||
return mw.getCurrentFrame():extensionTag{ name = 'templatestyles', args = { src = templatestyles} } |
|||
.. '<span class="plainlinks nourlexpansion">' |
|||
.. '[' .. coord_link .. uriComponents .. ' ' .. inner .. ']' |
|||
.. '</span>' |
|||
end |
|||
--[[ Helper function, convert decimal to degrees ]] |
|||
local function convert_dec2dms_d(coordinate) |
|||
local d = math_mod._round( coordinate, 0 ) .. "°" |
|||
return d .. "" |
|||
end |
|||
--[[ Helper function, convert decimal to degrees and minutes ]] |
|||
local function convert_dec2dms_dm(coordinate) |
|||
coordinate = math_mod._round( coordinate * 60, 0 ); |
|||
local m = coordinate % 60; |
|||
coordinate = math.floor( (coordinate - m) / 60 ); |
|||
local d = coordinate % 360 .."°" |
|||
return d .. string.format( "%02d′", m ) |
|||
end |
|||
--[[ Helper function, convert decimal to degrees, minutes, and seconds ]] |
|||
local function convert_dec2dms_dms(coordinate) |
|||
coordinate = math_mod._round( coordinate * 60 * 60, 0 ); |
|||
local s = coordinate % 60 |
|||
coordinate = math.floor( (coordinate - s) / 60 ); |
|||
local m = coordinate % 60 |
|||
coordinate = math.floor( (coordinate - m) / 60 ); |
|||
local d = coordinate % 360 .."°" |
|||
return d .. string.format( "%02d′", m ) .. string.format( "%02d″", s ) |
|||
end |
|||
--[[ |
|||
Helper function, convert decimal latitude or longitude to |
|||
degrees, minutes, and seconds format based on the specified precision. |
|||
]] |
|||
local function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) |
|||
local coord = tonumber(coordinate) |
|||
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 |
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 |
end |
||
if not(subdivision_names[3] and |
|||
if lat_d > 90 then |
|||
(string.find(settlement_type, '[nN]eighbo[u]?rhood') or string.find(settlement_type, '[sS]uburb'))) then |
|||
table.insert(errors, {source, "latitude degrees > 90"}) |
|||
subdivision_names[3] = nil --display the third subdivision_type only if suburb or neighborhood |
|||
end |
end |
||
if lat_d < -90 then |
|||
--if say "Voivodeship" is found within the subdivision_type, then specially handle |
|||
table.insert(errors, {source, "latitude degrees < -90"}) |
|||
--by adding Voivodeship to the end if not already present |
|||
end |
|||
for x, y in ipairs (subdivision_types) do |
|||
if lat_m >= 60 then |
|||
local special_types = { |
|||
table.insert(errors, {source, "latitude minutes >= 60"}) |
|||
"Voivodeship" |
|||
end |
|||
} |
|||
if lat_m < 0 then |
|||
for i, j in ipairs(special_types) do |
|||
table.insert(errors, {source, "latitude minutes < 0"}) |
|||
if subdivision_names[x] and string.find(y, j, 1, true) |
|||
end |
|||
and not string.find(subdivision_names[x], j, 1, true) then |
|||
if lat_s >= 60 then |
|||
subdivision_names[x] = subdivision_names[x].." "..j |
|||
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["dec-lat"] = lat; |
|||
coordinateSpec["dec-long"] = long; |
|||
local mode = coordinates.determineMode( lat, long ); |
|||
coordinateSpec["dms-lat"] = convert_dec2dms( lat, "N", "S", mode) -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}} |
|||
coordinateSpec["dms-long"] = convert_dec2dms( long, "E", "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 |
end |
||
if long_f:upper() == 'W' then |
|||
long_d = '-' .. long_d; |
|||
end |
|||
return parseDec( lat_d, long_d, format ); |
|||
end |
end |
||
end |
end |
||
for x, y in ipairs (subdivision_names) do |
|||
coordinateSpec["dms-lat"] = lat_d.."°"..optionalArg(lat_m,"′") .. optionalArg(lat_s,"″") .. lat_f |
|||
if y then |
|||
coordinateSpec["dms-long"] = long_d.."°"..optionalArg(long_m,"′") .. optionalArg(long_s,"″") .. long_f |
|||
if string.find(settlement_type, y, 1, true) then --if the subdivision is found within the settlement type |
|||
coordinateSpec["dec-lat"] = convert_dms2dec(lat_f, lat_d, lat_m, lat_s) -- {{coord/dms2dec|{{{4}}}|{{{1}}}|0{{{2}}}|0{{{3}}}}} |
|||
subdivision_names[x] = nil --don't display redundancy |
|||
coordinateSpec["dec-long"] = convert_dms2dec(long_f, long_d, long_m, long_s) -- {{coord/dms2dec|{{{8}}}|{{{5}}}|0{{{6}}}|0{{{7}}}}} |
|||
p.category ("settlement type") |
|||
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[i] = args[i] or '' |
|||
end |
|||
return table.concat(ret, '_') |
|||
end |
|||
if not args[1] then |
|||
-- no lat logic |
|||
return errorPrinter( {{"formatTest", "Missing latitude"}} ) |
|||
elseif not tonumber(args[1]) then |
|||
-- bad lat logic |
|||
return errorPrinter( {{"formatTest", "Unable to parse latitude as a number:" .. args[1]}} ) |
|||
elseif not args[4] and not args[5] and not args[6] then |
|||
-- dec logic |
|||
result, errors = parseDec(args[1], args[2], 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[1])), |
|||
((tonumber(args[1]) or 0) < 0) and 'S' or 'N', |
|||
math.abs(tonumber(args[2])), |
|||
((tonumber(args[2]) or 0) < 0) and 'W' or 'E', |
|||
args[3] or ''}, '_') |
|||
elseif dmsTest(args[4], args[8]) then |
|||
-- dms logic |
|||
result, errors, backward = parseDMS(args[1], args[2], args[3], args[4], |
|||
args[5], args[6], args[7], args[8], args.format) |
|||
if args[10] 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[3], args[6]) then |
|||
-- dm logic |
|||
result, errors, backward = parseDMS(args[1], args[2], nil, args[3], |
|||
args[4], args[5], nil, args[6], args['format']) |
|||
if args[8] 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[2], args[4]) then |
|||
-- d logic |
|||
result, errors, backward = parseDMS(args[1], nil, nil, args[2], |
|||
args[3], nil, nil, args[4], args.format) |
|||
if args[6] 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"}}) .. '[[Category:Pages with malformed coordinate tags]]' |
|||
end |
|||
result.name = args.name |
|||
local extra_param = {'dim', 'globe', 'scale', 'region', 'source', 'type'} |
|||
for _, v in ipairs(extra_param) do |
|||
if args[v] 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) .. '[[Category:Pages with malformed coordinate tags]]' |
|||
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")[1] then |
|||
local snaktype = mw.wikibase.getBestStatements(qid, "P625")[1].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 |
end |
||
if y == mw.title.getCurrentTitle().text then --if the title is the same as one of the subdivision_names |
|||
else |
|||
subdivision_names[x] = nil --don't display redundancy |
|||
-- 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('[[Category:%s]]', ret) |
|||
else |
|||
return '' |
|||
end |
|||
end |
|||
--[[ |
|||
link |
|||
Simple function to export the coordinates link for other uses. |
|||
Usage: |
|||
{{#invoke:Coordinates | link }} |
|||
]] |
|||
function coordinates.link(frame) |
|||
return coord_link; |
|||
end |
|||
--[[ |
|||
dec2dms |
|||
Wrapper to allow templates to call dec2dms directly. |
|||
Usage: |
|||
{{#invoke:Coordinates | dec2dms | decimal_coordinate | positive_suffix | |
|||
negative_suffix | precision }} |
|||
decimal_coordinate is converted to DMS format. If positive, the positive_suffix |
|||
is appended (typical N or E), if negative, the negative suffix is appended. The |
|||
specified precision is one of 'D', 'DM', or 'DMS' to specify the level of detail |
|||
to use. |
|||
]] |
|||
coordinates.dec2dms = makeInvokeFunc('_dec2dms') |
|||
function coordinates._dec2dms(args) |
|||
local coordinate = args[1] |
|||
local firstPostfix = args[2] or '' |
|||
local secondPostfix = args[3] or '' |
|||
local precision = args[4] or '' |
|||
return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision) |
|||
end |
|||
--[[ |
|||
Helper function to determine whether to use D, DM, or DMS |
|||
format depending on the precision of the decimal input. |
|||
]] |
|||
function coordinates.determineMode( value1, value2 ) |
|||
local precision = math.max( math_mod._precision( value1 ), math_mod._precision( value2 ) ); |
|||
if precision <= 0 then |
|||
return 'd' |
|||
elseif precision <= 2 then |
|||
return 'dm'; |
|||
else |
|||
return 'dms'; |
|||
end |
|||
end |
|||
--[[ |
|||
dms2dec |
|||
Wrapper to allow templates to call dms2dec directly. |
|||
Usage: |
|||
{{#invoke:Coordinates | dms2dec | direction_flag | degrees | |
|||
minutes | seconds }} |
|||
Converts DMS values specified as degrees, minutes, seconds too decimal format. |
|||
direction_flag is one of N, S, E, W, and determines whether the output is |
|||
positive (i.e. N and E) or negative (i.e. S and W). |
|||
]] |
|||
coordinates.dms2dec = makeInvokeFunc('_dms2dec') |
|||
function coordinates._dms2dec(args) |
|||
local direction = args[1] |
|||
local degrees = args[2] |
|||
local minutes = args[3] |
|||
local seconds = args[4] |
|||
return convert_dms2dec(direction, degrees, minutes, seconds) |
|||
end |
|||
--[[ |
|||
coord |
|||
Main entry point for Lua function to replace {{coord}} |
|||
Usage: |
|||
{{#invoke:Coordinates | coord }} |
|||
{{#invoke:Coordinates | coord | lat | long }} |
|||
{{#invoke:Coordinates | coord | lat | lat_flag | long | long_flag }} |
|||
... |
|||
Refer to {{coord}} documentation page for many additional parameters and |
|||
configuration options. |
|||
Note: This function provides the visual display elements of {{coord}}. In |
|||
order to load coordinates into the database, the {{#coordinates:}} parser |
|||
function must also be called, this is done automatically in the Lua |
|||
version of {{coord}}. |
|||
]] |
|||
coordinates.coord = makeInvokeFunc('_coord') |
|||
function coordinates._coord(args) |
|||
if not tonumber(args[1]) and not args[2] then |
|||
args[3] = args[1]; args[1] = nil |
|||
local entity = mw.wikibase.getEntityObject(args.qid) |
|||
if entity |
|||
and entity.claims |
|||
and entity.claims.P625 |
|||
and entity.claims.P625[1].mainsnak.snaktype == 'value' |
|||
then |
|||
local precision = entity.claims.P625[1].mainsnak.datavalue.value.precision |
|||
args[1] = entity.claims.P625[1].mainsnak.datavalue.value.latitude |
|||
args[2] = entity.claims.P625[1].mainsnak.datavalue.value.longitude |
|||
if precision then |
|||
precision = -math_mod._round(math.log(precision)/math.log(10),0) |
|||
args[1] = math_mod._round(args[1],precision) |
|||
args[2] = math_mod._round(args[2],precision) |
|||
end |
end |
||
end |
end |
||
end |
end |
||
local location = table.concat(tableTools.compressSparseArray(p.reverseTable(subdivision_names)), ', ') |
|||
local contents, backward = formatTest(args) |
|||
local Notes = args.notes or '' |
|||
location = p.cleanupLoc (location) |
|||
local Display = args.display and args.display:lower() or 'inline' |
|||
if location then location = " in " .. location else location = "" end |
|||
local function isInline(s) |
|||
-- Finds whether coordinates are displayed inline. |
|||
local language = mw.language.getContentLanguage() |
|||
return s:find('inline') ~= nil or s == 'i' or s == 'it' or s == 'ti' |
|||
--commented out for now (BROKEN) return p.shortdesc(language:ucfirst(settlement_type..location), frame)..p.categories |
|||
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 .. displayinline(contents, Notes) |
|||
end |
|||
if isInTitle(Display) then |
|||
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[count-1] or ''), '[EW]') do tmp[count] = (args[count] or ''); count = count+1 end |
|||
tmp.count = count; count = 2*(count-1) |
|||
while count >= tmp.count do table.insert(tmp, 1, (args[count] or '')); count = count-1 end |
|||
for i, v in ipairs(tmp) do args[i] = v end |
|||
else |
|||
while count <= 9 do args[count] = (args[count] 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[10] = '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(frame) |
|||
if frame.args[1] == '' or frame.args[2] == '' or not frame.args[2] then return nil end |
|||
frame.args[2] = mw.text.trim(frame.args[2]) |
|||
if frame.args[2] == 'lat' or frame.args[2] == 'long' then |
|||
local result, negative = mw.text.split((mw.ustring.match(frame.args[1],'[%.%d]+°[NS] [%.%d]+°[EW]') or ''), ' ') |
|||
if frame.args[2] == 'lat' then |
|||
result, negative = result[1], 'S' |
|||
else |
|||
result, negative = result[2], 'W' |
|||
end |
|||
result = mw.text.split(result, '°') |
|||
if result[2] == negative then result[1] = '-'..result[1] end |
|||
return result[1] |
|||
else |
|||
return mw.ustring.match(frame.args[1], 'params=.-_'..frame.args[2]..':(.-)[ _]') |
|||
end |
|||
end |
|||
--[[ |
|||
coordinsert |
|||
Injects some text into the Geohack link of a transclusion of {{Coord}} (if that text isn't already in the transclusion). Outputs the modified transclusion of {{Coord}}. |
|||
IF THE GEOHACK LINK SYNTAX CHANGES THIS FUNCTION MUST BE MODIFIED. |
|||
Usage: |
|||
{{#invoke:Coordinates | coordinsert | {{Coord}} | parameter:value | parameter:value | … }} |
|||
Do not make Geohack unhappy by inserting something which isn't mentioned in the {{Coord}} documentation. |
|||
]] |
|||
function coordinates.coordinsert(frame) |
|||
for i, v in ipairs(frame.args) do |
|||
if i ~= 1 then |
|||
if not mw.ustring.find(frame.args[1], (mw.ustring.match(frame.args[i], '^(.-:)') or '')) then |
|||
frame.args[1] = mw.ustring.gsub(frame.args[1], '(params=.-)_? ', '%1_'..frame.args[i]..' ') |
|||
end |
|||
end |
|||
end |
|||
if frame.args.name then |
|||
if not mw.ustring.find(frame.args[1], '<span class="vcard">') then |
|||
local namestr = frame.args.name |
|||
frame.args[1] = mw.ustring.gsub(frame.args[1], |
|||
'(<span class="geo%-default">)(<span[^<>]*>[^<>]*</span><span[^<>]*>[^<>]*<span[^<>]*>[^<>]*</span></span>)(</span>)', |
|||
'%1<span class="vcard">%2<span style="display:none"> (<span class="fn org">' .. namestr .. '</span>)</span></span>%3') |
|||
frame.args[1] = mw.ustring.gsub(frame.args[1], '(¶ms=[^&"<>%[%] ]*) ', '%1&title=' .. mw.uri.encode(namestr) .. ' ') |
|||
end |
|||
end |
|||
return frame.args[1] |
|||
end |
end |
||
return |
return p |
Latest revision as of 08:59, 11 January 2024
This Lua module is used on many pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
This module depends on the following other modules: |
Usage
Used in Template:Infobox settlement to generate short descriptions.
--generates auto short description for use in infobox settlement
local p = {}
p.categories = ""
local plain = require('Module:Plain text')._main
local getArgs = require('Module:Arguments').getArgs
local tableTools = require ('Module:TableTools')
function p.reverseTable (init)
init[1], init[3] = init[3], init[1]
return init
end
function p.assign (args, argname, num)
local val
local var = {}
for i = 0,num do
--handle initial "subdivision_foo" without number
if i == 0 then
val = ""
else
val = tostring(i)
end
var[i+1] = p.validate(plain(args[argname..val]))
end
return var
end
--Display short description using {{short description}}
function p.shortdesc(text, frame)
return frame:expandTemplate{title = 'Short description', args = {text, 'noreplace'}}
end
function p.category (cattype)
local category = string.format('[[Category:Pages using infobox settlement with bad %s]]', cattype)
if category then p.categories = p.categories..category end --categorize
end
--sanity and other checks
function p.validate (parameter, cat)
if not parameter then return nil end
parameter = parameter:gsub('%b()', '') --remove things in brackets as extraneous information
:gsub('%s+', ' ') --fix possible extra spaces from previous cleanup
:gsub('^%s+', '') --trim spaces from beginning
:gsub('%s+$', '') --trim spaces from end
if parameter:match("[,;]") or not parameter:match("%a") then --must have some letters, ignore if multiple types/subdivisions
if cat then p.category (cat) end
return nil
end
if (parameter == "") then return nil end
return parameter
end
--removes redundancy like "England, United Kingdom" and fixes issues like "Foo in United States" (to "Foo in the United States")
--also used in Module:Type in location
function p.cleanupLoc (location)
if location == "" then return nil end
local replacements = {
["England, United Kingdom"] = "England",
["Scotland, United Kingdom"] = "Scotland",
["Wales, United Kingdom"] = "Wales",
["New York City, New York, United States"] = "New York City",
["^United States$"] = "the United States",
["London, United Kingdom"] = "London, England"
}
for i, v in pairs(replacements) do
location = location:gsub(i, v) --series of replacements
end
return location
end
function p.main(frame)
local categories = ""
local subdivision_types = {}
local subdivision_names = {}
local args = getArgs (frame, {parentOnly = true})
local settlement_type = p.validate(plain(args.settlement_type or args.type), "settlement type") or "Place"
local short_description = plain(args.short_description)
subdivision_types = p.assign(args, "subdivision_type", 2)
subdivision_names = p.assign(args, "subdivision_name", 2)
if short_description then
if (short_description == 'no') then
return
else
local language = mw.language.getContentLanguage()
return p.shortdesc(language:ucfirst(short_description), frame)
end
end
if not(subdivision_names[3] and
(string.find(settlement_type, '[nN]eighbo[u]?rhood') or string.find(settlement_type, '[sS]uburb'))) then
subdivision_names[3] = nil --display the third subdivision_type only if suburb or neighborhood
end
--if say "Voivodeship" is found within the subdivision_type, then specially handle
--by adding Voivodeship to the end if not already present
for x, y in ipairs (subdivision_types) do
local special_types = {
"Voivodeship"
}
for i, j in ipairs(special_types) do
if subdivision_names[x] and string.find(y, j, 1, true)
and not string.find(subdivision_names[x], j, 1, true) then
subdivision_names[x] = subdivision_names[x].." "..j
end
end
end
for x, y in ipairs (subdivision_names) do
if y then
if string.find(settlement_type, y, 1, true) then --if the subdivision is found within the settlement type
subdivision_names[x] = nil --don't display redundancy
p.category ("settlement type")
end
if y == mw.title.getCurrentTitle().text then --if the title is the same as one of the subdivision_names
subdivision_names[x] = nil --don't display redundancy
end
end
end
local location = table.concat(tableTools.compressSparseArray(p.reverseTable(subdivision_names)), ', ')
location = p.cleanupLoc (location)
if location then location = " in " .. location else location = "" end
local language = mw.language.getContentLanguage()
--commented out for now (BROKEN) return p.shortdesc(language:ucfirst(settlement_type..location), frame)..p.categories
end
return p