テンプレート:Wd/doc

これはテンプレート:Wdの解説サブページです。
使用方法、カテゴリ、およびその他テンプレート自体に含まれない情報を収容しています。

Luaモジュールを使用しています:

Module:Wd

このテンプレートを使ってウィキデータからデータを取得できます。ウィキペディアの記事に関連付けられたウィキデータ項目だけでなく、関連付けられていないウィキデータ項目からも取得可能など、様々な機能を持っています。

用法

{{wdテンプレート:0テンプレート:Background colorテンプレート:0テンプレート:Background colorテンプレート:0テンプレート:Background colorテンプレート:0テンプレート:Background color}}

コマンド

コマンド(テンプレート:Background color, テンプレート:Background color, ...)はどのような値が返却されるかを決定します。

値クラス

値クラスのコマンドは組み合わせることができます。すなわち、このクラスの異なる種別の複数のコマンドを同時に与えることができます。

返された情報の断片をそれぞれ全て確認するためには、コマンドを個々にこのテンプレートに対して複数回呼び出すのではなく、複数のコマンドを組み合わせてこのテンプレートを１回呼び出すようにしてください。

種別	コマンド	戻り値	基本的な用法	説明
1	`property`	最初に一致したもの*	`{{wd\|property\|P1}}`	現在の項目エンティティまたは与えられたエンティティから、要求されたプロパティ（あるいはプロパティのリスト）を返します。
1	`properties`	一致したもの全て	`{{wd\|properties\|P1}}`	現在の項目エンティティまたは与えられたエンティティから、要求されたプロパティ（あるいはプロパティのリスト）を返します。

2	`qualifier`	最初に一致したもの*	`{{wd\|qualifier\|P1\|P2}}`	現在の項目エンティティまたは与えられたエンティティの与えられたプロパティから、要求された修飾子（あるいは修飾子のリスト）を返します。他の値クラスのコマンドとは異なり、このコマンドは１回の呼び出しで複数回与えて異なる修飾子を参照することができます。
2	`qualifiers`	一致したもの全て	`{{wd\|qualifiers\|P1\|P2}}`

3	`reference`	最初に一致したもの*	`{{wd\|reference\|P1}}`	現在の項目エンティティあるいは与えられたエンティティの与えられたプロパティから、出典（あるいは出典のリスト）を返します。
3	`references`	一致したもの全て	`{{wd\|references\|P1}}`

* （複数の主張あるいは文が一致した場合）複数の値の代わりに単一の値を返します。返された値はランクがいちばん高い主張の中から最初に見つかったものです。

名前クラス

名前クラスは組み合わせることができません。

Name class

The name class commands cannot be combined.

タイプ	コマンド	出力	基本的な用法	説明
I	`label`		`{{wd\|label}}`	現在の項目エンティティまたは与えられたエンティティのラベルを返します。ラベルを持たない項目エンティティの場合は、リンクされたページのタイトルがあれば代わりに返されます。

II	`title`		`{{wd\|title}}`	現在の項目エンティティまたは与えられた項目エンティティにリンクされたページのタイトルがあればそれを返します。項目エンティティのラベルが代わりに返されることはありません。

III	`alias`	最初のひとつ*	`{{wd\|alias}}`	現在の項目エンティティまたは与えられた項目エンティティの別名・エイリアス（のリスト）を返します。
III	`aliases`	すべて	`{{wd\|aliases}}`	現在の項目エンティティまたは与えられた項目エンティティの別名・エイリアス（のリスト）を返します。

* （複数の別名が登録されている場合に）すべてではなく一つだけを返します

フラグ

以下の（オプション）のフラグはこのテンプレートの振る舞いを変えるのに利用できます。フラグは（最初の）テンプレート:Background colorの後、他のテンプレート:Background colorの前に与えられなければなりません。利便性のために、空のフラグ(すなわち ||)も許可されていますが単に無視されます。

コマンドフラグ

これらのフラグ(テンプレート:Background color, テンプレート:Background color, ...)は直前に記述されたコマンドに直接適用されます。

