View source for Module:Wikidata/doc

Module permitting basic data retrieval from items. It is mostly useful for other modules or for {{tl|Data}}

<small><i>A copy is available on [https://test.wikidata.org/wiki/Module:Wikidata test Wikidata]</i></small>
== 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 {{p|248}})
* 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 {{p|580}}, {{p|582}} and {{p|585}} 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. 
* conj = the conjunction separating the statements. For example, conj = '<nowiki><br /></nowiki>' 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 {{tl|Data}} that takes exactly the same arguments.
* '''p.getLabel''' get the label of an entity

=== Examples ===

{| class="wikitable"
|-
! Code !! Render !! Comment
|-
| <nowiki>{{#invoke:Wikidata|getLabel|entity=Q42}}</nowiki> || {{#invoke:Wikidata|getLabel|entity=Q42}} || {{Q|42}}
|-
| <nowiki>{{#invoke:Wikidata|getLabel|entity=Q42|link=wikipedia}}</nowiki> || {{#invoke:Wikidata|getLabel|entity=Q42|link=wikipedia}} || 
|-
| <nowiki>{{#invoke:Wikidata|getLabel|entity=Q42|link=-}}</nowiki> || {{#invoke:Wikidata|getLabel|entity=Q42|link=-}} || 
|-
| <nowiki>{{#invoke:Wikidata|getLabel|entity=Q42|link=wikipedia|lang=ja}}</nowiki> || {{#invoke:Wikidata|getLabel|entity=Q42|link=wikipedia|lang=ja}} || 
|-
| <nowiki>{{#invoke:Wikidata|getLabel|entity=Q42|link=wikidata}}</nowiki> || {{#invoke:Wikidata|getLabel|entity=Q42|link=wikidata}} || 
|-
| <nowiki>{{#invoke:Wikidata|getLabel|entity=Q42|link=wikidata|lang=ja}}</nowiki> || {{#invoke:Wikidata|getLabel|entity=Q42|link=wikidata|lang=ja}} || 
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p31}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q42|property=p31}} || {{Q|42}} {{P|31}}
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p31|lang=ja}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q42|property=p31|lang=ja}} || 
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p569}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q42|property=p569}} || {{Q|42}} {{P|569}} 
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p569|lang=ja}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q42|property=p569|lang=ja}} || 
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q42|property=p569|displayformat=raw}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q42|property=p569|displayformat=raw}} || 
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186}} || {{Q|12418}} {{P|186}}
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|displayformat=raw}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|displayformat=raw}} || 
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|lang=ja}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|lang=ja}} || 
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|rank=valid}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|rank=valid}} || rank = "valid" accepts both "preferred" and "normal" values
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|numval=1}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|numval=1}} || returns the number of values numval (priority to those with "rank= preferred", if there are not enough of them, also accepts "rank = normal")
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|qualifier=p518}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|qualifier=p518}} || {{Q|12418}} {{P|186}} {{P|518}} should only display values that have a p518 qualifier
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|showqualifiers=p518}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q12418|property=p186|showqualifiers=p518}} ||  shows the value of the p518 qualifier (if any) in addition to the main value
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q83259|property=p669|showqualifiers=p670|delimiter=&amp;#32;}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q83259|property=p669|showqualifiers=p670|delimiter=&#32;}} || {{Q|83259}} {{P|669}} {{P|670}} shows the value of the P670 qualifier (if any) in addition to the main value separated by a space
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q12418|property=P276|sourceproperty=P854}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q12418|property=P276|sourceproperty=P854}} || {{Q|12418}} {{P|276}} {{P|854}}
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q11879536|property=P460|withsource=Q1645493}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q11879536|property=P460|withsource=Q1645493}} || {{Q|11879536}} {{P|460}} {{Q|1645493}}
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q11879536|property=P460|withsource=Q1645493|showsource=true}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q11879536|property=P460|withsource=Q1645493|showsource=true}} || 
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q153|property=P231|showsource=true}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q153|property=P231|showsource=true}} || {{Q|153}} {{P|231}}
|-
| <nowiki>{{#invoke:Wikidata|formatStatementsE|item=Q205309|property=P793|sorttype=inverted}}</nowiki> || {{#invoke:Wikidata|formatStatementsE|item=Q205309|property=P793|sorttype=inverted}} || {{Q|205309}} {{P|793}}
|}

== See also ==
* [[Module:Wd]]