Редактирование: Модуль:Wikidata/doc (раздел)

== Кастомизация ==
Поддерживаются три типа параметров-функций, которые дополнительно указывают, как надо форматировать значения:
* <code>property-module</code>, <code>property-function</code> — название модуля и функции модуля, которые отвечают за форматирование вывода массива значений ''свойства'' (statements, claims) с учётом квалификаторов, ссылок и прочего. Например, оформляет множество выводов в таблицу или график. Характерные примеры:
** вывод таблицы и графика населения в {{Tl|wikidata/Population}} и [[Модуль:Wikidata/Population]].
*: Спецификация функции: <code>function p.…( context, options )</code>, поведение по умолчанию: [[Модуль:Wikidata#formatPropertyDefault]].

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

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

=== Заготовки функций ===
{{Скрытый блок
| Заголовок     = property-function
| Содержание    = <syntaxhighlight lang="lua">
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
</syntaxhighlight>
Также см. код метода <code>formatPropertyDefault</code> ниже, в нём присутствует больше проверок и работа параметрами вызова.
}}
{{Скрытый блок
| Заголовок     = claim-function
| Содержание    = <syntaxhighlight lang="lua">
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
</syntaxhighlight>
Также см. код метода <code>formatStatementDefault</code> ниже, в нём есть пример работы с квалификаторами.
}}
{{Скрытый блок
| Заголовок     = value-function
| Содержание    = <syntaxhighlight lang="lua">
function formatSomeValue( context, options, value )
	return value;
end
</syntaxhighlight>
Также см. код метода <code>formatUrlSingle</code> в модуле [[Модуль:URL]].
}}

=== Context API ===
{{Заготовка раздела|описать публичные методы, доступные через <code>context</code>.}}
==== Переменные ====
* <code>entity</code>
* <code>frame</code>

==== Методы ====
* <code>cloneOptions( options )</code>
* <code>getSourcingCircumstances( statement )</code>
* <code>formatProperty( options )</code>
* <code>formatPropertyDefault( context, options )</code>
* <code>formatSnak( options, snak, circumstances )</code>
* <code>formatStatement( options, statement )</code>
* <code>formatStatementDefault( context, options, statement )</code>
* <code>formatRefs( options, statement )</code>
* <code>formatValueDefault( context, options, value )</code>
* <code>parseTimeBoundariesFromSnak( snak )</code>
* <code>parseTimeFromSnak( snak )</code>
* <code>selectClaims( options, propertyId )</code>
* <code>wrapSnak( value, hash, attributes )</code>
* <code>wrapStatement( value, propertyId, claimId, attributes )</code>
* <code>wrapQualifier( value, qualifierId, attributes )</code>

=== Функции для форматирования ===
==== property-function ====
* [[Модуль:Wikidata/date|Wikidata/date]]::formatDateIntervalProperty
* [[Модуль:Wikidata/Medals|Wikidata/Medals]]::formatProperty
* [[Модуль:Wikidata/Software|Wikidata/Software]]::formatVersionProperty
* [[Модуль:Wikidata/P512|Wikidata/P512]]::formatAcademicDegree
* [[Модуль:Wikidata/number|Wikidata/number]]::formatPropertyWithMostRecentClaimAndIndicator
* [[Модуль:Wikidata/number|Wikidata/number]]::formatColorIndex

==== claim-function ====
* [[Модуль:Wikidata/Places|Wikidata/Places]]::formatCountryClaimWithFlag
* [[Модуль:Wikidata/Places|Wikidata/Places]]::formatPlaceWithQualifiers
* [[Модуль:Wikidata/item|Wikidata/item]]::formatEntityWithGenderClaim
* [[Модуль:Wikidata/Biology|Wikidata/Biology]]::formatTaxonNameClaim
* [[Модуль:Wikidata/item|Wikidata/item]]::applyDefaultTemplate
* [[Модуль:Wikidata/date|Wikidata/date]]::formatDateOfBirthClaim
* [[Модуль:Wikidata/date|Wikidata/date]]::formatDateOfDeathClaim

==== value-function ====
* [[Модуль:Wikidata|Wikidata]]::extractCategory
* [[Модуль:Wikidata/link|Wikidata/link]]::fromModule
* [[Модуль:Wikidata/Medals|Wikidata/Medals]]::formatValue
* [[Модуль:Wikidata/media|Wikidata/media]]::formatCommonsCategory
* [[Модуль:Wikidata/Software|Wikidata/Software]]::formatExtension
* [[Модуль:Wikidata/number|Wikidata/number]]::formatRA
* [[Модуль:Wikidata/number|Wikidata/number]]::formatDMS
* [[Модуль:Wikidata/url|Wikidata/url]]::formatUrlValue
* [[Модуль:Wikidata/url|Wikidata/url]]::formatLangRefs