フラグ	説明
`linked`	そのプロパティや修飾子に接続されたウィキペディア記事があれば、それへのリンクを作成します。値に追加されている測定単位があれば、それにもリンクします。パラメータ省略時はリンクの無いプロパティまたは修飾子が返されます。
`short`	`[EXPENSIVE]` 返された任意のエンティティに短縮名があれば(P1813)を返します。そうでない場合は、エンティティのラベルを返す時のデフォルトの振る舞いとなります。
`raw`	利用できるものがあれば、生の値を返します。このフラグが項目あるいはプロパティのデータ種別で使用された場合は、Q識別子あるいはP識別子を返します。数量のデータ種別に対しては、このフラグは測定単位を除去します。このフラグが日時のデータ種別で使用された場合、返された日付は`年-月-日` (例 `1731-2-11`)の形式になります。日の精度でストアされたユリウス暦の日付には出力 (例：`1731-2-11/Julian`、`{{#titleparts}}` template functionを使って分割されている場合がある)に付加された`/Julian`を持っています。世界座標のデータ種別が使われている場合は、返された値(例：`52/5/3/N/4/19/3/E`、`{{#titleparts}}` template functionを使って複数の部分に分割されている場合がある)の中の様々なシンボルをスラッシュで置き換えます。
`multilanguage`	現在のウィキの言語だけでなく、任意の利用可能な言語で出力を与えます。

コンフィグレーションフラグ

これらのフラグ(テンプレート:Background color)は全般的なコンフィグレーションフラグで、最初のコマンドの後（かつ他の引数の前）であればどこに置いても構いません。

	フラグ	説明
組合せ可能：	`preferred`	選択された主張に対するランク制約をセットします。最初の3つはどの主張を選択するか、ランクをセットします。オプションで、`+`や`-`をつけて、例：`normal+`あるいは `preferred-`、ひとつ目は「標準」ランクあるいはそれ以上を選択し、２つ目は「推奨」ランクあるいはそれ以下の主張を選択します。全ランクの主張を取得するには、`preferred-`あるいは`deprecated+`を使用してください。追加で`best`フラグが与えられた場合は、選択された主張の中から最も高いランクを持つものだけが返されます。デフォルトは`normal+\|best`(このためデフォルトでは「非推奨」ランクの主張は返されません)です。出力は(どのフラグがセットされていても)常に高いランクから低いものにソートされます。
	`normal`
	`deprecated`
	`best`
組合せ可能：	`future`	選択された主張に日時制約をセットします。主張の「開始日時」(P580)及び「終了日時」(P582)修飾子を使用して、選択された期間に対して妥当かどうか判断します。デフォルトは`future\|current\|former`(このためデフォルトで任意の期間に対して妥当な主張が返されます)です。
	`current`
	`former`
択一：	`edit`	返されたウィキデータ上の主張を読者が編集するのに使用するであろう、出力の後のクリックできるアイコンを追加します。もし`edit@end`が使われている場合、infobox内での整形のためにアイコンは行の終端に置かれます。
択一：	`edit@end`
	`mdy`	日付値を日-月-年の順の代わりに、月-日-年の順で返します。
	`single`	複数（複数の主張が一致した場合）ではなく、単一の主張を返します。`property`/`properties`コマンドが与えられている場合には無意味であり、このフラグは冗長です。
	`sourced`	少なくともひとつの妥当な出典を持つ主張だけを返します。

引数

引数は全ての戻り値の取得元の情報源を決定します。

順番付き引数

次の表は利用可能な順番付き引数(テンプレート:Background color)をその固定された順に示しています。各コマンドには、利用可能な引数のセットがマークされています。複数のコマンドが与えられた場合は、利用可能なセットは個々のセットを連結したものになります。例えば、propertiesとqualifiersコマンドが与えられた場合、少なくともproperty_id及びqualifier_id引数の両方が同様に与えられるべきです。

ひとつ以上のqualifier/qualifiersコマンドを与えることができます。フラグを持つこれらのコマンド内で与えられている順番は、個々のqualifier_id引数が与えられている順番に一致します。

	(必須)	(オプション)	(オプション)	(必須)	(オプション)	(必須)	(必須)

