Module:Wikidata/doc: Difference between revisions

Content deleted Content added
Methods: correct documentation
Methods: clarify documentation for when preferred values exist
Line 4:
== 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 will be output likesimilar to <tt><nowiki>{{#property:}}</nowiki></tt>., except that Ifif values with preferred rank exist, then only they are returned.
* <tt>getRawValue</tt>: Returns non-linked property values and numbers with the thousand separator. All other values will be output likesimilar to <tt><nowiki>{{#property:}}</nowiki></tt>, including normal values, even if preferred values exist.
* <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". 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.