Module:Wd/doc
This is the documentation page for Module:Wd
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This Lua module is used on approximately 1,130,000 pages, or roughly 478% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
You might want to use one of the user-friendly wrapper templates {{Wikidata}} and {{WikidataOI}} instead of invoking this module directly. |
Related pages |
---|
This module is rated as alpha. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
This module is intended to fetch data from Wikidata with or without a link to the connected Wikipedia article.
The module is under development and is not yet complete. Of the available datatypes, it currently supports strings, quantities, monolingual text, time and globe coordinates.
Usage
edit{{#invoke:wd|function|flag1|flag2|flag3|arg1|arg2|arg3}}
Functions
editproperty
Returns the requested property or list of properties from the given item.qualifier
Returns the requested qualifier or list of qualifiers from the given property of the given item.propertyWithQualifier
Returns the requested property and its requested qualifier or a list thereof from the given item, with the qualifier formatted between parentheses behind the property and with units of measurement if applicable.label
Returns the label of the given item or property. In case of an item that has no label, the title of the linked page will be returned instead if it exists.title
Returns the title of the page linked to the given item if it exists. Any label of the item will never be returned instead.main
Intended for use by wrapper templates (around this module) to invoke one of the above functions, returning their respective output.
Parameters
editFlags
editlinked
Creates a link to the Wikipedia article that is connected to the property or qualifier if it exists. Also links units of measurement that may be appended to values.
If this parameter is omitted, then the plain property or qualifier value will be returned.short
(EXPENSIVE
when used)
Gets the short name (P1813) of any item returned if they have one attached. If that is not the case, then the default behaviour of returning the item label will occur.single
Returns only a single value instead of multiple (if multiple claims match). The returned value is the first match found from the best-ranked claims.mdy
Returns date values in month_day_year order instead of day_month_year order.- One of:
best
(default)preferred
normal
deprecated
Sets a rank constraint for the selected claims.
The latter three can be followed by a+
or a-
, e.g.normal+
orpreferred-
, where the first selects claims with a 'normal' rank or higher and the second selects claims with a 'preferred' rank or lower. To get claims of all ranks, usepreferred-
ordeprecated+
.
Output is always sorted from highest rank to lowest (regardless of this flag being set). - One of:
future
current
former
Sets a time constraint for the selected claims. Uses the claims' qualifiers of start time (P580) and end time (P582) to determine if the claim is valid for the selected time period. raw
Returns the raw value if applicable.
If this flag is used with item or property datatypes, then this will return the Q-identifier or P-identifier.
For quantity datatypes, this flag will strip off any units of measurement.
If this flag is used with time datatypes, then the returned date will be in the format ofyear-month-day
(e.g.1731-2-11
). Dates in the Julian calendar stored with a precision of days through millenniums will have/Julian
attached to the output (e.g.1731-2-11/Julian
, which may be split off using the{{#titleparts}}
template function).
If it is used with globe coordinate datatypes, then it replaces the various symbols with forward slashes in the returned value (e.g.52/5/3/N/4/19/3/E
, which may be split into parts using the{{#titleparts}}
template function).
Arguments
editproperty
editproperty | [<flags>] | [<item_id>] | <property_id>
<flags>
(optional)
A list of flags (see above).<item_id>
(optional,EXPENSIVE
when used)
Q-identifier of the item to be accessed (e.g. Q55).
If this parameter is omitted, then the item connected to the current page will be used.<property_id>
P-identifier or an available alias of the property to be accessed (e.g. P38).
qualifier
editqualifier | [<flags>] | [<item_id>] | <property_id> | [<claim_id_or_value>] | <qualifier_id>
<flags>
(optional)
A list of flags (see above).<item_id>
(optional,EXPENSIVE
when used)
Q-identifier of the item to be accessed (e.g. Q55).
If this parameter is omitted, then the item connected to the current page will be used.<property_id>
P-identifier or an available alias of the property to be accessed (e.g. P38).<claim_id_or_value>
(optional)
Either the Q-identifier of the particular claim to be accessed (e.g. Q6655) or a literal value (i.e. string or quantity etc., no item label) equal to the claim to be accessed.
Dates as literal values must be formattedyear-month-day
(e.g.1731-2-11
) for dates with a precision of days,year-month
(e.g.1731-2
) for dates with a precision of months, andyear
(e.g.1731
) for dates of lesser precision without any spaces or leading zeros. Dates BCE require a minus sign in front of the year (e.g.-2950-1-31
). Dates stored in the Julian calendar must have/Julian
attached to the end (e.g.1731-2-11/Julian
). Decades like the 2010s must be given as2010
(but the 2010s BCE as-2019
), centuries like the 20th century as1901
(but the 20th century BCE as-2000
), and millenniums like the 3rd millennium as2001
(but the 3rd millennium BCE as-3000
).
Globe coordinates as literal values must be formatted with forward slashes (i.e./
) between the parts and no symbols (e.g.52/5/3/N/4/19/3/E
) without any spaces or leading zeros.
The special type 'no value' can be given by entering the empty string (i.e.||
) and the special type 'unknown value' can be given by entering a space (i.e.|␣|
).
If this parameter is omitted, then all claims (matching any other constraints) within the property will be accessed.<qualifier_id>
P-identifier or an available alias of the qualifier to be accessed (e.g. P518).
propertyWithQualifier
editpropertyWithQualifier | [<flags>] | [<item_id>] | <property_id> | [<claim_id_or_value>] | <qualifier_id>
This function is equivalent to qualifier
, except that the property is also returned with the qualifier between parentheses behind it.
label
editlabel | [<flags>] | [<item_or_property_id>]
<flags>
(optional)
A list of flags (see above).<item_or_property_id>
(optional)
Q-identifier of the item (e.g. Q55) or P-identifier (or an available alias) of the property (e.g. P38) to be accessed.
If this parameter is omitted, then the item connected to the current page will be used.
title
edittitle | [<flags>] | [<item_id>]
<flags>
(optional)
A list of flags (see above).<item_id>
(optional)
Q-identifier of the item to be accessed (e.g. Q55).
If this parameter is omitted, then the item connected to the current page will be used.
main
main | <function> | [<parameters>]
<function>
The name of one of the above functions.<parameters>
(optional)
A list of flags and arguments applicable to the chosen function.
Named properties
editNamed properties are aliases for P-identifiers. The following named properties (which are case-sensitive) are currently available:
Alias | translates to |
P-identifier |
---|---|---|
coord | → | P625 |
startTime | → | P580 |
endTime | → | P582 |
shortName | → | P1813 |
Examples
editproperty
edit{{#invoke:wd|property|Q55|P395}}
→ NL
- Q55 (Netherlands), P1549 (demonym): [monolingual text]
{{#invoke:wd|property|Q55|P1549}}
→ Dutch
If the module is transcluded on the page (which is linked to Q55), then the Q55
can be omitted:
- P1549 (demonym): [monolingual text]
{{#invoke:wd|property|P1549}}
→ Dutch
property with rank
edit- Q55 (Netherlands), P38 (currency): [item label]
- best rank (default)
{{#invoke:wd|property|Q55|P38}}
→ Euro{{#invoke:wd|property|raw|Q55|P38}}
→ Q4916{{#invoke:wd|property|raw|linked|Q55|P38}}
→ Q4916{{#invoke:wd|property|best|Q55|P38}}
→ Euro{{#invoke:wd|property|best|linked|Q55|P38}}
→ Euro
- other ranks
{{#invoke:wd|property|preferred|Q55|P38}}
→ Euro{{#invoke:wd|property|preferred-|linked|Q55|P38}}
→ Euro
{{#invoke:wd|property|normal+|Q55|P38}}
→ Euro{{#invoke:wd|property|normal|Q55|P38}}
→ Dutch guilder
property with time constraint
edit- Q55 (Netherlands), P38 (currency): [item label]
{{#invoke:wd|property|normal+|current|Q55|P38}}
→ Euro{{#invoke:wd|property|normal+|former|Q55|P38}}
→ Dutch guilder
property with short name
edit- Q55 (Netherlands), P38 (currency): [item label]
{{#invoke:wd|property|normal|current|short|Q55|P38}}
→ US dollar{{#invoke:wd|property|normal|current|short|linked|Q55|P38}}
→ US dollar
property with return of quantity
edit- Q55 (Netherlands), P2884 (mains voltage): [quantity]
{{#invoke:wd|property|Q55|P2884}}
→ 230 volt{{#invoke:wd|property|linked|Q55|P2884}}
→ 230 volt{{#invoke:wd|property|raw|Q55|P2884}}
→ 230
property with return of globe coordinate
edit- Q55 (Netherlands), P625 (coordinate location): [globe coordinate]
{{#invoke:wd|property|Q55|P625}}
→ 52°19'N, 5°33'E{{#invoke:wd|property|linked|Q55|P625}}
→ 52°19'N, 5°33'E{{#invoke:wd|property|raw|Q55|P625}}
→ 52/19/N/5/33/E
A named property (or alias) can be used instead of the P-identifier:
- Q55 (Netherlands), "coord" (→ P625, coordinate location): [globe coordinate]
{{#invoke:wd|property|Q55|coord}}
→ 52°19'N, 5°33'E
property with return of single value
edit- Q55 (Netherlands), P150 (contains the administrative territorial entity): [item label]
{{#invoke:wd|property|Q55|P150}}
→ Groningen{{#invoke:wd|property|single|Q55|P150}}
→ Groningen
qualifier
edit- Q55 (Netherlands), P1343 (described by source), Q302556 (Catholic Encyclopedia), P958 (section, verse, paragraph, or clause): [string]
{{#invoke:wd|qualifier|Q55|P1343|Q302556|P958}}
→
If the module is transcluded on the page (which is linked to Q55), then the Q55
can be omitted:
- P1343 (described by source), Q302556 (Catholic Encyclopedia), P958 (section, verse, paragraph, or clause): [string]
{{#invoke:wd|qualifier|P1343|Q302556|P958}}
→
qualifier with rank
edit- Q55 (Netherlands), P38 (currency), P518 (applies to part): [item label]
- best rank (default)
{{#invoke:wd|qualifier|Q55|P38|P518}}
→ European Netherlands{{#invoke:wd|qualifier|raw|Q55|P38|P518}}
→ Q2118709{{#invoke:wd|qualifier|raw|linked|Q55|P38|P518}}
→ Q2118709{{#invoke:wd|qualifier|best|Q55|P38|P518}}
→ European Netherlands{{#invoke:wd|qualifier|best|linked|Q55|P38|P518}}
→ European Netherlands
- other ranks
{{#invoke:wd|qualifier|preferred|Q55|P38|P518}}
→ European Netherlands{{#invoke:wd|qualifier|preferred-|linked|Q55|P38|P518}}
→ European Netherlands; Caribbean Netherlands
{{#invoke:wd|qualifier|normal+|Q55|P38|P518}}
→ European Netherlands; Caribbean Netherlands{{#invoke:wd|qualifier|normal|Q55|P38|P518}}
→ Caribbean Netherlands
qualifier with time constraint
edit- Q55 (Netherlands), P38 (currency), P518 (applies to part): [item label]
{{#invoke:wd|qualifier|normal+|current|Q55|P38|P518}}
→ European Netherlands; Caribbean Netherlands{{#invoke:wd|qualifier|normal+|former|Q55|P38|P518}}
→
qualifier with claim ID
edit- Q55 (Netherlands), P38 (currency), Q4917 (United States dollar), P518 (applies to part): [item label]
{{#invoke:wd|qualifier|Q55|P38|Q4917|P518}}
→ Caribbean Netherlands{{#invoke:wd|qualifier|linked|Q55|P38|Q4917|P518}}
→ Caribbean Netherlands
qualifier with literal value
edit- Q55 (Netherlands), P2884 (mains voltage), 230 volt, P2144 (frequency): [quantity]
{{#invoke:wd|qualifier|Q55|P2884|230|P2144}}
→ 50 hertz{{#invoke:wd|qualifier|linked|Q55|P2884|230|P2144}}
→ 50 hertz{{#invoke:wd|qualifier|raw|Q55|P2884|230|P2144}}
→ 50
qualifier with return of time
edit{{#invoke:wd|qualifier|Q55|P463|Q458|P580}}
→{{#invoke:wd|qualifier|mdy|Q55|P463|Q458|P580}}
→{{#invoke:wd|qualifier|raw|Q55|P463|Q458|P580}}
→
qualifier with return of single value
edit- Q55 (Netherlands), P2855 (VAT rate), P518 (applies to part): [item label]
{{#invoke:wd|qualifier|Q55|P2855|P518}}
→ food{{#invoke:wd|qualifier|single|Q55|P2855|P518}}
→ food
propertyWithQualifier
edit- Q55 (Netherlands), P2884 (mains voltage), P2144 (frequency): [quantity]
{{#invoke:wd|propertyWithQualifier|Q55|P2884|P2144}}
→ Script error: The function "propertyWithQualifier" does not exist.{{#invoke:wd|propertyWithQualifier|linked|Q55|P2884|P2144}}
→ Script error: The function "propertyWithQualifier" does not exist.{{#invoke:wd|propertyWithQualifier|raw|Q55|P2884|P2144}}
→ Script error: The function "propertyWithQualifier" does not exist.
- Q55 (Netherlands), P38 (currency), P518 (applies to part): [item label]
{{#invoke:wd|propertyWithQualifier|normal+|current|Q55|P38|P518}}
→ Script error: The function "propertyWithQualifier" does not exist.{{#invoke:wd|propertyWithQualifier|normal+|current|short|linked|Q55|P38|P518}}
→ Script error: The function "propertyWithQualifier" does not exist.
If the module is transcluded on the page (which is linked to Q55), then the Q55
can be omitted:
- P38 (currency), P518 (applies to part): [item label]
{{#invoke:wd|propertyWithQualifier|normal+|current|P38|P518}}
→ Script error: The function "propertyWithQualifier" does not exist.
label
edit{{#invoke:wd|label|Q4917}}
→ United States dollar
{{#invoke:wd|label|linked|Q4917}}
→ United States dollar
{{#invoke:wd|label|short|Q4917}}
→ US dollar
{{#invoke:wd|label|short|linked|Q4917}}
→ US dollar
{{#invoke:wd|label|raw|Q4917}}
→ Q4917
{{#invoke:wd|label|raw|linked|Q4917}}
→ Q4917
{{#invoke:wd|label|P38}}
→ currency
{{#invoke:wd|label|linked|P38}}
→ currency
{{#invoke:wd|label|raw|P38}}
→ P38
{{#invoke:wd|label|raw|linked|P38}}
→ P38
{{#invoke:wd|label|Q776}}
→ Utrecht{{#invoke:wd|label|linked|Q776}}
→ Utrecht
If the module is transcluded on the page (which is linked to Q776), then the Q776
can be omitted:
{{#invoke:wd|label}}
→ Utrecht
title
edit{{#invoke:wd|title|Q776}}
→{{#invoke:wd|title|linked|Q776}}
→{{#invoke:wd|title|raw|Q776}}
→{{#invoke:wd|title|raw|linked|Q776}}
→
If the module is transcluded on the page (which is linked to Q776), then the Q776
can be omitted:
{{#invoke:wd|title}}
→
See also
edit- {{Wikidata}}, a user-friendly wrapper template for this module.