Module:WikidataIB: Difference between revisions

From Random Island Wiki
Jump to navigation Jump to search
>RexxS
(set up whitelist, blacklist and name)
>RexxS
(main algorithm implementation)
Line 1: Line 1:
-- Module to try out use of a blacklist and whitelist for infobox fields
-- Module to try out use of a blacklist and whitelist for infobox fields
-- can take a named parameter |qid which is the Wikidata ID for the article. This will not normally be used
-- can take a named parameter |qid which is the Wikidata ID for the article. This will not normally be used
-- Fields in blacklist are never to be displayed, i.e. module must return nil
-- Fields in blacklist are never to be displayed, i.e. module must return nil in all circumstances
-- Fields in whitelist return local value if it exists or the Wikidata value otherwise
-- Fields in whitelist return local value if it exists or the Wikidata value otherwise
-- The name of the field that this function is called from is passed in named parameter |name
-- The name of the field that this function is called from is passed in named parameter |name
-- The name is compulsory, so the module returns nil if it is not supplied
-- The name is compulsory when blacklist or whitelist is used, so the module returns nil if it is not supplied
-- blacklist is passed in named parameter |suppressfields
-- blacklist is passed in named parameter |suppressfields
-- whitelist is passed in named parameter |fetchwikidata
-- whitelist is passed in named parameter |fetchwikidata
local i18n =
{
    ["errors"] =
    {
        ["property-not-found"] = "Property not found.",
        ["entity-not-found"] = "Wikidata entity not found.",
        ["unknown-claim-type"] = "Unknown claim type.",
        ["unknown-entity-type"] = "Unknown entity type.",
        ["qualifier-not-found"] = "Qualifier not found.",
        ["site-not-found"] = "Wikimedia project not found.",
["unknown-datetime-format"] = "Unknown datetime format.",
["local-article-not-found"] = "Article is not yet available in this wiki"
    },
}


