Ethan's Workspace

Module:Infobox mapframe: Difference between revisions

[[Templates]]>ISUtahraptor
Created page with "local mf = require('Module:Mapframe') local getArgs = require('Module:Arguments').getArgs local yesno = require('Module:Yesno') local infoboxImage = require('Module:InfoboxIma..."
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 11: 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_GEOMASK_FILL_OPACITY = "0.25"
local DEFAULT_SHAPE_STROKE_WIDTH = "3"
local DEFAULT_SHAPE_STROKE_WIDTH = "2"
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_SHAPE_FILL_OPACITY = "0.1"
local DEFAULT_LINE_STROKE_WIDTH = "5"
local DEFAULT_LINE_STROKE_WIDTH = "5"
local DEFAULT_LINE_STROKE_COLOR = "#FF0000"
local DEFAULT_LINE_STROKE_COLOR = "#FF0000"
local DEFAULT_MARKER_COLOR = "#5E74F3"
local DEFAULT_MARKER_COLOR = "#5E74F3"


local util = {}
function util.noop(info)
local DEFAULT_NOOP_OUTPUT = ""
-- uncomment this when debugging
-- DEFAULT_NOOP_OUTPUT = "debug: mapframe no-op: " .. info
-- mw.log(DEFAULT_NOOP_OUTPUT)
return DEFAULT_NOOP_OUTPUT
end


-- Trim whitespace from args, and remove empty args
-- Trim whitespace from args, and remove empty args
function trimArgs(argsTable)
function util.trimArgs(argsTable)
local cleanArgs = {}
local cleanArgs = {}
for key, val in pairs(argsTable) do
for key, val in pairs(argsTable) do
Line 37: Line 48:
end
end


function getBestStatement(item_id, property_id)
function util.getBestStatement(item_id, property_id)
if not(item_id) or not(mw.wikibase.isValidEntityId(item_id)) or not(mw.wikibase.entityExists(item_id)) then
if not(item_id) or not(mw.wikibase.isValidEntityId(item_id)) or not(mw.wikibase.entityExists(item_id)) then
return false
return false
Line 52: Line 63:
end
end


function hasWikidataProperty(item_id, property_id)
function util.hasWikidataProperty(item_id, property_id)
return getBestStatement(item_id, property_id) and true or false
return util.getBestStatement(item_id, property_id) and true or false
end
end


function getStatementValue(statement)
function util.getStatementValue(statement)
return statement and statement.mainsnak and statement.mainsnak.datavalue and statement.mainsnak.datavalue.value or nil
return statement and statement.mainsnak and statement.mainsnak.datavalue and statement.mainsnak.datavalue.value or nil
end
end


function relatedEntity(item_id, property_id)
function util.relatedEntity(item_id, property_id)
local value = getStatementValue( getBestStatement(item_id, property_id) )
local value = util.getStatementValue( util.getBestStatement(item_id, property_id) )
return value and value.id or false
return value and value.id or false
end
end


function idType(id)
function util.idType(id)
if not id then  
if not id then  
return nil
return nil
Line 77: Line 88:
end
end


function getZoom(value, unit)
function util.shouldAutoRun(frame)
local length_km
if unit == 'km' then
length_km = tonumber(value)
elseif unit == 'mi' then
length_km = tonumber(value)*1.609344
elseif unit == 'km2' then
length_km = math.sqrt(tonumber(value))
elseif unit == 'mi2' then
length_km = math.sqrt(tonumber(value))*1.609344
end
-- max for zoom 2 is 6400km, for zoom 3 is 3200km, for zoom 4 is 1600km, etc
local zoom = math.floor(8 - (math.log10(length_km) - 2)/(math.log10(2)))
-- limit to values below 17
zoom = math.min(17, zoom)
-- take off 1 when calculated from area, to account for unusual shapes
if unit == 'km2' or unit == 'mi2' then
zoom = zoom - 1
end
-- minimum value is 1
return math.max(1, zoom)
end
 
function shouldAutoRun(frame)
-- Check if should be running
-- Check if should be running
local explicitlyOn = yesno(mw.text.trim(frame.getParent(frame).args.mapframe or "")) -- true of false or nil
local pargs = frame.getParent(frame).args
local explicitlyOn = yesno(mw.text.trim(pargs.mapframe or "")) -- true of false or nil
if pargs.coordinates == "{{{coordinates}}}" then explicitlyOn = false end
local onByDefault = (explicitlyOn == nil) and yesno(mw.text.trim(frame.args.onByDefault or ""), false) -- true or false
local onByDefault = (explicitlyOn == nil) and yesno(mw.text.trim(frame.args.onByDefault or ""), false) -- true or false
return explicitlyOn or onByDefault
return explicitlyOn or onByDefault
end
end


