Module:Infobox mapframe: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
Reschultzed (talk | contribs) No edit summary |
Reschultzed (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
local mf = require('Module:Mapframe') |
local mf = require('Module:Mapframe') |
||
local getArgs = require('Module:Arguments').getArgs |
|||
local yesno = require('Module:Yesno') |
|||
local infoboxImage = require('Module:InfoboxImage').InfoboxImage |
|||
-- Defaults |
-- Defaults |
||
Line 8: | Line 11: | ||
local DEFAULT_GEOMASK_STROKE_COLOR = "#777777" |
local DEFAULT_GEOMASK_STROKE_COLOR = "#777777" |
||
local DEFAULT_GEOMASK_FILL = "#888888" |
local DEFAULT_GEOMASK_FILL = "#888888" |
||
local DEFAULT_GEOMASK_FILL_OPACITY = "0.5" |
|||
local DEFAULT_SHAPE_STROKE_WIDTH = "3" |
local DEFAULT_SHAPE_STROKE_WIDTH = "3" |
||
local DEFAULT_SHAPE_STROKE_COLOR = "#FF0000" |
local DEFAULT_SHAPE_STROKE_COLOR = "#FF0000" |
||
local DEFAULT_SHAPE_FILL = "#606060" |
local DEFAULT_SHAPE_FILL = "#606060" |
||
local DEFAULT_SHAPE_FILL_OPACITY = "0.5" |
|||
local DEFAULT_LINE_STROKE_WIDTH = "5" |
local DEFAULT_LINE_STROKE_WIDTH = "5" |
||
local DEFAULT_LINE_STROKE_COLOR = "#FF0000" |
local DEFAULT_LINE_STROKE_COLOR = "#FF0000" |
||
Line 93: | Line 98: | ||
-- minimum value is 1 |
-- minimum value is 1 |
||
return math.max(1, zoom) |
return math.max(1, zoom) |
||
end |
|||
function shouldAutoRun(frame) |
|||
-- Check if should be running |
|||
local explicitlyOn = yesno(mw.text.trim(frame.getParent(frame).args.mapframe or "")) -- true of false or nil |
|||
local onByDefault = (explicitlyOn == nil) and yesno(mw.text.trim(frame.args.onByDefault or ""), false) -- true or false |
|||
return explicitlyOn or onByDefault |
|||
end |
|||
function argsFromAuto(frame) |
|||
-- Get args from the frame (invoke call) and the parent (template call). |
|||
-- Frame arguments are default values which are overridden by parent values |
|||
-- when both are present |
|||
local args = getArgs(frame, {parentFirst = true}) |
|||
-- Discard args not prefixed with "mapframe-", remove that prefix from those that remain |
|||
local fixedArgs = {} |
|||
for name, val in pairs(args) do |
|||
local fixedName = string.match(name, "^mapframe%-(.+)$" ) |
|||
if fixedName then |
|||
fixedArgs[fixedName] = val |
|||
-- allow coord, coordinates, etc to be unprefixed |
|||
elseif name == "coordinates" or name == "coord" or name == "coordinate" and not fixedArgs.coord then |
|||
fixedArgs.coord = val |
|||
-- allow id, qid to be unprefixed, map to id (if not already present) |
|||
elseif name == "id" or name == "qid" and not fixedArgs.id then |
|||
fixedArgs.id = val |
|||
end |
|||
end |
|||
return fixedArgs |
|||
end |
end |
||
local p = {} |
local p = {} |
||
p.autocaption = function(frame) |
|||
if not shouldAutoRun(frame) then return "" end |
|||
local args = argsFromAuto(frame) |
|||
if args.caption then |
|||
return args.caption |
|||
elseif args.switcher then |
|||
return "" |
|||
end |
|||
local maskItem |
|||
local maskType = idType(args.geomask) |
|||
if maskType == 'item' then |
|||
maskItem = args.geomask |
|||
elseif maskType == "property" then |
|||
maskItem = relatedEntity(args.id or mw.wikibase.getEntityIdForCurrentPage(), args.geomask) |
|||
end |
|||
local maskItemLabel = maskItem and mw.wikibase.getLabel( maskItem ) |
|||
return maskItemLabel and "Location in "..maskItemLabel or "" |
|||
end |
|||
function parseCustomWikitext(customWikitext) |
|||
-- infoboxImage will format an image if given wikitext containing an |
|||
-- image, or else pass through the wikitext unmodified |
|||
return infoboxImage({ |
|||
args = { |
|||
image = customWikitext |
|||
} |
|||
}) |
|||
end |
|||
p.auto = function(frame) |
|||
if not shouldAutoRun(frame) then return "" end |
|||
local args = argsFromAuto(frame) |
|||
if args.custom then |
|||
return frame:preprocess(parseCustomWikitext(args.custom)) |
|||
end |
|||
local mapframe = p._main(args) |
|||
return frame:preprocess(mapframe) |
|||
end |
|||
p.main = function(frame) |
p.main = function(frame) |
||
Line 107: | Line 181: | ||
-- `config` is the args passed to this module |
-- `config` is the args passed to this module |
||
local config = trimArgs(_config) |
local config = trimArgs(_config) |
||
-- Use wikidata by default |
|||
local useWikidata = true |
|||
-- Do not use wikidata when coords are specified, unless explicitly set |
|||
if config.coord then |
|||
useWikidata = config.wikidata and true or false |
|||
end |
|||
-- Require wikidata item, or specified coords |
-- Require wikidata item, or specified coords |
||
local wikidataId = config.id |
local wikidataId = config.id or mw.wikibase.getEntityIdForCurrentPage() |
||
if not(wikidataId) and not(config.coord) then |
if not(wikidataId) and not(config.coord) then |
||
return '' |
return '' |
||
Line 135: | Line 202: | ||
args.frame = "yes" |
args.frame = "yes" |
||
args.plain = "yes" |
args.plain = "yes" |
||
args["frame-width"] = config["frame-width"] or DEFAULT_FRAME_WIDTH |
args["frame-width"] = config["frame-width"] or config.width or DEFAULT_FRAME_WIDTH |
||
args["frame-height"] = config["frame-height"] or DEFAULT_FRAME_HEIGHT |
args["frame-height"] = config["frame-height"] or config.height or DEFAULT_FRAME_HEIGHT |
||
args["frame-align"] = "center" |
args["frame-align"] = "center" |
||
Line 159: | Line 226: | ||
args.zoom = config.zoom or DEFAULT_ZOOM |
args.zoom = config.zoom or DEFAULT_ZOOM |
||
end |
end |
||
-- Conditionals: whether point, geomask should be shown |
-- Conditionals: whether point, geomask should be shown |
||
local hasOsmRelationId = hasWikidataProperty(wikidataId, 'P402') -- P402 is OSM relation ID |
local hasOsmRelationId = hasWikidataProperty(wikidataId, 'P402') -- P402 is OSM relation ID |
||
local shouldShowPointMarker |
local shouldShowPointMarker; |
||
if config.point == "on" then |
|||
shouldShowPointMarker = true |
|||
elseif config.point == "none" then |
|||
shouldShowPointMarker = false |
|||
else |
|||
shouldShowPointMarker = not(hasOsmRelationId) or (config.marker and config.marker ~= 'none') or (config.coordinates or config.coord) |
|||
end |
|||
local shouldShowShape = config.shape ~= 'none' |
|||
local shapeType = config.shape == 'inverse' and 'shape-inverse' or 'shape' |
|||
local shouldShowLine = config.line ~= 'none' |
|||
local maskItem |
local maskItem |
||
local useWikidata = wikidataId and true or false -- Use shapes/lines based on wikidata id, if there is one |
|||
local maskType = idType(config.geomask) |
|||
-- But do not use wikidata when local coords are specified (and not turned off), unless explicitly set |
|||
if maskType == 'item' then |
|||
if useWikidata and config.coord and shouldShowPointMarker then |
|||
maskItem = config.geomask |
|||
useWikidata = config.wikidata and true or false |
|||
elseif maskType == "property" then |
|||
end |
|||
maskItem = relatedEntity(wikidataId, config.geomask) |
|||
-- Switcher |
|||
if config.switcher == "zooms" then |
|||
-- switching between zoom levels |
|||
local maxZoom = math.max(tonumber(args.zoom), 3) -- what zoom would have otherwise been (if 3 or more, otherwise 3) |
|||
local minZoom = 1 -- completely zoomed out |
|||
local midZoom = math.floor((maxZoom + minZoom)/2) -- midway between maxn and min |
|||
args.switch = "zoomed in, zoomed midway, zoomed out" |
|||
args.zoom = string.format("SWITCH:%d,%d,%d", maxZoom, midZoom, minZoom) |
|||
elseif config.switcher == "auto" then |
|||
-- switching between P276 and P131 areas with recursive lookup, e.g. item's city, |
|||
-- that city's state, and that state's country |
|||
args.zoom = nil -- let kartographer determine the zoom |
|||
local maskLabels = {} |
|||
local maskItems = {} |
|||
local maskItemId = relatedEntity(wikidataId, "P276") or relatedEntity(wikidataId, "P131") |
|||
local maskLabel = mw.wikibase.getLabel(maskItemId) |
|||
while maskItemId and maskLabel and mw.text.trim(maskLabel) ~= "" do |
|||
table.insert(maskLabels, maskLabel) |
|||
table.insert(maskItems, maskItemId) |
|||
maskItemId = maskItemId and relatedEntity(maskItemId, "P131") |
|||
maskLabel = maskItemId and mw.wikibase.getLabel(maskItemId) |
|||
end |
|||
if #maskLabels > 1 then |
|||
args.switch = table.concat(maskLabels, "###") |
|||
maskItem = "SWITCH:" .. table.concat(maskItems, ",") |
|||
elseif #maskLabels == 1 then |
|||
maskItem = maskItemId[1] |
|||
end |
|||
elseif config.switcher == "geomasks" and config.geomask then |
|||
-- switching between items in geomask parameter |
|||
args.zoom = nil -- let kartographer determine the zoom |
|||
local separator = (mw.ustring.find(config.geomask, "###", 0, true ) and "###") or |
|||
(mw.ustring.find(config.geomask, ";", 0, true ) and ";") or "," |
|||
local pattern = "%s*"..separator.."%s*" |
|||
local maskItems = mw.text.split(mw.ustring.gsub(config.geomask, "SWITCH:", ""), pattern) |
|||
local maskLabels = {} |
|||
if #maskItems > 1 then |
|||
for i, item in ipairs(maskItems) do |
|||
table.insert(maskLabels, mw.wikibase.getLabel(item)) |
|||
end |
|||
args.switch = table.concat(maskLabels, "###") |
|||
maskItem = "SWITCH:" .. table.concat(maskItems, ",") |
|||
end |
|||
end |
|||
-- resolve geomask item id (if not using geomask switcher) |
|||
if not maskItem then -- |
|||
local maskType = idType(config.geomask) |
|||
if maskType == 'item' then |
|||
maskItem = config.geomask |
|||
elseif maskType == "property" then |
|||
maskItem = relatedEntity(wikidataId, config.geomask) |
|||
end |
|||
end |
end |
||
Line 188: | Line 319: | ||
args["stroke-color"..argNumber] = config["geomask-stroke-color"] or config["geomask-stroke-colour"] or DEFAULT_GEOMASK_STROKE_COLOR |
args["stroke-color"..argNumber] = config["geomask-stroke-color"] or config["geomask-stroke-colour"] or DEFAULT_GEOMASK_STROKE_COLOR |
||
args["fill"..argNumber] = config["geomask-fill"] or DEFAULT_GEOMASK_FILL |
args["fill"..argNumber] = config["geomask-fill"] or DEFAULT_GEOMASK_FILL |
||
args["fill-opacity"..argNumber] = config["geomask-fill-opacity"] or DEFAULT_SHAPE_FILL_OPACITY |
|||
-- Recalculate zoom based on mask area, if available, and not set in config |
|||
-- Let kartographer determine zoom and position, unless it is explicitly set in config |
|||
if not config.zoom then |
|||
if not config.zoom and not config.switcher then |
|||
args.zoom = nil |
|||
args["frame-coord"] = nil |
|||
args["frame-lat"] = nil |
|||
args["frame-long"] = nil |
|||
local maskArea = getStatementValue( getBestStatement(maskItem, 'P2046') ) |
local maskArea = getStatementValue( getBestStatement(maskItem, 'P2046') ) |
||
if maskArea and maskArea.amount then |
|||
if maskArea.unit == 'http://www.wikidata.org/entity/Q712226' then -- square kilometre |
|||
args.zoom = getZoom(maskArea.amount, 'km2') |
|||
elseif maskArea.unit == 'http://www.wikidata.org/entity/Q232291' then -- square mile |
|||
args.zoom = getZoom(maskArea.amount, 'mi2') |
|||
end |
|||
end |
|||
end |
end |
||
incrementArgNumber() |
incrementArgNumber() |
||
-- Hack to fix phab:T255932 |
|||
if not args.zoom then |
|||
args["type"..argNumber] = "line" |
|||
args["id"..argNumber] = maskItem |
|||
args["stroke-width"..argNumber] = 0 |
|||
incrementArgNumber() |
|||
end |
|||
end |
end |
||
-- Shape |
-- Shape (or shape-inverse) |
||
if useWikidata then |
if useWikidata and shouldShowShape then |
||
args["type"..argNumber] = |
args["type"..argNumber] = shapeType |
||
if config.id then args["id"..argNumber] = config.id end |
if config.id then args["id"..argNumber] = config.id end |
||
args["stroke-width"..argNumber] = config["shape-stroke-width"] or config["stroke-width"] or DEFAULT_SHAPE_STROKE_WIDTH |
args["stroke-width"..argNumber] = config["shape-stroke-width"] or config["stroke-width"] or DEFAULT_SHAPE_STROKE_WIDTH |
||
args["stroke-color"..argNumber] = config["shape-stroke-color"] or config["shape-stroke-colour"] or config["stroke-color"] or config["stroke-colour"] or DEFAULT_SHAPE_STROKE_COLOR |
args["stroke-color"..argNumber] = config["shape-stroke-color"] or config["shape-stroke-colour"] or config["stroke-color"] or config["stroke-colour"] or DEFAULT_SHAPE_STROKE_COLOR |
||
args["fill"..argNumber] = config["shape-fill"] or DEFAULT_SHAPE_FILL |
args["fill"..argNumber] = config["shape-fill"] or DEFAULT_SHAPE_FILL |
||
args["fill-opacity"..argNumber] = config["shape-fill-opacity"] or DEFAULT_SHAPE_FILL_OPACITY |
|||
incrementArgNumber() |
incrementArgNumber() |
||
end |
end |
||
-- Line |
-- Line |
||
if useWikidata then |
if useWikidata and shouldShowLine then |
||
args["type"..argNumber] = "line" |
args["type"..argNumber] = "line" |
||
if config.id then args["id"..argNumber] = config.id end |
if config.id then args["id"..argNumber] = config.id end |
||
Line 231: | Line 368: | ||
end |
end |
||
local mapframe = mf._main(args) |
local mapframe = args.switch and mf.multi(args) or mf._main(args) |
||
local tracking = hasOsmRelationId and '' or '[[Category:Infobox mapframe without OSM relation ID on Wikidata]]' |
local tracking = hasOsmRelationId and '' or '[[Category:Infobox mapframe without OSM relation ID on Wikidata]]' |
||
return mapframe .. tracking |
return mapframe .. tracking |