Template:WikidataOI/doc
This is a documentation subpage for Template:WikidataOI. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
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
{{wikidataOI|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] | {{wikidataOI|property|P1}} | Returns the requested property – or list of properties – from the current item-entity or from a given entity. |
properties
|
all matches | {{wikidataOI|properties|P1}} | ||
II | qualifier
|
first match[a] | {{wikidataOI|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. |
qualifiers
|
all matches | {{wikidataOI|qualifiers|P1|P2}} | ||
III | reference
|
first match[a] | {{wikidataOI|reference|P1}} | Returns a reference – or list of references – from the given property of the current item-entity or of a given entity.[b] |
references
|
all matches | {{wikidataOI|references|P1}} | ||
|
Name class
The name class commands cannot be combined.
Type | Command | Returns | Basic usage | Description |
---|---|---|---|---|
I | label
|
{{wikidataOI|label}} | Returns the label of the current item-entity or of a given entity if present. | |
II | title
|
{{wikidataOI|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] | {{wikidataOI|alias}} | Returns an alias – or list of aliases – of the current item-entity or of a given entity if present. |
aliases
|
all matches | {{wikidataOI|aliases}} | ||
|
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 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. |
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 If the The default is 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 |
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
|
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) | |||
{{wikidataOI
|
commands
|
flags
|
entity_id
|
property_id
|
raw_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 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 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 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 This argument only has effect if the positional argument |
<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. |
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.
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: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 | ||||||||||||||
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 | ||||||||||||||
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 | 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 = "", P395 = ""
[string] |
{{wikidataOI|property|Q55|P395}}
|
Gets a literal string value. |
P395 = ""
[string] |
{{wikidataOI|property|P395}}
|
If the template is transcluded on the page (which is linked to Q55), then the Q55 can be omitted.
|
Q55 = "", P395 = ""
[string] |
{{wikidataOI|property|eid=Q55|P395}}
|
An entity-ID can also be given using the eid= argument.
|
Q55 = "", P395 = ""
[string] |
{{wikidataOI|property|edit|Q55|P395}}
|
Adds a clickable icon that may be used to edit the returned value on Wikidata. |
Q55 = "", P395 = ""
[string] |
{{wikidataOI|property|edit@end|Q55|P395}}
|
Places the edit icon at the end of the line. |
Q55 = "", P1082 = ""
[quantity] |
{{wikidataOI|property|normal+|Q55|P1082}}
|
Gets a single property value from claims with a 'normal' rank or higher. |
Q55 = "", P1082 = ""
[quantity] |
{{wikidataOI|properties|normal+|Q55|P1082}}
|
Gets multiple property values from claims with a 'normal' rank or higher. |
Q55 = "", P1082 = "", P585 = ""
[quantity], [time] |
{{wikidataOI|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] |
{{wikidataOI|properties|qualifier|references|normal+|Q55|P1082|P585}}
|
Gets references for each claim. |
Q55 = "", P1082 = ""
[quantity], [reference] |
A total of {{wikidataOI|property|references|Q55|P1082}} people live in the Netherlands.
|
Gets a property with its references. |
Q55 = "", P1082 = ""
[quantity], [reference] |
The Netherlands has a population of {{wikidataOI|property|references|Q55|P1082|punc=.}}
|
Adds a punctuation mark at the end of the output, in front of the references. |
Q55 = "", P1082 = "", P585 = ""
[quantity], [time], [reference] |
<ul>{{wikidataOI|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] |
{{wikidataOI|qualifier|normal+|Q55|P1082|P585}}
|
Gets a single qualifier per claim, by default for multiple matching claims. |
Q55 = "", P1082 = "", P585 = ""
[time] |
{{wikidataOI|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 = "", P1082 = "", P585 = ""
[time] |
{{wikidataOI|qualifier|Q55|P1082|'|P585}}
|
Gets a qualifier from claims for which the (raw) property value matches a given literal value. |
Q55 = "", P1082 = "", P585 = ""
[time] |
{{wikidataOI|qualifier|mdy|Q55|P1082|P585}}
|
Gets dates in month-day-year order. |
Q55 = "", P1082 = "", P585 = ""
[time] |
{{wikidataOI|qualifier|raw|Q55|P1082|P585}}
|
Gets a raw date value. |
Q55 = "", P1082 = ""
[reference] |
{{wikidataOI|'references|Q55|P1082|'}}
|
Gets the references from a particular claim. |
Q55 = "", P1082 = ""
[reference] |
{{wikidataOI|'references|raw|Q55|P1082|'}}
|
Gets references from a particular claim in their raw form. |
Q55 = "", P1081 = ""
[quantity], [reference] |
{{wikidataOI|properties|references|Q55|P1081}}
|
Gets properties from each claim with any references they have. |
Q55 = "", P1081 = ""
[quantity], [reference] |
{{wikidataOI|properties|references|sourced|Q55|P1081}}
|
Only gets properties from claims that have at least one reference. |
Q55 = "", P2855 = "", P518 = ""
[entity label] |
{{wikidataOI|qualifier|Q55|P2855|P518}}
|
Gets a single qualifier value (for each matching claim). |
Q55 = "", P2855 = "", P518 = ""
[entity label] |
{{wikidataOI|qualifiers|Q55|P2855|P518}}
|
Gets multiple qualifier values (for each matching claim). |
Q55 = "", P2855 = "", P518 = ""
[quantity], [entity label] |
{{wikidataOI|properties|qualifiers|Q55|P2855|P518}}
|
Gets multiple property values along with multiple qualifier values. |
Q55 = "", P2855 = "", P518 = ""
[quantity], [entity label] |
{{wikidataOI|properties|qualifiers|Q55|P2855|P518|sep=_+_|sep%s=}}
|
Returns the output with custom separators. |
Q55 = "", P35 = "", P580 = "", P582 = ""
[entity label], [time] |
{{wikidataOI|properties|qualifier|qualifier|normal+|Q55|P35|P580}}
|
Gets two different qualifier values for each claim. |
Q55 = "", P35 = "", P580 = "", P582 = ""
[entity label], [time] |
{{wikidataOI|properties|qualifier|qualifier|normal+|Q55|P35|P580}}
|
Returns the output with a custom separator. |
Q55 = "", P35 = "", P580 = "", P582 = ""
[entity label], [time] |
{{wikidataOI|properties|qualifier|qualifier|normal+|Q55|P35|P580}}
|
Returns the output in a custom format instead of with a custom separator. |
Q55 = "", P35 = "", Q29574 = "", P580 = "", P582 = ""
[entity label], [time] |
{{wikidataOI|properties|qualifier|raw|qualifier|normal+|Q55|P35}}
|
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 = ""
[entity label] |
{{wikidataOI|properties|qualifiers|normal+|current|Q55|P38|P518}}
|
Gets claims that are currently valid. |
Q55 = "", P38 = ", P518 = ""
[entity label] |
{{wikidataOI|properties|linked|qualifiers|normal+|current|Q55|P38}}
|
Gets claims with linked property values. |
Q55 = "", P38 = ", P518 = ""
[entity label] |
{{wikidataOI|properties|qualifiers|linked|normal+|current|Q55|P38}}
|
Gets claims with linked qualifier values. |
Q55 = "", P38 = ", P518 = ""
[entity label] |
{{wikidataOI|properties|linked|short|qualifiers|linked|normal+|current}}
|
Gets claims with linked property and qualifier values, with short property values wherever available. |
Q55 = "", P38 = ", Q4917 = "", P518 = ""
[entity label] |
{{wikidataOI|qualifiers|normal+|current|Q55|P38|Q4917|P518}}
|
Gets qualifiers from claims for which the (raw) property value matches a given Q-identifier. |
Q55 = "", P38 = ", P518 = "", Q27561 = ""
[entity label] |
{{wikidataOI|properties|normal+|current|Q55|P38|P518=Q27561}}
|
Gets properties from claims for which a (raw) qualifier value matches a given Q-identifier. |
Q55 = "", P38 = "
[entity label] |
{{wikidataOI|properties|normal+|former|Q55|P38}}
|
Gets claims that were valid in the past. |
Q55 = "", P38 = "
[entity label] |
{{wikidataOI|properties|raw|normal+|former|Q55|P38}}
|
Gets raw property values. |
Q55 = "", P38 = "
[entity label] |
{{wikidataOI|properties|raw|linked|normal+|former|Q55|P38}}
|
Gets raw property values that are linked to Wikidata. |
Q55 = "", P1549 = ""
[monolingual text] |
{{wikidataOI|property|Q55|P1549}}
|
Gets a monolingual text value in the current wiki's language. |
Q55 = "", P1549 = "", P407 = "", Q36846 = ""
[monolingual text] |
{{wikidataOI|property|multilanguage|Q55|P1549}}
|
Gets a monolingual text value in any available language. |
Q55 = "", P2884 = ""
[quantity] |
{{wikidataOI|property|Q55|P2884}}
|
Gets a quantity value with its associated unit of measurement. |
Q55 = "", P2884 = ""
[quantity] |
{{wikidataOI|property|linked|Q55|P2884}}
|
Gets a quantity value with a linked unit of measurement. |
Q55 = "", P2884 = ""
[quantity] |
{{wikidataOI|property|raw|Q55|P2884}}
|
Gets a raw quantity value. |
Q55 = "", P2884 = ""
[quantity] |
{{wikidataOI|property|unit|Q55|P2884}}
|
Gets only the unit of measurement. |
Q55 = "", P2884 = ""
[quantity] |
{{wikidataOI|property|unit|raw|Q55|P2884}}
|
Gets the raw unit of measurement. |
Q55 = "", P625 = ""
[globe coordinate] |
{{wikidataOI|property|Q55|P625}}
|
Gets a globe coordinate value. |
Q55 = "", P625 = ""
[globe coordinate] |
{{wikidataOI|property|linked|Q55|P625}}
|
Gets a linked globe coordinate value. |
Q55 = "", P625 = ""
[globe coordinate] |
{{wikidataOI|property|raw|Q55|P625}}
|
Gets a raw globe coordinate value. |
Q55 = "", P625 = ""
[globe coordinate] |
{{wikidataOI|property|Q55|coord}}
|
A property alias can be used instead of the P-identifier. |
Q55 = "", P41 = ""
[commons media] |
{{wikidataOI|property|linked|Q55|P41}}
|
Gets a media file name and links to it on Commons. |
Q55 = "", P41 = ""
[commons media] |
{{wikidataOI|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.
|
Q915684 = "", P2534 = ""
[math] |
{{wikidataOI|property|Q915684|P2534}}
|
Gets a mathematical expression. |
Q6256 = "", P3896 = ""
[geographic shape] |
{{wikidataOI|property|linked|Q6256|P3896}}
|
Gets a geographic shape data file name and links to it on Commons. |
Q4917 = ""
[entity label] |
{{wikidataOI|label|Q4917}}
|
Gets an item's label. |
Q4917 = ""
[entity label] |
{{wikidataOI|label|short|linked|Q4917}}
|
Gets an item's short and linked label. |
P38 = "
[entity label] |
{{wikidataOI|label|P38}}
|
Gets a property's label. |
P38 = "
[entity label] |
{{wikidataOI|label|linked|P38}}
|
Gets a property's label that is linked to Wikidata. |
Q776 = ""
[entity label] |
{{wikidataOI|label|Q776}}
|
Gets an item's label. |
Q776 = ""
[entity label] |
{{wikidataOI|label|linked|Q776}}
|
Gets an item's linked label. |
[entity label] |
{{wikidataOI|label}}
|
If the template is transcluded on the page (which is linked to Q776), then the Q776 can be omitted.
|
[entity label] |
{{wikidataOI|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.
|
Q776 = ""
[page title] |
{{wikidataOI|title|Q776}}
|
Gets the title of the page on the current wiki that is linked to the given item. |
Q776 = ""
[page title] |
{{wikidataOI|title|linked|Q776}}
|
Gets the linked title of the page on the current wiki that is linked to the given item. |
[page title] |
{{wikidataOI|title}}
|
If the template is transcluded on the page (which is linked to Q776), then the Q776 can be omitted.
|
Q55 = ""
[entity alias] |
{{wikidataOI|alias|Q55}}
|
Gets one of an item's aliases. |
Q55 = ""
[entity alias] |
{{wikidataOI|aliases|Q55}}
|
Gets all of an item's aliases. |
Q55 = ""
[entity alias] |
{{wikidataOI|alias|linked|Q55}}
|
Gets a linked alias from an item. |
[entity alias] |
{{wikidataOI|alias}}
|
If the template is transcluded on the page (which is linked to Q55), then the Q55 can be omitted.
|
Example references
See also
- {{WikidataOI}}, the same template but including an opt-in toggle.
- {{Property}}, used to add a Wikidata property link in text.
- {{Q}}, used to add a Wikidata item link to a Wikipedia article.
- {{Wikidata property}}, used to add a Wikidata property link to a Wikipedia article.
- {{Wikidata entity link}}, used to add a Wikidata entity link to a Wikipedia article.
- {{Uses Wikidata}}
- Module:Wd, the source module that is called by this template.