Модуль:Wikidata/doc

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

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

Общие сведения

Функции данного модуля не предназначены для прямого вызова из шаблонов карточек или других модулей, не являющихся функциями расширения данного. Для вызова из шаблонов карточек используйте шаблон {{Wikidata}} или один из специализированных шаблонов для свойств. Для вызова функций Викиданных предназначенных для отображения чаще всего достаточно вызова frame:expandTemplate{} с вызовом шаблона, ответственного за отрисовку свойства. С другой стороны, вызов определённых функций модуля (в основном это касается getEntity()) может в будущем стать предпочтительным. Данный 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) с учётом квалификаторов, ссылок и прочего. Например, оформляет множество выводов в таблицу или график. Характерные примеры:
  • вывод таблицы и графика населения в {{wikidata/Population}} и Модуль:Wikidata/Population.

  Спецификация функции: function p.…( context, options ), поведение по умолчанию: Модуль:Wikidata#formatPropertyDefault.

• claim-module, claim-function — название модуля и функции модуля, которые отвечают за форматирование вывода значения свойства (statement, claim) с учётом квалификаторов, ссылок и прочего. Может, например, дополнительно к основному значению (main snak) вывести значения квалификаторов. Характерные примеры:
  • вывод вышестоящих административных единиц и страны в Модуль:Wikidata/Places;
  • вывод авторов латинского названия и даты публикации в Модуль:Wikidata/Biology;
  • вывод операционной системы и даты релиза в Модуль:Wikidata/Software;
  • вывод количества и даты, на которую оно верно, в Модуль:Wikidata/number;

  Спецификация функции: function p.…( context, options, statement )

• value-module, value-function — название модуля и функции модуля, которые отвечают за форматирование значения (snak, snak data value), в зависимости от контекста, как значений свойства, так и значений квалификатора (если вызывается из claim-module/claim-function). Необходимо для изменения отображения свойства, например, генерации викиссылки вместо простой строки или даже вставки изображения вместо отображения имени файла изображения (так как ссылки на изображения хранятся как строки). Характерные примеры:
  • вывод ссылки на Викисклад в Модуль:Wikidata/media
  • вывод ссылок на внешние сайты в Модуль:Wikidata/link

  Спецификация функции: function p.…( value, options )

Заготовки функций

property-function

function p.formatSomeProperty( context, options )
	local claims = context.selectClaims( options, options.property );
	if claims == nil then
		return ''
	end

	local formattedStatements = {}
	for _, claim in ipairs( claims ) do
		local formattedStatement = context.formatStatement( options, claim )
		-- local formattedStatement = p.formatSomeStatement( context, options, claim )
		if ( formattedStatement and formattedStatement ~= '' ) then
			formattedStatement = context.wrapStatement( formattedStatement, options.property, claim.id )
			table.insert( formattedStatements, formattedStatement )
		end
	end

	return mw.text.listToText( formattedStatements, options.separator, options.conjunction )
end

Также см. код метода formatPropertyDefault ниже, в нём присутствует больше проверок и работа параметрами вызова.

claim-function

function formatSomeClaim( context, options, statement )
	local circumstances = context.getSourcingCircumstances( statement );
	options.qualifiers = statement.qualifiers;
	local result = context.formatSnak( options, statement.mainsnak, circumstances );

	if ( result and result ~= '' and options.references ) then
		result = result .. context.formatRefs( options, statement );
	end

	return result;
end

Также см. код метода formatStatementDefault ниже, в нём есть пример работы с квалификаторами.

value-function

function formatSomeValue( context, options, value )
	return value;
end

Также см. код метода formatUrlSingle в модуле Модуль:URL.

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

• Wikidata/date::formatDateIntervalProperty
• Wikidata/Medals::formatProperty
• Wikidata/Software::formatVersionProperty
• Wikidata/P512::formatAcademicDegree
• Wikidata/number::formatPropertyWithMostRecentClaimAndIndicator
• Wikidata/number::formatColorIndex

claim-function

• Wikidata/Places::formatCountryClaimWithFlag
• Wikidata/Places::formatPlaceWithQualifiers
• Wikidata/item::formatEntityWithGenderClaim
• Wikidata/Biology::formatTaxonNameClaim
• Wikidata/item::applyDefaultTemplate
• Wikidata/date::formatDateOfBirthClaim
• Wikidata/date::formatDateOfDeathClaim

value-function

• Wikidata::extractCategory
• Wikidata/link::fromModule
• Wikidata/Medals::formatValue
• Wikidata/media::formatCommonsCategory
• Wikidata/Software::formatExtension
• Wikidata/number::formatRA
• Wikidata/number::formatDMS
• Wikidata/url::formatUrlValue
• Wikidata/url::formatLangRefs

См. также

• Модуль:Wikibase
• Независимые иноязычные аналоги:
  • fr:Module:Wikidata
  • ca:Mòdul:Wikidades
  • it:Modulo:Wikidata
  • de:Modul:Wikidata
  • en:Module:WikidataIB
  • en:Module:Wd