Editing Module:WikidataIB/sandbox1/doc (section)

== Other main functions ==
=== Function getPreferredValue ===
The getPreferredValue function works exactly like getValue, taking the same parameters, but if any values for a property have the preferred rank set, it will only return those values. This is now deprecated in favour of <code>getValue|rank=best</code>.

=== Function getNormalValue ===
The getNormalValue function complements getPreferredValue, taking the same parameters, but if any values for a property have the normal rank set, it will only return those values. This is now deprecated in favour of <code>getValue|rank=normal</code>.

If a property has a mixture of preferred and normal ranks set, they can be separated by separate calls using <code>getValue|rank=preferred</code> (only returns preferred values) and <code>getValue|rank=normal</code> (only returns normal values).

Fetching the name(s) of the {{Q|P170}} from {{Q|Q29016906}}:
* <code><nowiki>{{#invoke:WikidataIB |getValue |P170 |fwd=ALL |qid=Q29016906 |osd=no}}</nowiki></code> → {{#invoke:WikidataIB |getValue |P170 |fwd=ALL |qid=Q29016906 |osd=no}}
* <code><nowiki>{{#invoke:WikidataIB |getValue |P170 |fwd=ALL |qid=Q29016906 |osd=no |rank=preferred}}</nowiki></code> → {{#invoke:WikidataIB |getValue |P170 |fwd=ALL |qid=Q29016906 |osd=no |rank=preferred}}
* <code><nowiki>{{#invoke:WikidataIB |getValue |P170 |fwd=ALL |qid=Q29016906 |osd=no |rank=normal}}</nowiki></code> → {{#invoke:WikidataIB |getValue |P170 |fwd=ALL |qid=Q29016906 |osd=no |rank=normal}}
* <code><nowiki>{{#invoke:WikidataIB |getValue |P170 |fwd=ALL |qid=Q29016906 |osd=no |rank=best}}</nowiki></code> → {{#invoke:WikidataIB |getValue |P170 |fwd=ALL |qid=Q29016906 |osd=no |rank=best}}

=== Function getCoords ===
* getCoords can also take a named parameter {{para|qid}} which is the Wikidata ID for an article. This will not normally be used as omitting it defaults to the current article.
* The first unnamed parameter, if supplied, will become the returned value and no call to Wikidata will be made.
* The coordinates from Wikidata are parsed and passed to [[Template:Coord]] which returns the display as if it were called manually.
* The blacklist of fields that are never to be displayed, and the whitelist are implemented in the same way as for getValue using {{para|suppressfields}} and {{para|fetchwikidata}}

=== Function getQualifierValue ===

The getQualifierValue function is for use when we want to fetch the value of a qualifier. We need to know the property and the value of the property that the qualifier relates to. The parameters are:
* The property ID passed in the unnamed parameter (or {{para|1}})
* The target value for that property in {{para|pval}}
* The qualifier ID for that target value in {{para|qual}}
* The same parameters to implement whitelisting and blacklisting of the property as in getValue
* Optional boolean to specify whether only sourced values of the property are returned (defaults to "no") in {{para|onlysourced}}
* Optional item ID for arbitrary access in {{para|qid}}
* The same parameters to format output as in getValue

==== Example of getQualifierValue ====
In {{Q|Q1513315}} there is a property {{Q|P793}}, which has a value {{Q|Q385378}}. That has two qualifiers, {{Q|P580}} and {{Q|P582}}. To get the start date:
* <code><nowiki>{{#invoke:WikidataIB |getQualifierValue |P793 |pval=Q385378 |qual=P580 |name=xyz |fetchwikidata=ALL }}</nowiki></code>
In [[South Pole Telescope]] it returns:
* {{#invoke:WikidataIB |getQualifierValue |P793 |pval=Q385378 |qual=P580 |name=xyz |fetchwikidata=ALL |qid=Q1513315}}

=== Function getValueByQual ===
The getValueByQual function returns the value of a property which has a qualifier with a given entity value. The parameters are:
* The property ID passed in the unnamed parameter (or {{para|1}})
* The property ID for a qualifier (or "ALL" or "DATES") in {{para|qualID}}
* The Wikibase-entity ID of a value for that qualifier in {{para|qvalue}}
* The same parameters to implement whitelisting and blacklisting of the property as in getValue
* Optional boolean to specify whether only sourced values of the property are returned (defaults to "no") in {{para|onlysourced}}
* Optional item ID for arbitrary access in {{para|qid}}
* The same parameters to format output as in getValue

==== Example of getValueByQual ====
In {{Q|Q10990}} there is a property {{Q|P443}} that has multiple values, each of which has a qualifier {{Q|P407}}. We can return the property value whose qualifier has the value {{Q|Q7979}}
* <code><nowiki>{{#invoke:WikidataIB |getValueByQual |qid=Q10990 |P443 |qualID=P407 |qvalue=Q7979 |fwd=ALL |osd=no |noicon=true}}</nowiki></code> → {{#invoke:WikidataIB/sandbox |getValueByQual |qid=Q10990 |P443 |qualID=P407 |qvalue=Q7979 |fwd=ALL |osd=no |noicon=true}}

=== Function getValueByLang ===
The getValueByLang function returns the value of a property which has a qualifier {{Q|P407}} whose value has the given language code. The parameters are:
* The property ID passed in the unnamed parameter (or {{para|1}})
* The MediaWiki language code to match the language whose code is given by {{para|lang|xx[-yy]}}. If no code is supplied, it uses the default language.
* The same parameters to implement whitelisting and blacklisting of the property as in getValue
* Optional boolean to specify whether only sourced values of the property are returned (defaults to "no") in {{para|onlysourced}}
* Optional item ID for arbitrary access in {{para|qid}}
* The same parameters to format output as in getValue