Jump to content

Module:WDfetch: Difference between revisions

From Amateur Theatre Wiki
test
Tag: Reverted
Undo revision 1449 by PCAdmin (talk)
Tag: Undo
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
-- This Lua module is designed for use in MediaWiki templates,
-- particularly for MDwiki infoboxes, to retrieve and display clean values
-- from Wikidata via the UnlinkedWikibase extension.
--
-- The module fetches the value of a specified Wikidata property (P-ID)
-- using the {{#statements:}} parser function provided by the extension.
--
-- Example usage in a template:
-- {{#invoke:WDfetch|getvalue|pid=P12081}}
-- This retrieves and returns the value of the Wikidata property P12081
-- for the current page's associated Wikibase item.
local p = {}
local p = {}


-- Function to fetch and display the value of a specified Wikidata property
-- Function to fetch the value of a specified Wikidata property.
-- from an entity, formatting the output similarly to the infobox display.
-- Requires both a property ID (e.g. P12081) and a Q‑ID (e.g. Q2934).
function p.getvalue(frame)
function p.getvalue(frame)
     -- Collect arguments from the calling frame.
     -- Collect arguments from the calling frame
     local args = {}
     local args = {}
     for k, v in pairs(frame:getParent().args) do
     for k, v in pairs(frame:getParent().args) do
Line 14: Line 24:
     end
     end


     -- Get the property ID.
     -- Get the property ID from the arguments
     local propertyId = args[1] or args.pid
     local propertyId = args[1] or args.pid
     if not propertyId then
     if not propertyId then
        mw.log("p.getvalue: No property ID provided.")
         return "Error: No property ID provided."
         return "Error: No property ID provided."
     end
     end


     -- Get the Q-ID.
     -- Use the #statements parser function to fetch the value
     local qid = args.qid
     local out = frame:callParserFunction("#statements", propertyId)
    if not qid then
        mw.log("p.getvalue: No Qid provided.")
        return "Error: No Qid provided."
    end
 
    mw.log("p.getvalue: Fetching entity for qid " .. qid)
    -- Retrieve the full entity object using the Lua interface.
    local entity = mw.ext.UnlinkedWikibase.getEntity(qid)
    if not entity then
        mw.log("p.getvalue: Entity not found for qid " .. qid)
        return "Error: Entity not found for Qid " .. qid
    end
 
    -- Extract claims from the entity.
    local claims = entity.claims or {}
    local propertyClaims = claims[propertyId]
    if not propertyClaims or #propertyClaims == 0 then
        mw.log("p.getvalue: No claims found for property " .. propertyId)
        return nil
    end


     -- Extract the first claim's value.
     -- If no result is found, return nil
    local claim = propertyClaims[1]
     if string.sub(out, 1, 4) ~= "<!--" then
     if not (claim and claim.mainsnak and claim.mainsnak.datavalue) then
         -- Strip HTML markup: Remove <span> tags used by the extension
         mw.log("p.getvalue: Claim structure invalid for property " .. propertyId)
        local p1 = string.find(out, ">", 1, true) or 0
         return nil
        local p2 = string.find(out, "<", -1, true) or #out + 1
    end
         out = string.sub(out, p1 + 1, p2 - 1)


    local datatype = claim.mainsnak.datatype
         -- Capitalize the first letter of the result
    mw.log("p.getvalue: Processing claim for property " .. propertyId .. " with datatype " .. datatype)
         out = out:gsub("^%l", string.upper)
    local value
 
    if datatype == "wikibase-item" then
        value = '{{wdl|' .. claim.mainsnak.datavalue.value.id .. '}}'
    elseif datatype == "monolingualtext" then
        value = claim.mainsnak.datavalue.value.text
    elseif datatype == "commonsMedia" then
        value = '[[File:' .. claim.mainsnak.datavalue.value .. '|300px]]'
    elseif datatype == "time" then
         -- Format the time value using the English date format.
        local timeValue = claim.mainsnak.datavalue.value.time
         local lang = mw.language.getContentLanguage()
        value = lang:formatDate('j F Y', timeValue)
     else
     else
         value = '<small><em>Type ' .. datatype .. ' not handled by Module:Infobox yet.</em></small>'
         out = nil
    end
 
    -- Capitalize the first letter if the result is a string.
    if type(value) == "string" then
        value = value:gsub("^%l", string.upper)
     end
     end


    mw.log("p.getvalue: Returning value: " .. tostring(value))
     return out
     return value
end
end


return p
return p

Latest revision as of 12:31, 2 March 2025

Documentation for this module may be created at Module:WDfetch/doc

-- This Lua module is designed for use in MediaWiki templates, 
-- particularly for MDwiki infoboxes, to retrieve and display clean values 
-- from Wikidata via the UnlinkedWikibase extension.
--
-- The module fetches the value of a specified Wikidata property (P-ID) 
-- using the {{#statements:}} parser function provided by the extension.
--
-- Example usage in a template:
-- {{#invoke:WDfetch|getvalue|pid=P12081}}
-- This retrieves and returns the value of the Wikidata property P12081 
-- for the current page's associated Wikibase item.

local p = {}

-- Function to fetch the value of a specified Wikidata property.
function p.getvalue(frame)
    -- Collect arguments from the calling frame
    local args = {}
    for k, v in pairs(frame:getParent().args) do
        if v ~= "" then args[k] = v end
    end
    for k, v in pairs(frame.args) do
        if v ~= "" then args[k] = v end
    end

    -- Get the property ID from the arguments
    local propertyId = args[1] or args.pid
    if not propertyId then
        return "Error: No property ID provided."
    end

    -- Use the #statements parser function to fetch the value
    local out = frame:callParserFunction("#statements", propertyId)

    -- If no result is found, return nil
    if string.sub(out, 1, 4) ~= "<!--" then
        -- Strip HTML markup: Remove <span> tags used by the extension
        local p1 = string.find(out, ">", 1, true) or 0
        local p2 = string.find(out, "<", -1, true) or #out + 1
        out = string.sub(out, p1 + 1, p2 - 1)

        -- Capitalize the first letter of the result
        out = out:gsub("^%l", string.upper)
    else
        out = nil
    end

    return out
end

return p