![]() | This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
![]() | 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,810,000 pages, or roughly 3% 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. |
This module is intended to fetch data from Wikidata with or without a link to the connected Wikipedia article and with many other features.
Usage
Note: Do not use this template or Module:Wd in infobox templates, per the 2018 RFC. Instead, use Module:WikidataIB.
The general structure of a call to this module is as follows. Note that the basic structure consists of positional commands, flags and arguments, which all have a fixed position.
{{#invoke:wd|command1|flag1a|flag1b|flag1c|command2|flag2a|flag2b|flag2c|flag0a|flag0b|flag0c|arg1|arg2|arg3}}
Use different commands to get different kinds of values from Wikidata. At least one command must be given and multiple commands can be combined into one call as shown above (in any order, more than two is also possible), but this only applies to commands from the claim class; calls containing a command from the general class cannot contain any other command. Each command can be followed by any number of command flags, which are optional and can be used to tweak the output generated by that command.
The commands and their flags may be followed by any number of configuration flags, which are also optional and affect the selection of data and the module's behaviour in general. The call is closed with the positional arguments, which may be required depending on the given command(s). Some named arguments (i.e. name-value pairs) also exist, as well as a set of named flags for advanced usage that can be used to change the way the fetched values are merged together into the output.
This module was designed to provide the basic needs for fetching data from Wikidata, but a lot can be achieved through different combinations of calls. For convenience, such combinations could be wrapped into new templates that serve a specific need. See also the section on common use cases below for some examples of useful "building blocks". Likewise, the functionality of this module can be extended by creating wrapper templates that use the main
command provided by this module (just like {{WikidataOI}} does).
Common use cases
Below follows a list of common use cases. In the future, shortcut commands may be implemented that are equivalent to these calls for convenience.
Call | Use case |
---|---|
{{#invoke:wd|label|raw}}
|
Returns the Q-identifier of the Wikidata item connected to the current page (e.g. "Q55"). |
{{#if:
|
Performs a check to determine if the current page has a Wikidata item.
Note that this statement relies on a returned value that is either empty or non-empty and that the |
Commands
The commands (command1
, command2
, ...) determine what kind of values are returned. One call can only contain commands from a single class.
Claim class
The claim class commands can be combined, meaning that multiple commands of different types from this class can be given at one time (see above for usage).
Combine multiple commands into one call to this module, instead of making multiple calls to this module with one command each, to be sure that all the returned pieces of information belong to each other (see also the examples below).
Type | Command | Returns | Basic usage | Description |
---|---|---|---|---|
I | property
|
first match[a] | {{#invoke:wd|property|P1}}
|
Returns the requested property – or list of properties – from the current item-entity or from a given entity.
This command can be given only once in one call. |
properties
|
all matches | {{#invoke:wd|properties|P1}}
| ||
II | qualifier
|
first match[b] | {{#invoke:wd|qualifier|P1|P2}}
|
Returns the requested qualifier – or list of qualifiers – from the given property of the current item-entity or of a given entity.
Unlike the other claim class commands, this command can be given multiple times to retrieve different qualifiers in one call. |
qualifiers
|
all matches | {{#invoke:wd|qualifiers|P1|P2}}
| ||
III | reference
|
first match[b] | {{#invoke:wd|reference|P1}}
|
Returns a reference – or list of references – from the given property of the current item-entity or of a given entity.[c]
This command can be given only once in one call. |
references
|
all matches | {{#invoke:wd|references|P1}}
| ||
|
General class
The general class commands cannot be combined.
Type | Command | Returns | Basic usage | Description |
---|---|---|---|---|
I | label
|
{{#invoke:wd|label}}
|
Returns the label of the current item-entity or of a given entity if present. | |
II | title
|
{{#invoke:wd|title}}
|
Returns the title of the page connected to the current item-entity or to a given item-entity if such page exists. | |
III | description
|
{{#invoke:wd|description}}
|
Returns the description of the current item-entity or of a given entity if present. | |
IV | alias
|
first match[a] | {{#invoke:wd|alias}}
|
Returns an alias – or list of aliases – of the current item-entity or of a given entity if present. |
aliases
|
all matches | {{#invoke:wd|aliases}}
| ||
V | badge
|
first match[a] | {{#invoke:wd|badge}}
|
Returns a badge – or list of badges – for the page connected to the current item-entity or to a given item-entity if such page exists. |
badges
|
all matches | {{#invoke:wd|badges}}
| ||
Flags
The following (optional) flags are available which can be used to alter this module's behaviour. They must be given after the (first) command and before the positional arguments. For convenience, empty flags (i.e. ||
) are allowed and will simply be ignored.
Command flags
These flags (flag1*
, flag2*
, ...) apply to the command that precedes them directly.
Flag | Description |
---|---|
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 instead of the regular label. For quantity datatypes, this flag will strip off any units of measurement, unless the If this flag is used with time datatypes, then the returned date will be in the format of If it is used with globe coordinate datatypes, then it replaces the various symbols with forward slashes in the returned value (e.g. |
linked
|
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] Returns the short name (P1813) of any entity returned if they have one attached. If that is not the case, then the default behaviour of returning the entity's label will occur.
|
multilanguage
|
Returns monolingual text values in any available language, not just the current wiki's language. |
unit
|
Returns only the unit of measurement for quantity datatypes. |
Configuration flags
These flags (flag0*
) are general configuration flags and can be given anywhere after the first command (but before the positional arguments).
Flag | Description | Command class | |
---|---|---|---|
Combination of: | preferred
|
Sets a rank constraint for the selected claim(s).
The first three set the ranks for which claim(s) will be selected. They can optionally be followed by a If the The default is Output is always sorted from highest rank to lowest (regardless of any of these flags being set). |
claim |
normal
| |||
deprecated
| |||
best
| |||
Combination of: | future
|
Sets a time constraint for the selected claim(s). Uses the claims' qualifiers of start time (P580) and end time (P582) to determine if the claim is valid for the selected time period(s).
The default is |
claim |
current
| |||
former
| |||
mdy
|
Returns date values in month-day-year order instead of day-month-year order. | claim | |
single
|
Returns only a single claim instead of multiple (if multiple claims match). Has no effect if the property /properties command is given, in which case this flag would be redundant.
|
claim | |
sourced
|
Only returns claims that have at least one non-empty reference. (References having only ignored parameters are considered empty.) | claim | |
One of: | edit
|
Adds a clickable icon after the output that may be used by readers to edit the returned claim on Wikidata.
If |
claim, general |
edit@end
|
Arguments
The arguments determine the sources from which all the returned values are fetched.
Positional arguments
The following table shows the available positional arguments (arg*
) in their fixed order. For each command, the applicable set of arguments is marked. If multiple commands are given, then the applicable set is the union of the individual sets. For instance, if the commands properties
and qualifiers
have been given, then at least both the arguments property_id
and qualifier_id
should be given as well.
More than one qualifier
/qualifiers
command can be given. The order in which these commands with their flags are given matches the order in which the respective qualifier_id
arguments are given.
(required) | (optional) | (optional) | (required) | (optional) | (required) | (required) | |||
{{#invoke:wd
|
commands
|
flags
|
entity_id
|
property_id
|
raw_value
|
qualifier_id
|
qualifier_id
|
}}
| |
---|---|---|---|---|---|---|---|---|---|
label , title ,description ,alias /aliases ,badge /badges
|
|||||||||
property /properties
|
|||||||||
reference /references
|
|||||||||
qualifier /qualifiers
|
|||||||||
qualifier /qualifiers (optional 2nd, 3rd, etc.)
| |||||||||
Below follows a description of all positional arguments.
Argument | Description |
---|---|
entity_id
(optional) |
[EXPENSIVE] Q-identifier of the item-entity to be accessed (e.g. Q55 ), P-identifier (or an available alias) of the property-entity to be accessed preceded by the Property: prefix (e.g. Property:P38 ), or page title of the Wikipedia article whose connected item-entity is to be accessed preceded by : , a prefixed colon (e.g. :Netherlands ).
In case of the general class commands, the If this parameter is omitted, then the item-entity connected to the current page will be used (except when |
property_id
|
P-identifier (or an available alias) of the property within the entity to be accessed, without the Property: prefix (e.g. P35 ).
|
raw_value
(optional) |
Either the Q-identifier equal to the property value (e.g. Q29574 ) or a literal value (i.e. string or quantity etc., no entity label) equal to the raw property value of the particular claim to be accessed.
Dates as literal values must be formatted Globe coordinates as literal values must be formatted with forward slashes (i.e. The special type 'no value' can be given by entering the empty string (i.e. To get a literal vertical bar 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 within the entity to be accessed, without the Property: prefix (e.g. P580 ).
|
Named arguments
Below follows a description of all named arguments, which are name-value pairs (i.e. |name=value
). These are all optional and can be given anywhere after the first command.
Argument | Description | Command class |
---|---|---|
eid=
|
[EXPENSIVE] This argument can be used to give the Q-identifier (e.g. |eid=Q55 ) or P-identifier (or an available alias) of the entity to be accessed. It offers the same functionality as the positional argument entity_id , with one difference: if the argument is given but its value is left empty (i.e. |eid= ), then no entity is accessed at all instead of the item-entity connected to the current page. This is useful in some cases where a variable entity-ID is expected, but where the item-entity connected to the current page should not be accessed as the default.
Also, the This argument only has effect if the positional argument |
claim, general |
page=
|
[EXPENSIVE] This argument can be used to give the page title (e.g. |page=Netherlands ) of the Wikipedia article whose connected item-entity is to be accessed. It behaves similar to the named argument eid= and can be used instead of the positional argument entity_id (note that no prefixed colon, : , is required). If the argument is given but its value is left empty (i.e. |page= ), then no entity is accessed at all instead of the item-entity connected to the current page.
This argument only has effect if the positional argument |
claim, general |
date=
|
This argument can be used to set a particular date (e.g. |date=1731-02-11 ) relative to which claim matching using the future , current and former flags is done, instead of relative to today. It overrides the default of these flags to current so that by default only claims that were valid at the given date are returned (based on the claims' qualifiers of start time (P580) and end time (P582)).
The date value must be formatted |
claim |
<qualifier>=
|
The <qualifier> is a placeholder for a set of arguments that determine which claims should be accessed based on qualifier value, analogous to the pair of positional arguments property_id and raw_value (that determine access based on property value).
As such, Example: Multiple arguments of this type can be given to match multiple qualifier values simultaneously for each claim. |
claim |
Property aliases
Property aliases are other names for P-identifiers that can be used instead. The following property aliases (which are case-sensitive) are currently available:
Alias | translates to |
P-identifier |
---|---|---|
coord | → | P625 |
image | → | P18 |
author | → | P50 |
authorNameString | → | P2093 |
publisher | → | P123 |
importedFrom | → | P143 |
wikimediaImportURL | → | P4656 |
statedIn | → | P248 |
pages | → | P304 |
language | → | P407 |
hasPart | → | P527 |
publicationDate | → | P577 |
startTime | → | P580 |
endTime | → | P582 |
chapter | → | P792 |
retrieved | → | P813 |
referenceURL | → | P854 |
sectionVerseOrParagraph | → | P958 |
archiveURL | → | P1065 |
title | → | P1476 |
formatterURL | → | P1630 |
quote | → | P1683 |
shortName | → | P1813 |
definingFormula | → | P2534 |
archiveDate | → | P2960 |
inferredFrom | → | P3452 |
typeOfReference | → | P3865 |
column | → | P3903 |
subjectNamedAs | → | P1810 |
wikidataProperty | → | P1687 |
References
When either the reference
or the references
command is used and a reference is encountered (in Wikidata), the module checks if the reference contains an imported from Wikimedia project (P143), inferred from (P3452) or Wikimedia import URL (P4656) property. In the case one of these properties is present, the whole reference is ignored (i.e. it is treated as if it wasn't present).
Else, the module attempts to display the reference using the {{Cite web}} template. The reference has to have a reference URL (P854) property. The below table shows the mapping of Wikidata properties to parameters of Cite web.
Wikidata property | Parameter of Cite web | Notes |
---|---|---|
archive date (P2960) | archive-date | |
archive URL (P1065) | archive-url | |
author (P50) | author/authorN | N can be 1, 2, 3... |
author name string (P2093) | ||
language of work or name (P407) | language | Ignored when the same as the local language. |
page(s) (P304) | pages | |
publication date (P577) | date | |
publisher (P123) | publisher | |
quotation (P1683) | quote | |
reference URL (P854) | url | |
retrieved (P813) | access-date | |
section (P958) | at | |
stated in (P248) | website | |
subject named as (P1810) | title | Used only when title (P1476) is not present, but a URL (either from reference URL (P854) or from an external identifier, as described below) is, otherwise ignored. |
title (P1476) | title |
The following properties are ignored: image (P18), type of reference (P3865).
If there is no reference URL (P854) property present in the reference, but a property of the "External identifier" data type is present both in the reference and in the Wikidata property (P1687) of the item in stated in (P248), a URL is generated from its content and is used in the same manner as a URL given in reference URL (P854).
If there is no reference URL (P854) property, or the reference has unknown properties, the module attempts to display it using the {{Cite Q}} template. The stated in (P248) property is mandatory. The below table shows the mapping of properties to Cite Q parameters.
Wikidata property | Parameter of Cite Q | Notes |
---|---|---|
stated in (P248) | 1 | Value supplied to the parameter is raw, i.e. it is just the plain QID. |
chapter (P792) | chapter | |
column (P3903) | at | |
page(s) (P304) | pages | |
publication date (P577) | date | |
retrieved (P813) | access-date | |
section (P958) | section | |
title (P1476) | title | |
any property of the "External identifier" data type | id | The label ("name") of the property is prepended before its content. |
The properties listed under the first table (in this section) are also ignored when using Cite Q.
A reference could be displayed using Cite Q only if the reference has a stated in (P248) property and has only properties listed in the table above. If neither Cite web nor Cite Q could be used to display a reference, an error message with an explanation is returned.
To fix this error, check if the reference has the required properties and doesn't have any unknown properties, as described above. The Wikidata help page on references can also be helpful when sourcing statements.
Advanced usage
The layout of the output from (a combination of) commands that have both a singular and a plural form (e.g. property
/properties
) can be customized by using a number of named flags, which are name-value pairs (i.e. |flag=value
), that can be given anywhere after the first command. The table below shows the available named flags.
To insert a space at the beginning or end of a value
, use an underscore _
. To get a literal underscore, escape it by placing a backslash \
directly in front of it (i.e. \_
); the same holds for a literal backslash (i.e. \\
). To get a literal vertical bar |
, use {{!}}
or |
.
Named flag | Default value | Default condition | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
format=
|
%p[%s][%r]
|
if the property /properties command was given and the qualifier /qualifiers command was not given
|
The format of a single claim. The available parameters are as follows.
Optional parameters can be given by encapsulating them between square brackets: To use two opening square brackets that directly follow each other (i.e. At least one parameter must be given that is not optional, while the To get a literal | ||||||||||||||||
%q[%s][%r]
|
if the property /properties command was not given and the qualifier /qualifiers command was given
| ||||||||||||||||||
%r
|
if only the reference /references command was given
| ||||||||||||||||||
%p[ <span style="font-size:85\%">(%q)</span>][%s][%r]
|
if the property /properties command was given and the qualifier /qualifiers command was given
| ||||||||||||||||||
%a[%s]
|
if the alias /aliases command was given
| ||||||||||||||||||
%b[%s]
|
if the badge /badges command was given
| ||||||||||||||||||
sep=
|
_
|
default | The fixed separator between each pair of claims, aliases or badges. | ||||||||||||||||
|
if only the reference /references command was given without the raw flag
| ||||||||||||||||||
sep%s=
|
,
|
default | The movable separator between each pair of claims, aliases or badges. This will be the value of the %s parameter applied to all claims, aliases or badges, except for the last in the list (which can be set with the punc flag).
| ||||||||||||||||
;
|
if the property /properties command was not given and the qualifier /qualifiers command was given
| ||||||||||||||||||
sep%q1= , sep%q2= , sep%q3= , ...
|
,_
|
default | The separator between each pair of qualifiers of a single claim. These are the value separators for the %q1 , %q2 , %q3 , ... parameters.
If only one | ||||||||||||||||
sep%q=
|
,_
|
if exactly one qualifier /qualifiers command was given
|
The separator between each set of qualifiers of a single claim. This is the value separator for the %q parameter.
If only one | ||||||||||||||||
;_
|
if more than one qualifier /qualifiers command was given
| ||||||||||||||||||
sep%r=
|
|
default | The separator between each pair of references of a single claim. This is the value separator for the %r parameter.
| ||||||||||||||||
_
|
if the raw flag was given for the reference /references command
| ||||||||||||||||||
punc=
|
|
default | A punctuation mark placed at the end of the output. This will be placed on the %s parameter applied to the last claim (or alias or badge) in the list.
This allows the last claim's references to be placed after the punctuation mark when the output is used as part of a sentence. |
Examples
Parameters and output types | Example | Description |
---|---|---|
Q55 = "Netherlands", P395 = "licence plate code"
[string] |
{{#invoke:wd|property|Q55|P395}}
|
Gets a literal string value. |
P395 = "licence plate code"
[string] |
{{#invoke:wd|property|P395}}
|
If the module is transcluded on the Netherlands page (which is linked to Q55), then the Q55 can be omitted.
|
Q55 = "Netherlands", P395 = "NL"
[string] |
{{#invoke:wd|property|eid=Q55|P395}}
|
An entity-ID can also be given using the eid= argument.
|
P395 = "NL"
[string] |
{{#invoke:wd|property|page=Netherlands|P395}}
|
A page title can be given instead of an entity-ID using the page= argument.
|
Q55 = "Netherlands", P395 = "licence plate code"
[string] |
{{#invoke:wd|property|edit|Q55|P395}} |
Adds a clickable icon that may be used to edit the returned value on Wikidata. |
Q55 = "Netherlands", P395 = "licence plate code"
[string] |
{{#invoke:wd|property|edit@end|Q55|P395}} |
Places the edit icon at the end of the line. |
Q55 = "Netherlands", P1082 = "population"
[quantity] |
{{#invoke:wd|property|normal+|Q55|P1082}}
|
Gets a single property value from claims with a 'normal' rank or higher. |
Q55 = "Netherlands", P1082 = "population"
[quantity] |
{{#invoke:wd|properties|normal+|Q55|P1082}}
|
Gets multiple property values from claims with a 'normal' rank or higher. |
Q55 = "Netherlands", P1082 = "population", P585 = "point in time"
[quantity], [time] |
{{#invoke:wd|properties|qualifier|normal+|Q55|P1082|P585}}
|
Gets a single qualifier value for each claim, additional to the property value. |
Q55 = "Netherlands", P1082 = "population", P585 = "point in time"
[quantity], [time], [reference] |
{{#invoke:wd|properties|qualifier|references|normal+|Q55|P1082|P585}} |
Gets references for each claim. |
Q55 = "Netherlands", P1082 = "population"
[quantity], [reference] |
A total of
|
Gets a property with its references. |
Q55 = "Netherlands", P1082 = "population"
[quantity], [reference] |
The Netherlands has a population of
|
Adds a punctuation mark at the end of the output, in front of the references. |
Q55 = "Netherlands", P1082 = "population", P585 = "point in time"
[quantity], [time], [reference] |
<ul>
|
Returns the output in a custom format. |
Q55 = "Netherlands", P1082 = "population", P585 = "point in time"
[time] |
{{#invoke:wd|qualifier|normal+|Q55|P1082|P585}}
|
Gets a single qualifier per claim, by default for multiple matching claims. |
Q55 = "Netherlands", P1082 = "population", P585 = "point in time"
[time] |
{{#invoke:wd|qualifier|normal+|single|Q55|P1082|P585}}
|
To get a single qualifier for only a single claim, give the single flag too so that only a single claim will be accessed.
|
Q55 = "Netherlands", P1082 = "population", P585 = "point in time"
[time] |
{{#invoke:wd|qualifier|Q55|P1082|10026773|P585}}
|
Gets a qualifier from claims for which the (raw) property value matches a given literal value. |
Q55 = "Netherlands", P1082 = "population", P585 = "point in time"
[time] |
{{#invoke:wd|qualifier|mdy|Q55|P1082|10026773|P585}}
|
Gets dates in month-day-year order. |
Q55 = "Netherlands", P1082 = "population", P585 = "point in time"
[time] |
{{#invoke:wd|qualifier|raw|Q55|P1082|10026773|P585}}
|
Gets a raw date value. |
Q55 = "Netherlands", P1082 = "population"
[reference] |
{{#invoke:wd|references|Q55|P1082|10026773}}
|
Gets the references from a particular claim. |
Q55 = "Netherlands", P1082 = "population"
[reference] |
{{#invoke:wd|references|raw|Q55|P1082|10026773}}
|
Gets references from a particular claim in their raw form. |
Q55 = "Netherlands", P1081 = "Human Development Index"
[quantity], [reference] |
{{#invoke:wd|properties|references|normal+|Q55|P1081}}
|
Gets properties from each claim with any references they have. |
Q55 = "Netherlands", P1081 = "Human Development Index"
[quantity], [reference] |
{{#invoke:wd|properties|references|normal+|sourced|Q55|P1081}}
|
Only gets properties from claims that have at least one reference. |
Q55 = "Netherlands", P2855 = "VAT rate", P518 = "applies to part"
[entity label] |
{{#invoke:wd|qualifier|Q55|P2855|P518}}
|
Gets a single qualifier value (for each matching claim). |
Q55 = "Netherlands", P2855 = "VAT rate", P518 = "applies to part"
[entity label] |
{{#invoke:wd|qualifiers|Q55|P2855|P518}}
|
Gets multiple qualifier values (for each matching claim). |
Q55 = "Netherlands", P2855 = "VAT rate", P518 = "applies to part"
[quantity], [entity label] |
{{#invoke:wd|properties|qualifiers|Q55|P2855|P518}}
|
Gets multiple property values along with multiple qualifier values. |
Q55 = "Netherlands", P2855 = "VAT rate", P518 = "applies to part"
[quantity], [entity label] |
{{#invoke:wd|properties|qualifiers|Q55|P2855|P518|sep=_+_|sep%s=|sep%q=_/_}}
|
Returns the output with custom separators. |
Q55 = "Netherlands", P35 = "head of state", P580 = "start time", P582 = "end time"
[entity label], [time] |
{{#invoke:wd|properties|qualifier|qualifier|normal+|Q55|P35|P580|P582}}
|
Gets two different qualifier values for each claim. |
Q55 = "Netherlands", P35 = "head of state", P580 = "start time", P582 = "end time"
[entity label], [time] |
{{#invoke:wd|properties|qualifier|qualifier|normal+|Q55|P35|P580|P582|sep%q=_–_}}
|
Returns the output with a custom separator. |
Q55 = "Netherlands", P35 = "head of state", P580 = "start time", P582 = "end time"
[entity label], [time] |
{{#invoke:wd|properties|qualifier|qualifier|normal+|Q55|P35|P580|P582|format=%p[ <span style="font-size:85\%">(%q1[ – %q2])</span>][%s][%r]}}
|
Returns the output in a custom format instead of with a custom separator. |
Q55 = "Netherlands", P35 = "head of state", P580 = "start time", P582 = "end time"
[entity label], [time] |
{{#invoke:wd|properties|qualifier|qualifier|normal+|Q55|P35|P580|P582|format=%p[ <span style="font-size:85\%">([<![]--%q2]since [%q2--[]>]%q1[ – %q2])</span>][%s][%r]}}
|
To add text only when a certain value is not present, like adding the word since if there is no end time, wrap it in between two optional blocks containing HTML comment tags and the relevant parameter (this also prevents the text from being added to the page source). |
Q55 = "Netherlands", P35 = "head of state", Q29574 = "Beatrix of the Netherlands", P580 = "start time", P582 = "end time"
[entity label], [time] |
{{#invoke:wd|properties|qualifier|raw|qualifier|normal+|Q55|P35|Q29574|P580|P582|format=%p[ <span style="font-size:85\%">(%q1[ – %q2])</span>][%s][%r]}}
|
Gets a property with qualifiers from claims for which the property matches a given Q-identifier, with one of the qualifier values in its raw form. |
Q55 = "Netherlands", P38 = "currency", P518 = "applies to part"
[entity label] |
{{#invoke:wd|properties|qualifiers|normal+|current|Q55|P38|P518}}
|
Gets claims that are currently valid. |
Q55 = "Netherlands", P38 = currency", P518 = "applies to part"
[entity label] |
{{#invoke:wd|properties|linked|qualifiers|normal+|current|Q55|P38|P518}}
|
Gets claims with linked property values. |
Q55 = "Netherlands", P38 = currency", P518 = "applies to part"
[entity label] |
{{#invoke:wd|properties|qualifiers|linked|normal+|current|Q55|P38|P518}}
|
Gets claims with linked qualifier values. |
Q55 = "Netherlands", P38 = currency", P518 = "applies to part"
[entity label] |
{{#invoke:wd|properties|linked|short|qualifiers|linked|normal+|current|Q55|P38|P518}}
|
Gets claims with linked property and qualifier values, with short property values wherever available. |
Q55 = "Netherlands", P38 = currency", Q4917 = "United States dollar", P518 = "applies to part"
[entity label] |
{{#invoke:wd|qualifiers|normal+|current|Q55|P38|Q4917|P518}}
|
Gets qualifiers from claims for which the (raw) property value matches a given Q-identifier. |
Q55 = "Netherlands", P38 = currency", P518 = "applies to part", Q27561 = "Caribbean Netherlands"
[entity label] |
{{#invoke:wd|properties|normal+|current|Q55|P38|P518=Q27561}}
|
Gets properties from claims for which a (raw) qualifier value matches a given Q-identifier. |
Q55 = "Netherlands", P38 = currency"
[entity label] |
{{#invoke:wd|properties|normal+|former|Q55|P38}}
|
Gets claims that were valid in the past. |
Q55 = "Netherlands", P38 = currency"
[entity label] |
{{#invoke:wd|properties|raw|normal+|former|Q55|P38}}
|
Gets raw property values. |
Q55 = "Netherlands", P38 = currency"
[entity label] |
{{#invoke:wd|properties|raw|linked|normal+|former|Q55|P38}}
|
Gets raw property values that are linked to Wikidata. |
Q55 = "Netherlands", P1549 = "demonym"
[monolingual text] |
{{#invoke:wd|property|Q55|P1549}}
|
Gets a monolingual text value in the current wiki's language. |
Q55 = "Netherlands", P1549 = "demonym", P407 = "language of work or name", Q36846 = "Toki Pona"
[monolingual text] |
{{#invoke:wd|property|multilanguage|Q55|P1549|P407=Q36846}}
|
Gets a monolingual text value in any available language. |
Q55 = "Netherlands", P2884 = "mains voltage"
[quantity] |
{{#invoke:wd|property|Q55|P2884}}
|
Gets a quantity value with its associated unit of measurement. |
Q55 = "Netherlands", P2884 = "mains voltage"
[quantity] |
{{#invoke:wd|property|linked|Q55|P2884}}
|
Gets a quantity value with a linked unit of measurement. |
Q55 = "Netherlands", P2884 = "mains voltage"
[quantity] |
{{#invoke:wd|property|raw|Q55|P2884}}
|
Gets a raw quantity value. |
Q55 = "Netherlands", P2884 = "mains voltage"
[quantity] |
{{#invoke:wd|property|unit|Q55|P2884}}
|
Gets only the unit of measurement. |
Q55 = "Netherlands", P2884 = "mains voltage"
[quantity] |
{{#invoke:wd|property|unit|raw|Q55|P2884}}
|
Gets the raw unit of measurement. |
Q55 = "Netherlands", P625 = "coordinate ___location"
[globe coordinate] |
{{#invoke:wd|property|Q55|P625}}
|
Gets a globe coordinate value. |
Q55 = "Netherlands", P625 = "coordinate ___location"
[globe coordinate] |
{{#invoke:wd|property|linked|Q55|P625}} |
Gets a linked globe coordinate value. |
Q55 = "Netherlands", P625 = "coordinate ___location"
[globe coordinate] |
{{#invoke:wd|property|raw|Q55|P625}}
|
Gets a raw globe coordinate value. |
Q55 = "Netherlands", P625 = "coordinate ___location"
[globe coordinate] |
{{#invoke:wd|property|Q55|coord}}
|
A property alias can be used instead of the P-identifier. |
Q55 = "Netherlands", P41 = "flag image"
[commons media] |
{{#invoke:wd|property|linked|Q55|P41}} |
Gets a media file name and links to it on Commons. |
Q55 = "Netherlands", P41 = "flag image"
[commons media] |
{{#invoke:wd|property|raw|Q55|P41|format=\[\[File:%p {{!}} thumb {{!}} left\]\]}} |
A Commons media file can be included on the page as-is by omitting the linked and raw flags, but by using the raw flag it can be freely formatted.
|
Q55 = "Netherlands", P41 = "flag image"
[commons media] |
{{#invoke:wd|property|raw|date=1700-05-06|Q55|P41|format=\[\[File:%p {{!}} thumb {{!}} left\]\]}} |
To get the value of a property that was valid at a given time, the date= argument can be used.
|
Q55 = "Netherlands", P41 = "flag image"
[commons media] |
{{#invoke:wd|property|raw|date=1700-05-06|former|Q55|P41|format=\[\[File:%p {{!}} thumb {{!}} left\]\]}} |
The time constraint flags work relatively to the date value given for the date= argument.
|
Q915684 = "Lorentz–Lorenz equation", P2534 = "defining formula"
[math] |
{{#invoke:wd|property|Q915684|P2534}} |
Gets a mathematical expression. |
Q915684 = "Lorentz–Lorenz equation", P7235 = "in defining formula", P9758 = "symbol represents"
[entity label], [math] |
<ul>
|
Mathematical expressions can be combined with regular text as usual. |
Q6256 = "country", P3896 = "geoshape"
[geographic shape] |
{{#invoke:wd|property|linked|Q6256|P3896}} |
Gets a geographic shape data file name and links to it on Commons. |
Q4917 = "United States dollar"
[entity label] |
{{#invoke:wd|label|Q4917}}
|
Gets an item's label. |
Q4917 = "United States dollar"
[entity label] |
{{#invoke:wd|label|short|linked|Q4917}} |
Gets an item's short and linked label. |
P38 = currency"
[entity label] |
{{#invoke:wd|label|P38}}
|
Gets a property's label. |
P38 = currency"
[entity label] |
{{#invoke:wd|label|linked|P38}}
|
Gets a property's label that is linked to Wikidata. |
Q776 = "Utrecht"
[entity label] |
{{#invoke:wd|label|Q776}}
|
Gets an item's label. |
Q776 = "Utrecht"
[entity label] |
{{#invoke:wd|label|linked|Q776}}
|
Gets an item's linked label. |
[entity label] |
{{#invoke:wd|label}}
|
If the module is transcluded on the Utrecht (province) page (which is linked to Q776), then the Q776 can be omitted.
|
[entity label] |
{{#invoke:wd|label|raw}}
|
If just the label command with the raw flag is given, then the Q-identifier of the item connected to the current page is returned.
|
[entity label] |
{{#invoke:wd|label|raw|linked}}
|
If additionally the linked flag is given, then the Q-identifier of the item connected to the current page is linked to Wikidata.
|
Q776 = "Utrecht"
[page title] |
{{#invoke:wd|title|Q776}}
|
Gets the title of the page on the current wiki that is linked to the given item. |
Q776 = "Utrecht"
[page title] |
{{#invoke:wd|title|linked|Q776}} |
Gets the linked title of the page on the current wiki that is linked to the given item. |
[page title] |
{{#invoke:wd|title}}
|
If the module is transcluded on the Utrecht (province) page (which is linked to Q776), then the Q776 can be omitted.
|
Q55 = "Netherlands"
[entity description] |
{{#invoke:wd|description|Q55}}
|
Gets an item's description. |
[entity description] |
{{#invoke:wd|description}}
|
If the module is transcluded on the Netherlands page (which is linked to Q55), then the Q55 can be omitted.
|
Q55 = "Netherlands"
[entity alias] |
{{#invoke:wd|alias|Q55}}
|
Gets one of an item's aliases. |
Q55 = "Netherlands"
[entity alias] |
{{#invoke:wd|aliases|Q55}}
|
Gets all of an item's aliases. |
Q55 = "Netherlands"
[entity alias] |
{{#invoke:wd|alias|linked|Q55}}
|
Gets a linked alias from an item. |
[entity alias] |
{{#invoke:wd|alias}}
|
If the module is transcluded on the Netherlands page (which is linked to Q55), then the Q55 can be omitted.
|
Q2 = "Earth"
[page badge] |
{{#invoke:wd|badges|Q2}}
|
Gets the badges for the page on the current wiki that is linked to the given item. |
Q2 = "Earth"
[page badge] |
{{#invoke:wd|badges|raw|Q2}}
|
Gets the raw badges for the page on the current wiki that is linked to the given item. |
[page badge] |
{{#invoke:wd|badges}}
|
If the module is transcluded on the Earth page (which is linked to Q2), then the Q2 can be omitted.
|
Q28865 = "Python", P548 = "version type", P348 = "software version identifier",
[version], [reference] |
{{#invoke:wd|property|reference|edit|Q28865|P548=Q2804309|P348}}
|
Get Python's latest stable release version with its references. You may want to use P548=Q2122918 to get the latest preview release version. |
Example references
- ^ a b c d e f g h i j "Bevolking; kerncijfers, 1950-2022".
- ^ a b c d e "CBS StatLine - Bevolking; kerncijfers". Statistics Netherlands. Archived from the original on 27 August 2015. Retrieved 22 August 2015.
- ^ a b "CBS StatLine - Bevolking; kerncijfers". Archived from the original on 3 September 2014. Retrieved 26 August 2014.
- ^ a b "Nederland telt 17 miljoen inwoners". 21 March 2016.
- ^ a b "Bevolking; kerncijfers, 1950-2022". Retrieved 18 March 2023.
- ^ a b c d e f g h i j k l m n o p q r s t u v w x y z aa ab ac ad ae af ag ah ai aj ak al am an ao ap aq ar as at au av aw ax ay az ba bb bc bd "Human Development Data (1990-2017)". Human Development Report. Archived from the original on 30 December 2018.
- ^ a b c d e f g h i j k l m n "Netherlands". Archived from the original on 2 February 2017.
- ^ "It's time for another set of Python releases! Python 3.11.3, 3.10.11 and 3.12 alpha 7 are now available". 5 April 2023. Retrieved 6 April 2023.
TemplateData
This template fetches data from the centralized knowledge base Wikidata. To edit the data, click on "Wikidata item" in the left sidebar.
Parameter | Description | Type | Status | |||
---|---|---|---|---|---|---|
No parameters specified |
See also
- {{Wikidata}}, a user-friendly wrapper template for this module.
- {{WikidataOI}}, a wrapper template for this module that adds an opt-in toggle.
- {{Pageid to title}}, to get a page title using its local page id, rather than Wikidata
local p = {}
local aliasesP = {
author = "P50",
publisher = "P123",
importedFrom = "P143",
statedIn = "P248",
coord = "P625",
publicationDate = "P577",
startTime = "P580",
endTime = "P582",
retrieved = "P813",
referenceURL = "P854",
archiveURL = "P1065",
title = "P1476",
quote = "P1683",
shortName = "P1813",
language = "P2439",
archiveDate = "P2960"
}
local aliasesQ = {
percentage = "Q11229",
prolepticJulianCalendar = "Q1985786"
}
local State = {}
State.__index = State
-- allows for recursive calls
function State.new()
local stt = {}
setmetatable(stt, State)
stt.outPreferred = {}
stt.outNormal = {}
stt.outDeprecated = {}
stt.bestRank = true
stt.foundRank = 3
stt.maxRank = nil
stt.minRank = nil
stt.period = 0
stt.propertyWithQualifier = false
stt.pageTitle = false
stt.linked = false
stt.rawValue = false
stt.shortName = false
stt.singleValue = false
stt.mdyDate = false
stt.withRefs = false
stt.langCode = mw.language.getContentLanguage().code
stt.langName = mw.language.fetchLanguageName(stt.langCode, stt.langCode)
stt.langObj = mw.language.new(stt.langCode)
stt:setRankBoundaries("best")
return stt
end
function State:unknownDatatypeError(type)
return "<strong class=\"error\">Unknown or unsupported datatype '" .. type .. "'</strong>"
end
function State:parseWikidataURL(url)
local i, j
if url:match('^http[s]?://') then
i, j = url:find("Q")
if i then
return url:sub(i)
end
end
return nil
end
function State:parseDate(dateStr, precision)
precision = precision or "d"
local i, j, index, ptr
local parts = {nil, nil, nil}
if dateStr == nil then
return parts[1], parts[2], parts[3] -- year, month, day
end
-- 'T' for snak values, '/' for outputs with '/Julian' attached
i, j = dateStr:find("[T/]")
if i then
dateStr = dateStr:sub(1, i-1)
end
local from = 1
if dateStr:sub(1,1) == "-" then
-- this is a negative number, look further ahead
from = 2
end
index = 1
ptr = 1
i, j = dateStr:find("-", from)
if i then
-- year
parts[index] = tonumber(mw.ustring.gsub(dateStr:sub(ptr, i-1), "^\+(.+)$", "%1"), 10) -- remove + sign
if parts[index] == -0 then
parts[index] = 0
end
if precision == "y" then
-- we're done
return parts[1], parts[2], parts[3] -- year, month, day
end
index = index + 1
ptr = i + 1
i, j = dateStr:find("-", ptr)
if i then
-- month
parts[index] = tonumber(dateStr:sub(ptr, i-1), 10)
if precision == "m" then
-- we're done
return parts[1], parts[2], parts[3] -- year, month, day
end
index = index + 1
ptr = i + 1
end
end
if dateStr:sub(ptr) ~= "" then
-- day if we have month, month if we have year, or year
parts[index] = tonumber(dateStr:sub(ptr), 10)
end
return parts[1], parts[2], parts[3] -- year, month, day
end
function State:convertUnit(unit, link)
link = link or false
local itemID, label, title
if unit == "" or unit == "1" then
return nil
end
itemID = self:parseWikidataURL(unit)
if itemID then
if itemID == aliasesQ.percentage then
return "%"
else
label = mw.wikibase.label(itemID)
title = nil
if link or label == nil then
title = mw.wikibase.sitelink(itemID)
end
if link then
if title then
return " " .. "[[" .. title .. "|" .. (label or title) .. "]]"
end
if not label then
return " " .. "[[d:" .. itemID .. "|" .. itemID .. "]]"
end
end
return " " .. (label or title or itemID)
end
end
return " " .. unit
end
function State:getShortName(itemID)
return p._property({"single", itemID, aliasesP.shortName})
end
function State:getLabel(ID)
return p._label({ID})
end
function State:getOrdinalSuffix(num)
if tostring(num):sub(-2,-2) == '1' then
return "th" -- 10th, 11th, 12th, 13th, ... 19th
end
num = tostring(num):sub(-1)
if num == '1' then
return "st"
elseif num == '2' then
return "nd"
elseif num == '3' then
return "rd"
else
return "th"
end
end
function State:addDecimalMarks(n)
local left,num,right = string.match(n,'^([^%d]*%d)(%d*)(.-)$')
return left..(num:reverse():gsub('(%d%d%d)','%1,'):reverse())..right
end
function State:getValue(snak, raw, link, anyLang)
raw = raw or false
link = link or false
anyLang = anyLang or false
if snak.snaktype == 'value' then
if snak.datavalue.type == 'string' then
return snak.datavalue.value
elseif snak.datavalue.type == 'monolingualtext' then
if anyLang then
return snak.datavalue.value['text'], snak.datavalue.value['language']
elseif snak.datavalue.value['language'] == self.langCode then
return snak.datavalue.value['text']
else
return nil
end
elseif snak.datavalue.type == 'quantity' then
-- strip + signs from front
local value = mw.ustring.gsub(snak.datavalue.value['amount'], "^\+(.+)$", "%1")
if not raw then
value = self:addDecimalMarks(value)
local unit = self:convertUnit(snak.datavalue.value['unit'], link)
if unit then
value = value .. unit
end
end
return value
elseif snak.datavalue.type == 'time' then
local y, m, d, p, yDiv, yRound, yFull, value, calendarID, dateStr
local yFactor = 1
local sign = 1
local suffix = ""
local mayAddCalendar = false
local calendar = ""
local precision = snak.datavalue.value['precision']
if precision == 11 then
p = "d"
elseif precision == 10 then
p = "m"
else
p = "y"
yFactor = 10^(9-precision)
end
y, m, d = self:parseDate(snak.datavalue.value['time'], p)
if y < 0 then
sign = -1
y = y * sign
end
-- if precision is tens/hundreds/thousands/millions/billions of years
if precision <= 8 then
yDiv = y / yFactor
-- if precision is tens/hundreds/thousands of years
if precision >= 6 then
mayAddCalendar = true
if precision <= 7 then
-- round centuries/millenniums up (e.g. 20th century or 3rd millennium)
yRound = math.ceil(yDiv)
if not raw then
if precision == 6 then
suffix = " millennium"
else
suffix = " century"
end
suffix = self:getOrdinalSuffix(yRound) .. suffix
else
-- if not verbose, take the first year of the century/millennium
-- (e.g. 1901 for 20th century or 2001 for 3rd millennium)
yRound = (yRound - 1) * yFactor + 1
end
else
-- precision == 8
-- round decades down (e.g. 2010s)
yRound = math.floor(yDiv) * yFactor
if not raw then
suffix = "s"
end
end
if raw and sign < 0 then
-- if BCE then compensate for "counting backwards"
-- (e.g. -2019 for 2010s BCE, -2000 for 20th century BCE or -3000 for 3rd millennium BCE)
yRound = yRound + yFactor - 1
end
else
local yReFactor, yReDiv, yReRound
-- round to nearest for tens of thousands of years or more
yRound = math.floor(yDiv + 0.5)
if yRound == 0 then
if precision <= 2 and y ~= 0 then
yReFactor = 1e6
yReDiv = y / yReFactor
yReRound = math.floor(yReDiv + 0.5)
if yReDiv == yReRound then
-- change precision to millions of years only if we have a whole number of them
precision = 3
yFactor = yReFactor
yRound = yReRound
end
end
if yRound == 0 then
-- otherwise, take the unrounded (original) number of years
precision = 5
yFactor = 1
yRound = y
mayAddCalendar = true
end
end
if precision >= 1 and y ~= 0 then
yFull = yRound * yFactor
yReFactor = 1e9
yReDiv = yFull / yReFactor
yReRound = math.floor(yReDiv + 0.5)
if yReDiv == yReRound then
-- change precision to billions of years if we're in that range
precision = 0
yFactor = yReFactor
yRound = yReRound
else
yReFactor = 1e6
yReDiv = yFull / yReFactor
yReRound = math.floor(yReDiv + 0.5)
if yReDiv == yReRound then
-- change precision to millions of years if we're in that range
precision = 3
yFactor = yReFactor
yRound = yReRound
end
end
end
if not raw then
if precision == 3 then
suffix = " million years"
elseif precision == 0 then
suffix = " billion years"
else
yRound = yRound * yFactor
if yRound == 1 then
suffix = " year"
else
suffix = " years"
end
end
else
yRound = yRound * yFactor
end
end
else
yRound = y
mayAddCalendar = true
end
if mayAddCalendar then
calendarID = self:parseWikidataURL(snak.datavalue.value['calendarmodel'])
if calendarID and calendarID == aliasesQ.prolepticJulianCalendar then
if not raw then
if link then
calendar = " ([[Julian calendar|Julian]])"
else
calendar = " (Julian)"
end
else
calendar = "/Julian"
end
end
end
if not raw then
local ce = nil
if sign < 0 then
ce = "BCE"
elseif precision <= 5 then
ce = "CE"
end
if ce then
if link then
ce = "[[Common Era|" .. ce .. "]]"
end
suffix = suffix .. " " .. ce
end
value = tostring(yRound)
if m then
dateStr = self.langObj:formatDate("F", "1-"..m.."-1")
if d then
if self.mdyDate then
dateStr = dateStr .. " " .. d .. ","
else
dateStr = d .. " " .. dateStr
end
end
value = dateStr .. " " .. value
end
value = value .. suffix .. calendar
else
value = tostring(yRound * sign)
if m then
value = value .. "-" .. m
if d then
value = value .. "-" .. d
end
end
value = value .. calendar
end
return value
elseif snak.datavalue.type == 'globecoordinate' then
local precision, numDigits, strFormat, value, globe
local latValue, latitude, latDegrees, latMinutes, latSeconds
local latDirection = "N"
local lonValue, longitude, lonDegrees, lonMinutes, lonSeconds
local lonDirection = "E"
local degSymbol = "°"
local minSymbol = "'"
local secSymbol = '"'
local partsGlue = ", "
if raw then
degSymbol = "/"
minSymbol = "/"
secSymbol = "/"
partsGlue = "/"
end
latitude = snak.datavalue.value['latitude']
longitude = snak.datavalue.value['longitude']
if latitude < 0 then
latDirection = "S"
latitude = math.abs(latitude)
end
if longitude < 0 then
lonDirection = "W"
longitude = math.abs(longitude)
end
precision = snak.datavalue.value['precision']
latitude = math.floor(latitude / precision + 0.5) * precision
longitude = math.floor(longitude / precision + 0.5) * precision
latDegrees = math.floor(latitude)
lonDegrees = math.floor(longitude)
latMinutes = math.floor((latitude - latDegrees) * 60)
lonMinutes = math.floor((longitude - lonDegrees) * 60)
latSeconds = (latitude - (latDegrees + latMinutes / 60)) * 3600
lonSeconds = (longitude - (lonDegrees + lonMinutes / 60)) * 3600
latValue = latDegrees .. degSymbol
lonValue = lonDegrees .. degSymbol
if precision < 1 then
latValue = latValue .. latMinutes .. minSymbol
lonValue = lonValue .. lonMinutes .. minSymbol
end
if precision < (1 / 60) then
numDigits = math.ceil(-math.log10(3600 * precision))
if numDigits < 0 or numDigits == -0 then
numDigits = 0
end
strFormat = "%." .. numDigits .. "f"
latSeconds = string.format(strFormat, latSeconds)
lonSeconds = string.format(strFormat, lonSeconds)
latValue = latValue .. latSeconds .. secSymbol
lonValue = lonValue .. lonSeconds .. secSymbol
end
latValue = latValue .. latDirection
lonValue = lonValue .. lonDirection
value = latValue .. partsGlue .. lonValue
if link then
globe = self:parseWikidataURL(snak.datavalue.value['globe'])
if globe then
globe = mw.wikibase.label(globe):lower()
else
globe = "earth"
end
value = "[https://tools.wmflabs.org/geohack/geohack.php?language="..self.langCode.."¶ms="..latitude.."_"..latDirection.."_"..longitude.."_"..lonDirection.."_globe:"..globe.." "..value.."]"
end
return value
elseif snak.datavalue.type == 'wikibase-entityid' then
local value = ""
local title = nil
local itemID = "Q" .. snak.datavalue.value['numeric-id']
if raw then
if link then
return "[[d:" .. itemID .. "|" .. itemID .. "]]"
else
return itemID
end
end
if self.shortName then
value = self:getShortName(itemID)
end
if value == "" then
value = mw.wikibase.label(itemID)
end
if link or value == nil then
title = mw.wikibase.sitelink(itemID)
end
if link then
if title then
value = "[[" .. title .. "|" .. (value or title) .. "]]"
elseif not value then
value = "[[d:" .. itemID .. "|" .. itemID .. "]]"
end
elseif not value then
value = (title or itemID)
end
return value
else
return self:unknownDatatypeError(snak.datavalue.type)
end
elseif snak.snaktype == 'somevalue' then
if raw then
return " " -- single space represents 'somevalue'
else
return "unknown"
end
elseif snak.snaktype == 'novalue' then
if raw then
return "" -- empty value represents 'novalue'
else
return "none"
end
else
return nil
end
end
function State:getSingleRawQualifier(claim, qualifierID)
local qualifiers
if claim.qualifiers then qualifiers = claim.qualifiers[qualifierID] end
if qualifiers and qualifiers[1] then
return self:getValue(qualifiers[1], true) -- raw = true
else
return nil
end
end
function State:snakEqualsValue(snak, value)
local snakValue = self:getValue(snak, true) -- raw = true
if snakValue and snak.snaktype == 'value' and snak.datavalue.type == 'wikibase-entityid' then value = value:upper() end
return snakValue == value
end
function State:setRankBoundaries(rank)
local rankPos
if (rank == "best") then
self.bestRank = true
self.foundRank = 3
return
else
self.bestRank = false
end
if (rank:sub(1,9) == "preferred") then
rankPos = 1
elseif (rank:sub(1,6) == "normal") then
rankPos = 2
elseif (rank:sub(1,10) == "deprecated") then
rankPos = 3
end
if (rank:sub(-1) == "+") then
self.maxRank = 1
self.minRank = rankPos
elseif (rank:sub(-1) == "-") then
self.maxRank = rankPos
self.minRank = 3
else
self.maxRank = rankPos
self.minRank = rankPos
end
end
function State:convertRank(rank)
if (rank == "preferred") then
return 1
elseif (rank == "normal") then
return 2
elseif (rank == "deprecated") then
return 3
else
return 4 -- default (in its literal sense)
end
end
function State:rankMatches(rankPos)
if self.bestRank then
if self.foundRank > rankPos then
self.foundRank = rankPos
-- found a better rank, reset worse rank outputs
if self.foundRank == 1 then
self.outNormal = {}
self.outDeprecated = {}
elseif self.foundRank == 2 then
self.outDeprecated = {}
end
end
return self.foundRank >= rankPos -- == would also work here
else
return (self.maxRank <= rankPos and rankPos <= self.minRank)
end
end
function State:datePrecedesDate(aY, aM, aD, bY, bM, bD)
if aY == nil or bY == nil then
return nil
end
aM = aM or 1
aD = aD or 1
bM = bM or 1
bD = bD or 1
if aY < bY then
return true
end
if aY > bY then
return false
end
if aM < bM then
return true
end
if aM > bM then
return false
end
if aD < bD then
return true
end
return false
end
function State:timeMatches(claim)
local startTime = nil
local startTimeY = nil
local startTimeM = nil
local startTimeD = nil
local endTime = nil
local endTimeY = nil
local endTimeM = nil
local endTimeD = nil
if self.period == 0 then
-- any time
return true
end
local now = os.date('!*t')
startTime = self:getSingleRawQualifier(claim, aliasesP.startTime)
if startTime and startTime ~= "" and startTime ~= " " then
startTimeY, startTimeM, startTimeD = self:parseDate(startTime)
end
endTime = self:getSingleRawQualifier(claim, aliasesP.endTime)
if endTime and endTime ~= "" and endTime ~= " " then
endTimeY, endTimeM, endTimeD = self:parseDate(endTime)
elseif endTime == " " then
-- end time is 'unknown', assume it is somewhere in the past;
-- we can do this by taking the current date as a placeholder for the end time
endTimeY = now['year']
endTimeM = now['month']
endTimeD = now['day']
end
if startTimeY ~= nil and endTimeY ~= nil and self:datePrecedesDate(endTimeY, endTimeM, endTimeD, startTimeY, startTimeM, startTimeD) then
-- invalidate end time if it precedes start time
endTimeY = nil
endTimeM = nil
endTimeD = nil
end
if self.period == 1 then
-- future
if startTimeY == nil or not self:datePrecedesDate(now['year'], now['month'], now['day'], startTimeY, startTimeM, startTimeD) then
return false
else
return true
end
elseif self.period == 2 then
-- current
if (startTimeY ~= nil and self:datePrecedesDate(now['year'], now['month'], now['day'], startTimeY, startTimeM, startTimeD)) or
(endTimeY ~= nil and not self:datePrecedesDate(now['year'], now['month'], now['day'], endTimeY, endTimeM, endTimeD)) then
return false
else
return true
end
elseif self.period == 3 then
-- former
if endTimeY == nil or self:datePrecedesDate(now['year'], now['month'], now['day'], endTimeY, endTimeM, endTimeD) then
return false
else
return true
end
end
end
function State:appendOutput(value, rankPos)
local done = false
if rankPos == 1 then
self.outPreferred[#self.outPreferred + 1] = value
if self.singleValue then
done = true
end
elseif rankPos == 2 then
self.outNormal[#self.outNormal + 1] = value
if self.singleValue and not self.bestRank and self.maxRank == 2 then
done = true
end
elseif rankPos == 3 then
self.outDeprecated[#self.outDeprecated + 1] = value
if self.singleValue and not self.bestRank and self.maxRank == 3 then
done = true
end
end
return done
end
function State:out()
local out = ""
if self.outDeprecated[1] then
if self.singleValue then
out = self.outDeprecated[1]
else
out = table.concat(self.outDeprecated, ", ")
end
end
if self.outNormal[1] then
if self.singleValue then
out = self.outNormal[1]
else
if out ~= "" then
out = "; " .. out
end
out = table.concat(self.outNormal, ", ") .. out
end
end
if self.outPreferred[1] then
if self.singleValue then
out = self.outPreferred[1]
else
if out ~= "" then
out = "; " .. out
end
out = table.concat(self.outPreferred, ", ") .. out
end
end
return out
end
-- logic based on https://www.wikidata.org/wiki/Help:Sources
function State:getReferences(claim)
local snaks, snakValue, lang, params, leadParams, property, ref
local value = ""
if not claim.references then
return ""
end
for i, v in ipairs(claim.references) do
if v.snaks then
ref = ""
snaks = {}
params = {}
leadParams = {}
for i2, v2 in pairs(v.snaks) do
if v2[1] then
snaks[i2] = v2[1]
end
end
if snaks[aliasesP.importedFrom] then
snaks[aliasesP.importedFrom] = nil
end
if snaks[aliasesP.referenceURL] and snaks[aliasesP.title] then
params["url"] = self:getValue(snaks[aliasesP.referenceURL])
params["title"] = self:getValue(snaks[aliasesP.title], false, false, true)
if snaks[aliasesP.publicationDate] then params["date"] = self:getValue(snaks[aliasesP.publicationDate]) end
if snaks[aliasesP.retrieved] then params["access-date"] = self:getValue(snaks[aliasesP.retrieved]) end
if snaks[aliasesP.archiveURL] then params["archive-url"] = self:getValue(snaks[aliasesP.archiveURL]) end
if snaks[aliasesP.archiveDate] then params["archive-date"] = self:getValue(snaks[aliasesP.archiveDate]) end
if snaks[aliasesP.author] then params["author"] = self:getValue(snaks[aliasesP.author]) end
if snaks[aliasesP.publisher] then params["publisher"] = self:getValue(snaks[aliasesP.publisher]) end
if snaks[aliasesP.quote] then params["quote"] = self:getValue(snaks[aliasesP.quote], false, false, true) end
if snaks[aliasesP.language] then
snakValue = self:getValue(snaks[aliasesP.language])
if self.langName ~= snakValue then
params["language"] = snakValue
end
end
ref = mw.getCurrentFrame():expandTemplate{title="cite_web", args=params}
else
for i2, v2 in pairs(snaks) do
property = self:getLabel(i2)
if property ~= "" then
snakValue, lang = self:getValue(v2, false, (i2 == aliasesP.statedIn), true)
if lang and lang ~= self.langCode then
snakValue = "''" .. snakValue .. "'' (" .. mw.language.fetchLanguageName(lang, self.langCode) .. ")"
end
if i2 == aliasesP.referenceURL or i2 == aliasesP.statedIn then
leadParams[#leadParams + 1] = snakValue
elseif i2 ~= aliasesP.language or self.langName ~= snakValue then
params[#params + 1] = property .. ": " .. snakValue
end
end
end
ref = table.concat(leadParams, "; ")
params = table.concat(params, "; ")
if params ~= "" then
if ref ~= "" then
ref = ref .. "; "
end
ref = ref .. params
end
if ref ~= "" then
ref = ref .. "."
end
end
if ref ~= "" then
value = value .. mw.getCurrentFrame():extensionTag("ref", ref)
end
end
end
return value
end
function State:processFlag(flag)
if flag == "linked" then
self.linked = true
return true
elseif flag == "raw" then
self.rawValue = true
return true
elseif flag == "short" then
self.shortName = true
return true
elseif flag == "single" then
self.singleValue = true
return true
elseif flag == "mdy" then
self.mdyDate = true
return true
elseif flag == "refs" then
self.withRefs = true
return true
elseif flag == "best" or flag:match('^preferred[+-]?$') or flag:match('^normal[+-]?$') or flag:match('^deprecated[+-]?$') then
self:setRankBoundaries(flag)
return true
elseif flag == "future" then
self.period = 1
return true
elseif flag == "current" then
self.period = 2
return true
elseif flag == "former" then
self.period = 3
return true
else
return false
end
end
function p.property(frame)
return p._property(frame.args)
end
function p._property(args, _)
_ = _ or State.new()
local entity, propertyID, claims, rankPos, value, done
local nextArg = mw.text.trim(args[1] or "")
local nextIndex = 2
while _:processFlag(nextArg) do
nextArg = mw.text.trim(args[nextIndex] or "")
nextIndex = nextIndex + 1
end
if nextArg:sub(1,1):upper() == "Q" then
entity = mw.wikibase.getEntity(nextArg)
propertyID = mw.text.trim(args[nextIndex] or "")
else
entity = mw.wikibase.getEntity()
propertyID = nextArg
end
if aliasesP[propertyID] then
propertyID = aliasesP[propertyID]
end
propertyID = propertyID:upper()
if entity and entity.claims then claims = entity.claims[propertyID] end
if claims then
for i, v in ipairs(claims) do
rankPos = _:convertRank(v.rank)
if _:rankMatches(rankPos) and _:timeMatches(v) then
value = _:getValue(v.mainsnak, _.rawValue, _.linked)
if value then
if _.withRefs then
value = value .. _:getReferences(v)
end
done = _:appendOutput(value, rankPos)
if done then
break
end
end
end
end
return _:out()
else
return ""
end
end
function p.qualifier(frame)
return p._qualifier(frame.args)
end
function p._qualifier(args, _)
_ = _ or State.new()
local entity, propertyID, propertyValue, qualifierID, claims, qualifiers, rankPos, outValue, outInter, outQualifiers
local done = false
local nextArg = mw.text.trim(args[1] or "")
local nextIndex = 2
while _:processFlag(nextArg) do
nextArg = mw.text.trim(args[nextIndex] or "")
nextIndex = nextIndex + 1
end
if nextArg:sub(1,1):upper() == "Q" then
entity = mw.wikibase.getEntity(nextArg)
propertyID = mw.text.trim(args[nextIndex] or "")
nextIndex = nextIndex + 1
else
entity = mw.wikibase.getEntity()
propertyID = nextArg
end
if aliasesP[propertyID] then
propertyID = aliasesP[propertyID]
end
propertyID = propertyID:upper()
nextArg = args[nextIndex]
nextIndex = nextIndex + 1
qualifierID = nextArg
nextArg = mw.text.trim(args[nextIndex] or "")
nextIndex = nextIndex + 1
if nextArg == "" then
-- claim ID or literal value has NOT been given
propertyValue = nil
qualifierID = mw.text.trim(qualifierID or "")
else
-- claim ID or literal value has been given
propertyValue = qualifierID -- cannot be nil when reached; empty value represents 'novalue'
if propertyValue ~= "" and mw.text.trim(propertyValue) == "" then
propertyValue = " " -- single space represents 'somevalue'
else
propertyValue = mw.text.trim(propertyValue)
end
qualifierID = nextArg
end
if aliasesP[qualifierID] then
qualifierID = aliasesP[qualifierID]
end
qualifierID = qualifierID:upper()
if entity and entity.claims then claims = entity.claims[propertyID] end
if claims then
for i, v in ipairs(claims) do
rankPos = _:convertRank(v.rank)
if propertyValue == nil or _:snakEqualsValue(v.mainsnak, propertyValue) then
if _:rankMatches(rankPos) and _:timeMatches(v) then
outValue = nil
outInter = nil
outQualifiers = {}
if _.propertyWithQualifier then
-- get the property value first
outValue = _:getValue(v.mainsnak, _.rawValue, _.linked)
if outValue and _.withRefs then
outValue = outValue .. _:getReferences(v)
end
end
if v.qualifiers then qualifiers = v.qualifiers[qualifierID] end
if (not _.propertyWithQualifier or outValue) and qualifiers then
-- get a bare qualifier, or the qualifiers connected to the property if it had a value
for i2, v2 in ipairs(qualifiers) do
outInter = _:getValue(v2, _.rawValue, _.linked)
if outInter then
if not _.propertyWithQualifier then
done = _:appendOutput(outInter, rankPos)
if done then
break
end
else
outQualifiers[#outQualifiers + 1] = outInter
end
end
end
end
if _.propertyWithQualifier and outValue then
outQualifiers = table.concat(outQualifiers, ", ")
if outQualifiers ~= "" then
outQualifiers = " <span style=\"font-size:smaller\">(" .. outQualifiers .. ")</span>"
outValue = outValue .. outQualifiers
end
done = _:appendOutput(outValue, rankPos)
end
if done then
break
end
end
end
end
return _:out()
else
return ""
end
end
function p.propertyWithQualifier(frame)
return p._propertyWithQualifier(frame.args)
end
function p._propertyWithQualifier(args, _)
_ = _ or State.new()
_.propertyWithQualifier = true
return p._qualifier(args, _)
end
function p.label(frame)
return p._label(frame.args)
end
function p._label(args, _)
_ = _ or State.new()
local ID
local label = ""
local title = nil
local nextArg = mw.text.trim(args[1] or "")
local nextIndex = 2
while _:processFlag(nextArg) do
nextArg = mw.text.trim(args[nextIndex] or "")
nextIndex = nextIndex + 1
end
ID = nextArg
if ID ~= "" then
if aliasesP[ID] then
ID = aliasesP[ID]
end
ID = ID:upper()
-- check if this is a valid ID, and if the number is not larger than max int (to prevent error)
if not string.match(ID, '^[QP]%d+$') or tonumber(string.match(ID, '%d+')) > 2147483647 then
return ""
end
if _.rawValue then
if mw.wikibase.getEntity(ID) or mw.wikibase.resolvePropertyId(ID) then
if _.linked then
if ID:sub(1,1) == "P" then
label = "[[d:Property:" .. ID .. "|" .. ID .. "]]"
else
label = "[[d:" .. ID .. "|" .. ID .. "]]"
end
else
label = ID
end
end
else
if ID:sub(1,1) == "P" then
if not _.pageTitle then
label = mw.wikibase.label(ID) or ""
if _.linked and label ~= "" then
label = "[[d:Property:" .. ID .. "|" .. label .. "]]"
end
end
else
if not _.pageTitle then
if _.shortName then
label = _:getShortName(ID)
end
-- at this point, 'label' will be a string and not nil
if label == "" then
label = mw.wikibase.label(ID)
end
else
-- set 'label' to nil so 'title' will always prevail
label = nil
end
-- at this point, 'label' will be nil or a non-empty string
if _.linked or label == nil then
title = mw.wikibase.sitelink(ID)
end
if _.linked and title then
label = "[[" .. title .. "|" .. (label or title) .. "]]"
else
label = label or title or ""
end
end
end
else
if _.rawValue then
label = mw.wikibase.getEntityIdForCurrentPage() or ""
if _.linked and label ~= "" then
label = "[[d:" .. label .. "|" .. label .. "]]"
end
else
if not _.pageTitle then
label = mw.wikibase.label()
else
-- set 'label' to nil so 'title' will always prevail
label = nil
end
if _.linked or label == nil then
title = mw.title.getCurrentTitle().prefixedText
end
if _.linked then
label = "[[" .. title .. "|" .. (label or title) .. "]]" -- not much use since it links to the current page, but does add wiki mark-up
else
label = label or title
end
end
end
return label
end
function p.title(frame)
return p._title(frame.args)
end
function p._title(args, _)
_ = _ or State.new()
_.pageTitle = true
return p._label(args, _)
end
-- main function that may be used by wrapper templates
function p.main(frame)
local f, args, i, v
frame = frame:getParent() or frame
f = mw.text.trim(frame.args[1] or "")
assert(p[f], 'The function "' .. f .. '" does not exist')
args = {}
for i, v in ipairs(frame.args) do
if i > 1 then
args[i-1] = v
end
end
frame.args = args
return p[f](frame)
end
return p