function argsFromAuto(frame)
function util.argsFromAuto(frame)
-- Get args from the frame (invoke call) and the parent (template call).
-- Get args from the frame (invoke call) and the parent (template call).
-- Frame arguments are default values which are overridden by parent values
-- Frame arguments are default values which are overridden by parent values
-- when both are present
-- when both are present
local args = getArgs(frame, {parentFirst = true})
local args = getArgs(frame, {parentFirst = true})
 
-- Discard args not prefixed with "mapframe-", remove that prefix from those that remain
-- Discard args not prefixed with "mapframe-", remove that prefix from those that remain
local fixedArgs = {}
local fixedArgs = {}
Line 125: Line 115:
elseif name == "id" or name == "qid" and not fixedArgs.id then
elseif name == "id" or name == "qid" and not fixedArgs.id then
fixedArgs.id = val
fixedArgs.id = val
        -- allow captionstyle to be unprefixed, for compatibility with [[Module:Infobox]]
        elseif name == "captionstyle" and not fixedArgs.captionstyle then
            fixedArgs.captionstyle = val
end
end
end
end
return fixedArgs
return fixedArgs
end
function util.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
function util.trackAndWarn(trackingCat, warning)
    local title = mw.title.getCurrentTitle()
    local results = title and title.namespace == 0 and trackingCat and '[[Category:'..trackingCat..']]' or ''
    if warning then
        local warn = require('Module:If preview')._warning
        results = results..warn({warning})
    end
    return results
end
function util.ternary(flag, other)
    other = other or 'other'
    flag = flag == 'none' and 'no' or flag
    local yesNoOut = yesno(flag,other)
    local yes = (yesNoOut == true)
    local no = (yesNoOut == false)
    return yes, no
end
end


local p = {}
local p = {}


p.autocaption = function(frame)
 
if not shouldAutoRun(frame) then return "" end
p._caption = function(args)
local args = argsFromAuto(frame)
if args.caption then
if args.caption then
return args.caption
return args.caption
elseif args.switcher then  
elseif args.switcher then  
return ""
return util.noop("no caption or switcher")
end
end
local maskItem
local maskItem
local maskType = idType(args.geomask)
local maskType = util.idType(args.geomask)
if maskType == 'item' then
if maskType == 'item' then
maskItem = args.geomask
maskItem = args.geomask
elseif maskType == "property" then
elseif maskType == "property" then
maskItem = relatedEntity(args.id or mw.wikibase.getEntityIdForCurrentPage(), args.geomask)
maskItem = util.relatedEntity(args.id or mw.wikibase.getEntityIdForCurrentPage(), args.geomask)
end
end
local maskItemLabel = maskItem and mw.wikibase.getLabel( maskItem )
local maskItemLabel = maskItem and mw.wikibase.getLabel( maskItem )
return maskItemLabel and "Location in "..maskItemLabel or ""
return maskItemLabel and "Location in "..maskItemLabel
end
or util.noop("missing maskItemLabel with type " .. (maskType or "nil") .. " and item " .. (maskItem or "nil"))
 
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
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)
--A list of types for objects that are too small to allow Kartographer to take over zoom
local parent = frame.getParent(frame)
local tinyType = {
local parentArgs = parent.args
    landmark=true,
local mapframe = p._main(parentArgs)
    railwaystation=true,
return frame:preprocess(mapframe)
    edu=true,
end
    pass=true,
    camera=true
}               


p._main = function(_config)
p._main = function(_config)
    -- accumulate tracking cats
    local tracking = ''
-- `config` is the args passed to this module
-- `config` is the args passed to this module
local config = trimArgs(_config)
local config = util.trimArgs(_config)
    -- allow alias for config.coord
    config.coord = config.coord or config.coordinates
-- Require wikidata item, or specified coords
-- Require wikidata item, or specified coords
local wikidataId = config.id or mw.wikibase.getEntityIdForCurrentPage()
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 false, util.trackAndWarn('Pages using infobox mapframe with missing coordinates')
end
end


