Template:Wikidata/doc

This template uses Lua:

Module:Wd

This template is intended to fetch data from Wikidata with or without a link to the connected Wikipedia article and with many other features.

Usage

{{wikidata |command1|flag1a|flag1b|flag1c |command2|flag2a|flag2b|flag2c |flag0a|flag0b|flag0c |arg1|arg2|arg3}}

Commands

The commands (command1, command2, ...) determine what kind of values are returned. One call can only contain commands from a single class.

Value class

The value class commands can be combined, meaning that multiple commands of different types from this class can be given at one time.

Combine multiple commands into one call to this template instead of making multiple calls to this template with one command each to be sure that all the returned pieces of information belong to each other.

Type	Command	Returns	Basic usage	Description
I	`property`	first match^[a]	`{{wikidata\|property\|P1}}`	Returns the requested property – or list of properties – from the current item-entity or from a given entity.
I	`properties`	all matches	`{{wikidata\|properties\|P1}}`

II	`qualifier`	first match^[a]	`{{wikidata\|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 value-class commands, this command can be given multiple times to retrieve different qualifiers in one call.
II	`qualifiers`	all matches	`{{wikidata\|qualifiers\|P1\|P2}}`

III	`reference`	first match^[a]	`{{wikidata\|reference\|P1}}`	Returns a reference – or list of references – from the given property of the current item-entity or of a given entity.^[b]
III	`references`	all matches	`{{wikidata\|references\|P1}}`

↑ ^1.0 ^1.1 ^1.2 Returns only a single value instead of multiple (if multiple claims or statements match). The returned value is the first match found from the best-ranked claims. ↑ Only references that are valid according to the Wikidata guideline on sources are returned (i.e. those that have at least a property (P248) or (P854)).

Name class

The name class commands cannot be combined.

Type	Command	Returns	Basic usage	Description
I	`label`		`{{wikidata\|label}}`	Returns the label of the current item-entity or of a given entity if present.

II	`title`		`{{wikidata\|title}}`	Returns the title of the page linked to the current item-entity or to a given item-entity if such page exists.

III	`alias`	first match^[a]	`{{wikidata\|alias}}`	Returns an alias – or list of aliases – of the current item-entity or of a given entity if present.
III	`aliases`	all matches	`{{wikidata\|aliases}}`

↑ Returns only a single alias instead of multiple (if multiple aliases are present).

Flags

The following (optional) flags are available which can be used to alter this template's behaviour. They must be given after the (first) command and before the other 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
`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 (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.
`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, unless the `unit` flag is also given in which case the raw unit of measurement (its Q-identifier) will be returned. If this flag is used with time datatypes, then the returned date will be in the format of `year-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).
`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 other arguments).

	Flag	Command class	Description
Combination of:	`preferred`	value	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 `+` or a `-`, e.g. `normal+` or `preferred-`, 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, use `preferred-` or `deprecated+`. If the `best` flag is given additionally, then only the claims that have the highest rank amongst the selected claims will be returned. The default is `normal+\|best` (so by default claims with a 'deprecated' rank are never returned). Output is always sorted from highest rank to lowest (regardless of any of these flags being set).
	`normal`
	`deprecated`
	`best`
Combination of:	`future`	value	Sets a time constraint for the selected claim(s). Uses the claims' qualifiers of (P580) and (P582) to determine if the claim is valid for the selected time period(s). The default is `future\|current\|former` (so by default claims that are valid for any time period are returned).
	`current`
	`former`
	`mdy`	value	Returns date values in month-day-year order instead of day-month-year order.
	`single`	value	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.
	`sourced`	value	Only returns claims that have at least one valid reference.
One of:	`edit`	value, name	Adds a clickable icon after the output that may be used by readers to edit the returned claim on Wikidata. If `edit@end` is used, then the icon will be placed at the end of the line for neat alignment in infoboxes.
One of:	`edit@end`	value, name

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)

`{{wikidata`	`commands`	`flags`	`entity_id`	`property_id`	`raw_value`	`qualifier_id`	`qualifier_id`	`}}`

			`label`, `title`
			`label`, `title`
			`property`/`properties`
			`property`/`properties`
			`reference`/`references`
			`reference`/`references`
			`qualifier`/`qualifiers`
			`qualifier`/`qualifiers`
			`qualifier`/`qualifiers` (optional 2^nd, 3^rd, etc.)
			`qualifier`/`qualifiers` (optional 2^nd, 3^rd, 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`), or P-identifier (or an available alias) of the property-entity to be accessed preceded by the `Property:` prefix (e.g. `Property:P38`). In case of the name class commands, the `Property:` prefix may be omitted for P-identifiers (e.g. `P38`). If this parameter is omitted, then the item-entity connected to the current page will be used (except when `eid=` is given, see below). If this parameter is given, but empty (i.e. `\|\|`), then due to its position it will be interpreted as an empty flag and thus be ignored, giving the same result as if it were omitted. See also the `eid=` named argument below that can be used to give an entity-ID too, but without the item-entity connected to the current page being used as a result in this specific case.
