Module:Wikidata/doc

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

Module permitting basic data retrieval from Wikidata items, based on mw:Extension:Wikibase Client/Lua

Functions callable from Lua

p.getClaims returns claims in a particular item that match a particular query

• item (required): its Qid
• property (required) property that the claims should have
• qualifier = qualifiers that the statement should have
• withrank = rank of the statement ; 'preferred', 'normal', 'deprecated' or 'valid' (ie. normal and preferred). By default = preferred.
• sourceproperty = this property should be used in the source
• withsource = the source that should be provided in the statement (if sourceproperty is not provided, the property used is stated in (P248))
• excludespecial = set to true if you do not want to get "novalue" and "somevalue".
• numval = if you want to set a maximum number of values to be returned
• sorttype = set to "chronological" to get the statements in chronological order using the start time (P580), end time (P582) and point in time (P585) qualifiers. Set to "inverted" for chronological order. From a Lua module, you can also define your own sorting criteria.
• showsource = set to "true" if you want the source of the statement to be displayed.

p.formatStatements(args): returns a string containing the statements given in the table args. Same keys as getClaims, plus formatting arguments:

• lang (required) for the desired language
• displayformat = the format in which the args should be returned. For example, for a string-type property displayformat = "weblink" returns a formatted weblink.
• conjtype = the conjunction separating the statements. For example, conj = '<br />' will make a new line between each statement.
• showqualifiers = the qualifiers that should be shown along with the mainsnak value

p.getLabel get the label of an entity

• entity = entity ID with its Q or P
• lang

Functions callable from wikitext

• p.formatStatementsE same as p.formatStatements, except that "lang" is not required. It is most conveniently used from {{Data}} that takes exactly the same arguments.

Examples

Code	Render	Comment
{{#invoke:Wikidata|pageId}}		return wikidata q-code for pages connected to wikidata
{{#invoke:Wikidata|getLabel|entity=Q42|link=wikipedia}}	Douglas Adams	link to wikipedia
{{#invoke:Wikidata|getLabel|entity=Q42|link=wikipedia|format=lc}}	Douglas Adams	link to wikipedia but shown with lower case
{{#invoke:Wikidata|getLabel|entity=Q42|link=-}}	Douglas Adams	no links
{{#invoke:Wikidata|getLabel|entity=Q42|link=wikipedia|lang=ja}}	ダグラス・アダムズ
{{#invoke:Wikidata|getLabel|entity=Q42|link=wikidata}}	Douglas Adams	link to wikidata
{{#invoke:Wikidata|getLabel|entity=Q42|link=wikidata|lang=ja}}	ダグラス・アダムズ
{{#invoke:Wikidata|getDescription|entity=Q42|link=wikidata|lang=fr}}	écrivain et humoriste anglais (1952–2001)
{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p31}}	human
{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p31|link=-}}	human
{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p31|lang=ja}}	ヒト
{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p569}}	11 March 1952
{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p569|lang=ja}}	1952年3月11日
{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186}}	oil paint and poplar panel
{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|link=-}}	oil paint and poplar panel
{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|displayformat=raw}}	Q296955 and Q106857865
{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|lang=ja}}	油絵具およびポプラ板
{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|rank=valid}}	oil paint, poplar panel and wood	rank = "valid" accepts both "preferred" and "normal" values
{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|showqualifiers=p518}}	oil paint and poplar panel (painting support)	shows the value of the p518 qualifier (if any) in addition to the main value
{{#invoke:Wikidata|formatStatementsE|item=Q83259|property=p669|showqualifiers=p670|delimiter= }}		shows the value of the P670 qualifier (if any) in addition to the main value separated by a space
{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|qualifier=p518}}		should only display values that have a p518 qualifier
{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|numval=1}}	oil paint	returns the number of values numval (priority to those with "rank= preferred", if there are not enough of them, also accepts "rank = normal")
{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=P276|sourceproperty=P854}}	Salle des États, Louvre
{{#invoke:Wikidata|formatStatementsE|item=Q11879536|property=P460|withsource=Q1645493}}	Lisa del Giocondo
{{#invoke:Wikidata|formatStatementsE|item=Q153|property=P231|showsource=true}}	64-17-5
{{#invoke:Wikidata|formatStatementsE|item=Q205309|property=P793|sorttype=inverted}}	closure, demolition, renovation, renovation, first match and construction
{{#invoke:Wikidata|formatStatementsE|property=P625|item=Q90|displayformat=latitude}}	48.856666666667	Latitude of Paris
{{#invoke:Wikidata|formatStatementsE|property=P19|item=Q1441042}}	unknown	unknown value
{{#invoke:Wikidata|formatStatementsE|property=P19|item=Q43650835}}	not applicable	no value