-- Require coords (specified or from wikidata), so that map will be centred somewhere
-- Require coords (specified or from wikidata), so that map will be centred somewhere
-- (P625 = coordinate location)
-- (P625 = coordinate location)
local hasCoordinates = hasWikidataProperty(wikidataId, 'P625') or config.coordinates or config.coord
    local wdCoordinates = util.getStatementValue(util.getBestStatement(wikidataId, 'P625'))
if not hasCoordinates then
    if not (config.coord or wdCoordinates) then
return ''
return false, util.trackAndWarn('Pages using infobox mapframe with missing coordinates')
end
end


Line 206: Line 218:
args["frame-align"]  = "center"
args["frame-align"]  = "center"


args["frame-coord"] = config["frame-coordinates"] or config["frame-coord"] or ""
args["frame-coord"] = config["frame-coordinates"] or config["frame-coord"]
-- Note: config["coordinates"] or config["coord"] should not be used for the alignment of the frame;
-- Note: config["coordinates"] or config["coord"] should not be used for the alignment of the frame;
-- see talk page ( https://en.wikipedia.org/wiki/Special:Diff/876492931 )
-- see talk page ( https://en.wikipedia.org/wiki/Special:Diff/876492931 )


-- deprecated lat and long parameters
-- deprecated lat and long parameters
args["frame-lat"]    = config["frame-lat"] or config["frame-latitude"] or ""
args["frame-lat"]    = config["frame-lat"] or config["frame-latitude"]
args["frame-long"]  = config["frame-long"] or config["frame-longitude"] or ""
args["frame-long"]  = config["frame-long"] or config["frame-longitude"]
 
    -- if zoom isn't specified from config, first check wikidata
    local zoom = config.zoom or util.getStatementValue(util.getBestStatement(wikidataId, 'P6592'))
    if not zoom then
    -- Calculate zoom from length or area (converted to km or km2)
    -- Zoom so that length or area is completely included in mapframe
    local getZoom = require('Module:Infobox dim')._zoom
    zoom = getZoom({length_km=config.length_km, length_mi=config.length_mi,
                        width_km=config.width_km, width_mi=config.width_mi,
                area_km2=config.area_km2, area_mi2=config.area_mi2,
                        area_ha=config.area_ha, area_acre=config.area_acre,
                        type=config.type, population=config.population,
                viewport_px=math.min(args["frame-width"],args["frame-height"]),
                        latitude=wdCoordinates and wdCoordinates.latitude})
    end
    args.zoom = zoom or DEFAULT_ZOOM


-- Calculate zoom from length or area (converted to km or km2)
-- Use OSM relation ID if available; otherwise use geoshape if that is available
if config.length_km then
-- (geoshape is required for defunct entities, which are outside OSM's scope)
args.zoom = getZoom(config.length_km, 'km')
local hasOsmRelationId = util.hasWikidataProperty(wikidataId, 'P402') -- P402 is OSM relation ID
elseif config.length_mi then
local hasGeoshape = util.hasWikidataProperty(wikidataId, 'P3896') -- P3896 is geoshape
args.zoom = getZoom(config.length_mi, 'mi')
local wikidataProvidesGeo = hasOsmRelationId or hasGeoshape
elseif config.area_km2 then
 
args.zoom = getZoom(config.area_km2, 'km2')
    -- determine marker argument value, determine whether to show marker
elseif config.area_mi2 then
    local forcePoint, suppressPoint = util.ternary(config.point)
args.zoom = getZoom(config.area_mi2, 'mi2')
    local forceMarker, suppressMarker = util.ternary(config.marker,true)
else
 
args.zoom = config.zoom or DEFAULT_ZOOM
    forcePoint = forcePoint or forceMarker
end
    suppressPoint = suppressPoint or suppressMarker
 
    local showMarker = not suppressPoint and (forcePoint or not wikidataProvidesGeo or config.coord)
   
    -- wikidata = "yes" turns on both shape and line
    -- wikidata = "no" turns off both shape and line
    -- otherwise show both if wikidata provides geo
    local forceWikidata, suppressWikidata = util.ternary(config.wikidata)
    local showShape = not suppressWikidata and (forceWikidata or wikidataProvidesGeo or not config.coord)
    local showLine = showShape


-- Conditionals: whether point, geomask should be shown
    -- determine shape parameter value, determine whether to show or suppress shape
local hasOsmRelationId = hasWikidataProperty(wikidataId, 'P402') -- P402 is OSM relation ID
    -- also determine whether to invert shape
local shouldShowPointMarker;
    local forceShape, suppressShape = util.ternary(config.shape)
if config.point == "on" then
    showShape = wikidataId and not suppressShape and (forceShape or showShape)
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 shapeType = config.shape == 'inverse' and 'shape-inverse' or 'shape'
local shouldShowLine = config.line ~= 'none'
 
local maskItem
    -- determine line parameter value, determine whether to show or suppress line
local useWikidata = wikidataId and true or false -- Use shapes/lines based on wikidata id, if there is one
    local forceLine, suppressLine = util.ternary(config.line)
-- But do not use wikidata when local coords are specified (and not turned off), unless explicitly set
    showLine = wikidataId and not suppressLine and (forceLine or showLine)
if useWikidata and config.coord and shouldShowPointMarker then
 
useWikidata = config.wikidata and true or false
    local maskItem
end
-- Switcher
-- Switcher
if config.switcher == "zooms" then
if config.switcher == "zooms" then
Line 261: Line 289:
local maskLabels = {}
local maskLabels = {}
local maskItems = {}
local maskItems = {}
local maskItemId = relatedEntity(wikidataId, "P276") or  relatedEntity(wikidataId, "P131")  
local maskItemId = util.relatedEntity(wikidataId, "P276") or  util.relatedEntity(wikidataId, "P131")  
local maskLabel = mw.wikibase.getLabel(maskItemId)
local maskLabel = mw.wikibase.getLabel(maskItemId)
while maskItemId and maskLabel and mw.text.trim(maskLabel) ~= "" do
while maskItemId and maskLabel and mw.text.trim(maskLabel) ~= "" do
table.insert(maskLabels, maskLabel)
table.insert(maskLabels, maskLabel)
table.insert(maskItems, maskItemId)
table.insert(maskItems, maskItemId)
maskItemId = maskItemId and relatedEntity(maskItemId, "P131")
maskItemId = maskItemId and util.relatedEntity(maskItemId, "P131")
maskLabel = maskItemId and mw.wikibase.getLabel(maskItemId)
maskLabel = maskItemId and mw.wikibase.getLabel(maskItemId)
end
end
Line 294: Line 322:
-- resolve geomask item id (if not using geomask switcher)
-- resolve geomask item id (if not using geomask switcher)
if not maskItem then --   
if not maskItem then --   
local maskType = idType(config.geomask)
local maskType = util.idType(config.geomask)
if maskType == 'item' then
if maskType == 'item' then
maskItem = config.geomask
maskItem = config.geomask
elseif maskType == "property" then
elseif maskType == "property" then
maskItem = relatedEntity(wikidataId, config.geomask)
maskItem = util.relatedEntity(wikidataId, config.geomask)
end
end
end
end
    -- if asking for shape or line from Wikidata
    -- and if Wikidata actually has shape/line data (wikidataProvidesGeo=true)
    -- and if no geomask
    -- and if zoom not explicitly set
    -- and if the object size inferred from its type is not too small
    -- then let Kartographer "take over" zoom
    if (showLine or showShape) and wikidataProvidesGeo and not maskItem
      and not config.zoom and not (config.type and tinyType[config.type]) then
    args.zoom = nil
    end
    if not maskItem and not showShape and not showLine and not showMarker then
        return false, util.trackAndWarn('Pages using infobox mapframe with no geometry','No geometry specified for mapframe')
    end
-- Keep track of arg numbering
-- Keep track of arg numbering
Line 326: Line 369:
args["frame-lat"] = nil
args["frame-lat"] = nil
args["frame-long"] = nil
args["frame-long"] = nil
local maskArea = getStatementValue( getBestStatement(maskItem, 'P2046') )
local maskArea = util.getStatementValue( util.getBestStatement(maskItem, 'P2046') )
end
end
incrementArgNumber()
incrementArgNumber()
Line 339: Line 382:
-- Shape (or shape-inverse)
-- Shape (or shape-inverse)
if useWikidata and shouldShowShape then
if showShape then
args["type"..argNumber] = shapeType
args["type"..argNumber] = shapeType
if config.id then args["id"..argNumber] = config.id end
if hasGeoshape and not hasOsmRelationId then
args["from"..argNumber] = string.sub( util.getStatementValue( util.getBestStatement(wikidataId, 'P3896') ), 6)
elseif 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
Line 350: Line 397:
-- Line
-- Line
if useWikidata and shouldShowLine then
if showLine then
args["type"..argNumber] = "line"
args["type"..argNumber] = "line"
if config.id then args["id"..argNumber] = config.id end
if hasGeoshape and not hasOsmRelationId then
args["from"..argNumber] = string.sub( util.getStatementValue( util.getBestStatement(wikidataId, 'P3896') ), 6)
elseif config.id then  
args["id"..argNumber] = config.id
end
args["stroke-width"..argNumber] = config["line-stroke-width"] or config["stroke-width"] or DEFAULT_LINE_STROKE_WIDTH
args["stroke-width"..argNumber] = config["line-stroke-width"] or config["stroke-width"] or DEFAULT_LINE_STROKE_WIDTH
args["stroke-color"..argNumber] = config["line-stroke-color"] or config["line-stroke-colour"] or config["stroke-color"] or config["stroke-colour"] or DEFAULT_LINE_STROKE_COLOR
args["stroke-color"..argNumber] = config["line-stroke-color"] or config["line-stroke-colour"] or config["stroke-color"] or config["stroke-colour"] or DEFAULT_LINE_STROKE_COLOR
Line 358: Line 409:
end
end


-- Point
-- Point marker
if shouldShowPointMarker then
if showMarker then
args["type"..argNumber] = "point"
args["type"..argNumber] = "point"
if config.id then args["id"..argNumber] = config.id end
if config.id then args["id"..argNumber] = config.id end
Line 367: Line 418:
incrementArgNumber()
incrementArgNumber()
end
end
    -- if Wikidata doesn't link to OSM and the map has no mask or point,
    -- then center the map on the coordinates either from the infobox or from wikidata
    if not maskItem and not showMarker and not wikidataProvidesGeo then
        if config.coord then
            args["frame-coord"] = args["frame-coord"] or config.coord
        else
            args["frame-lat"] = args["frame-lat"] or wdCoordinates.latitude
            args["frame-long"] = args["frame-long"] or wdCoordinates.longitude
        end
        tracking = tracking..util.trackAndWarn('Pages using infobox mapframe with forced centering')
    end
    -- protect against nil frame arguments
    args["frame-coord"] = args["frame-coord"] or ""
    args["frame-lat"] = args["frame-lat"] or ""
    args["frame-long"] = args["frame-long"] or ""


local mapframe = args.switch and mf.multi(args) or 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]]'
tracking = tracking..((showLine or showShape) and not wikidataProvidesGeo
return mapframe .. tracking
                          and util.trackAndWarn('Pages using infobox mapframe without shape links in Wikidata')
                          or '')
return true, mapframe.. tracking
end
 
-- Entry points
 
p.main = function(frame)
local parent = frame.getParent(frame)
local parentArgs = parent.args
local _, mapframe = p._main(parentArgs)
return frame:preprocess(mapframe)
end
 
p.auto = function(frame)
if not util.shouldAutoRun(frame) then
return util.noop("auto should not autorun")
end
local args = util.argsFromAuto(frame)
if args.custom then
return frame:preprocess(util.parseCustomWikitext(args.custom))
end
local _, mapframe = p._main(args)
return frame:preprocess(mapframe)
end
end


p.autocaption = function(frame)
if not util.shouldAutoRun(frame) then
return util.noop("autocaption should not autorun")
end
local args = util.argsFromAuto(frame)
    local caption = p._caption(args)
    return caption
end
p.autoWithCaption = function(frame)
if not util.shouldAutoRun(frame) then
return util.noop("autoWithCaption should not autorun")
end
local args = util.argsFromAuto(frame)
    local wikitext
    local caption
    local ok
    if args.custom then
        ok = true
        wikitext = util.parseCustomWikitext(args.custom)
    else
        ok, wikitext = p._main(args)
    end
    if not ok then return wikitext end
    wikitext = frame:preprocess(wikitext)
    caption = p._caption(args)
    local data = mw.html.create():wikitext(wikitext)
    data:tag('div')
    :addClass('infobox-caption')
:cssText(args.captionstyle)
:wikitext(caption)
    return tostring(data)
end
   
return p
return p
Retrieved from "http://ethans-workspace.com/wiki/Module:Infobox_mapframe"