पटलम्:Wikidata/doc

You might want to use one of the user-friendly wrapper templates {{Wikidata}} and {{WikidataOI}} instead of invoking this module directly.

This पटलम् is intended to fetch data from Wikidata with or without a link to the connected Wikipedia article.

Usage

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

Commands

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 पटलम् instead of making multiple calls to this पटलम् with one command each to be sure that all the returned pieces of information belong to each other.

Type	Command	Returns	Basic usage	Description
1	property	first match*	{{#invoke:wikidata|property|P1}}	Returns the requested property – or list of properties – from the current item, or a given item.
	properties	all matches	{{#invoke:wikidata|properties|P1}}
2	qualifier	first match*	{{#invoke:wikidata|qualifier|P1|P2}}	Returns the requested qualifier – or list of qualifiers – from the given property of the current item, or a given item. Unlike the other value-class commands, this command can be given multiple times to retrieve different qualifiers in one call.
	qualifiers	all matches	{{#invoke:wikidata|qualifiers|P1|P2}}
3	reference	first match*	{{#invoke:wikidata|reference|P1}}	Returns a reference – or list of references – from the given property of the current item, or a given item.
	references	all matches	{{#invoke:wikidata|references|P1}}
* 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.

Name class

The name class commands cannot be combined.

Command	Basic usage	Description
label	{{#invoke:wikidata|label}}	Returns the label of the current item, or a 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	{{#invoke:wikidata|title}}	Returns the title of the page linked to the current item, or a given item, if such page exists. The label of the item will never be returned instead.

Main class

Command	Basic usage	Description
main	{{#invoke:wikidata|main|command|P1}}	Intended for use by a wrapper template (around this module) to invoke one of the above commands, returning their respective output. The parameters passed to the wrapper template are the ones that will be used by the module, e.g. {{wikidata|property|P1549}} → {{#invoke:Wd|main}} → {{#invoke:Wd|main|property|P1549}}. Therefore, any parameters set by the wrapper template itself will be discarded, e.g. {{wikidata|property|P1549}} → {{#invoke:Wd|main|qualifier|P1082|P585}} → {{#invoke:Wd|main|property|P1549}}.

Flags

The following (optional) flags are available which can be used to alter this पटलम्'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 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.
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 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).

Configuration flags

These flags (flag0*) are general configuration flags and can be given anywhere after the first command (but before the other arguments).

	Flag	Description
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 + 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	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 future|current|former (so by default claims that are valid for any time period are returned).
	current
	former
	mdy	Returns date values in month_day_year order instead of day_month_year order.

Arguments

The following table shows the available arguments (arg*) in their fixed order. For each command, the minimal set of arguments is marked (i.e. 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 qualifier_id arguments are given.

	(required)		(optional)	(optional)	(required)	(optional)	(required)	(required)
{{#invoke:wikidata	commands		flags	item_id	property_id	claim_id_or_lit_value	qualifier_id	qualifier_id	}}
				label, title
				property/properties
				reference/references
				qualifier/qualifiers
				qualifier/qualifiers (optional 2nd, 3rd, etc.)

Below follows a description of all arguments.

Argument	Description
item_id (optional)	EXPENSIVE Q-identifier of the item to be accessed (e.g. Q55). In case of the label command, a P-identifier (or an available alias) of a property (e.g. P38) can also be given. 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_lit_value (optional)	Either the Q-identifier equal to the property value 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 property value (in its raw form) of the 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 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).

Named properties

Named properties are aliases for P-identifiers. The following named properties (which are case-sensitive) are currently available:

Alias	translates to	P-identifier
coord	→	P625
author	→	P50
publisher	→	P123
importedFrom	→	P143
statedIn	→	P248
publicationDate	→	P577
startTime	→	P580
endTime	→	P582
retrieved	→	P813
referenceURL	→	P854
archiveURL	→	P1065
title	→	P1476
quote	→	P1683
shortName	→	P1813
language	→	P2439
archiveDate	→	P2960

Advanced usage

The layout of the output from value class commands can be customized by using a number of named flags, which are name-value pairs (i.e. |flag=value). The table below shows the available named flags.

Named flags can be given anywhere after the first command. To insert a space at the beginning or end of a value, use the HTML entity  .

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. %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. 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. \%).
	%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
sep=	&#32;	default	The fixed separator between each pair of claims.
		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=, ...	,&#32;	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=	,&#32;	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.
	&#32;	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.
	&#32;	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 in the list. This allows any 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 = "", P1549 = "" ↓ [monolingual text]	{{#invoke:wikidata|property|Q55|P1549}} ↓	Gets a monolingual text value in the current wiki's language.
P1549 = "" ↓ [monolingual text]	{{#invoke:wikidata|property|P1549}} ↓	If the पटलम् is transcluded on the page (which is linked to Q55), then the Q55 can be omitted.
Q55 = "", P395 = "" ↓ [string]	{{#invoke:wikidata|property|Q55|P395}} ↓	Gets a literal string value.
Q55 = "", P1082 = "" ↓ [quantity]	{{#invoke:wikidata|property|normal+|Q55|P1082}} ↓	Gets a single property value from claims with a 'normal' rank or higher.
Q55 = "", P1082 = "" ↓ [quantity]	{{#invoke:wikidata|properties|normal+|Q55|P1082}} ↓	Gets multiple property values from claims with a 'normal' rank or higher.
Q55 = "", P1082 = "", P585 = "" ↓ [quantity], [time]	{{#invoke:wikidata|properties|qualifier|normal+|Q55|P1082|P585}} ↓	Gets a single qualifier value for each claim, additional to the property value.
Q55 = "", P1082 = "", P585 = "" ↓ [quantity], [time], [reference]	{{#invoke:wikidata|properties|qualifier|references|normal+|Q55|P1082|P585}} ↓	Gets references for each claim.
Q55 = "", P1082 = "" ↓ [quantity], [reference]	A total of {{#invoke:wikidata|property|references|Q55|P1082}} people live in the Netherlands. ↓ A total of people live in the Netherlands.	Gets a property with its references.
Q55 = "", P1082 = "" ↓ [quantity], [reference]	The Netherlands has a population of {{#invoke:wikidata|property|references|Q55|P1082|punc=.}} ↓ The Netherlands has a population of	Adds a punctuation mark at the end of the output, in front of the references.
Q55 = "", P1082 = "", P585 = "" ↓ [quantity], [time], [reference]	<ul>{{#invoke:wikidata|properties|qualifier|references|normal+|Q55|P1082|P585|format=<li>%p[%r][<ul><li>%q</li></ul>]</li>}}</ul> ↓	Returns the output in a custom format.
Q55 = "", P1082 = "", P585 = "" ↓ [time]	{{#invoke:wikidata|qualifier|normal+|Q55|P1082|P585}} ↓	Gets a single qualifier per claim, by default for multiple matching claims.
Q55 = "", P1082 = "", P585 = "" ↓ [time]	{{#invoke:wikidata|property|qualifier|normal+|Q55|P1082|P585|format=%q[%s][%r]}} ↓	To get a single qualifier for only a single claim, give the property command too along with the regular qualifier format.
Q55 = "", P1082 = "", P585 = "" ↓ [time]	{{#invoke:wikidata|qualifier|Q55|P1082||P585}} ↓	Gets a qualifier from claims for which the (raw) property value matches a given literal value.
Q55 = "", P1082 = "", P585 = "" ↓ [time]	{{#invoke:wikidata|qualifier|mdy|Q55|P1082||P585}} ↓	Gets dates in month_day_year order.
Q55 = "", P1082 = "", P585 = "" ↓ [time]	{{#invoke:wikidata|qualifier|raw|Q55|P1082||P585}} ↓	Gets a raw date value.
Q55 = "", P1082 = "" ↓ [reference]	{{#invoke:wikidata|references|Q55|P1082|}} ↓	Gets the references from a particular claim.
Q55 = "", P1082 = "" ↓ [reference]	{{#invoke:wikidata|references|raw|Q55|P1082|}} ↓	Gets references from a particular claim in their raw form.
Q55 = "", P2855 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|qualifier|Q55|P2855|P518}} ↓	Gets a single qualifier value (for each matching claim).
Q55 = "", P2855 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|qualifiers|Q55|P2855|P518}} ↓	Gets multiple qualifier values (for each matching claim).
Q55 = "", P2855 = "", P518 = "" ↓ [quantity], [item label]	{{#invoke:wikidata|properties|qualifiers|Q55|P2855|P518}} ↓	Gets multiple property values along with multiple qualifier values.
Q55 = "", P2855 = "", P518 = "" ↓ [quantity], [item label]	{{#invoke:wikidata|properties|qualifiers|Q55|P2855|P518|sep=&#32;+&#32;|sep%s=|sep%q=&#32;/&#32;}} ↓	Returns the output with custom separators.
Q55 = "", P35 = "", P580 = "", P582 = "" ↓ [item label], [time]	{{#invoke:wikidata|properties|qualifier|qualifier|normal+|Q55|P35|P580|P582}} ↓	Gets two different qualifier values for each claim.
Q55 = "", P35 = "", P580 = "", P582 = "" ↓ [item label], [time]	{{#invoke:wikidata|properties|qualifier|qualifier|normal+|Q55|P35|P580|P582|sep%q=&#32;–&#32;}} ↓	Returns the output with a custom separator.
Q55 = "", P35 = "", P580 = "", P582 = "" ↓ [item label], [time]	{{#invoke:wikidata|properties|qualifier|qualifier|normal+|Q55|P35|P580|P582|format=%p[ <span style="font-size:smaller">(%q1[ – %q2])</span>][%s][%r]}} ↓	Returns the output in a custom format instead of with a custom separator.
Q55 = "", P35 = "", Q29574 = "", P580 = "", P582 = "" ↓ [item label], [time]	{{#invoke:wikidata|properties|qualifier|raw|qualifier|normal+|Q55|P35|Q29574|P580|P582|format=%p[ <span style="font-size:smaller">(%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 = "", P38 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|properties|qualifiers|normal+|current|Q55|P38|P518}}}} ↓	Gets claims that are currently valid.
Q55 = "", P38 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|properties|linked|qualifiers|normal+|current|Q55|P38|P518}}}} ↓	Gets claims with linked property values.
Q55 = "", P38 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|properties|qualifiers|linked|normal+|current|Q55|P38|P518}}}} ↓	Gets claims with linked qualifier values.
Q55 = "", P38 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|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 = "", P38 = "", Q4917 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|qualifiers|linked|normal+|current|Q55|P38|Q4917|P518}}}} ↓	Gets qualifiers from claims for which the (raw) property value matches a given item ID.
Q55 = "", P38 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|properties|qualifiers|normal+|former|Q55|P38|P518}}}} ↓	Gets claims that were valid in the past.
Q55 = "", P38 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|properties|raw|qualifiers|normal+|former|Q55|P38|P518}}}} ↓	Gets raw property values.
Q55 = "", P38 = "", P518 = "" ↓ [item label]	{{#invoke:wikidata|properties|raw|linked|qualifiers|normal+|former|Q55|P38|P518}}}} ↓	Gets raw property values that are linked to Wikidata.
Q55 = "", P2884 = "" ↓ [quantity]	{{#invoke:wikidata|property|Q55|P2884}} ↓	Gets a quantity value with its associated unit of measurement.
Q55 = "", P2884 = "" ↓ [quantity]	{{#invoke:wikidata|property|linked|Q55|P2884}} ↓	Gets a quantity value with a linked unit of measurement.
Q55 = "", P2884 = "" ↓ [quantity]	{{#invoke:wikidata|property|raw|Q55|P2884}} ↓	Gets a raw quantity value.
Q55 = "", P625 = "" ↓ [globe coordinate]	{{#invoke:wikidata|property|Q55|P625}} ↓	Gets a globe coordinate value.
Q55 = "", P625 = "" ↓ [globe coordinate]	{{#invoke:wikidata|property|linked|Q55|P625}} ↓	Gets a linked globe coordinate value.
Q55 = "", P625 = "" ↓ [globe coordinate]	{{#invoke:wikidata|property|raw|Q55|P625}} ↓	Gets a raw globe coordinate value.
Q55 = "", P625 = "" ↓ [globe coordinate]	{{#invoke:wikidata|property|Q55|coord}} ↓	A named property (or alias) can be used instead of the P-identifier.
Q4917 = "" ↓ [item label]	{{#invoke:wikidata|label|Q4917}} ↓	Gets an item's label.
Q4917 = "" ↓ [item label]	{{#invoke:wikidata|label|short|linked|Q4917}} ↓	Gets an item's short and linked label.
P38 = "" ↓ [property label]	{{#invoke:wikidata|label|P38}} ↓	Gets a property's label.
P38 = "" ↓ [property label]	{{#invoke:wikidata|label|linked|P38}} ↓	Gets a property's label that is linked to Wikidata.
Q776 = "" ↓ [item label]	{{#invoke:wikidata|label|Q776}} ↓	Gets an item's label.
Q776 = "" ↓ [item label]	{{#invoke:wikidata|label|linked|Q776}} ↓	Gets an item's linked label.
↓ [item label]	{{#invoke:wikidata|label}} ↓	If the पटलम् is transcluded on the page (which is linked to Q776), then the Q776 can be omitted.
Q776 = "" ↓ [page title]	{{#invoke:wikidata|title|Q776}} ↓	Gets the title of the page on the current wiki that is linked to the given item.
Q776 = "" ↓ [page title]	{{#invoke:wikidata|title|linked|Q776}} ↓	Gets the linked title of the page on the current wiki that is linked to the given item.
↓ [page title]	{{#invoke:wikidata|title}} ↓	If the पटलम् is transcluded on the page (which is linked to Q776), then the Q776 can be omitted.

See also

• {{Wikidata}}, a user-friendly wrapper template for this module.
• {{WikidataOI}}, a wrapper template for this module that adds an opt-in toggle.