-- This is used to get a value, or a comma separated list of them if multiple values exist
-- This is used to get a value, or a comma separated list of them if multiple values exist
p.getValue = function(frame)
p.getValue = function(frame)
local propertyID = mw.text.trim(frame.args[1] or "")
local propertyID = mw.text.trim(frame.args[1] or "")
-- There may be a local parameter supplied, if it's blank, set it to nil
local input_parm = mw.text.trim(frame.args[2] or "")
local input_parm = mw.text.trim(frame.args[2] or "")
if qid and (#qid == 0) then qid = nil end
-- can take a named parameter |qid which is the Wikidata ID for the article. This will not normally be used.
-- can take a named parameter |qid which is the Wikidata ID for the article. This will not normally be used.
Line 25: Line 43:
-- The name of the field that this function is called from is passed in named parameter |name
-- The name of the field that this function is called from is passed in named parameter |name
local fieldname = frame.args.name
local fieldname = frame.args.name
-- if not fieldname or (#fieldname == 0) then return nil end
if input_parm then
if blacklist then
local entity = mw.wikibase.getEntityObject()
-- The name is compulsory when blacklist is used, so return nil if it is not supplied
local claims
if not fieldname or (#fieldname == 0) then return nil end
-- If this field is on the blacklist, then return nil
if blacklist:find(fieldname) then return nil end
end
-- If we got his far then we're not on the blacklist
-- If a non-blank input parameter was supplied return it
if input_parm then return input_parm end
-- Otherwise see if this field is on the whitelist:
if whitelist:find(fieldname) then
local entity = mw.wikibase.getEntityObject(qid)
local props
if entity and entity.claims then
if entity and entity.claims then
claims = entity.claims[propertyID]
props = entity.claims[propertyID]
end
end
if claims then
if props then
-- if wiki-linked value output as link if possible
if props[1] and props[1].mainsnak.snaktype == "value" and props[1].mainsnak.datavalue.type == "wikibase-entityid" then
if (claims[1] and claims[1].mainsnak.snaktype == "value" and claims[1].mainsnak.datavalue.type == "wikibase-entityid") then
-- if wiki-linked value, then output as link if possible
local out = {}
local out = {}
for k, v in pairs(claims) do
for k, v in pairs(props) do
local sitelink = mw.wikibase.sitelink("Q" .. v.mainsnak.datavalue.value["numeric-id"])
local sitelink = mw.wikibase.sitelink("Q" .. v.mainsnak.datavalue.value["numeric-id"])
local label = mw.wikibase.label("Q" .. v.mainsnak.datavalue.value["numeric-id"])
local label = mw.wikibase.label("Q" .. v.mainsnak.datavalue.value["numeric-id"])
Line 50: Line 80:
return table.concat(out, ", ")
return table.concat(out, ", ")
else
else
-- just return best vakues
-- not a linkable article title, so just return formatted best value
return entity:formatPropertyValues(propertyID).value
return entity:formatPropertyValues(propertyID).value
end
end
else
else
return ""
-- no property stored for this article
return nil
end
end
else
else
-- not on the whitelist so just return what should be a nil input parameter
return input_parm
return input_parm
end
end
end
end

Revision as of 15:27, 16 May 2016

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

-- Module to try out use of a blacklist and whitelist for infobox fields
-- can take a named parameter |qid which is the Wikidata ID for the article. This will not normally be used
-- Fields in blacklist are never to be displayed, i.e. module must return nil in all circumstances
-- Fields in whitelist return local value if it exists or the Wikidata value otherwise
-- The name of the field that this function is called from is passed in named parameter |name
-- The name is compulsory when blacklist or whitelist is used, so the module returns nil if it is not supplied
-- blacklist is passed in named parameter |suppressfields
-- whitelist is passed in named parameter |fetchwikidata

local i18n =
{
    ["errors"] =
    {
        ["property-not-found"] = "Property not found.",
        ["entity-not-found"] = "Wikidata entity not found.",
        ["unknown-claim-type"] = "Unknown claim type.",
        ["unknown-entity-type"] = "Unknown entity type.",
        ["qualifier-not-found"] = "Qualifier not found.",
        ["site-not-found"] = "Wikimedia project not found.",
		["unknown-datetime-format"] = "Unknown datetime format.",
		["local-article-not-found"] = "Article is not yet available in this wiki"
    },
}

-- This is used to get a value, or a comma separated list of them if multiple values exist
p.getValue = function(frame)
	local propertyID = mw.text.trim(frame.args[1] or "")
	
	-- There may be a local parameter supplied, if it's blank, set it to nil
	local input_parm = mw.text.trim(frame.args[2] or "")
	if qid and (#qid == 0) then qid = nil end
	
	-- can take a named parameter |qid which is the Wikidata ID for the article. This will not normally be used.
	local qid = frame.args.qid
	if qid and (#qid == 0) then qid = nil end
	
	-- The blacklist is passed in named parameter |suppressfields
	local blacklist = frame.args.suppressfields
	
	-- The whitelist is passed in named parameter |fetchwikidata
	local whitelist = frame.args.fetchwikidata
	
	-- The name of the field that this function is called from is passed in named parameter |name
	local fieldname = frame.args.name
	
	if blacklist then
		-- The name is compulsory when blacklist is used, so return nil if it is not supplied
		if not fieldname or (#fieldname == 0) then return nil end
		-- If this field is on the blacklist, then return nil
		if blacklist:find(fieldname) then return nil end
	end
	
	-- If we got his far then we're not on the blacklist
	
	-- If a non-blank input parameter was supplied return it
	if input_parm then return input_parm end
	
	-- Otherwise see if this field is on the whitelist:
	if whitelist:find(fieldname) then
		local entity = mw.wikibase.getEntityObject(qid)
		local props
		if entity and entity.claims then
			props = entity.claims[propertyID]
		end
		if props then
			if props[1] and props[1].mainsnak.snaktype == "value" and props[1].mainsnak.datavalue.type == "wikibase-entityid" then
				-- if wiki-linked value, then output as link if possible
				local out = {}
				for k, v in pairs(props) do
					local sitelink = mw.wikibase.sitelink("Q" .. v.mainsnak.datavalue.value["numeric-id"])
					local label = mw.wikibase.label("Q" .. v.mainsnak.datavalue.value["numeric-id"])
					if label == nil then label = "Q" .. v.mainsnak.datavalue.value["numeric-id"] end
							
					if sitelink then
						out[#out + 1] = "[[" .. sitelink .. "|" .. label .. "]]"
					else
						out[#out + 1] = "[[:d:Q" .. v.mainsnak.datavalue.value["numeric-id"] .. "|" .. label .. "]]<abbr title='" .. i18n["errors"]["local-article-not-found"] .. "'>[*]</abbr>"
					end
				end
				return table.concat(out, ", ")
			else
				-- not a linkable article title, so just return formatted best value
				return entity:formatPropertyValues(propertyID).value
			end
		else
			-- no property stored for this article
			return nil
		end
	else
	-- not on the whitelist so just return what should be a nil input parameter
		return input_parm
	end
end