Модуль:Wikidata/doc

Материал из Партопедии
Перейти к навигации Перейти к поиску

Это страница документации Модуль:Wikidata.

Шаблон:СИШ Шаблон:Module rating Шаблон:TOC right Используется в {{Wikidata}} (см. описания параметров там же). Настраивается при помощи Модуль:Wikidata/config.

Прежде чем вносить какие-либо изменения в данный модуль, просьба оттестировать их в /песочнице. Обратите внимание, что не всё корректно работает в песочнице.

Общие сведения[править]

Функции данного модуля не предназначены для прямого вызова из шаблонов карточек или других модулей, не являющихся функциями расширения данного. Для вызова из шаблонов карточек используйте шаблон {{wikidata}} или один из специализированных шаблонов для свойств. Для вызова функций Викиданных предназначенных для отображения чаще всего достаточно вызова frame:expandTemplate{} с вызовом шаблона, ответственного за отрисовку свойства. С другой стороны, вызов определённых функций модуля (в основном это касается getEntityObject()) может в будущем стать предпочтительным. Данный Lua-функционал в любом случае стоит рассматривать как unstable с точки зрения сохранения совместимости на уровне кода (вместе с соответствующими функциями API для Wikibase Client).

Далее описывается внутренняя документация. Названия функций и параметров могут изменяться. При их изменении автор изменений обязан обновить шаблон {{wikidata}} и специализированные шаблоны свойств. Изменения в других местах, если кто-то всё-таки вызывает функции модуля напрямую, остаются на совести автора «костыля». Итак, при вызове шаблона {{wikidata}} или специализированного шаблона свойства управление отдаётся на функцию formatStatements, которая принимает frame. Из frame достаются следующие опции, которые так или иначе передаются в остальные функции:

  • plain — булевый переключатель (по умолчанию false). Если true, результат совпадает с обычным вызовом {{#property:pNNN}} (по факту им и будет являться)
  • references — булевый переключатель (по умолчанию true). Если true, после вывода значения параметра дополнительно выводит ссылки на источники, указанные в Викиданных. Для вывода используется Модуль:Sources. Обычно отключается для тех свойств, которые являются «самоописываемыми», например, внешними идентификаторами или ссылками (когда такая ссылка является доказательством своей актуальности), например, идентификаторы IMDb.
  • value — значение, которое надо выводить вместо значений из Викиданных (используется, если что-то задано уже в карточке в виде т. н. локального свойства)

По умолчанию модуль поддерживает вывод следующих значений без дополнительных настроек:

  • географические координаты (coordinates)
  • количественные значения (quantity)
  • моноязычный текст (monolingualtext)
  • строки (string)
  • даты (time)

Остальные типы данных требуют указания функции форматирования значения.

Кастомизация[править]

Поддерживаются три типа параметров-функций, которые дополнительно указывают, как надо форматировать значения:

  • property-module, property-function — название модуля и функции модуля, которые отвечают за форматирование вывода массива значений свойства (statements, claims) с учётом квалификаторов, ссылок и прочего. Например, оформляет множество выводов в таблицу или график. Характерные примеры:
    Спецификация функции: function p.…( context, options ), поведение по умолчанию: Модуль:Wikidata#formatPropertyDefault.
  • claim-module, claim-function — название модуля и функции модуля, которые отвечают за форматирование вывода значения свойства (statement, claim) с учётом квалификаторов, ссылок и прочего. Может, например, дополнительно к основному значению (main snak) вывести значения квалификаторов. Характерные примеры:
    Спецификация функции: function p.…( context, statement )
  • value-module, value-function — название модуля и функции модуля, которые отвечают за форматирование значения (snak, snak data value), в зависимости от контекста, как значений свойства, так и значений квалификатора (если вызывается из claim-module/claim-function). Необходимо для изменения отображения свойства, например, генерации викиссылки вместо простой строки или даже вставки изображения вместо отображения имени файла изображения (так как ссылки на изображения хранятся как строки). Характерные примеры:
    Спецификация функции: function p.…( value, options )

Заготовки функций[править]

Шаблон:Скрытый Шаблон:Скрытый Шаблон:Скрытый

Context API[править]

Шаблон:Заготовка раздела

Переменные[править]

  • entity
  • frame

Методы[править]

  • cloneOptions( options )
  • getSourcingCircumstances( statement )
  • formatProperty( options )
  • formatPropertyDefault( context, options )
  • formatSnak( options, snak, circumstances )
  • formatStatement( options, statement )
  • formatStatementDefault( context, options, statement )
  • formatRefs( options, statement )
  • formatValueDefault( context, options, value )
  • parseTimeBoundariesFromSnak( snak )
  • parseTimeFromSnak( snak )
  • selectClaims( options, propertyId )
  • wrapSnak( value, hash, attributes )
  • wrapStatement( value, propertyId, claimId, attributes )
  • wrapQualifier( value, qualifierId, attributes )

Функции для форматирования[править]

property-function[править]

claim-function[править]

value-function[править]

См. также[править]