Difference between revisions of "Module:Wikibase/sandbox"

From blackwiki
Jump to navigation Jump to search
blackwiki>Uzume
(update)
blackwiki>Uzume
m (clarify comments)
Line 10: Line 10:
 
end
 
end
  
-- Return the entity URL of a given entity ID
+
-- Return the URL of an entity given its entity ID
 
-- or the item linked to the current page if no argument is provided.
 
-- or the item linked to the current page if no argument is provided.
 
function p.wdurl(frame)
 
function p.wdurl(frame)
Line 16: Line 16:
 
end
 
end
  
-- Return the label of a given entity ID
+
-- Return the label of an entity given its entity ID
 
-- or the item linked to the current page if no argument is provided.
 
-- or the item linked to the current page if no argument is provided.
 
function p.label(frame)
 
function p.label(frame)
Line 22: Line 22:
 
end
 
end
  
-- Return the description of a given entity ID
+
-- Return the description of an entity given its entity ID
 
-- or the item linked to the current page if no argument is provided.
 
-- or the item linked to the current page if no argument is provided.
 
function p.description(frame)
 
function p.description(frame)
Line 28: Line 28:
 
end
 
end
  
-- Return the local sitelink of a an item given its entity ID
+
-- Return the local title of an item given its entity ID
 
-- or the item linked to the current page if no argument is provided.
 
-- or the item linked to the current page if no argument is provided.
 
function p.page(frame)
 
function p.page(frame)
Line 38: Line 38:
 
end
 
end
  
-- Return the data type of a property given its entity ID
+
-- Return the data type of a property given its entity ID.
 
function p.datatype(frame)
 
function p.datatype(frame)
 
prop = mw.wikibase.getEntity(frame.args[1] and mw.text.trim(frame.args[1]):upper():gsub('PROPERTY:P', 'P')) -- trim and remove any "Property:" prefix
 
prop = mw.wikibase.getEntity(frame.args[1] and mw.text.trim(frame.args[1]):upper():gsub('PROPERTY:P', 'P')) -- trim and remove any "Property:" prefix

Revision as of 21:13, 24 April 2020

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

---------- Module:Wikibase ----------------
local p = {}

-- Return the entity ID of the item linked to the current page.
function p.id(frame)
	if not mw.wikibase then
		return "no mw.wikibase"
	end
	return mw.wikibase.getEntityIdForCurrentPage() or "no entity"
end

-- Return the URL of an entity given its entity ID
-- or the item linked to the current page if no argument is provided.
function p.wdurl(frame)
	return mw.wikibase.getEntityUrl(frame.args[1] and mw.text.trim(frame.args[1])) -- defaults to entity URL of the item linked to the current page
end

-- Return the label of an entity given its entity ID
-- or the item linked to the current page if no argument is provided.
function p.label(frame)
	return mw.wikibase.getLabel(frame.args[1] and mw.text.trim(frame.args[1])) -- defaults to label of the item linked to the current page
end

-- Return the description of an entity given its entity ID
-- or the item linked to the current page if no argument is provided.
function p.description(frame)
	return mw.wikibase.getDescription(frame.args[1] and mw.text.trim(frame.args[1])) -- defaults to description of the item linked to the current page
end

-- Return the local title of an item given its entity ID
-- or the item linked to the current page if no argument is provided.
function p.page(frame)
	qid = frame.args[1] and mw.text.trim(frame.args[1])
	if not qid or qid == '' then
		qid = mw.wikibase.getEntityIdForCurrentPage() -- default the item connected to the current page
	end
	return mw.wikibase.getSitelink(qid or '') -- requires one string arg
end

-- Return the data type of a property given its entity ID.
function p.datatype(frame)
	prop = mw.wikibase.getEntity(frame.args[1] and mw.text.trim(frame.args[1]):upper():gsub('PROPERTY:P', 'P')) -- trim and remove any "Property:" prefix
	return prop and prop.datatype
end

return p