Импортёр: 1 версия импортирована

2024-05-01T10:26:42Z

1 версия импортирована

← Предыдущая версия	Версия от 13:26, 1 мая 2024
(нет различий)

ru>Andras в 13:32, 12 февраля 2024

2024-02-12T13:32:31Z

Новая страница

== Назначение ==
В модуле собираются сервисные фукнции, связанные с чтением Викиданных.


== Функции, доступные из вики-разметки ==
=== label() ===
; Описание
: Возвращает метку свойства или элемента Викиданных на указанном языке. Если на указанном языке метки нет, возвращается метка на английском. Если нет метки и на английском, возвращается «нет метки» (константа MSG_NO_LABEL). Если указать несуществующее свойство или элемент Викиданных, будет сгенерирована ошибка Lua (см. константы ERRMSG_PROPERTY_NOT_FOUND, ERRMSG_ITEM_NOT_FOUND и ERRMSG_ENTITY_NOT_FOUND). Для элементов-перенаправлений возвращается метка элемента, на который оно указывает.
: Функция используется в шаблоне {{Tl|WD label}}.
; Использование
: <nowiki>{{</nowiki>#invoke:WD|label|''идентификатор''|''язык''<nowiki>}}</nowiki>

Параметры:
* ''идентификатор'' — идентификатор свойства (Pxxx или pxxx) или элемента Викиданных (Qxxx или qxxx);
* ''язык'' — двухбуквенный код языка (ru, en, de и т. д.).

Примеры для свойств:
* <nowiki>{{#invoke:WD|label|P569|ru}}</nowiki> → {{#invoke:WD|label|P569|ru}}
* <nowiki>{{#invoke:WD|label|P569|en}}</nowiki> → {{#invoke:WD|label|P569|en}}
* <nowiki>{{#invoke:WD|label|P569|de}}</nowiki> → {{#invoke:WD|label|P569|de}}
* <nowiki>{{#invoke:WD|label|P569|la}}</nowiki> → {{#invoke:WD|label|P569|la}}
* <nowiki>{{#invoke:WD|label|P97|ru}}</nowiki> → {{#invoke:WD|label|P97|ru}}
* <nowiki>{{#invoke:WD|label|P97|en}}</nowiki> → {{#invoke:WD|label|P97|en}}
* <nowiki>{{#invoke:WD|label|P97|la}}</nowiki> (нет метки на латыни) → {{#invoke:WD|label|P97|la}}

Примеры для элементов:
* <nowiki>{{#invoke:WD|label|Q2|ru}}</nowiki> → {{#invoke:WD|label|Q2|ru}}
* <nowiki>{{#invoke:WD|label|Q2|en}}</nowiki> → {{#invoke:WD|label|Q2|en}}
* <nowiki>{{#invoke:WD|label|Q2|de}}</nowiki> → {{#invoke:WD|label|Q2|de}}
* <nowiki>{{#invoke:WD|label|Q2|la}}</nowiki> → {{#invoke:WD|label|Q2|la}}
* <nowiki>{{#invoke:WD|label|Q8258093|ru}}</nowiki> (перенаправление Q8258093 → Q6305566) → {{#invoke:WD|label|Q8258093|ru}}

Примеры ошибок:
* <nowiki>{{#invoke:WD|label|P999999|ru}}</nowiki> (несуществующее свойство) → ошибка Lua «свойство P999999 не найдено»
* <nowiki>{{#invoke:WD|label|Q6|ru}}</nowiki> (несуществующий элемент) → ошибка Lua «элемент Q6 не найден»
* <nowiki>{{#invoke:WD|label|BOND007|ru}}</nowiki> (неверный идентификатор) → ошибка Lua «Введённый идентификатор не известен системе. Используйте один из действующих идентификаторов сущностей»

=== description() ===
; Описание
: Возвращает описание свойства или элемента Викиданных на указанном языке. Если на указанном языке описания нет, возвращается описание на английском. Если нет описания и на английском, возвращается «нет описания» (константа MSG_NO_DESCRIPTION). Если указать несуществующее свойство или элемент Викиданных, будет сгенерирована ошибка Lua (см. константы ERRMSG_PROPERTY_NOT_FOUND, ERRMSG_ITEM_NOT_FOUND и ERRMSG_ENTITY_NOT_FOUND). Для элементов-перенаправлений возвращается описание элемента, на который оно указывает.
: Функция используется в шаблоне {{Tl|WD description}}.
; Использование
: <nowiki>{{</nowiki>#invoke:WD|description|''идентификатор''|''язык''<nowiki>}}</nowiki>

Параметры:
* ''идентификатор'' — идентификатор свойства (Pxxx или pxxx) или элемента Викиданных (Qxxx или qxxx);
* ''язык'' — двухбуквенный код языка (ru, en, de и т. д.).

Примеры для свойств:
* <nowiki>{{#invoke:WD|description|P569|ru}}</nowiki> → {{#invoke:WD|description|P569|ru}}
* <nowiki>{{#invoke:WD|description|P569|en}}</nowiki> → {{#invoke:WD|description|P569|en}}
* <nowiki>{{#invoke:WD|description|P569|de}}</nowiki> → {{#invoke:WD|description|P569|de}}
* <nowiki>{{#invoke:WD|description|P97|ru}}</nowiki> → {{#invoke:WD|description|P97|ru}}
* <nowiki>{{#invoke:WD|description|P97|en}}</nowiki> → {{#invoke:WD|description|P97|en}}
* <nowiki>{{#invoke:WD|description|P97|la}}</nowiki> (нет описания на латыни) → {{#invoke:WD|description|P97|la}}

Примеры для элементов:
* <nowiki>{{#invoke:WD|description|Q2|ru}}</nowiki> → {{#invoke:WD|description|Q2|ru}}
* <nowiki>{{#invoke:WD|description|Q2|en}}</nowiki> → {{#invoke:WD|description|Q2|en}}
* <nowiki>{{#invoke:WD|description|Q2|de}}</nowiki> → {{#invoke:WD|description|Q2|de}}
* <nowiki>{{#invoke:WD|description|Q2|la}}</nowiki> (нет описания на латыни) → {{#invoke:WD|description|Q2|la}}
* <nowiki>{{#invoke:WD|description|Q8258093|ru}}</nowiki> (перенаправление Q8258093 → Q6305566) → {{#invoke:WD|description|Q8258093|ru}}

Примеры ошибок:
* <nowiki>{{#invoke:WD|description|P999999|ru}}</nowiki> (несуществующее свойство) → ошибка Lua «свойство P999999 не найдено»
* <nowiki>{{#invoke:WD|description|Q6|ru}}</nowiki> (несуществующий элемент) → ошибка Lua «элемент Q6 не найден»
* <nowiki>{{#invoke:WD|description|BOND007|ru}}</nowiki> (неверный идентификатор) → ошибка Lua «Введённый идентификатор не известен системе. Используйте один из действующих идентификаторов сущностей»

=== datatype() ===
; Описание
: Возвращает тип данных свойства Викиданных (одно из значений констант DT_xxx). Если свойство не найдено или функции передан идентификатор элемента, генерируется ошибка Lua (константа ERRMSG_PROPERTY_NOT_FOUND).
; Использование
: <nowiki>{{</nowiki>#invoke:WD|datatype|''идентификатор''<nowiki>}}</nowiki>

Примеры:
* <nowiki>{{#invoke:WD|datatype|P31}}</nowiki> → {{#invoke:WD|datatype|P31}}
* <nowiki>{{#invoke:WD|datatype|P1687}}</nowiki> → {{#invoke:WD|datatype|P1687}}
* <nowiki>{{#invoke:WD|datatype|P304}}</nowiki> → {{#invoke:WD|datatype|P304}}
* <nowiki>{{#invoke:WD|datatype|P1476}}</nowiki> → {{#invoke:WD|datatype|P1476}}
* <nowiki>{{#invoke:WD|datatype|P18}}</nowiki> → {{#invoke:WD|datatype|P18}}
* <nowiki>{{#invoke:WD|datatype|P854}}</nowiki> → {{#invoke:WD|datatype|P854}}
* <nowiki>{{#invoke:WD|datatype|P569}}</nowiki> → {{#invoke:WD|datatype|P569}}
* <nowiki>{{#invoke:WD|datatype|P625}}</nowiki> → {{#invoke:WD|datatype|P625}}
* <nowiki>{{#invoke:WD|datatype|P2067}}</nowiki> → {{#invoke:WD|datatype|P2067}}

Примеры ошибок:
* <nowiki>{{#invoke:WD|datatype|P999999}}</nowiki> (несуществующее свойство) → ошибка Lua «свойство P999999 не найдено»
* <nowiki>{{#invoke:WD|datatype|Q2}}</nowiki> (элемент) → ошибка Lua «свойство Q2 не найдено»
* <nowiki>{{#invoke:WD|datatype|BOND007}}</nowiki> (неверный идентификатор) → ошибка Lua «Введённый идентификатор не известен системе. Используйте один из действующих идентификаторов сущностей»

=== format_property() ===
; Описание
: Для указанного свойства Викиданных возвращает ссылку на него в виде <nowiki>[[:d:Property:Pxxx|<метка> (Pxxx)]]</nowiki> с меткой на указанном языке. Если на указанном языке метки нет, используется метка на английском. Если нет метки и на английском, вместо неё используется «нет метки». Если свойство не найдено или функции передан идентификатор элемента, генерируется ошибка Lua (константа ERRMSG_PROPERTY_NOT_FOUND).
: Функция используется в шаблоне {{Tl|WD property}}
; Использование
: <nowiki>{{</nowiki>#invoke:WD|format_property|''идентификатор''|''язык''<nowiki>}}</nowiki>

Параметры:
* ''идентификатор'' — идентификатор свойства Викиданных (Pxxx или pxxx);
* ''язык'' — двухбуквенный код языка (ru, en, de и т. д.).

Примеры:
* <nowiki>{{#invoke:WD|format_property|P569|ru}}</nowiki> → {{#invoke:WD|format_property|P569|ru}}
* <nowiki>{{#invoke:WD|format_property|P569|en}}</nowiki> → {{#invoke:WD|format_property|P569|en}}
* <nowiki>{{#invoke:WD|format_property|P569|de}}</nowiki> → {{#invoke:WD|format_property|P569|de}}
* <nowiki>{{#invoke:WD|format_property|P569|la}}</nowiki> → {{#invoke:WD|format_property|P569|la}}
* <nowiki>{{#invoke:WD|format_property|P97|ru}}</nowiki> → {{#invoke:WD|format_property|P97|ru}}
* <nowiki>{{#invoke:WD|format_property|P97|en}}</nowiki> → {{#invoke:WD|format_property|P97|en}}
* <nowiki>{{#invoke:WD|format_property|P97|la}}</nowiki> (нет метки на латыни) → {{#invoke:WD|format_property|P97|la}}

Примеры ошибок:
* <nowiki>{{#invoke:WD|format_property|P999999|ru}}</nowiki> (несуществующее свойство) → ошибка Lua «свойство P999999 не найдено»
* <nowiki>{{#invoke:WD|format_property|Q2|ru}}</nowiki> (не свойство) → ошибка Lua «свойство Q2 не найдено»
* <nowiki>{{#invoke:WD|format_property|BOND007|ru}}</nowiki> (неверный идентификатор) → ошибка Lua «Введённый идентификатор не известен системе. Используйте один из действующих идентификаторов сущностей»

=== format_item() ===
; Описание
: Для указанного элемента Викиданных возвращает ссылку на него в виде <nowiki>[[:d:Qxxx|<метка> (Qxxx)]]</nowiki> с меткой на указанном языке. Если на указанном языке метки нет, используется метка на английском. Если нет метки и на английском, вместо неё используется «нет метки». Если элемент не найден или функции передан идентификатор свойства, генерируется ошибка Lua (константа ERRMSG_ITEM_NOT_FOUND). Для элементов-перенаправлений возвращается ссылка метка и идентификатор на того элемента, на который оно указывает.
: Функция используется в шаблоне {{Tl|WD item}}.
; Использование
: <nowiki>{{</nowiki>#invoke:WD|format_item|''идентификатор''|''язык''<nowiki>}}</nowiki>

Параметры:
* ''идентификатор'' — идентификатор элемента Викиданных (Qxxx или qxxx);
* ''язык'' — двухбуквенный код языка (ru, en, de и т. д.).

Примеры:
* <nowiki>{{#invoke:WD|format_item|Q2|ru}}</nowiki> → {{#invoke:WD|format_item|Q2|ru}}
* <nowiki>{{#invoke:WD|format_item|Q2|en}}</nowiki> → {{#invoke:WD|format_item|Q2|en}}
* <nowiki>{{#invoke:WD|format_item|Q2|de}}</nowiki> → {{#invoke:WD|format_item|Q2|de}}
* <nowiki>{{#invoke:WD|format_item|Q2|la}}</nowiki> → {{#invoke:WD|format_item|Q2|la}}
* <nowiki>{{#invoke:WD|format_item|Q8258093|ru}}</nowiki> (перенаправление Q8258093 → Q6305566) → {{#invoke:WD|format_item|Q8258093|ru}}

Примеры ошибок:
* <nowiki>{{#invoke:WD|format_item|Q6|ru}}</nowiki> (несуществующий элемент) → ошибка Lua «элемент Q6 не найден»
* <nowiki>{{#invoke:WD|format_item|P569|ru}}</nowiki> (не элемент) → ошибка Lua «элемент P569 не найден»
* <nowiki>{{#invoke:WD|format_item|BOND007|ru}}</nowiki> (неверный идентификатор) → ошибка Lua «Введённый идентификатор не известен системе. Используйте один из действующих идентификаторов сущностей»

=== dump_entity() ===
; Описание
:Отладочная функция, позволяющая показать значение в формате JSON, возвращаемое функцией <code>mw.wikibase.getEntity()</code> для указанного элемента или свойства Викиданных.
; Использование
: <nowiki>{{</nowiki>#invoke:WD|dump_entity|''идентификатор''<nowiki>}}</nowiki>

Параметр:
* ''идентификатор'' — идентификатор свойства (Pxxx или pxxx) или элемента Викиданных (Qxxx или qxxx).

Примеры (из-за объёмности вывода результат не показан, чтобы увидеть его, используйте [[Служебная:Песочница для шаблонов]]):
* <nowiki>{{#invoke:WD|dump_entity|P569}}</nowiki>
* <nowiki>{{#invoke:WD|dump_entity|Q2188189}}</nowiki>

=== dump_sitelinks() ===
; Описание
: Отладочная функция, позволяющая показать ссылки в формате JSON для указанного элемента Викиданных.
; Использование
: <nowiki>{{</nowiki>#invoke:WD|dump_sitelinks|''идентификатор''<nowiki>}}</nowiki>

Параметр:
* ''идентификатор'' — идентификатор элемента Викиданных (Qxxx или qxxx).

Пример:
*

{| class="standard"
! Вызов || Результат
|-
| <nowiki>{{#invoke:WD|dump_sitelinks|Q15920521}}</nowiki> || {{#invoke:WD|dump_sitelinks|Q15920521}}
|-
| <nowiki>{{#invoke:WD|dump_sitelinks|Q4100335}}</nowiki> || class="plainlinks" | {{#invoke:WD|dump_sitelinks|Q4100335}}
|-
| <nowiki>{{#invoke:WD|dump_sitelinks|Q644102}}</nowiki> || class="plainlinks" | {{#invoke:WD|dump_sitelinks|Q644102}}
|-
|}

=== dump_statements() ===
; Описание
: Отладочная функция, позволяющая показать утверждения данного свойства в формате JSON для указанного элемента или свойства Викиданных.
; Использование
: <nowiki>{{</nowiki>#invoke:WD|dump_statements|''идентификатор''|''свойство''<nowiki>}}</nowiki>

Параметры:
* ''идентификатор'' — идентификатор свойства (Pxxx или pxxx) или элемента Викиданных (Qxxx или qxxx);
* ''свойство'' — идентификатор свойства (Pxxx или pxxx), значение которого надо показать.

Примеры:
{| class="standard"
! Вызов || Результат
|-
| <nowiki>{{#invoke:WD|dump_statements|Q359|P856}}</nowiki> || class="plainlinks" | {{#invoke:WD|dump_statements|Q359|P856}}
|-
| <nowiki>{{#invoke:WD|dump_statements|P527|P1696}}</nowiki> || {{#invoke:WD|dump_statements|P527|P1696}}
|-
| <nowiki>{{#invoke:WD|dump_statements|Q15920521|P1476}}</nowiki> || {{#invoke:WD|dump_statements|Q15920521|P1476}}
|-
| <nowiki>{{#invoke:WD|dump_statements|Q4100335|P570}}</nowiki> || class="plainlinks" | {{#invoke:WD|dump_statements|Q4100335|P570}}
|-
|}

== Функции, доступные из других модулей ==
=== is_property() ===
…

=== is_item() ===
…

=== is_statement() ===
…

=== get_statement_value() ===
…

=== get_item_id() ===
…

=== get_item_qid() ===
…

=== has_valid_item_value() ===
…

=== get_label() ===
…

=== get_description() ===
…

=== get_sitelink() ===
…

=== get_sitelink_by_lang() ===
…

=== table_to_string() ===
…

<includeonly>[[Категория:Модули:Викиданные]]</includeonly>
<noinclude>
[[Категория:Модули:Документация]]</noinclude>

Модуль:WD/doc - История изменений

Импортёр: 1 версия импортирована

ru>Andras в 13:32, 12 февраля 2024