模组:Wikidata/doc

这是Module:Wikidata的文档页面

此模块的文档不存在、不全面或不能详细描述其功能及/或其代码中的参数。请帮助扩充并改进其文档。

此模块文档被引用于约145,000个页面。
为了避免造成大规模的影响，所有对此模块文档的编辑应先于沙盒或测试样例上测试。
测试后无误的版本可以一次性地加入此模块文档中，但是修改前请务必于讨论页发起讨论。

模板引用数量会自动更新。

此模块文档已评为alpha版，可接受第三方输入，并可用于少量页面以检查是否存在问题，但需要受到检查。欢迎提供新功能或修改其输入输出机制的建议。

英文维基百科中已弃用该模块，并推荐使用Module:WikidataIB或Module:Wd代替。

方法

“Wikidata”模块包含下列方法，将属性ID作为首个参数提供，可从维基数据中检索任何属性的值：

getValue：以wiki内链形式返回值（如果适用）。其他值的输出类似{{#property:}}，但如果值有首选等级则值返回有首选等级的值。与w:ru:Модуль:Wikidata的formatStatements不同，getValue不获取任何参考资料（另见w:en:Module talk:Wikidata/Archive 1#Why the references from Wikidata get dropped?）。
getRawValue：返回的属性值不加内链，数字使用千位分隔符。将数量属性的数值返回为纯数字。其他值的输出类似{{#property:}}，包括一般的值，即使存在首选的值。
getDateValue：返回经过格式化的日期。默认格式[日月年]；可选添加第三个参数来指定格式：[月日, 年]用"mdy"；"my"仅有月和年；"y"则仅有年。A further optional parameter, which must be fourth, such as "BCE", may be added to override the default "BC" that is suffixed for dates BC.
getImages：返回特定属性的所有图像。例如图像 (P18)，基因图谱图像 (P692)等。参数为| propertyID | value / FETCH_WIKIDATA / nil | separator (default=space) | size (default=220px). The returned text will be in the format [[File:Filename | size]] for each image with a selectable size and separator (which may be html). If a property is supplied that is not of type "commonsMedia", it will return empty text.
getUnits：需要将表示数量的一个属性ID作为第一个参数，返回该属性在当前页面上使用的单位的名称。属性非数量类型或者未设置时返回空。如果第二个参数不是"FETCH_WIKIDATA"，则会使用该参数代替从维基数据获取值。
getUnitID：同上，但返回单位的QID。

可以通过以下方法检索维基数据的限定符值（如果存在）：

getQualifierValue：返回有wiki链接（内链）的值，如果适用。
getRawQualifierValue：返回非内链格式的值
getQualifierDateValue：返回格式化后的日期

如果调用此代码的条目在维基数据中没有定义属性，则返回一个空字符串（""）。

其他方法：

pageId：返回当前页面的维基数据ID（QID），如果未链接维基数据则什么也不返回。使用{{#invoke:ResolveEntityId|page}}获取其他页面的QID。
getTAValue：获取P1323属性的TA98值（《解剖学术语》第一版 1998）。它不需要参数，并将其输出构造为列表，每个值都链接到外部资源。这是编写需要返回外部链接的函数的示例。
ViewSomething：获取结构化数据中的任何内容，包括标签、描述、参考资料和跨wiki链接。另见[1]
getSiteLink：获取一个页面在参数指定的某个wiki中的名称（例如"enwikiquote"对应英文维基语录，"arwiki"对应阿拉伯语维基百科）。
Dump: {{#invoke:Wikidata|Dump|claims}} 用来探查结构化数据。参数与ViewSomething相同。仅通过预览查看此调用的结果。这对开发访问数据的Lua脚本大有帮助。如果不带参数使用，会转储所有内容，包括标签、描述、参考资料和跨wiki链接。封装模板另见{{Dump}}。
getImageLegend：返回图像图例（非P18属性，而是P2096属性）。
Call as {{#invoke:Wikidata |getImageLegend | <PARAMETER> | lang=<ISO-639code> |id=<QID>}}

Returns PARAMETER, unless it is equal to "FETCH_WIKIDATA", from Item QID (expensive call). If QID is omitted or blank, the current article is used (not an expensive call). If lang is omitted, it uses the local wiki language, otherwise it uses the provided ISO-639 language code.

The label is returned from the first image with 'preferred' rank; or from the first image with 'normal' rank if no image has preferred rank.
getValueShortName：与getValue返回的数据相同，但尽可能运用简称属性作为标签。这样可以让管道链接首选使用较短的文字标签。如果项没有短名称，则使用普通的标签。

访问其他QID

2015年9月16日起，可以通过其他条目的QID获取其他条目的数据。调用如下：

{{#invoke:Wikidata|getValueFromID|<QID>|<属性>|FETCH_WIKIDATA}}

与getValue相同，但使用一个额外的参数表示要获取属性值的QID。例如：

{{#invoke:Wikidata|getValueFromID|{{Get QID|理查德·伯顿}}|P26|FETCH_WIKIDATA}}

将从本维基百科中的标题为理查德·伯顿的页面对应的维基数据项（理查德·伯顿 (Q151973)）中获取'配偶'（P26）列表，以内链形式展示。

如此，可以在用户命名空间中设置测试环境，但请注意，这些是“高成本”调用，请不要过度使用。

参数

对一般用法（getValue），提供两个未命名参数。第一个是要检索的属性ID（例如P19对应出生地）。第二个参数可能为空、"FETCH_WIKIDATA"，或者将作为返回值的其他字符串。
对于一般的不加内链用法（getRawValue），提供两个未命名参数。第一个是要检索的属性ID（例如P21对应性别）。第二个参数可能为空、"FETCH_WIKIDATA"，或者将作为返回值的其他字符串。
对于一般的日期用法（getDateValue），提供三个未命名参数。第一个是要检索的属性ID（例如P569对应出生日期）。第二个参数可能为空、"FETCH_WIKIDATA"，或者将作为返回值的其他字符串。第三个参数是返回的日期格式，可能为dmy, mdy, my或y（另见实际源码）。

请注意，wikibase调用不再支持小写参数：~~p123~~，因此如果出现问题，检查是否正确使用了大写参数（如P123）。

用法

例子：配偶 (P26)

{{#invoke:Wikidata|getValue|P26|}} = 不返回任何内容
{{#invoke:Wikidata|getValue|P26|FETCH_WIKIDATA}} = 返回内链形式的维基数据中存储的P26（配偶）属性
{{#invoke:Wikidata|getValue|P26|[[Hillary Rodham Clinton]]}} = 返回Hillary Rodham Clinton，即允许信息框使用本地自定义的值代替维基数据中的值。

信息框模板中使用

信息框的定义中可以这样调用：

| data55 = {{#invoke:Wikidata|getValue|P26|{{{spouse|FETCH_WIKIDATA}}} }}

使信息框变为：

信息框参数|spouse设为空（即"| spouse ="）时，不显示spouse
未提供信息框参数|spouse时，根据维基数据内容显示内链形式的一个或多个值
本地提供信息框参数时，显示本地提供的参数|spouse。例如"|spouse = Hillary Rodham Clinton"

另一种方式：

| data55 = {{#invoke:Wikidata|getValue|P26|{{{spouse|}}} }}

使信息框变为：

信息框参数|spouse设为空（即"| spouse ="）时，不显示spouse
未提供信息框参数|spouse时，不显示spouse
本地提供信息框参数时，显示本地提供的参数|spouse。例如"|spouse = Hillary Rodham Clinton"
本地将信息框参数设为FETCH_WIKIDATA时，根据维基数据内容显示内链形式的一个或多个值

另见Module:WikidataIB版本，支持在每个条目上用本地参数定义：不显示的参数（黑名单）；仅从维基数据自动获取哪些参数（白名单）。用它可以修改信息框而不对使用信息框的条目内容和效果产生任何修改，直至在条目中明确启用相应参数。

例子：出生地

方式如上所述：

{{#invoke:Wikidata|getValue|P19|}} = 不返回任何内容
{{#invoke:Wikidata|getValue|P19|FETCH_WIKIDATA}} = 返回内链形式的维基数据中存储的P19（出生地）属性，指向对应条目
{{#invoke:Wikidata|getValue|P19|[[Hope, Arkansas|Hope]]}} = 返回Hope，即允许信息框使用本地自定义的值代替维基数据中的值。

例子：性别

不希望返回内链形式的性别，因此使用：

- {{#invoke:Wikidata|getRawValue|P21|FETCH_WIKIDATA}}

例子：出生日期

使用dmy格式的出生日期则使用：

- {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|dmy}}

使用mdy格式的出生日期则使用：

- {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|mdy}}

仅获取出生年份：

- {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|y}}

获取出生年份（BC）但希望显示为BCE：

- {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|y|BCE}}

例子：链接到一个维基数据项

使用下列代码检索QID：

- {{#invoke:Wikidata|pageId}}

用wiki语法的内链链接到维基数据：

- [[d:{{#invoke:Wikidata|pageId}}|Name of Link]]

例子：链接到另一个wiki页面

链接到另一个wiki站点，此例为英文维基导游：

- [[voy:{{#invoke:Wikidata|getSiteLink|enwikivoyage}}|Name of Link]]

测试

配偶

复制并粘贴下列代码到任何条目并预览（请勿保存！）：

 * - {{#invoke:Wikidata|getValue|P26|}}
 * - {{#invoke:Wikidata|getValue|P26|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P26|[[希拉里·克林顿]]}}

在比尔·克林顿中可以看到：

但在贝拉克·奥巴马中：

在理查德·伯顿中：

-
- Elizabeth Taylor, Sally Burton, Sybil Christopher, Suzy Miller, Elizabeth Taylor
- 希拉里·克林顿

在弗朗茨·卡夫卡中则是：

出生地

复制并粘贴下列代码到任何条目并预览（请勿保存！）：

 * - {{#invoke:Wikidata|getValue|P19|}}
 * - {{#invoke:Wikidata|getValue|P19|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P19|[[纽波特]]}}

在威廉·埃勒里中尝试，看到维基数据如何正确的消歧义。

测试getValue、getRawValue及getDateValue

复制并粘贴下列代码到任何条目并预览（请勿保存！）：

 * - {{#invoke:Wikidata|getValue|P19|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P26|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P27|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getValue|P140|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getRawValue|P21|FETCH_WIKIDATA}}
 * - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|dmy}}
 * - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|mdy}}
 * - {{#invoke:Wikidata|getDateValue|P569|FETCH_WIKIDATA|y}}

如果存在，这分别会返回出生地、配偶、国籍、宗教、性别、出生日期（两种格式）、出生年份。

另见

Module:WikidataIB，用于信息框中处理维基数据