Module:Wikidata/doc

2015-02-08T12:13:39Z

134.134.137.73: remove sandbox

{{module rating|alpha}}
This module is a modification of the original at [[Module:Sandbox/Tom Morris]] which was created 19 May 2013.

== Methods ==
The module "{{BASEPAGENAME}}" 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:
* <tt>getValue</tt>: Returns wiki-linked values, if applicable. All other values with be output like <tt><nowiki>{{#property:}}</nowiki></tt>, regardless of their rank.
* <tt>getRawValue</tt>: Returns non-linked property values and numbers with the thousand separator. All other values with be output like <tt><nowiki>{{#property:}}</nowiki></tt>.
* <tt>getDateValue</tt>: 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".

Wikidata qualifier values (if present) can be retrieved by the following methods:
* <tt>getQualifierValue</tt>: returns only wiki-linked values, if applicable.
* <tt>getRawQualifierValue</tt>: returns non-linked values
* <tt>getQualifierDateValue</tt>: 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:
* <tt>pageId</tt>: returns the Wikidata id (Q…) of the current page or nothing if the page is not connected to Wikidata

== Parameters ==
* 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.

== Usage ==
=== Example:spouse ===
* <code><nowiki>{{#invoke:Wikidata|getValue|P26|}}</nowiki></code> = returns nothing, so suppresses the display of spouse in an infobox
* <code><nowiki>{{#invoke:Wikidata|getValue|P26|FETCH_WIKIDATA}}</nowiki></code> = 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 Rodham Clinton]])
* <code><nowiki>{{#invoke:Wikidata|getValue|P26|[[Hillary Clinton]]}}</nowiki></code> = returns [[Hillary Clinton]], allowing an infobox to use a local value rather than the value stored in Wikidata.

=== Example in Infobox template ===
Inside an infobox definition, it may be called like this:
* <code><nowiki>| data55 = {{#invoke:Wikidata|getValue|P26|{{{spouse|FETCH_WIKIDATA}}} }}</nowiki></code>
which causes the infobox to:
# not display spouse if the infobox parameter <code>|spouse</code> is set to be blank (as <code>"| spouse ="</code>}
# display the linked value(s) from Wikidata if the infobox parameter <code>|spouse</code> is not supplied
# display the local infobox parameter <code>|spouse</code> if it is supplied (e.g. <code>"|spouse = Hillary Clinton"</code>)

Optionally, it could be called as:
* <code><nowiki>| data55 = {{#invoke:Wikidata|getValue|P26|{{{spouse|}}} }}</nowiki></code>
which should behave as the parameter does now, unless the parameter is set to FETCH_WIKIDATA when it displays the linked value(s) fetched from Wikidata.

=== Example:birth place ===
This works in just the same way as the calls above:
* <code><nowiki>{{#invoke:Wikidata|getValue|P19|}}</nowiki></code> = returns nothing, so suppresses the display of birth place in an infobox
* <code><nowiki>{{#invoke:Wikidata|getValue|P19|FETCH_WIKIDATA}}</nowiki></code> = 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]])
* <code><nowiki>{{#invoke:Wikidata|getValue|P19|[[Hope, Arkansas|Hope]]}}</nowiki></code> = returns [[Hope, Arkansas|Hope]], allowing an infobox to use a local value rather than the value stored in Wikidata.

=== Example:gender ===
We don't want the returned value linked, so use:
* - <code><nowiki>{{#invoke:Wikidata|getRawValue|P21|FETCH_WIKIDATA}}</nowiki></code>

=== Example:date of birth ===
If we want the date of birth in dmy format, we use:
* - <code><nowiki>{{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|dmy}}</nowiki></code>

If we want the date of birth in mdy format, we use:
* - <code><nowiki>{{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|mdy}}</nowiki></code>

=== Example: Linking to Wikidata item ===
Use the following code to just retrieve the Q-ID:
* - <code><nowiki>{{#invoke:Wikidata|pageId}}</nowiki></code>

Linking to Wikidata used the usual Wiki markup:
* - <code><nowiki>[[d:{{#invoke:Wikidata|pageId}}|Name of Link]]</nowiki></code>

== Testing ==
=== Testing spouse ===
Copy and paste the following into any article and preview it (please don't save!):
<pre>
* - {{#invoke:Wikidata|getValue|P26|}}
* - {{#invoke:Wikidata|getValue|P26|FETCH_WIKIDATA}}
* - {{#invoke:Wikidata|getValue|P26|[[Hillary Clinton]]}}
</pre>

In [[Bill Clinton]] you should get:
* -
* - [[Hillary Rodham Clinton]]
* - [[Hillary Clinton]]

In [[Barack Obama]] you should get:
* -
* - [[Michelle Obama]]
* - [[Hillary Clinton]]

In [[Richard Burton]] you should get:
* -
* - [[Sally Burton]], [[Elizabeth Taylor]]
* - [[Hillary Clinton]]

In [[Franz Kafka]] you should get:
* -
* -
* - [[Hillary Clinton]]

=== Testing birthplace ===
Copy and paste the following into any article and preview it (please don't save!):
<pre>
* - {{#invoke:Wikidata|getValue|P19|}}
* - {{#invoke:Wikidata|getValue|P19|FETCH_WIKIDATA}}
* - {{#invoke:Wikidata|getValue|P19|[[Newport]]}}
</pre>
Try [[William Ellery]] and check that the Wikidata call correctly disambiguates.

=== Testing getValue, getRawValue and getDateValue ===
Copy and paste the following into any article and preview it (please don't save!):
<pre>
* - {{#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}}
</pre>
This should return the Wikidata values for birthplace, spouse, citizenship, religion, gender and date of birth (twice) if they exist. The dob is first in dmy format and then in mdy.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
[[Category:Wikidata]]
}}</includeonly>

The Official Website for Mark Eitzel & American Music Club - User contributions [en]

Module:Wikidata/doc