عرض مصدر وحدة:Wikidata.Ca/شرح

<!-- -->
<div dir="ltr">
{{Wikidatapowered}}
This is the documentation of [[Module:{{ROOTPAGENAME}}]] in English.

This module fetches formatted data from Wikidata. It works in local language and it has options for internationalization.

Wondering what does Wikidades mean? See [[wikt:en:dada#Catalan]].

== Functions ==
Basic function:
* <code>[[#Function claim|claim]]</code>: returns the value (or values) of a statement or a qualifier formatted with parameters or using a default format depending on the data type.

Other functions:
* <code>[[#Function getLabel|getLabel]]</code>: returns the label of an item, with some optional parameters.
* <code>[[#Function getParentValues|getParentValues]]</code>: returns labels and parent values of a property, recursively.
* <code>[[#Function linkWithParentLabel|linkWithParentLabel]]</code>: creates a link with the label of a parent property. For example, to link {{P|P405}} with the label {{P|P835}} from the parent item.
* <code>[[#Function yearsOld|yearsOld]]</code>: returns the age of a person: difference between {{P|P569}} and {{P|P570}}, when the two properties exist; or difference between {{P|P569}} and current date, if there is no P570. Returns the completed years (nn) or range of years (nn/mm) depending on the precision of the dates.
* <code>[[#Function editAtWikidata|editAtWikidata]]</code>: returns a pencil icon linked to a declaration on Wikidata. Planned to pop up an editing interface by [[mw:Wikidata Bridge]].

Other [[#Utility functions|utility functions]]: getSiteLink, lang, numStatements, validProperty, formatNum.

== Function claim ==
Returns the value (or values) of a statement or a qualifier formatted with parameters or using a default format depending on the data type. By default, it refers to the Wikidata item (Qid) associated to the current page.

Full syntax:
:<code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|claim|item= |lang= |property= |qualifier= |value= |list= |tablesort= |formatting= |separator= |conjunction= |editicon= |showerrors= |default= }}</nowiki></code>

Additional syntax for table format:
:<code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|claim|item= |lang= |property= |qualifier= |qualifier2= |...|qualifier</nowiki>''x''<nowiki>= |formatting=table |tablesort=  |sorting= |rowformat= |rowsubformat1= |...|rowsubformat</nowiki>''x''<nowiki>= |colformat0= |...|colformat</nowiki>''x''<nowiki>= |case0= |...|case</nowiki>''x''<nowiki>= |separator= |conjunction= |editicon= |showerrors= |default= |references= }}</nowiki></code>

=== General parameters ===
*<code>item=</code> (optional) Specifies an item (Qid) other than the associated to current page. Use it with moderation as arbitrary access to Wikidata is expensive. It can be defined in the parent frame of the template. Alias <code>from</code>.

*<code>lang=</code> (optional) Indicates the code of a given language. It can be defined in the parent frame of the template. By default, it uses the local language of the wiki. If there is no label in this language then it tries in the fall back languages defined in MediaWiki. On the debug console type =mw.dumpObject(mw.language.getFallbacksFor(mw.getContentLanguage():getCode())) to see the fallback languages of your wiki. If the label has not been found in the preferred language, it adds the language code and a label icon to translate it on Wikidata. [[File:Arbcom ru editing.svg|10px|baseline|Edit the value on Wikidata|link=d:Q12069631#P31]] to translate it on Wikidata.

*<code>property=</code> (required) Property id of the statement (Pid). It is possible to define alternative properties with any separator, for example "P17 or P131", and it gets the first one found. It also accepts a minuscule p, but it is not recommended. It also accepts the property label, for example "property=country" is equivalent to "property=P17" for {{P|P17}}.

*<code>qualifier=</code> (optional) Qualifier (Pid) of a property value.

*<code>value=</code> (optional) Value preferred to Wikidata one. It can be an optional parameter in a template with format <nowiki>{{{parameter|}}}</nowiki>, so if it exists then it takes the value of the parameter, if it is void then it gets the value of Wikidata.
** <code>value=NONE</code> With this special value, it returns a void string. This allows to set a parameter that does not fetch anything from Wikidata, or to show only values provided in the template with <code><nowiki>{{{parameter|NONE}}}</nowiki></code>. It is equivalent to wiki syntax: <code><nowiki>{{#ifeq:{{{parameter|}}}|NONE|<!-- do nothing -->}}</nowiki></code>.

*<code>references=</code> (optional) With any value, recommended <code>yes</code> for readability, it shows the references of the value. With a numeric value it is the maximum number of references to fetch for the statement, by default 1. If exist {{P|P854}}, and either {{P|P1476}} or {{P|P248}}, then it is formatted with {{Q|Q5637226}} using the local parameters defined in table i18n["cite"] at [[Module:{{ROOTPAGENAME}}/i18n]]. If exist {{P|P1433}}, and title or stated in, then it is formatted with {{Q|Q5624899}}. Otherwise, it is formatted as text.
*: If used with formatting=table (see [[#Parameters of table with property and qualifiers|below]]) you must include a placeholder for references.

*<code>list=</code> (optional):
** <code>list=true</code> (default) shows a list of all preferred and normal values (see separator and conjunction below). It never fetches deprecated values.
** <code>list=false</code> or <code>list=no</code> shows only one value, the best ranked (preferred or normal) or the oldest of those with the best rank.
** <code>list=lang</code> for monolingual values, shows values corresponding to the language of the lang parameter. See parameters lang and formatting for monolingualtext.
** <code>list=notlang</code> for monolingual values, it does not show values corresponding to the language of the lang parameter.
* <code>listrank=bestrank</code> lists only the best ranked values, either preferred or normal. If list=lang is used then bestrank is ignored. For compatibility with older versions, list=bestrank or list=firstrank are aliases. It is equivalent to list=true if all values have the same rank. It is equivalent to list=false if only one value is best ranked.
* <code>listmax=''<number>''</code> Sets the maximum number of values to be returned. For compatibility with older versions, list=''<number>'' is also valid. Setting listmax=1 is equal to list=false. Setting listmax=0 is equal to list=true.
* <code>tablesort=0</code> (optional) sorts the list in ascending order. By default, sorting is by rank (preferred, normal), and by order in Wikidata.

* <code>separator=</code> (optional) Separator to use in lists or tables. For lists, the default is [[MediaWiki:Comma-separator]] (in English a comma and a blank space ',%nbsp;'). For tables, the default is a line break <nowiki><br /></nowiki>. In some specials cases, a <nowiki><br /></nowiki> may not work if it is included with [[mw:Strip marker|strip markers]]. The alternative is to use the mark of a line feed control character: separator=LF.

* <code>conjunction=</code> (optional) Conjunction to use as a separator between the last two elements of a list. By default, it is equal to 'separator' if it is defined, otherwise it is [[MediaWiki:And]] plus [[MediaWiki:Word-separator]] (in English ' and '). For tables the default is a line break <nowiki><br /></nowiki>.

* <code>qseparator=</code> (opcional) Separator for qualifiers to use in lists or tables. For lists, the default is separator. For tables the default is [[MediaWiki:Comma-separator]].

* <code>qconjunction=</code> (opcional) Conjunction for qualifiers. For lists the default is conjunction. For tables, the default is qseparator.

*<code>case=</code> (optional) Grammatical case to be used. As a general case handled by the module:
** case=gender: according to {{P|21}} of the element it shows the label {{P|P2521}} of the value.
** For other particular cases of the local wiki, see the documentation of [[Module:{{ROOTPAGENAME}}/i18n]].

*<code>itemgender=</code> (optional) Item where to check {{P|21}} for using the feminine form if necessary. By default it is <code>item</code>. It is used in combination with case=gender.

*<code>editicon=</code> (optional) Definition of the pencil icon [[File:Arbcom ru editing.svg|10px|baseline|Edit the value on Wikidata|link=d:Q12069631#P31]] to show and edit the statement fetched from Wikitada (planned to pop up an editing interface by [[mw:Wikidata Bridge]]). Value of editicion is get from invoke call, or from parent frame of the template, or by default from definition of value addpencil in [[Module:{{ROOTPAGENAME}}/i18n]] as wiki setting.
** editicon=true: show the icon. It will not be necessary if this is the default value of the wiki.
** editicon=false or editicon=no: do not show the icon.
** editicon=right: show the icon and align it to the right.

*<code>shownovalue=</code> (optional) Flag for ignoring statements defined as "no value". By default it is shownovalue=true showing message [[MediaWiki:Wikibase-snakview-snaktypeselector-novalue]]. With values shownovalue=false or shownovalue=no then the statement is ignored.

*<code>showerrors=</code> (optional) With any value, typically 'yes', it shows error messages, if any. By default it shows the 'default' parameter.

*<code>default=</code> (optional) Text to show for any error if 'showerrors' parameter is not defined.

*<code>sandbox=</code> (opcional) With any value, typically 'yes', it redirects the invokes to [[Module:{{ROOTPAGENAME}}/sandbox]]. The title of the subpage is retrieved from [[MediaWiki:Sandboxlink-subpage-name]], "sandbox" in English, check it in the wiki language if necessary. This parameter can be used as parent from a template. It makes no sense used directly in an invoke or require for testing purposes. To be used only in preview or temporally as the sandbox module should not have any permanent link.

=== Parameters for formatting ===
<code>formatting=</code> (optional). Options for formatting depending on the data value and type:

Data value entity:
* <code>formatting=raw</code> Wikidata id (Qid or Pid) of the value.
* <code>formatting=label</code> Label of the value in local language, its fall backs or as ''raw''.
* <code>formatting=sitelink</code> Title of the local site page, not linked. If there is no local page then it returns the format raw prefixed with interwiki link "d:".
* <code>formatting=internallink</code> Internal link whenever possible: 1) to local wiki page (sitelink), 2) red link to the label if it does not exist as sitelink in another Wikidata item, 3) to Wikidata as last option.
* <code>formatting=''pattern''</code> Format using a pattern with $1 as a parameter to replace. It can include templates or parser functions with a non-expanded format: {{tl|((}}template<nowiki>{{!}}</nowiki>$1{{tl|))}} or {{tl|((}}template<nowiki>{{!}}</nowiki>parameter name{{tl|1==}}$1{{tl|))}}, or alike. 
: The default format is a [[m:Help:Piped link|piped link]] with link target as ''sitelink'' and link label as ''label''. A link to Wikidata is formatted with <span style="color:#5f9cbb;">light blue color</span> different from the <span style="color:#0645AD;">internal blue link</span>.
:* <code>formatting=ucfirst</code> Variant of the default piped link with uppercase in first letter of label. In a list, it is used only for the first value.
:* <code>formatting=ucinternallink</code> Both "ucfirst" and "internallink".

Data value string:
: General:
:* <code>formatting=''pattern''</code> Format using a pattern with $1 as a parameter to replace, for example: <code><nowiki>formatting=[http://whc.unesco.org/en/list/$1 $1]</nowiki></code>. For identifiers statements with an auto-generated link, the pattern can be found in the talk page of the property. It can include templates or parser functions with a non-expanded format (see above for entity).
: Type URL:
:* <code>formatting=weblink</code> Format as external link with the website as label: <nowiki>[http://www.example.com example.com], [http://example.com/en/page example.com…]</nowiki>.
: Type external-id:
:* <code>formatting=externalid</code> Format as external link with the URL pattern from {{P|P1630}} in entity Pid of <code>property</code>.
: Type math formula:
:: Returns the content wrapped with tag <nowiki><math></nowiki> that generates an image of the formula. See [[mw:Extension:Math]] and examples in {{P|P2534}}.
: Type musical notation
:: Returns the content wrapped with tag <nowiki><score></nowiki> that generates an image of the score. See [[mw:Extension:Score]] and examples in {{P|P6686}}. Format options:
:* <code>formatting=sound</code> (optional) Adds the attribute sound="1" to the tag, embedding an audio player after the score image.

Data value quantity:
: By default it shows the quantity.
* <code>formatting=unit</code> Shows the quantity and the unit. It can show plural units if it is defined at [[Module:{{ROOTPAGENAME}}/Units]].
** <code>formatting=unitlinked</code> Alternative with unit name linked.
* <code>formatting=unitcode</code> Shows the quantity and the code or abbreviation of the unit defined in {{P|5061}}. It can be changed locally at [[Module:{{ROOTPAGENAME}}/Units]]. If not found it shows the unit name.
** <code>formatting=unitcodelinked</code> Alternative with unit code linked.
* <code>formatting=duration</code> Shows a duration quantity broken into human-readable units: millennia, centuries, decades, years, days, hours, minutes, and seconds. For example, 123456 seconds: 1 day, 10 hours, 17 minutes and 36 seconds. Previously it tries to convert the unit to seconds (using convert=Q11574), otherwise it assumes the quantity is expressed in seconds.
** <code>formatting=durationhms</code> Shows duration abbreviated in hours, minutes and seconds. For example, 12345 seconds: 3h 25m 45s. Format of local abbreviations can be defined at [[Module:{{ROOTPAGENAME}}/i18n]] in table "hms".
** <code>formatting=durationh:m:s</code> Shows duration hms simplified, as in 3:25:45, or minutes and seconds as in 01:23 or 45:00.
** <code>formatting=durationm:s</code> Shows duration in minutes and seconds, even if greater than 60 minutes (i.e. used in duration of songs).
* <code>formatting=raw</code> Shows the quantity without any language format, that is with decimal point and no thousand separators. It is the appropriate format for numerical calculations. See also the [[#Utility functions|function formatNum]] for applying the format to the final result according to language definitions.
* <code>formatting=''pattern''</code> Format using a pattern with $1 as a parameter to replace.
* <code>numformat=''%width.precision'flag'''</code> Formats according to [[mw:Extension:Scribunto/Lua reference manual#string.format|string.format specifiers]] for numbers, where width is the total width of the returned value, a point is the decimal separator, precision is the number of decimal places to show, and flag can be: f floating point, e scientific notation, i integer, o octal, h hexadecimal, E i H upper-case, among others. For example, for number 15.656: "%.1f" formats 15.7, "%05i" formats 00015, "%.2e" formats 1.57e+01.
* <code>convert=''Qid''</code> (optional) Convert the quantity to the unit requested by its Qid. Conversions are made according to factors indicated in Qid for properties {{P|P2370}} or {{P|P2442}}, except for temperatures defined with conversion formulas between ºC, ºF and ºK. For example, a value of "74 inch" with convert=Q174728 ({{Q|Q174728}}) gives "188 centimeters" according to the conversion "2.54 centimeter" indicated in {{Q|Q218593}}. It is rounded keeping the default precision of the original value according to the number of significant figures. It can be combined with formatting=unitcode. It can also be used with formatting=table, see below.
* <code>convert=default</code> (optional) Conversion of units defined in table convert_default at [[Module:{{ROOTPAGENAME}}/Units]].
* <code>convert=default2</code> (optional) Variant that shows two values: the converted quantity and the original quantity in brackets.
* <code>convert=M</code> Converts to millions, rounding with no decimals, if the quantity is greater than 100,000,000. Adds M before the unit name or code, for example Meuro, M$.

Data value monolingual (monolingualtext):
* <code>formatting=language</code> Returns the language code of a monolingual value, for example used in {{P|P1448}}.
* <code>formatting=text</code> Returns the text wrapped in a span with lang attribute, if it's different from the local language: <code><nowiki><span lang="xx">foreign text</span></nowiki></code>.
* <code>formatting=''pattern''</code> Format using a pattern with $language and $text as parameters to be replaced, for example "formatting=($language) $text".
* <code>list=lang</code> Shows the values corresponding to the defined language or the default language. See lang parameter above.
* <code>list=notlang</code> Does not show the values corresponding to the defined language or the default language. For example, it may be useful for {{P|P1559}} avoiding redundancy in wiki local language.

Data value coordinates (globecoordinate):
* <code>formatting=latitude</code> Returns the latitude in decimal format.
* <code>formatting=longitude</code> Returns the longitude in decimal format.
* <code>formatting=globe</code> (default) Returns the globe parameter recognized by [[:en:Template:Coord#globe:G|Template:Coord]]. It is requested for coordinates of globes other than Earth.
* <code>formatting=$lat...$lon...$globe</code> Format using a pattern with $lat, $lon and optionally $globe as parameters to be replaced.  It can include templates with non-expanded format, i.ex. {{tl|((}}coord<nowiki>{{!}}</nowiki>$lat<nowiki>{{!}}</nowiki>$lon{{tl|))}}.
* <code>formatting=dimension</code> Returns the dimension in meters equivalent to [[:en:Wikipedia:WikiProject Geographical coordinates#dim:D|dim parameter of GeoHack]].

Data value datetime (labeled time):
: By default it uses the format defined [[Module:{{ROOTPAGENAME}}/i18n]], in datetime table, depending on the precision. Optionally, for precision of day:
* <code>formatting= ''#time syntax''</code> Accepts any valid format of [[mw:Help:Extension:ParserFunctions#.23time|#time parser function]]. For example: formatting=d-m-Y ({{#time:d-m-Y}}), <nowiki>formatting=[[j xg]]</nowiki> ({{#time:[[j xg]]}}), <nowiki>formatting=Y</nowiki> ({{#time:Y}}).
: Adds the calendar when it may be ambiguous: if the date is before 1582-10-15 and it is set to Gregorian, or if it is later than 1582-10-04 and it is set to Julian. See [[:en:Adoption of the Gregorian calendar]] for further reading.

=== Parameters of table with property and qualifiers ===
{| class="wikitable" style="float:right;"
! !! property !! qualifier1 !! qualifier2 etc.
|-
! values 1st statement
| $0 || $1 || $2, etc.
|-
! 2nd, etc.
| $0 || $1 || $2, etc.
|}
<code>formatting=table</code> A statement with qualifiers is considered as a table of values shown at right. You can define the format of the rows and each column in the table. Separators for rows by default are line breaks (see separator and conjunction above). If you really want the output in a wikitable you can use separator=<nowiki></tr><tr></nowiki> and the corresponding opening and closing tags before and after the invoke. Specific parameters for this format:

Columns:
* <code>qualifier1 ... qualifier''x''=</code> Qualifiers with consecutive numbers without any limitation. General parameter <code>qualifier</code> is an alias for qualifier1.
** <code>qualifier''x'' = P''id1'' OR P''id2''</code> Alternatives values for a qualifier, without limitation of successive ORs. It takes the first one found. A typical example is {{P|P585}} OR {{P|P580}}.
** <code>qualifier''x'' = P''id1''/P''id2''</code> From the entity value of property P''id1'' it gets the parent value P''id2''. This allows to obtain additional data in the table even though defined in a parent element. For example, to get railway lines with its icon: qualifier=P81/P154. It can be combined with the OR option taking priority the OR.
** <code>qualifier''x'' = /P''id''</code> Equivalent to previous one but without P''id1'', it gets another property of same entity. This allows to obtain values defined either in a qualifier or in a property.
* <code>colformat0 ... colformat''x''=</code> Format to apply to each column, using 0 for the property and 1-x for every qualifier. It accepts  the same syntax as <code>formatting</code> for each data type. See above [[#Parameters for formatting]].
* <code>case0 ... case''x''=</code> Grammatical case to apply to each column. Parameter <code>case</code>, without numbering, applies to all values. See above [[#General parameters]].
* <code>convert0 ... convert''x''=</code> Conversion of units to apply to each column. See above [[#Parameters for formatting]], data type quantity.
* <code>whitelist0 ... whitelist''x''=</code> List raw values, usually Qids, in a column to show the statement, with any separator.
* <code>blacklist0 ... blacklist''x''=</code> List raw values, usually Qids, in a column to do not show the statement, with any separator.
*: Using several whitelist, or several blacklist, it works as an OR function. If a whitelist is used in a column and a blacklist in another column then results may be unexpected (see [https://ca.wikipedia.org/w/index.php?title=Tema:Ujnttzn0w9k1x0vq&topic_showPostId=ujsb7o283btc0pix#flow-post-ujsb7o283btc0pix an explanatory table, in Catalan]).
* <code>selectvalue1 ... selectvalue''x''=</code> List raw values, usually Qids, in a column to show its value.
* <code>ignorevalue1 ... ignorevalue''x''=</code> List raw values, usually Qids, in a column to do not show its value.

Rows:
* <code>rowformat=</code> Format of the rows of values for property and qualifiers. The property uses the placeholder $0 and the qualifiers $1 to $x. By default it is <code>rowformat=$0 ($1, ... $x)</code>. You can include list tags * or # and also templates or parser functions not expanded: {{tl|((}}template<nowiki>{{!}}</nowiki>unnamed parameter<nowiki>{{!}}</nowiki>name{{tl|1==}}named parameter{{tl|))}}. If used with parameter "references" (see [[#General parameters|above]]) you must include the placeholder $R0 for references.
* <code>rowsubformat1 ... rowsubformat''x''=</code> Previous format to apply to $1-$x defined in rowformat, only if there is any value. For example "rowformat=$0 $1" and "rowsubformat1=($1)" gives "$0 ($1)" or "$0" if $1 is void, avoiding empty parenthesis. A rowsubformat may have several variables $1-$x. Note that substitutions are made consecutively in numeric order, so it may include a posterior $x but not an anterior one as it has been already handled.
* <code>tablesort=</code> with values 0 to x, it sorts the table per property (0) or per qualifier (1 to x). Sorting is in ascending order alphabetically, numerically or by date. It accepts multiple sorting keys with any separator, i.e. <code>tablesort=0/2/1</code>. By default it sorts the property by rank (preferred, normal), and by order in Wikidata.
* <code>sorting=-1</code> sorts in descending order. With any other value, or by default, it sorts in ascending order. If tablesort is used with multiple keys, the sorting order is applied to all the keys.
* <code>list=false</code> shows only the first row of the table, according to the order indicated or by default.

== Function getLabel ==
Returns the label of an item.
* <code>1=</code> (first positional parameter, required) Wikitada id of the item (Qid or Pid). Alias: <code>item</code>, <code>from</code>.
* <code>lang=</code> (optional) Language code, as in function claim. See above [[#General parameters]].
* <code>itemgender=</code> (optional) Qid to determine the gender form to use for the label, as in function claim. See above [[#General parameters]].
* <code>linked=</code> (optional) With any value, except 'no', it returns the label linked either to sitelink page or to Wikidata.
* <code>label=</code> (optional) Shows this label instead of one fetched from Wikidata. It makes sense if used with linked=yes.
* <code>editicon=</code> (optional) allows to remove the pencil edit icon, as in function claim. See above [[#General parameters]].

== Function getParentValues ==
Returns recursively values of a property labeled with a parent value.
* <code>item=</code> (optional) Specifies an item (Qid) other than the associated to current page. Use it with moderation, as arbitrary access to Wikidata is expensive.
* <code>property=</code> (optional) Property id of the statement (Pid). By default it is {{P|131}}. Supports a list of alternative values with any separator.
* <code>label=</code> (optional) Parent property id to use as label. By default, it is {{P|31}}.
* <code>uptolabelid=</code> (optional) Last iteration to fetch, using Qid, if previously there is not any 'property' not found. It supports multiple values with any separator.
* <code>upto=</code> (optional) Quantity value of maximum number of iterations. By default it is 10 as a protection, large enough for common cases.
** upto=''label'' (deprecated): Alternative to <code>uptolabelid</code> using a label value, for example "upto=country".
* <code>uptovalueid=</code> (optional) Alternative to <code>uptolabelid</code> using Qid of values instead of labels. It supports multiple values with any separator. Alias uptolinkid provisionally for backwards compatibility.
* <code>showlabelid=</code> (optional) White list of label Qids to show, with any separator.
* <code>labelshow=</code> (deprecated) Alternative to <code>showlabelid</code> using label values with a slash as a separator.
* <code>include_self=true</code> (optional) Includes current page on the output list.
* <code>sorting=-1</code> (optional) Sorts the list of paired values in descending order.
* <code>last_only=true</code> (optional) Only shows the last value fetched. For example, with uptolinkid=Qid and last_only=true it will show the value corresponding to label Qid.
* <code>formatting=</code> (optional) Format for the property value. By default it is a piped link to local page or Wikidata (see above [[#Parameters for formatting|formatting]] for data value entity).
* <code>valuetext=</code> (optional) Property to use as link label with 'property' value as link target.
* <code>labelformat=</code> (optional) Format for the label. By default, it is "label" (see above [[#Parameters for formatting|formatting]] for data value entity).
* <code>rowformat=</code> (optional) Output format for each pair of values, with placeholder $0 for the label and $1 for the value. By default it is "rowformat=$0 = $1", for example "country = <nowiki>[[France]]</nowiki>"
* <code>separator=</code> (optional) Separator for each pair of label-value, by default <nowiki><br /></nowiki>.
* <code>cascade=true</code> (optional) Output with indentation. It may be useful if rowformat only uses $1.

Note: labels can be fixed for needs of an infobox in [[Module:{{ROOTPAGENAME}}/labels]]. For example, in Catalan "Municipi del Brasil" is modified to "Municipi" removing the determiner introduced by a preposition.

== Function linkWithParentLabel ==
Creates a link with the label of a parent property.

It accepts most parameters of [[#Function claim|function claim]], except "formatting" that uses the default "internallink". Additionally:
* <code>parent=</code> the parent property id to use as a link label. It accepts alternative values with any separator, as it does the parameter "property" of the function claim.

== Function yearsOld ==
Returns the age of a person calculating the completed years between birth date and death date or current date. If both dates do not have precision of day then it shows a range of years, maximum a decade.

The syntax is: <code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|yearsOld|formatting= |item= }}</nowiki></code>. Parameters <code>item</code> and <code>formatting</code> are optional. By default it shows the quantity.
* <code>formatting=unit</code> (optional) Gets the unit from table i18n["years-old"] at [[Module:{{ROOTPAGENAME}}/i18n]] for singular, plural or other plural forms as paucal used in Slavic languages as Russian. See parser function PLURAL at [[mw:Help:Magic words#Localization]].
* <code>formatting=''pattern''</code> (optional) Format using a pattern with $1 as a placeholder for the quantity. A common use case is " ($1 years old)". It does not evaluate the expression in singular, plural or paucal and fetches the unit from {{Q|Q24564698}}. As an alternative you can define a global pattern in table i18n["years-old"] that allows the parameter $1.

== Function editAtWikidata ==
Returns the pencil icon to edit a declaration on Wikidata.

Syntax: <code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|editAtWikidata|<value>|item= |property= |lang= |editicon= }}</nowiki></code>
* <code>1</code> (optional), first unnamed parameter. If it exists it will not show any icon. For example if a parameter is informed locally then it has not been fetched from Wikidata and the icon is not needed.
* <code>property=''Pid''</code> (required). Id of the property to link with anchor. It does not check the Pid, other anchors can be used, for example property=identifiers to link to the identifiers section.
* <code>item=''Qid''</code> (optional). Id of the item. It will not be necessary if it is the same as the associated page.
* <code>lang=''code''</code> (optional). Language code. Opening the link to Wikidata will display the page in this language. By default it uses the local wiki language for the main article space or the user language defined in the preferences for other namespaces.
* <code>editicon=<right/true></code> (optional). With value right it aligns to the right. Value true only makes sense if the wiki is set with ["addpencil"]=false at [[Module:{{ROOTPAGENAME}}/i18n]].
See above [[#General parameters]] for more reading about these parameters.

== Utility functions ==
* <code>getSiteLink</code> Returns the title of local page for a given item. Syntax:
*: <code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|getSiteLink|<Qid>|<wiki>}}</nowiki></code>
*: Without any parameter it returns the current page. With a Qid it returns the local page linked in the Qid item. It returns a void string if there is no local page linked. A second parameter with the wiki code it return the page linked for this wiki (enwiki, frwiki,... cawiktionary, etc.)

* <code>lang</code> Returns the language code as managed by function claim. See [[#General parameters]] above. Syntax:
*: <code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|lang|{{{lang|}}}}}</nowiki></code>
*: Parameter lang is optional.

* <code>numStatements</code> Returns the number of statements of a multi-value property considering only best ranked values. It allows the decide how to handle long lists. With a second unnamed parameter it counts the number of values of a qualifier. Syntax:
*: <code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|numStatements|<Pid>|item={{{item|}}} }}</nowiki></code>
*: <code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|numStatements|<Pid>|<Qual_id>|item={{{item|}}} }}</nowiki></code>
*: Example: <nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|numStatements|P47|item=Q1861}}</nowiki> → {{#invoke:{{ROOTPAGENAME}}|numStatements|P47|item=Q1861}}
*: For more complex queries, for example with list=true for preferred and normal ranking or with filters as whitelist, it can be used with the same syntax as [[#Function claim|function claim]], without positional parameters.

* <code>validProperty</code> Returns "void" if the property is not found, or it has only statements with values "no value" or "some value" or with deprecated rank. Syntax:
*: <code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|validProperty|<Pid>|item={{{item|}}}</nowiki></code>
*: It can be used as an alternative to #property. It accepts the same parameter used by this parser function: <code>from</code> is an alias for <code>item</code>.

* <code>formatNum</code> Formats a quantity according to language definitions. It is equivalent to magic word [[mw:Help:Magic words#Formatting|formatnum]] with the option to specify a language other than the wiki default. Syntax:
*: <code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>|formatNum|<num>|<lang>}}</nowiki></code>
*: First requested parameter is the number to format. The second optional parameter is the language code (see parameter lang of [[#General parameters|function claim]]).

* <code><s>getTAValue</s></code> Old function retrieving values of {{P|P1323}}. Removed and replaced with a simple call <nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P1323 | formatting=externalid | separator=<br />}}</nowiki>.

* For debugging functions see [[Module:{{ROOTPAGENAME}}/debug]].

== Wikidata redirects ==
A Wikidata element can be redirected to another element, often as a result of a merge. The values of a property can be provisionally a redirect, usually fixed by bot after a week.

When fetching data, it follows redirects: values fetched correspond to the target element of a redirect. If a Qid is used raw, not for fetching its data but for comparison purposes as in a filter, then a Qid redirected may provoke unexpected results. This may affect function claim with parameters whitelist, blacklist, selectvalue or ignorevalue, and function getParentValues with parameters uptolabelid, uptovalueid, showlabelid.

You can validate Qids included in a template, or other page. Use <code><nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki>/debug|validateIds|<page>}}</nowiki></code> with the page title to check. For every Qid included in the page it shows: [[File:Symbol OK.svg|13px|link=|Ok]] (ok), [[File:Red x.svg|13px|link=|Nay]] (not found) or[[File:Redirectltr.png|40px|link=|#REDIRECT]](redirect). This function is expensive and for a long list it may raise an error for not enough Lua memory.

== Using from another module ==
All functions (claim, getLabel, getParentValues, linkWithParentLabel, yearsOld, lang) can be used from other modules via <code>require</code> with the same parameters provided in a table, for example:
: <nowiki>require("Module:</nowiki>{{ROOTPAGENAME}}<nowiki>").claim{item="Q...", property="P...", ...}</nowiki>
: <nowiki>require("Module:</nowiki>{{ROOTPAGENAME}}<nowiki>").getLabel({"Q...", ['lang']="en"})</nowiki>
Function claim can return a second value depending of parameter query that may be used on infobox modules for specific treatment. With query=untranslated it returns nil or true for values not translated in requested language. With query=num it returns the number of statements as [[#Utility functions|function numStatements]] does.

Parameters that accept "true" or "false" values can be defined as boolean type.

== Dependencies ==
* Subpages relative to the main module.
** [[Module:{{ROOTPAGENAME}}/i18n|../i18n]] (optional): translations of messages and local formats. If <code>lang</code> has a value other than local language then it searches the corresponding subpage, for example [[Module:{{ROOTPAGENAME}}/i18n/eu|../i18n/eu]]. If it does not exist then defaults to English.
** [[Module:{{ROOTPAGENAME}}/Units|../Units]] (optional): definition of plurals and codes for units. If it does not exist or the unit is not found then it uses the unit name.
** [[Module:{{ROOTPAGENAME}}/labels|../labels]] (optional): exceptions and fixes of labels for an infobox.
** [[Module:{{ROOTPAGENAME}}/debug|../debug]]: may appear occasionally for the track function.
* Mediawiki messages used in requested or default language:
** [[Mediawiki:Comma-separator]], [[Mediawiki:And]], [[Mediawiki:Word-separator]]
** [[Mediawiki:Wikibase-snakview-snaktypeselector-novalue]], [[Mediawiki:Wikibase-snakview-snaktypeselector-somevalue]]
** [[Mediawiki:Wikibase-time-calendar-gregorian]], [[Mediawiki:Wikibase-time-calendar-julian]]
** [[Mediawiki:Translate-taction-translate]]
** [[Mediawiki:Wikibase-client-data-bridge-bailout-suggestion-go-to-repo-button]]
** [[MediaWiki:Sandboxlink-subpage-name]]
*: If necessary, they can be created in [[m:translatewiki.net|Translatewiki]]. If you have an account in Translatewiki, you can access directly to it activating the following link with the title of the message and the language code: <code><nowiki>[[translatewiki:MediaWiki:</nowiki>''<message>''/''<lang>'']]</code>.

</div>
== أمثلة استعمال ==
الأمثلة أدناه هي عينات تستعمل بيانات لمقالات مقابلة.

*مثال بسيط:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim |property=P20}}</nowiki> <br>
في مقالة [[جان فرانسوا شامبليون]] تعطينا : {{#invoke:{{ROOTPAGENAME}} | claim |property=P20|item=Q260|showerrors=sip|editicon=false}}
:وهي قراءة لل{{خاصية|P20}} من ويكي بيانات.

*قراءة بلا روابط:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P20 | formatting=label}}</nowiki> <br>
تعطينا: {{#invoke:{{ROOTPAGENAME}} | claim | property=P20 | formatting=label|item=Q260|showerrors=sip|editicon=false}}

*قيمة معروفة:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P20 | value={{{مكان_الوفاة|}}} }}</nowiki> <br>
في قوالب المعلومات
:ستعرض قيمة <nowiki>{{{مكان_الوفاة|}}}</nowiki> إذا عرفت في المقالة، وإلا فإن النتيجة ستكون قراءة من ويكي بيانات : [[باريس]]

*قيمة بتنسيق تاريخ:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P569}}</nowiki> <br>
تعطينا تاريخ الميلاد بتنسيق التواريخ الافتراضي:
: {{#invoke:{{ROOTPAGENAME}} | claim | property=P569|item=Q260|showerrors=sip|editicon=false}}

* التنسيق وفق نمط معين:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P214 | formatting=[http://viaf.org/viaf/$1 $1]}}</nowiki> <br>
تعطينا:
:{{#invoke:{{ROOTPAGENAME}} | claim | property=P214 | formatting=[http://viaf.org/viaf/$1 $1]|item=Q260|showerrors=sip|editicon=false}}

*قيمة واحدة:
{{#invoke:{{ROOTPAGENAME}} | claim | property=P18 | list=false | formatting=[[ملف:$1|thumb|upright=.5|صورة توضيحية]]|item=Q260|editicon=false}}
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P18 | list=false | formatting=[[ملف:$1|thumb|upright=.5|صورة توضيحية]]}}</nowiki>
:يعرض أول قيمة (في هذه الحالة صورة) من القيمة المعرفة.

*تنسيق رابط خارجي:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P856 | formatting=weblink}}</nowiki> <br>
في مقالة [[برلين]] تعطينا:
:{{#invoke:{{ROOTPAGENAME}} | claim | property=P856 | formatting=weblink| item=Q64|showerrors=sip|editicon=false}}

*استعمال قالب في النتيجة:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | item=Q425440 | property=P267 | formatting={{((}}color{{!}}green{{!}}$1{{))}} }}</nowiki>، <br>
تستعمل {{قا|color}}, تعطينا:
: {{#invoke:{{ROOTPAGENAME}} | claim | item=Q425440 | property=P267|editicon=false | formatting={{((}}color{{!}}green{{!}}$1{{))}} }}

*قائمة قيم:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P47}}</nowiki> <br>
في مقالة [[بايي دو لا لوار]] تعطينا:
: {{#invoke:{{ROOTPAGENAME}} | claim | property=P47 | item=Q16994 |editicon=false|showerrors=sip}}
:لاحظ رابط <nowiki>[[بروتاني (منطقة إدارية)]] يظهر [[بروتاني]]</nowiki>

*قائمة منسقة:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P150 | separator=<br /> | conjunction=<br />}}</nowiki> <br>
تعطينا
: {{#invoke:{{ROOTPAGENAME}} | claim | property=P150 | separator=<br /> | conjunction=<br /> | item=Q746061 |editicon=false|showerrors=sip}}

*إحداثيات جغرافية:
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P625 | formatting=latitude}}</nowiki> تعطينا: {{#invoke:{{ROOTPAGENAME}} | claim | property=P625 | formatting=latitude | item=Q746061 |showerrors=sip|editicon=false}}
:<nowiki>{{#invoke:</nowiki>{{ROOTPAGENAME}}<nowiki> | claim | property=P625 | formatting=longitude}}</nowiki> تعطينا: {{#invoke:{{ROOTPAGENAME}} | claim | property=P625 | formatting=longitude | item=Q746061 |showerrors=sip|editicon=false}}

== طالع أيضا ==
* [[mw:Extension:Wikibase Client/Lua|Wikibase Lua functions]] : هي الدوال الأساسية التي يمكن العثور عليها في  [[Module:Wikibase]].