`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 `year-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, and `year` (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 as `2010` (but the 2010s BCE as `-2019`), centuries like the 20th century as `1901` (but the 20th century BCE as `-2000`), and millenniums like the 3rd millennium as `2001` (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 single underscore (i.e. `\|_\|`). 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 `\|`. 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 inside the call.

Argument	Description
`eid=`	`[EXPENSIVE]` This argument offers the same functionality as the positional argument `entity_id` (e.g. `\|eid=Q55`), 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 `Property:` prefix may be omitted for P-identifiers (e.g. `\|eid=P38`) for all commands. This argument only has effect if the positional argument `entity_id` is omitted.
`<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, `<qualifier>` is any qualifier's P-identifier (or an available alias) without the `Property:` prefix (e.g. `P518`). Its value is either the Q-identifier equal to one of the qualifier values (e.g. `Q27561`) or a literal value (i.e. string or quantity etc., no entity label) equal to one of the raw qualifier values of the particular claim to be accessed. The value format is the same as for the positional argument `raw_value`. The special type 'no value' given by the empty string also matches the total absence within the claim of the particular qualifier. Example: `\|P518=Q27561` Multiple arguments of this type can be given to match multiple qualifier values simultaneously for each 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

author	→	P50
publisher	→	P123
importedFrom	→	P143
statedIn	→	P248
pages	→	P304
languageOfWorkOrName	→	P407
publicationDate	→	P577
startTime	→	P580
endTime	→	P582
chapter	→	P792
retrieved	→	P813
referenceURL	→	P854
sectionVerseOrParagraph	→	P958
archiveURL	→	P1065
title	→	P1476
formatterURL	→	P1630
quote	→	P1683
shortName	→	P1813
language	→	P407
archiveDate	→	P2960
column	→	P3903

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 inside the call. 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.

Parameter	Description
`%p`	The claim's property value applied by the `property`/`properties` command.
`%q1`, `%q2`, `%q3`, ...	The claim's qualifier value or list of qualifier values applied by the corresponding `qualifier`/`qualifiers` command.
`%q`	The collection of the qualifier values applied by each `qualifier`/`qualifiers` command (i.e. `%q1` + `%q2` + `%q3` + ...). If only one `qualifier`/`qualifiers` command was given, then this parameter is equivalent to `%q1`.
`%r`	The claim's reference value or list of reference values applied by the `reference`/`references` command.
`%a`	The entity's alias applied by the `alias`/`aliases` command.
`%s`	The movable separator placeholder. This is a special parameter that is not applied by a command, but instead is filled automatically between each pair of claims (if a list of claims is returned). This is handy in case a reference is returned as well, since it allows the reference to be placed after the punctuation mark as prescribed by Wikipedia's manual of style. The default value is a comma (`,`) and can be overridden with the `sep%s` flag (see below).

Optional parameters can be given by encapsulating them between square brackets: [...]. All content between the square brackets is only displayed if a value for each optional parameter that has been defined between the same brackets has been found. Optional content can also be nested.

To use two opening square brackets that directly follow each other (i.e. [[), use {{!((}}.

At least one parameter must be given that is not optional, while the %s parameter must always be defined as optional.

To get a literal [, ], % or \, escape the character by placing a backslash \ directly in front of it (e.g. \%). See also the description directly above this table for more.

%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:smaller">(%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

sep= Template:Dfn default The fixed separator between each pair of claims.

Template:Dfn if only the reference/references command was given without the raw flag

sep%s= , default The movable separator between each pair of claims. This will be the value of the %s parameter applied to all claims except for the last in the list.

; if the property/properties command was not given and the qualifier/qualifiers command was given

sep%q1=, sep%q2=, sep%q3=, ...

Template:Dfn

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 qualifier/qualifiers command was given, then the sep%q1 flag is equivalent to sep%q.

sep%q=

Template:Dfn

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 qualifier/qualifiers command was given, then this flag is equivalent to sep%q1.

Template:Dfn if more than one qualifier/qualifiers command was given

sep%r= Template:Dfn default The separator between each pair of references of a single claim. This is the value separator for the %r parameter.

Template:Dfn if the raw flag was given for the reference/references command

punc=

Template:Dfn