VOOZH about

URL: https://en.wikipedia.org/wiki/Module:Wikidata/sandbox

โ‡ฑ Module:Wikidata/sandbox - Wikipedia


Jump to content
From Wikipedia, the free encyclopedia
๐Ÿ‘ Image
This is the module sandbox page for Module:Wikidata (diff).
See also the companion subpage for test cases (run).
๐Ÿ‘ Image
Module documentation
[view] [edit] [history] [purge]
๐Ÿ‘ Image
Module:Wikidata is deprecated. Please use Module:WikidataIB or Module:Wd instead.
๐Ÿ‘ Image
This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.
๐Ÿ‘ Warning
This Lua module is used on approximately 204,000 pages.
To avoid major disruption and server load, any changes should be tested in the module's or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

Methods

[edit]

The module "Wikidata" contains the following methods, that allow the calling script to retrieve the value for any property from Wikidata by supplying the property ID as the first parameter:

  • getValue: Returns wiki-linked values, if applicable. All other values will be output similar to {{#property:}}, except that if values with preferred rank exist, then only they are returned. Unlike formatStatements from w:ru:ะœะพะดัƒะปัŒ:Wikidata, getValue does not yet pick up any references (see w:en:Module talk:Wikidata/Archive 1#Why the references from Wikidata get dropped?).
  • getRawValue: Returns non-linked property values and numbers with the thousand separator. It also returns the plain numeric value of a property which is a quantity. All other values will be output similar to {{#property:}}, including normal values, even if preferred values exist.
  • getDateValue: Special method to return formatted dates. The default date format is [day month year]; an optional third parameter can be added for other date formats: for [month day, year], add "mdy"; for [month year], add "my"; for year only, add "y". A further optional parameter, which must be fourth, such as "BCE", may be added to override the default "BC" that is suffixed for dates BC.
  • getImages: Returns all of the images of a particular property, e.g. image (P18), Gene Atlas Image (P692), etc. Parameters are | propertyID | value / FETCH_WIKIDATA / nil | separator (default=space) | size (default=220px). The returned text will be in the format [[File:Filename | size]] for each image with a selectable size and separator (which may be html). If a property is supplied that is not of type "commonsMedia", it will return empty text.
  • getUnits This takes a propertyID which is a quantity as the first parameter, and returns the name of the units that the property is using on the current page. It returns empty if the property is not a quantity type or if the value is not set. The second parameter may be used to override fetching from Wikidata, if it is anything other than "FETCH_WIKIDATA".
  • getUnitID This takes a propertyID which is a quantity as the first parameter, and returns the QID of the units that the property is using on the current page. It returns empty if the property is not a quantity type or if the value is not set. The second parameter may be used to override fetching from Wikidata, if it is anything other than "FETCH_WIKIDATA".

Wikidata qualifier values (if present) can be retrieved by the following methods:

  • getQualifierValue: returns only wiki-linked values, if applicable.
  • getRawQualifierValue: returns non-linked values
  • getQualifierDateValue: returns formatted dates

If the property is not defined in Wikidata for the article that invokes this code, then an empty string ("") is returned.

Other methods:

  • pageId: returns the Wikidata id (Qโ€ฆ) of the current page or nothing if the page is not connected to Wikidata. To get the Wikidata id of another page, use {{#invoke:ResolveEntityId|page}}.
  • getTAValue: gets the TA98 (Terminologia Anatomica first edition 1998) values for property P1323. It takes no parameters and constructs its output as a list, with each value linked to an external resource. This is an exemplar for writing calls that need to return external links.
  • ViewSomething: gets anything in the structured data, including labels, descriptions, references and interwiki links. See [1]
  • getSiteLink: gets name of a page in given in argument wiki (like "enwikiquote" for English Wikiquote, "arwiki" for the Arabic Wikipedia).
  • Dump: {{#invoke:Wikidata|Dump|claims}} spies the structured data. It uses the same arguments as ViewSomething. Try this with preview only to see results. That helps you a lot in developing Lua scripts that access the data. If used without arguments, it dumps everything including labels, descriptions, references and interwiki links. There is the wrapper template, see {{Dump}}.
  • getImageLegend: returns an image legend (image is property P18; image legend is property P2096).
    Call as {{#invoke:Wikidata |getImageLegend | <PARAMETER> | lang=<ISO-639code> |id=<QID>}}
    Returns PARAMETER, unless it is equal to "FETCH_WIKIDATA", from Item QID (expensive call). If QID is omitted or blank, the current article is used (not an expensive call). If lang is omitted, it uses the local wiki language, otherwise it uses the provided ISO-639 language code.
    The label is returned from the first image with 'preferred' rank; or from the first image with 'normal' rank if no image has preferred rank.
  • getValueShortName: returns the same data as getValue, but utilizes the property short name as the label, if available. This allows for piped links to use a shorter label where preferred. If short name is not set on the item, the normal label is used.

Arbitrary Access

[edit]

As of 16 September 2015, it is now possible to fetch data from other articles by using their QID. The following call:

  • {{#invoke:Wikidata|getValueFromID|<QID>|<Property>|FETCH_WIKIDATA}}

will do the same as getValue, but takes an extra parameter, which is the QID of the Wikidata item that you want to get the property value from. For example:

  • {{#invoke:Wikidata|getValueFromID|{{Get QID|Richard Burton (actor) }}|P26|FETCH_WIKIDATA}}

will fetch a list of the linked values for 'spouse' (P26) from redirect page title Richard Burton (actor) (corresponding to Wikidata label Richard Burton (Q151973)) from anywhere in the English Wikipedia.

This means that testing environments may be set up in user space, but remember that these calls are classed as expensive, so please use them as sparingly as possible.

Parameters

[edit]
  • For the generalized case (getValue), two unnamed parameters are supplied. The first is the ID of the property that is to be retrieved (e.g. P19 for birthplace or P26 for spouse). The second may be null, "FETCH_WIKIDATA", or any other string, which becomes the returned value.
  • For the generalized unlinked case (getRawValue), two unnamed parameters are supplied. The first is the ID of the property that is to be retrieved (e.g. P21 for gender). The second may be null, "FETCH_WIKIDATA", or any other string, which becomes the returned value.
  • For the generalized date case (getDateValue), three unnamed parameters are supplied. The first is the ID of the property that is to be retrieved (e.g. P569 for date of birth). The second may be null, "FETCH_WIKIDATA", or any other string, which becomes the returned value. The third is the format that the date should be returned in, either dmy, mdy, my, or y.

Please note that lower-case parameters are no longer supported by the wikibase call: p123, so please check that upper-case, like P123, is used if problems should arise.

Usage

[edit]

Example: spouse (P26)

[edit]
  • {{#invoke:Wikidata|getValue|P26|}} = returns nothing, so suppresses the display of spouse in an infobox
  • {{#invoke:Wikidata|getValue|P26|FETCH_WIKIDATA}} = returns the linked value(s) of property P26 (spouse) stored in wikidata for the corresponding article (e.g. for article Bill Clinton, it returns Hillary Clinton)
  • {{#invoke:Wikidata|getValue|P26|[[Hillary Rodham Clinton]]}} = returns Hillary Rodham Clinton, allowing an infobox to use a local value rather than the value stored in Wikidata.

Example in Infobox template

[edit]

Inside an infobox definition, it may be called like this:

  • | data55 = {{#invoke:Wikidata|getValue|P26|{{{spouse|FETCH_WIKIDATA}}} }}

which causes the infobox to:

  1. not display spouse if the infobox parameter |spouse is set to be blank (as "| spouse =")
  2. display the linked value(s) from Wikidata if the infobox parameter |spouse is not supplied
  3. display the local infobox parameter |spouse if it is supplied (e.g. "|spouse = Hillary Rodham Clinton")

Optionally, it could be called as:

  • | data55 = {{#invoke:Wikidata|getValue|P26|{{{spouse|}}} }}

which causes the infobox to:

  1. not display spouse if the infobox parameter |spouse is set to be blank (as "| spouse ="}
  2. not display spouse if the infobox parameter |spouse is not supplied
  3. display the local infobox parameter |spouse if it is supplied (e.g. "|spouse = Hillary Rodham Clinton")
  4. display the linked value(s) from Wikidata if the infobox parameter is locally set to FETCH_WIKIDATA

See Module:WikidataIB for a modification that allows fields, on a per article basis, to be blacklisted so that they never display. It also allows the editor to specify, on a per article basis, which fields may be automatically fetched from Wikidata when local parameter is supplied; the default is none, allowing an infobox to be modified to accept Wikidata without any change in the articles using the infobox until the functionality is enabled in the article.

Example:birth place

[edit]

This works in just the same way as the calls above:

  • {{#invoke:Wikidata|getValue|P19|}} = returns nothing, so suppresses the display of birth place in an infobox
  • {{#invoke:Wikidata|getValue|P19|FETCH_WIKIDATA}} = returns the linked value(s) of property P19 (place of birth) stored in wikidata for the corresponding article (e.g. for article Bill Clinton, it returns Hope, Arkansas)
  • {{#invoke:Wikidata|getValue|P19|[[Hope, Arkansas|Hope]]}} = returns Hope, allowing an infobox to use a local value rather than the value stored in Wikidata.

Example:gender

[edit]

We don't want the returned value linked, so use:

  • - {{#invoke:Wikidata|getRawValue|P21|FETCH_WIKIDATA}}

Example:date of birth

[edit]

If we want the date of birth in dmy format, we use:

  • - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|dmy}}

If we want the date of birth in mdy format, we use:

  • - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|mdy}}

If we want a year of birth, we use:

  • - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|y}}

If we want a year of birth that may be BC, but should read "BCE", we use:

  • - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|y|BCE}}

Example: Linking to Wikidata item

[edit]

Use the following code to just retrieve the Q-ID:

  • - {{#invoke:Wikidata|pageId}}

Linking to Wikidata used the usual Wiki markup:

  • - [[d:{{#invoke:Wikidata|pageId}}|Name of Link]]

Example: Linking to another wiki page

[edit]

Use code like this to link to another wiki. English Wikivoyage in the example:

  • - [[voy:{{#invoke:Wikidata|getSiteLink|enwikivoyage}}|Name of Link]]


Testing

[edit]

Testing spouse

[edit]

Copy and paste the following into any article and preview it (please don't save!):

 * - {{#invoke:Wikidata|getValue|P26|}}
 * - {{#invoke:Wikidata|getValue|P26|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P26|[[Hillary Rodham Clinton]]}}

In Bill Clinton you should get:


In Barack Obama you should get:


In Richard Burton you should get:


In Franz Kafka you should get:

Testing birthplace

[edit]

Copy and paste the following into any article and preview it (please don't save!):

 * - {{#invoke:Wikidata|getValue|P19|}}
 * - {{#invoke:Wikidata|getValue|P19|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P19|[[Newport]]}}

Try William Ellery and check that the Wikidata call correctly disambiguates.

Testing getValue, getRawValue and getDateValue

[edit]

Copy and paste the following into any article and preview it (please don't save!):

 * - {{#invoke:Wikidata|getValue|P19|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P26|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P27|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P140|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getRawValue|P21|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|dmy}}
 * - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|mdy}}
 * - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|y}}

This should return the Wikidata values for birthplace, spouse, citizenship, religion, gender, date of birth (twice) and year of birth, if they exist. The dob is first in dmy format and then in mdy.

Testing dates BC/BCE

[edit]

Copy and paste the following into a short section of article such as Horace #See also and preview it (please don't save!):

 * - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|y}}
 * - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|y|BCE}}

This should return 65 BC and 65 BCE, respectively.

See also

[edit]
-- vim: set noexpandtab ft=lua ts=4 sw=4:
require('strict')
localp={}
localdebug=false
------------------------------------------------------------------------------
-- module local variables and functions
localwiki=
{
langcode=mw.language.getContentLanguage().code
}
-- internationalisation
locali18n=
{
["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."
},
["datetime"]=
{
-- $1 is a placeholder for the actual number
[0]="$1 billion years",-- precision: billion years
[1]="$100 million years",-- precision: hundred million years
[2]="$10 million years",-- precision: ten million years
[3]="$1 million years",-- precision: million years
[4]="$100,000 years",-- precision: hundred thousand years
[5]="$10,000 years",-- precision: ten thousand years
[6]="$1 millennium",-- precision: millennium
[7]="$1 century",-- precision: century
[8]="$1s",-- precision: decade
-- the following use the format of #time parser function
[9]="Y",-- precision: year,
[10]="F Y",-- precision: month
[11]="F j, Y",-- precision: day
[12]="F j, Y ga",-- precision: hour
[13]="F j, Y g:ia",-- precision: minute
[14]="F j, Y g:i:sa",-- precision: second
["beforenow"]="$1 BCE",-- how to format negative numbers for precisions 0 to 5
["afternow"]="$1 CE",-- how to format positive numbers for precisions 0 to 5
["bc"]='$1 "BCE"',-- how print negative years
["ad"]="$1",-- how print positive years
-- the following are for function getDateValue() and getQualifierDateValue()
["default-format"]="dmy",-- default value of the #3 (getDateValue) or
-- #4 (getQualifierDateValue) argument
["default-addon"]="BC",-- default value of the #4 (getDateValue) or
-- #5 (getQualifierDateValue) argument
["prefix-addon"]=false,-- set to true for languages put "BC" in front of the
-- datetime string; or the addon will be suffixed
["addon-sep"]=" ",-- separator between datetime string and addon (or inverse)
["format"]=-- options of the 3rd argument
{
["mdy"]="F j, Y",
["my"]="F Y",
["y"]="Y",
["dmy"]="j F Y",
["ymd"]="Y-m-d",
["ym"]="Y-m"
}
},
["monolingualtext"]='<span lang="%language">%text</span>',
["warnDump"]="[[Category:Called function 'Dump' from module Wikidata]]",
["ordinal"]=
{
[1]="st",
[2]="nd",
[3]="rd",
["default"]="th"
}
}
ifwiki.langcode~="en"then
--require("Module:i18n").loadI18n("Module:Wikidata/i18n", i18n)
-- got idea from [[:w:Module:Wd]]
localmodule_title;if...==nilthen
module_title=mw.getCurrentFrame():getTitle()
else
module_title=...
end
require('Module:i18n').loadI18n(module_title..'/i18n',i18n)
end
-- this function needs to be internationalised along with the above:
-- takes cardinal numer as a numeric and returns the ordinal as a string
-- we need three exceptions in English for 1st, 2nd, 3rd, 21st, .. 31st, etc.
localfunctionmakeOrdinal(cardinal)
localordsuffix=i18n.ordinal.default
ifcardinal%10==1then
ordsuffix=i18n.ordinal[1]
elseifcardinal%10==2then
ordsuffix=i18n.ordinal[2]
elseifcardinal%10==3then
ordsuffix=i18n.ordinal[3]
end
-- In English, 1, 21, 31, etc. use 'st', but 11, 111, etc. use 'th'
-- similarly for 12 and 13, etc.
if(cardinal%100==11)or(cardinal%100==12)or(cardinal%100==13)then
ordsuffix=i18n.ordinal.default
end
returntostring(cardinal)..ordsuffix
end
localfunctionprintError(code)
return'<span class="error">'..(i18n.errors[code]orcode)..'</span>'
end
localfunctionparseDateFormat(f,timestamp,addon,prefix_addon,addon_sep)
localyear_suffix
localtstr=""
locallang_obj=mw.language.new(wiki.langcode)
localf_parts=mw.text.split(f,'Y',true)
foridx,f_partinpairs(f_parts)do
year_suffix=''
ifstring.match(f_part,"x[mijkot]$")then
-- for non-Gregorian year
f_part=f_part..'Y'
elseifidx<#f_partsthen
-- supress leading zeros in year
year_suffix=lang_obj:formatDate('Y',timestamp)
year_suffix=string.gsub(year_suffix,'^0+','',1)
end
tstr=tstr..lang_obj:formatDate(f_part,timestamp)..year_suffix
end
ifaddon~=""andprefix_addonthen
returnaddon..addon_sep..tstr
elseifaddon~=""then
returntstr..addon_sep..addon
else
returntstr
end
end
localfunctionparseDateValue(timestamp,date_format,date_addon)
localprefix_addon=i18n["datetime"]["prefix-addon"]
localaddon_sep=i18n["datetime"]["addon-sep"]
localaddon=""
-- check for negative date
ifstring.sub(timestamp,1,1)=='-'then
timestamp='+'..string.sub(timestamp,2)
addon=date_addon
end
local_date_format=i18n["datetime"]["format"][date_format]
if_date_format~=nilthen
returnparseDateFormat(_date_format,timestamp,addon,prefix_addon,addon_sep)
else
returnprintError("unknown-datetime-format")
end
end
-- This local function combines the year/month/day/BC/BCE handling of parseDateValue{}
-- with the millennium/century/decade handling of formatDate()
localfunctionparseDateFull(timestamp,precision,date_format,date_addon)
localprefix_addon=i18n["datetime"]["prefix-addon"]
localaddon_sep=i18n["datetime"]["addon-sep"]
localaddon=""
-- check for negative date
ifstring.sub(timestamp,1,1)=='-'then
timestamp='+'..string.sub(timestamp,2)
addon=date_addon
end
-- get the next four characters after the + (should be the year now in all cases)
-- ok, so this is dirty, but let's get it working first
localintyear=tonumber(string.sub(timestamp,2,5))
ifintyear==0andprecision<=9then
return""
end
-- precision is 10000 years or more
ifprecision<=5then
localfactor=10^((5-precision)+4)
localy2=math.ceil(math.abs(intyear)/factor)
localrelative=mw.ustring.gsub(i18n.datetime[precision],"$1",tostring(y2))
ifaddon~=""then
-- negative date
relative=mw.ustring.gsub(i18n.datetime.beforenow,"$1",relative)
else
relative=mw.ustring.gsub(i18n.datetime.afternow,"$1",relative)
end
returnrelative
end
-- precision is decades (8), centuries (7) and millennia (6)
localera,card
ifprecision==6then
card=math.floor((intyear-1)/1000)+1
era=mw.ustring.gsub(i18n.datetime[6],"$1",makeOrdinal(card))
end
ifprecision==7then
card=math.floor((intyear-1)/100)+1
era=mw.ustring.gsub(i18n.datetime[7],"$1",makeOrdinal(card))
end
ifprecision==8then
era=mw.ustring.gsub(i18n.datetime[8],"$1",tostring(math.floor(math.abs(intyear)/10)*10))
end
iferathen
ifaddon~=""then
era=mw.ustring.gsub(mw.ustring.gsub(i18n.datetime.bc,'"',""),"$1",era)
else
era=mw.ustring.gsub(mw.ustring.gsub(i18n.datetime.ad,'"',""),"$1",era)
end
returnera
end
local_date_format=i18n["datetime"]["format"][date_format]
if_date_format~=nilthen
-- check for precision is year and override supplied date_format
ifprecision==9then
_date_format=i18n["datetime"][9]
end
returnparseDateFormat(_date_format,timestamp,addon,prefix_addon,addon_sep)
else
returnprintError("unknown-datetime-format")
end
end
-- the "qualifiers" and "snaks" field have a respective "qualifiers-order" and "snaks-order" field
-- use these as the second parameter and this function instead of the built-in "pairs" function
-- to iterate over all qualifiers and snaks in the intended order.
localfunctionorderedpairs(array,order)
ifnotorderthenreturnpairs(array)end
-- return iterator function
locali=0
returnfunction()
i=i+1
iforder[i]then
returnorder[i],array[order[i]]
end
end
end
-- precision: 0 - billion years, 1 - hundred million years, ..., 6 - millennia, 7 - century, 8 - decade, 9 - year, 10 - month, 11 - day, 12 - hour, 13 - minute, 14 - second
localfunctionnormalizeDate(date)
date=mw.text.trim(date,"+")
-- extract year
localyearstr=mw.ustring.match(date,"^\-?%d+")
localyear=tonumber(yearstr)
-- remove leading zeros of year
returnyear..mw.ustring.sub(date,#yearstr+1),year
end
localfunctionformatDate(date,precision,timezone)
precision=precisionor11
localdate,year=normalizeDate(date)
ifyear==0andprecision<=9thenreturn""end
-- precision is 10000 years or more
ifprecision<=5then
localfactor=10^((5-precision)+4)
localy2=math.ceil(math.abs(year)/factor)
localrelative=mw.ustring.gsub(i18n.datetime[precision],"$1",tostring(y2))
ifyear<0then
relative=mw.ustring.gsub(i18n.datetime.beforenow,"$1",relative)
else
relative=mw.ustring.gsub(i18n.datetime.afternow,"$1",relative)
end
returnrelative
end
-- precision is decades, centuries and millennia
localera
ifprecision==6thenera=mw.ustring.gsub(i18n.datetime[6],"$1",tostring(math.floor((math.abs(year)-1)/1000)+1))end
ifprecision==7thenera=mw.ustring.gsub(i18n.datetime[7],"$1",tostring(math.floor((math.abs(year)-1)/100)+1))end
ifprecision==8thenera=mw.ustring.gsub(i18n.datetime[8],"$1",tostring(math.floor(math.abs(year)/10)*10))end
iferathen
ifyear<0thenera=mw.ustring.gsub(mw.ustring.gsub(i18n.datetime.bc,'"',""),"$1",era)
elseifyear>0thenera=mw.ustring.gsub(mw.ustring.gsub(i18n.datetime.ad,'"',""),"$1",era)end
returnera
end
-- precision is year
ifprecision==9then
returnyear
end
-- precision is less than years
ifprecision>9then
--[[ the following code replaces the UTC suffix with the given negated timezone to convert the global time to the given local time
		timezone = tonumber(timezone)
		if timezone and timezone ~= 0 then
			timezone = -timezone
			timezone = string.format("%.2d%.2d", timezone / 60, timezone % 60)
			if timezone[1] ~= '-' then timezone = "+" .. timezone end
			date = mw.text.trim(date, "Z") .. " " .. timezone
		end
		]]--
localformatstr=i18n.datetime[precision]
ifyear==0thenformatstr=mw.ustring.gsub(formatstr,i18n.datetime[9],"")
elseifyear<0then
-- Mediawiki formatDate doesn't support negative years
date=mw.ustring.sub(date,2)
formatstr=mw.ustring.gsub(formatstr,i18n.datetime[9],mw.ustring.gsub(i18n.datetime.bc,"$1",i18n.datetime[9]))
elseifyear>0andi18n.datetime.ad~="$1"then
formatstr=mw.ustring.gsub(formatstr,i18n.datetime[9],mw.ustring.gsub(i18n.datetime.ad,"$1",i18n.datetime[9]))
end
returnmw.language.new(wiki.langcode):formatDate(formatstr,date)
end
end
localfunctionprintDatavalueEntity(data,parameter)
-- data fields: entity-type [string], numeric-id [int, Wikidata id]
localid
ifdata["entity-type"]=="item"thenid="Q"..data["numeric-id"]
elseifdata["entity-type"]=="property"thenid="P"..data["numeric-id"]
elsereturnprintError("unknown-entity-type")
end
ifparameterthen
ifparameter=="link"then
locallinkTarget=mw.wikibase.getSitelink(id)
locallinkName=mw.wikibase.getLabel(id)
iflinkTargetthen
-- if there is a local Wikipedia article link to it using the label or the article title
return"[["..linkTarget.."|"..(linkNameorlinkTarget).."]]"
else
-- if there is no local Wikipedia article output the label or link to the Wikidata object to let the user input a proper label
iflinkNamethenreturnlinkNameelsereturn"[[:d:"..id.."|"..id.."]]"end
end
else
returndata[parameter]
end
else
returnmw.wikibase.getLabel(id)orid
end
end
localfunctionprintDatavalueTime(data,parameter)
-- data fields: time [ISO 8601 time], timezone [int in minutes], before [int], after [int], precision [int], calendarmodel [wikidata URI]
-- precision: 0 - billion years, 1 - hundred million years, ..., 6 - millennia, 7 - century, 8 - decade, 9 - year, 10 - month, 11 - day, 12 - hour, 13 - minute, 14 - second
-- calendarmodel: e.g. http://www.wikidata.org/entity/Q1985727 for the proleptic Gregorian calendar or http://www.wikidata.org/wiki/Q11184 for the Julian calendar]
ifparameterthen
ifparameter=="calendarmodel"thendata.calendarmodel=mw.ustring.match(data.calendarmodel,"Q%d+")-- extract entity id from the calendar model URI
elseifparameter=="time"thendata.time=normalizeDate(data.time)end
returndata[parameter]
else
returnformatDate(data.time,data.precision,data.timezone)
end
end
localfunctionprintDatavalueMonolingualText(data,parameter)
-- data fields: language [string], text [string]
ifparameterthen
returndata[parameter]
else
localresult=mw.ustring.gsub(mw.ustring.gsub(i18n.monolingualtext,"%%language",data["language"]),"%%text",data["text"])
returnresult
end
end
localfunctionfindClaims(entity,property)
ifnotpropertyornotentityornotmw.wikibase.getBestStatements(entity,property)[1]thenreturnend
ifmw.ustring.match(property,"^P%d+$")then
-- if the property is given by an id (P..) access the claim list by this id
returnmw.wikibase.getBestStatements(entity,property)
else
property=mw.wikibase.resolvePropertyId(property)
ifnotpropertythenreturnend
returnmw.wikibase.getBestStatements(entity,property)
end
end
localfunctiongetSnakValue(snak,parameter)
ifsnak.snaktype=="value"then
-- call the respective snak parser
ifsnak.datavalue.type=="string"thenreturnsnak.datavalue.value
elseifsnak.datavalue.type=="globecoordinate"thenreturnprintDatavalueCoordinate(snak.datavalue.value,parameter)
elseifsnak.datavalue.type=="quantity"thenreturnprintDatavalueQuantity(snak.datavalue.value,parameter)
elseifsnak.datavalue.type=="time"thenreturnprintDatavalueTime(snak.datavalue.value,parameter)
elseifsnak.datavalue.type=="wikibase-entityid"thenreturnprintDatavalueEntity(snak.datavalue.value,parameter)
elseifsnak.datavalue.type=="monolingualtext"thenreturnprintDatavalueMonolingualText(snak.datavalue.value,parameter)
end
end
returnmw.wikibase.renderSnak(snak)
end
localfunctiongetQualifierSnak(claim,qualifierId)
-- a "snak" is Wikidata terminology for a typed key/value pair
-- a claim consists of a main snak holding the main information of this claim,
-- as well as a list of attribute snaks and a list of references snaks
ifqualifierIdthen
-- search the attribute snak with the given qualifier as key
ifclaim.qualifiersthen
localqualifier=claim.qualifiers[qualifierId]
ifqualifierthenreturnqualifier[1]end
end
returnnil,printError("qualifier-not-found")
else
-- otherwise return the main snak
returnclaim[1].mainsnak
end
end
localfunctiongetValueOfClaim(claim,qualifierId,parameter)
localerror
localsnak
snak,error=getQualifierSnak(claim,qualifierId)
ifsnakthen
returngetSnakValue(snak,parameter)
else
returnnil,error
end
end
localfunctiongetReferences(frame,claim)
localresult=""
-- traverse through all references
forrefinpairs(claim.referencesor{})do
localrefparts
-- traverse through all parts of the current reference
forsnakkey,snakvalinorderedpairs(claim.references[ref].snaksor{},claim.references[ref]["snaks-order"])do
ifrefpartsthenrefparts=refparts..", "elserefparts=""end
-- output the label of the property of the reference part, e.g. "imported from" for P143
refparts=refparts..tostring(mw.wikibase.getLabel(snakkey))..": "
-- output all values of this reference part, e.g. "German Wikipedia" and "English Wikipedia" if the referenced claim was imported from both sites
forsnakidx=1,#snakvaldo
ifsnakidx>1thenrefparts=refparts..", "end
refparts=refparts..getSnakValue(snakval[snakidx])
end
end
ifrefpartsthenresult=result..frame:extensionTag("ref",refparts)end
end
returnresult
end
localfunctionparseInput(frame)
localqid=frame.args.qidormw.wikibase.getEntityIdForCurrentPage()ornil
ifqidand(#qid==0)thenqid=nilend
localpropertyID=mw.text.trim(frame.args[1]or"")
localinput_parm=mw.text.trim(frame.args[2]or"")
ifinput_parm~="FETCH_WIKIDATA"then
returnfalse,input_parm,nil,nil
end
localclaims
ifqidandmw.wikibase.entityExists(qid)andmw.wikibase.getBestStatements(qid,propertyID)[1]then
claims=mw.wikibase.getBestStatements(qid,propertyID)
ifnotclaimsthen
returnfalse,"",nil,nil
end
else
returnfalse,"",nil,nil
end
returntrue,claims
end
localfunctionisType(claims,type)
returnclaimsandclaims.mainsnak.snaktype=="value"andclaims.mainsnak.datavalue.type==type
end
localfunctiongetValue(claims,delim,labelHook)
iflabelHook==nilthen
labelHook=function(qnumber)
returnnil;
end
end
localout={}
ifclaims[1]then
locali=1
whileclaims[i]~=nildo
ifisType(claims[i],"wikibase-entityid")then
localqnumber="Q"..claims[i].mainsnak.datavalue.value["numeric-id"]
localsitelink=mw.wikibase.getSitelink(qnumber)
locallabel=labelHook(qnumber)ormw.wikibase.getLabel(qnumber)orqnumber
ifsitelinkthen
out[#out+1]="[["..sitelink.."|"..label.."]]"
else
out[#out+1]="[[:d:"..qnumber.."|"..label.."]]<abbr title='"..i18n["errors"]["local-article-not-found"].."'>[*]</abbr>"
end
else
out[#out+1]=mw.wikibase.renderSnak(claims[i].mainsnak)
end
i=i+1
end
end
returntable.concat(out,delim)
end
------------------------------------------------------------------------------
-- module global functions
ifdebugthen
functionp.inspectI18n(frame)
localval=i18n
for_,keyinpairs(frame.args)do
key=mw.text.trim(key)
val=val[key]
end
returnval
end
end
functionp.descriptionIn(frame)
locallangcode=frame.args[1]
localid=frame.args[2]
-- return description of a Wikidata entity in the given language or the default language of this Wikipedia site
returnmw.wikibase.getEntity(id):getDescription(langcodeorwiki.langcode)
end
functionp.labelIn(frame)
locallangcode=frame.args[1]
localid=frame.args[2]
-- return label of a Wikidata entity in the given language or the default language of this Wikipedia site
returnmw.wikibase.getEntity(id):getLabel(langcodeorwiki.langcode)
end
-- This is used to get a value, or a comma separated list of them if multiple values exist
p.getValue=function(frame)
localdelimdefault=", "-- **internationalise later**
localdelim=frame.args.delimiteror""
delim=string.gsub(delim,'"','')
if#delim==0then
delim=delimdefault
end
localgo,claims=parseInput(frame)
ifnotgothen
returnclaims
end
returngetValue(claims,delim)
end
-- Same as above, but uses the short name property for label if available.
p.getValueShortName=function(frame)
localgo,claims=parseInput(frame)
ifnotgothen
returnclaims
end
-- if wiki-linked value output as link if possible
localfunctionlabelHook(qnumber)
locallabel
locali=1
ifmw.wikibase.entityExists(qnumber)then
ifmw.wikibase.getBestStatements(qnumber,"P1813")[1]then
whilemw.wikibase.getBestStatements(qnumber,"P1813")[i]~=nildo
ifmw.wikibase.getBestStatements(qnumber,"P1813")[i].mainsnak.datavalue.value.language=="en"then
label=mw.wikibase.getBestStatements(qnumber,"P1813")[i].mainsnak.datavalue.value.text
end
i=i+1
end
end
end
iflabel==nilorlabel==""thenreturnnilend
returnlabel
end
returngetValue(claims,", ",labelHook);
end
-- This is used to get a value, or a comma separated list of them if multiple values exist
-- from an arbitrary entry by using its QID.
-- Use : {{#invoke:Wikidata|getValueFromID|<ID>|<Property>|FETCH_WIKIDATA}}
-- E.g.: {{#invoke:Wikidata|getValueFromID|Q151973|P26|FETCH_WIKIDATA}} - to fetch value of 'spouse' (P26) from 'Richard Burton' (Q151973)
-- Please use sparingly - this is an *expensive call*.
p.getValueFromID=function(frame)
localitemID=mw.text.trim(frame.args[1]or"")
localpropertyID=mw.text.trim(frame.args[2]or"")
localinput_parm=mw.text.trim(frame.args[3]or"")
ifinput_parm=="FETCH_WIKIDATA"then
localclaims
ifframe.args[1]andmw.wikibase.entityExists(itemID)andmw.wikibase.getBestStatements(itemID,propertyID)[1]then
claims=mw.wikibase.getBestStatements(itemID,propertyID)
end
ifclaimsthen
returngetValue(claims,", ")
else
return""
end
else
returninput_parm
end
end
localfunctiongetQualifier(frame,outputHook)
localpropertyID=mw.text.trim(frame.args[1]or"")
localqualifierID=mw.text.trim(frame.args[2]or"")
localinput_parm=mw.text.trim(frame.args[3]or"")
ifinput_parm=="FETCH_WIKIDATA"then
localentityid=mw.wikibase.getEntityIdForCurrentPage()
ifmw.wikibase.entityExists(entityid)~=nilandmw.wikibase.getBestStatements(entityid,propertyID)[1]~=nilthen
localout={}
locali=1
whilemw.wikibase.getBestStatements(entityid,propertyID)[i]~=nildo
fork2,v2inpairs(mw.wikibase.getBestStatements(entityid,propertyID)[i].qualifiers[qualifierID])do
ifv2.snaktype=='value'then
out[#out+1]=outputHook(v2);
end
end
i=i+1
end
returntable.concat(out,", "),true
else
return"",false
end
else
returninput_parm,false
end
end
p.getQualifierValue=function(frame)
localfunctionoutputValue(value)
localqnumber="Q"..value.datavalue.value["numeric-id"]
if(mw.wikibase.getSitelink(qnumber))then
return"[["..mw.wikibase.getSitelink(qnumber).."]]"
else
return"[[:d:"..qnumber.."|"..qnumber.."]]<abbr title='"..i18n["errors"]["local-article-not-found"].."'>[*]</abbr>"
end
end
return(getQualifier(frame,outputValue))
end
-- This is used to get a value like 'male' (for property p21) which won't be linked and numbers without the thousand separators
p.getRawValue=function(frame)
localgo,claims=parseInput(frame)
ifnotgothen
returnclaims
end
localresult={}
locali=1
whileclaims[i]~=nildo
-- if number type: remove thousand separators, bounds and units
ifisType(claims[i],"quantity")then
result[#result+1]=mw.ustring.gsub(mw.wikibase.renderSnak(claims[i].mainsnak),"(%d),(%d)","%1%2")
result[#result+1]=mw.ustring.gsub(mw.wikibase.renderSnak(claims[i].mainsnak),"(%d)ยฑ.*","%1")
else
result[#result+1]=mw.wikibase.renderSnak(claims[i].mainsnak)
end
i=i+1
end
returntable.concat(result,', ')
end
-- This is used to get the unit name for the numeric value returned by getRawValue
p.getUnits=function(frame)
localgo,claims=parseInput(frame)
ifnotgothen
returnclaims
end
localresult={}
locali=1
whileclaims[i]~=nildo
locali=1
ifisType(claims[i],"quantity")then
result[#result+1]=mw.ustring.sub(mw.renderSnak(claims[i].mainsnak),mw.ustring.find(result," ")+1,-1)
else
result[#result+1]=mw.renderSnak(claims[i].mainsnak)
end
i=i+1
end
returnresult
end
-- This is used to get the unit's QID to use with the numeric value returned by getRawValue
p.getUnitID=function(frame)
localgo,claims=parseInput(frame)
ifnotgothen
returnclaims
end
localresult
ifisType(claims[1],"quantity")then
-- get the url for the unit entry on Wikidata:
result=claims[1].mainsnak.datavalue.value.unit
-- and just reurn the last bit from "Q" to the end (which is the QID):
result=mw.ustring.sub(result,mw.ustring.find(result,"Q"),-1)
end
returnresult
end
p.getRawQualifierValue=function(frame)
localfunctionoutputHook(value)
ifvalue.datavalue.value["numeric-id"]then
returnmw.wikibase.getLabel("Q"..value.datavalue.value["numeric-id"])
else
returnvalue.datavalue.value
end
end
localret,gotData=getQualifier(frame,outputHook)
ifgotDatathen
ret=string.upper(string.sub(ret,1,1))..string.sub(ret,2)
end
returnret
end
-- This is used to get a date value for date_of_birth (P569), etc. which won't be linked
-- Dates and times are stored in ISO 8601 format (sort of).
-- At present the local formatDate(date, precision, timezone) function doesn't handle timezone
-- So I'll just supply "Z" in the call to formatDate below:
p.getDateValue=function(frame)
localdate_format=mw.text.trim(frame.args[3]ori18n["datetime"]["default-format"])
localdate_addon=mw.text.trim(frame.args[4]ori18n["datetime"]["default-addon"])
localgo,claims=parseInput(frame)
ifnotgothen
returnclaims
end
localout={}
locali=1
whileclaims[i]~=nildo
ifclaims[i].mainsnak.datavalue.type=='time'then
localtimestamp=claims[i].mainsnak.datavalue.value.time
localdateprecision=claims[i].mainsnak.datavalue.value.precision
-- A year can be stored like this: "+1872-00-00T00:00:00Z",
-- which is processed here as if it were the day before "+1872-01-01T00:00:00Z",
-- and that's the last day of 1871, so the year is wrong.
-- So fix the month 0, day 0 timestamp to become 1 January instead:
timestamp=timestamp:gsub("%-00%-00T","-01-01T")
out[#out+1]=parseDateFull(timestamp,dateprecision,date_format,date_addon)
i=i+1
end
end
returntable.concat(out,", ")
end
p.getQualifierDateValue=function(frame)
localdate_format=mw.text.trim(frame.args[4]ori18n["datetime"]["default-format"])
localdate_addon=mw.text.trim(frame.args[5]ori18n["datetime"]["default-addon"])
localfunctionoutputHook(value)
localtimestamp=value.datavalue.value.time
returnparseDateValue(timestamp,date_format,date_addon)
end
return(getQualifier(frame,outputHook))
end
-- This is used to fetch all of the images with a particular property, e.g. image (P18), Gene Atlas Image (P692), etc.
-- Parameters are | propertyID | value / FETCH_WIKIDATA / nil | separator (default=space) | size (default=frameless)
-- It will return a standard wiki-markup [[File:Filename | size]] for each image with a selectable size and separator (which may be html)
-- e.g. {{#invoke:Wikidata|getImages|P18|FETCH_WIKIDATA}}
-- e.g. {{#invoke:Wikidata|getImages|P18|FETCH_WIKIDATA|<br>|250px}}
-- If a property is chosen that is not of type "commonsMedia", it will return empty text.
p.getImages=function(frame)
localsep=mw.text.trim(frame.args[3]or" ")
localimgsize=mw.text.trim(frame.args[4]or"frameless")
localgo,claims=parseInput(frame)
ifnotgothen
returnclaims
end
if(claims[1]andclaims[1].mainsnak.datatype=="commonsMedia")then
localout={}
locali=1
whileclaims[i]~=nildo
localfilename=claims[i].mainsnak.datavalue.value
out[#out+1]="[[File:"..filename.."|"..imgsize.."]]"
i=i+1
end
returntable.concat(out,sep)
else
return""
end
end
-- This is used to get the TA98 (Terminologia Anatomica first edition 1998) values like 'A01.1.00.005' (property P1323)
-- which are then linked to https://ifaa.unifr.ch/Public/EntryPage/TA98%20Tree/Entity%20TA98%20EN/01.1.00.005%20Entity%20TA98%20EN.htm
-- uses the newer mw.wikibase calls instead of directly using the snaks
-- formatPropertyValues returns a table with the P1323 values concatenated with ", " so we have to split them out into a table in order to construct the return string
p.getTAValue=function(frame)
localentid=mw.wikibase.getEntityIdForCurrentPage()
localprops=mw.wikibase.getEntity(entid):formatPropertyValues('P1323')
localout={}
localt={}
fork,vinpairs(props)do
ifk=='value'then
t=mw.text.split(v,", ")
fork2,v2inpairs(t)do
out[#out+1]="[https://ifaa.unifr.ch/Public/EntryPage/TA98%20Tree/Entity%20TA98%20EN/"..string.sub(v2,2).."%20Entity%20TA98%20EN.htm "..v2.."]"
end
end
end
localret=table.concat(out,"<br> ")
if#ret==0then
ret="Invalid TA"
end
returnret
end
--[[
This is used to return an image legend from Wikidata
image is property P18
image legend is property P2096
Call as {{#invoke:Wikidata |getImageLegend | <PARAMETER> | lang=<ISO-639code> |id=<QID>}}
Returns PARAMETER, unless it is equal to "FETCH_WIKIDATA", from Item QID (expensive call)
If QID is omitted or blank, the current article is used (not an expensive call)
If lang is omitted, it uses the local wiki language, otherwise it uses the provided ISO-639 language code
ISO-639: https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html#wp1252447
Ranks are: 'preferred' > 'normal'
This returns the label from the first image with 'preferred' rank
Or the label from the first image with 'normal' rank if preferred returns nothing
Ranks: https://www.mediawiki.org/wiki/Extension:Wikibase_Client/Lua
]]
p.getImageLegend=function(frame)
-- look for named parameter id; if it's blank make it nil
localid=frame.args.id
ifidand(#id==0)then
id=nil
end
-- look for named parameter lang
-- it should contain a two-character ISO-639 language code
-- if it's blank fetch the language of the local wiki
locallang=frame.args.lang
if(notlang)or(#lang<2)then
lang=mw.language.getContentLanguage().code
end
-- first unnamed parameter is the local parameter, if supplied
localinput_parm=mw.text.trim(frame.args[1]or"")
ifinput_parm=="FETCH_WIKIDATA"then
localimglbl
ifidandmw.wikibase.entityExists(id)andmw.wikibase.getBestStatements(id,"P18")[1]and
mw.wikibase.getBestStatements(id,"P18")[1].mainsnak.datavalueand
mw.wikibase.getBestStatements(id,"P18")[1].rank=="preferred"then-- in getBestStatements if there is an preferred value, it is ordered first.
imglbl=mw.wikibase.getBestStatements(id,"P18")[1].mainsnak.datavalue.value
elseifidandmw.wikibase.entityExists(id)andmw.wikibase.getBestStatements(id,"P18")[1]and
mw.wikibase.getBestStatements(id,"P18")[1].mainsnak.datavaluethen-- only normal and preferred rank values outputted in beststatements
imglbl=mw.wikibase.getBestStatements(id,"P18")[1].mainsnak.datavalue.value
end
returnimglbl
else
returninput_parm
end
end
-- This is used to get the QIDs of all of the values of a property, as a comma separated list if multiple values exist
-- Usage: {{#invoke:Wikidata |getPropertyIDs |<PropertyID> |FETCH_WIKIDATA}}
-- Usage: {{#invoke:Wikidata |getPropertyIDs |<PropertyID> |<InputParameter> |qid=<QID>}}
p.getPropertyIDs=function(frame)
localgo,propclaims=parseInput(frame)
ifnotgothen
returnpropclaims
end
-- if wiki-linked value collect the QID in a table
if(propclaims[1]andpropclaims[1].mainsnak.snaktype=="value"andpropclaims[1].mainsnak.datavalue.type=="wikibase-entityid")then
localout={}
locali=1
whileclaims[i]~=nildo
out[#out+1]="Q"..claims[i].mainsnak.datavalue.value["numeric-id"]
i=i+1
end
returntable.concat(out,", ")
else
-- not a wikibase-entityid, so return empty
return""
end
end
-- returns the page id (Q...) of the current page or nothing of the page is not connected to Wikidata
functionp.pageId(frame)
returnmw.wikibase.getEntityIdForCurrentPage()
end
functionp.claim(frame)
localproperty=frame.args[1]or""
localid=frame.args["id"]ormw.wikibase.getEntityIdForCurrentPage()
localqualifierId=frame.args["qualifier"]
localparameter=frame.args["parameter"]
locallist=frame.args["list"]
localreferences=frame.args["references"]
localshowerrors=frame.args["showerrors"]
localdefault=frame.args["default"]
ifdefaultthenshowerrors=nilend
-- check wikidata entity
ifnotmw.wikibase.entityExists(id)then
ifshowerrorsthenreturnprintError("entity-not-found")elsereturndefaultend
end
-- fetch the first claim of satisfying the given property
localclaims=mw.wikibase.getBestStatements(id,property)ornil
ifnotclaimsornotclaims[1]then
ifshowerrorsthenreturnprintError("property-not-found")elsereturndefaultend
end
-- no need to sort, bestStatements orders preferred rank first
localresult
localerror
locali=1
iflistthen
localvalue
-- iterate over all elements and return their value (if existing)
result={}
foridxinpairs(claims)do
localclaim=claims[i]
value,error=getValueOfClaim(claim,qualifierId,parameter)
ifnotvalueandshowerrorsthenvalue=errorend
ifvalueandreferencesthenvalue=value..getReferences(frame,claim)end
result[#result+1]=value
i=i+1
end
result=table.concat(result,list)
else
-- return first element
localclaim=claims[i]
result,error=getValueOfClaim(claim,qualifierId,parameter)
ifresultandreferencesthenresult=result..getReferences(frame,claim)end
end
ifresultthenreturnresultelse
ifshowerrorsthenreturnerrorelsereturndefaultend
end
end
-- look into entity object
functionp.ViewSomething(frame)
localf=(frame.args[1]orframe.args.id)andframeorframe:getParent()
localid=f.args.id
ifidand(#id==0)then
id=nil
end
localdata=mw.wikibase.getEntity(id)
ifnotidornotmw.wikibase.entityExists(id)then
returnnil
end
locali=1
whiletruedo
localindex=f.args[i]
ifnotindexthen
iftype(data)=="table"then
returnmw.text.jsonEncode(data,mw.text.JSON_PRESERVE_KEYS+mw.text.JSON_PRETTY)
else
returntostring(data)
end
end
data=data[index]ordata[tonumber(index)]
ifnotdatathen
return
end
i=i+1
end
end
-- getting sitelink of a given wiki
-- get sitelink of current item if qid not supplied
functionp.getSiteLink(frame)
localqid=frame.args.qid
ifqid==""thenqid=nilend
localf=mw.text.trim(frame.args[1]or"")
ifnotquidornotmw.wikibase.entityExists(qid)then
return
end
locallink=mw.wikibase.getSitelink(f)
ifnotlinkthen
return
end
returnlink
end
functionp.Dump(frame)
localf=(frame.args[1]orframe.args.id)andframeorframe:getParent()
localdata=mw.wikibase.getEntity(f.args.id)
ifnotdatathen
returni18n.warnDump
end
locali=1
whiletruedo
localindex=f.args[i]
ifnotindexthen
return"<pre>"..mw.dumpObject(data).."</pre>"..i18n.warnDump
end
data=data[index]ordata[tonumber(index)]
ifnotdatathen
returni18n.warnDump
end
i=i+1
end
end
returnp