`{{wd`	`コマンド`	`フラグ`	`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.)

以下は全ての引数の説明です。

引数	説明
`entity_id` (オプション)	`[EXPENSIVE]` アクセスすべき項目エンティティのQ識別子(例：`Q55`)、または`Property:`接頭辞(例：`Property:P38`)があるアクセスすべきプロパティエンティティのP識別子 (あるいは利用可能な別名)。 `label`コマンドの場合は、the `Property:`接頭辞は prefix may be omitted for P識別子用(例：`P38`)には省略される場合があります。このパラメータが省略された場合、現在のページに接続してる項目エンティティが使用されます。
`property_id`	アクセスすべきエンティティ内のプロパティのP識別子 (または利用可能な別名)で、`Property:`接頭辞の無いもの(例：`P35`)。
`raw_value` (オプション)	Q識別子がプロパティ値(例：`Q29574`)に等しいか、あるいはリテラル値 (すなわち文字列あるいは数値など、非項目ラベル)がアクセスすべき特定の主張の生プロパティ値に等しいか。 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. `\\`). このパラメータが省略された場合、プロパティ内の全ての主張(任意の他の制約に一致するもの)がアクセスされます。
`qualifier_id`	アクセスすべきエンティティ内の修飾子のP識別子 (あるいは利用可能な別名)で、`Property:`接頭辞(例：`P580`)を持たない。

名前付き引数

名前付き引数は識別子の値に基いてどの主張にアクセスするか決定します。これはプロパティ値に基いてアクセスを決定する順番付き引数 property_id及びraw_valueのペアと類似しています。

名前付き引数は名前-値のペア|qualifier=valueで、呼び出し内部のどこでも、以下の条件の下で与えることができます：

qualifierは修飾子のP識別子 (あるいは利用可能な別名)でProperty: 接頭辞(例：P518)を持ちません;
valueはQ識別子が修飾子の値のひとつ(例：Q27561)に等しいか、またはリテラル値 (すなわち文字列や数字など、非項目ラベル)がアクセスすべき特定の主張の生の修飾子の値のひとつに等しい。値の形式は順番付き引数raw_value用のものと同じです。空の文字列で与えられる特別な種別 '値なし' は、特定の修飾子の主張内に全く無い場合にも一致します。

例：|P518=Q27561

複数の名前付き引数は、主張ごとに同時に複数の修飾子の値に一致するように与えることができます。

プロパティ別名

プロパティ別名はP識別子の代わりに使える別の名前です。以下のプロパティ別名(大文字小文字を区別)が現在利用できます:

別名	_読み替え^先	P識別子
coord	→	P625

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

高度な用法

値クラスコマンドによる出力のレイアウトは多数ある名前付きフラグを使ってカスタマイズできます。これは名前と値のペア(すなわち|flag=value)です。下記の表に利用可能な名前付きフラグが示されています。

名前付きフラグは呼び出しの中のどこでも与えることができます。valueの先頭または終端に空白を挿入するには、アンダースコア_を使います。リテラルのアンダースコアを取得するには、その前に直接バックスラッシュ\を置くこと(すなわち\_)でエスケープします; リテラルのバックスラッシュ(すなわち\\)用にも保持されます。

名前付きフラグデフォルト値デフォルト条件説明

format=

%p[%s][%r]

property/propertiesコマンドが与えられておりかつqualifier/qualifiersコマンドが与えられていない場合

単一の主張のフォーマット。利用可能なパラメータは以下の通り。

パラメータ	説明
`%p`	`property`/`properties`コマンドが適用されたその主張のプロパティ値。
`%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= テンプレート:Dfn default The fixed separator between each pair of claims.

テンプレート: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=, ...

テンプレート: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=

テンプレート: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.

テンプレート:Dfn if more than one qualifier/qualifiers command was given

sep%r= テンプレート:Dfn default The separator between each pair of references of a single claim. This is the value separator for the %r parameter.

テンプレート:Dfn if the raw flag was given for the reference/references command

punc=

テンプレート:Dfn