در حال ویرایش الگو:Wikidata/توضیحات (بخش)

== Arguments ==
The arguments determine the sources from which all the returned values are fetched.

=== Positional arguments ===
The following table shows the available positional arguments (<code>{{Background color|#ffdfc4|arg*}}</code>) 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 <code>properties</code> and <code>qualifiers</code> have been given, then at least both the arguments <code>property_id</code> and <code>qualifier_id</code> should be given as well.

More than one <code>qualifier</code>/<code>qualifiers</code> command can be given. The order in which these commands with their flags are given matches the order in which the respective <code>qualifier_id</code> arguments are given.
{| class="wikitable" style="background:none;border:none;"
|- style="text-align:center;"
| rowspan="2" style="background:none;border:none;" |
| colspan="2" | {{smaller|''(required)''}}
| {{smaller|{{color|#777|''(optional)''}}}}
| {{smaller|{{color|#777|(optional)}}}}
| {{smaller|(required)}}
| {{smaller|{{color|#777|(optional)}}}}
| {{smaller|(required)}}
| {{smaller|(required)}}
| rowspan="2" style="background:none;border:none;" |
|-
| colspan="2" |
|
|
|
|
|
|
|-
| style="border-right:2px solid #000;" | ''<code><nowiki>{{</nowiki>{{{prename|}}}{{lcfirst:{{ROOTPAGENAME}}}}</code>''
| colspan="2" style="border-right:2px solid #000;" | ''<code>commands</code>''
| style="border-right:2px solid #000;" | ''<code style="color:#777;">flags</code>''
! style="border-right:2px solid #000;background-color:#ffdfc4;" | <code style="color:#777;">entity_id</code>
! style="border-right:2px solid #000;background-color:#ffdfc4;" | <code>property_id</code>
! style="border-right:2px solid #000;background-color:#ffdfc4;" | <code style="color:#777;">raw_value</code>
! style="border-right:2px solid #000;background-color:#ffdfc4;" | <code>qualifier_id</code>
! style="background-color:#ffdfc4;" | <code>qualifier_id</code>
| ''<code><nowiki>}}</nowiki></code>''
|-
| rowspan="12" colspan="2" style="background:none;border:none;" |
| rowspan="2" colspan="2" style="border-style:dashed;border-left-color:blue;border-bottom-color:blue;" |
|
|
|
|
|
| rowspan="12" style="background:none;border:none;" |
|- style="text-align:center;"
| rowspan="2" | <code>label</code>, <code>title</code>,<br /><code>description</code>,<br /><code>alias</code>/<code>aliases</code>,<br /><code>badge</code>/<code>badges</code>
| rowspan="2" style="border-top:none;border-bottom:none;" |
| rowspan="2" style="border-top:none;border-bottom:none;" |
| rowspan="2" style="border-top:none;border-bottom:none;" |
| rowspan="2" style="border-top:none;border-bottom:none;" |
|-
| rowspan="2" colspan="2" style="border-style:dashed;border-left-color:blue;border-bottom-color:blue;" |
|- style="text-align:center;"
| rowspan="2" colspan="2" style="border-top:none;" | <code>property</code>/<code>properties</code>
| rowspan="2" style="border-top:none;border-bottom:none;" |
| rowspan="2" style="border-top:none;border-bottom:none;" |
| rowspan="2" style="border-top:none;border-bottom:none;" |
|-
| rowspan="2" colspan="2" style="border-style:dashed;border-left-color:blue;border-bottom-color:blue;" |
|- style="text-align:center;"
| rowspan="2" colspan="3" style="border-top:none;" | <code>reference</code>/<code>references</code>
| rowspan="2" style="border-top:none;border-bottom:none;" |
| rowspan="2" style="border-top:none;border-bottom:none;" |
|-
| rowspan="2" colspan="2" style="border-style:dashed;border-left-color:blue;border-bottom-color:blue;" |
|- style="text-align:center;"
| rowspan="2" colspan="4" style="border-top:none;" | <code>qualifier</code>/<code>qualifiers</code>
| rowspan="2" style="border-top:none;border-bottom:none;" |
|-
| rowspan="2" colspan="2" style="border-style:dashed;border-left-color:blue;border-bottom-color:blue;" |
|- style="text-align:center;"
| rowspan="2" colspan="5" style="border-top:none;" | <code>qualifier</code>/<code>qualifiers</code> ''(optional 2<sup>nd</sup>, 3<sup>rd</sup>, etc.)''
|-
| rowspan="2" colspan="2" style="border:none;" |
|-
| colspan="5" style="border:none;" |
|}

Below follows a description of all positional arguments.

{| class="wikitable"
|-
! Argument
! Description
|-
! style="text-align:left;" | <code style="color:#777;">entity_id</code>

{{smaller|{{nobold|(optional)}}}}
| '''<code>{{color|red|[EXPENSIVE]}}</code>''' '''Q-identifier''' of the item-entity to be accessed (e.g. <code>Q55</code>), '''P-identifier''' (or an available '''[[#Property aliases|alias]]''') of the property-entity to be accessed preceded by the <code>Property:</code> prefix (e.g. <code>Property:P38</code>), or '''page title''' of the Wikipedia article whose connected item-entity is to be accessed preceded by <code>:</code>, a prefixed colon (e.g. <code>:Netherlands</code>).

In case of the [[#General class|general class commands]], the <code>Property:</code> prefix may be omitted for P-identifiers (e.g. <code>P38</code>).

If this parameter is omitted, then the item-entity connected to the current page will be used (except when <code>eid=</code> or <code>page=</code> is given, [[#Named arguments|see below]]). If this parameter is given, but empty (i.e. <code>&#124;&#124;</code>), then due to its position it will be interpreted as an [[#Flags|empty flag]] and thus be ignored, giving the same result as if it were omitted. See also the [[#Named arguments|named arguments <code>eid=</code> and <code>page=</code>]] below that can be used to give an entity-ID or page title too, but without the item-entity connected to the current page being used as a default.
|-
! style="text-align:left;" | <code>property_id</code>
| '''P-identifier''' (or an available '''[[#Property aliases|alias]]''') of the property within the entity to be accessed, without the <code>Property:</code> prefix (e.g. <code>P35</code>).
|-
! style="text-align:left;" | <code style="color:#777;">raw_value</code>

{{smaller|{{nobold|(optional)}}}}
| Either the '''Q-identifier''' equal to the property value (e.g. <code>Q29574</code>) 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 <code>yyyy-mm-dd</code> (e.g. <code>1731-02-11</code>) for dates with a precision of days, <code>yyyy-mm</code> (e.g. <code>1731-02</code>) for dates with a precision of months, and <code>yyyy</code> (e.g. <code>1731</code>) for dates of lesser precision. Dates BCE require a minus sign in front of the year (e.g. <code>-2950-01-31</code>). Dates stored in the Julian calendar must have <code>/Julian</code> attached to the end (e.g. <code>1731-02-11/Julian</code>). Decades like the 2010s must be given as <code>2010</code> (but the 2010s BCE as <code>-2019</code>), centuries like the 20th century as <code>1901</code> (but the 20th century BCE as <code>-2000</code>), and millenniums like the 3rd millennium as <code>2001</code> (but the 3rd millennium BCE as <code>-3000</code>).

Globe coordinates as literal values must be formatted with forward slashes (i.e. <code>/</code>) between the parts and no symbols (e.g. <code>52/5/3/N/4/19/3/E</code>) ''without any spaces or leading zeros''.

The special type &#39;'''no value'''&#39; can be given by entering the empty string (i.e. <code>&#124;&#124;</code>) and the special type &#39;'''unknown value'''&#39; can be given by entering a single underscore (i.e. <code>&#124;_&#124;</code>). To get a literal underscore, escape it by placing a backslash <code>\</code> directly in front of it (i.e. <code>\_</code>); the same holds for a literal backslash (i.e. <code>\\</code>).

To get a literal vertical bar <code>|</code>, use <code>{{tl|!}}</code> or <code>&amp;#124;</code>.

If this parameter is omitted, then all claims (matching any other constraints) within the property will be accessed.
|-
! style="text-align:left;" | <code>qualifier_id</code>
| '''P-identifier''' (or an available '''[[#Property aliases|alias]]''') of the qualifier within the entity to be accessed, without the <code>Property:</code> prefix (e.g. <code>P580</code>).
|}


=== Named arguments ===
Below follows a description of all named arguments, which are name-value pairs (i.e. <code>|name=value</code>). These are all optional and can be given anywhere {{module other|after the first command|inside the call}}.

{| class="wikitable"
|-
! Argument
! Description
! Command class
|-
! style="text-align:right;" | <code>eid=</code>
| '''<code>{{color|red|[EXPENSIVE]}}</code>''' This argument can be used to give the '''Q-identifier''' (e.g. <code>&#124;eid=Q55</code>) or '''P-identifier''' (or an available '''[[#Property aliases|alias]]''') of the entity to be accessed. It offers the same functionality as the [[#Positional arguments|positional argument <code>entity_id</code>]], with one difference: if the argument is given but its value is left empty (i.e. <code>&#124;eid=</code>), 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 <code>Property:</code> prefix may be omitted for P-identifiers (e.g. <code>&#124;eid=P38</code>) for all commands.

This argument only has effect if the positional argument <code>entity_id</code> is omitted.
| [[#Claim class|claim]], [[#General class|general]]
|-
! style="text-align:right;" | <code>page=</code>
| '''<code>{{color|red|[EXPENSIVE]}}</code>''' This argument can be used to give the '''page title''' (e.g. <code>&#124;page=Netherlands</code>) of the Wikipedia article whose connected item-entity is to be accessed. It behaves similar to the named argument <code>eid=</code> and can be used instead of the [[#Positional arguments|positional argument <code>entity_id</code>]] (note that no prefixed colon, <code>:</code>, is required). If the argument is given but its value is left empty (i.e. <code>&#124;page=</code>), 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 <code>entity_id</code> and the named argument <code>eid=</code> are omitted.
| claim, general
|-
! style="text-align:right;" | <code>date=</code>
| This argument can be used to set a particular date (e.g. <code>&#124;date=1731-02-11</code>) relative to which claim matching using the [[#Configuration flags|<code>future</code>, <code>current</code> and <code>former</code> flags]] is done, instead of relative to today. It overrides the default of these flags to <code>current</code> so that by default only claims that were valid at the given date are returned (based on the claims' qualifiers of {{wpl|P580}} and {{wpl|P582}}).

The date value must be formatted <code>yyyy-mm-dd</code> (e.g. <code>1731-02-11</code>), <code>yyyy-mm</code> (e.g. <code>1731-02</code>) or <code>yyyy</code> (e.g. <code>1731</code>).
| claim
|-
! style="text-align:right;" | <code>''<qualifier>''=</code>
| The <code>''<qualifier>''</code> 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|positional arguments <code>property_id</code> and <code>raw_value</code>]] (that determine access based on property value).

As such, <code>''<qualifier>''</code> is any qualifier's '''P-identifier''' (or an available '''[[#Property aliases|alias]]''') without the <code>Property:</code> prefix (e.g. <code>P518</code>). Its value is either the '''Q-identifier''' equal to one of the qualifier values (e.g. <code>Q27561</code>) 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 <code>raw_value</code>. The special type &#39;'''no value'''&#39; given by the empty string also matches the total absence within the claim of the particular qualifier.

Example: <code>|P518=Q27561</code>

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 sensitivity|case-sensitive]]) are currently available:

{| class="wikitable"
|-
! Alias
! <sub>translates<br /></sub><sup>to</sup>
! P-identifier
|- <!-- property aliases purely for convenience -->
| coord ||style="text-align: center;"| → || [[d:Property:P625|P625]]
|-
!colspan="3"|
|- <!-- property aliases used by the module itself -->
| image ||style="text-align: center;"| → || [[d:Property:P18|P18]]
|-
| author ||style="text-align: center;"| → || [[d:Property:P50|P50]]
|-
| authorNameString ||style="text-align: center;"| → || [[d:Property:P2093|P2093]]
|-
| publisher ||style="text-align: center;"| → || [[d:Property:P123|P123]]
|-
| importedFrom ||style="text-align: center;"| → || [[d:Property:P143|P143]]
|-
| wikimediaImportURL ||style="text-align: center;"| → || [[d:Property:P4656|P4656]]
|-
| statedIn ||style="text-align: center;"| → || [[d:Property:P248|P248]]
|-
| pages ||style="text-align: center;"| → || [[d:Property:P304|P304]]
|-
| language ||style="text-align: center;"| → || [[d:Property:P407|P407]]
|-
| hasPart ||style="text-align: center;"| → || [[d:Property:P527|P527]]
|-
| publicationDate ||style="text-align: center;"| → || [[d:Property:P577|P577]]
|-
| startTime ||style="text-align: center;"| → || [[d:Property:P580|P580]]
|-
| endTime ||style="text-align: center;"| → || [[d:Property:P582|P582]]
|-
| chapter ||style="text-align: center;"| → || [[d:Property:P792|P792]]
|-
| retrieved ||style="text-align: center;"| → || [[d:Property:P813|P813]]
|-
| referenceURL ||style="text-align: center;"| → || [[d:Property:P854|P854]]
|-
| sectionVerseOrParagraph ||style="text-align: center;"| → || [[d:Property:P958|P958]]
|-
| archiveURL ||style="text-align: center;"| → || [[d:Property:P1065|P1065]]
|-
| title ||style="text-align: center;"| → || [[d:Property:P1476|P1476]]
|-
| formatterURL ||style="text-align: center;"| → || [[d:Property:P1630|P1630]]
|-
| quote ||style="text-align: center;"| → || [[d:Property:P1683|P1683]]
|-
| shortName ||style="text-align: center;"| → || [[d:Property:P1813|P1813]]
|-
| definingFormula ||style="text-align: center;"| → || [[d:Property:P2534|P2534]]
|-
| archiveDate ||style="text-align: center;"| → || [[d:Property:P2960|P2960]]
|-
| inferredFrom ||style="text-align: center;"| → || [[d:Property:P3452|P3452]]
|-
| typeOfReference ||style="text-align: center;"| → || [[d:Property:P3865|P3865]]
|-
| column ||style="text-align: center;"| → || [[d:Property:P3903|P3903]]
|-
| subjectNamedAs ||style="text-align: center;"| → || [[d:Property:P1810|P1810]]
|-
| wikidataProperty ||style="text-align: center;"| → || [[d:Property:P1687|P1687]]
|}