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

2025-07-27T15:38:08Z

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

← Предыдущая версия		Версия от 15:38, 27 июля 2025
(нет различий)

Буквица>D6194c-1cc: /* План разработки */ Вроде всё хорошо

2023-09-03T05:47:22Z

План разработки: Вроде всё хорошо

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

Модуль предназначен для форматирования набора данных, полученных из Викиданных посредством модуля [[Модуль:WDBackend|WDBackend]] или заданных вручную. Форматирование может осуществляться в произвольной форме, как в строчку, так и в табличном виде.

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

== Использование ==
Модуль является библиотечным и предназначен для использования в других модулях. Данный модуль '''не предназначен''' для использования в статьях или других шаблонах напрямую через вызов <code><nowiki>#invoke</nowiki></code>.

Требуемое форматирование описывается профилем, представляющим собой таблицу Lua. Профиль описывает представление отдельных полей, то есть то, как они должны отображаться. Недостающий функционал реализуется указанием в профиле собственных функций, принимающих определённый набор аргументов и возвращающих определённый результат.

Для форматирования профиля в совокупности с передаваемым набором данных необходимо использовать функцию <code>format()</code>. В качестве результата возвращается отформатированный викитекст.

Для примера использования см. модуль [[Модуль:CiteGost]].

=== Формат профиля в общем виде ===
<syntaxhighlight lang="Lua">
{
-- Корневой тег:
tag = {
name = 'Имя тега',
classes = { 'class1', 'class2', ... },
attr = { атрибут1='значение1', атрибут2='значение2', ... },
tag = Вложенный тег,
},
-- Группы:
-- Начало 1-й группы:
{
-- Тег группы:
tag = {
name = 'Имя тега',
classes = { 'class1', 'class2', ... },
attr = { атрибут1='значение1', атрибут2='значение2', ... },
css = { свойство1='значение1', свойство2='значение2', ... },
tag = Вложенный тег
},
ensureEnds = 'Символ/текст, которым должно заканчиваться предыдущее поле',
delimiter = 'Разделитель, добавляемый по отношению к предыдущему полю',
childEnsureEnds = 'Символ/текст, которым должны заканчиваться поля группы',
childDelimiter = 'Разделитель полей в группе',
-- Дочерние элементы текущей группы по факту продолжают предыдущие элементы (влияет на повышение первой буквы до заглавной):
passthrough = true,
prefix = 'Текст до начала группы',
-- Поля группы (подгруппы):
-- 1-е поле группы:
{
-- Тег поля:
tag = {
name = 'Имя тега',
classes = { 'class1', 'class2', ... },
attr = { атрибут1='значение1', атрибут2='значение2', ... },
tag = Вложенный тег
css = { свойство1='значение1', свойство2='значение2', ... },
},
ensureEnds = 'Символ/текст, которым должен заканчиваться предшествующий текст',
delimiter = 'Разделитель, отделяющий текущий элемент от предыдущего',
-- Функция, разрешающая отображение поля:
cond = функция,
prefix = 'Текст до поля',
field = 'Название поля',
-- Менять ли первую букву поля на заглавную
capitalize = true/false
urlMaskProp = 'P-идентификатор свойства, отвечающего за маску ссылки',
-- Функции, через которые поле будет отформатировано:
format = { функция1, функция2, ... },
suffix = 'Текст после поля',
},

-- Второе поле:
{
value = 'Отображаемое значение',
},

-- Остальные группы:
...

suffix = 'Текст в конце группы',
},
-- Остальные группы:
...
ensureEnds = 'Окончение форматированных данных, например, точка.'
}
</syntaxhighlight>

=== Функции форматирования полей ===
Форматирование поля задаётся через команду '''<code>format</code>''' с указанием функции форматирования, принимающей определённый набор аргументов. Доступны следующие встроенные функции:
* '''<code>numericalRanges</code>''' — форматирование диапазона чисел (корректирует знак диапазона);
* '''<code>dash</code>''' — оформление тире в тексте;
* '''<code>unit</code>''' — получение единицы измерения у элемента Викиданных;
* '''<code>abbr</code>''' — получить сокращённое обозначение (есть ограничения) у элемента Викиданных;
* '''<code>short</code>''' — получить короткое название у элемента Викиданных;
* '''<code>abbrWithHint</code>''' — получить сокращённое обозначение (есть ограничения) у элемента Викиданных с расшифровкой в подсказке;
* '''<code>date</code>''' — форматирование даты;
* '''<code>quantity</code>''' — форматирование количества с указанной в нём единицей измерения;
* '''<code>entity</code>''' — получить значение идентификатора элемента Викиданных;
* '''<code>wikilink</code>''' — оформить поле Викиссылкой, если это возможно;
* '''<code>wikisource</code>''' — оформить поле ссылкой на Викитеку, если в элементе Викиданных указана соответствующая статья;
* '''<code>link</code>''' — оформить поле внешней ссылкой, если это возможно;
* '''<code>wikidata</code>''' — добавление к полю надстрочной ссылки на элемент Викиданных, если хотя бы в одном языковом разделе есть статья по теме;
* '''<code>wikidataLink</code>''' — оформить поле ссылкой на элемент Викиданных, который с полем связан.
* '''<code>forceWikidataLink</code>''' — оформить поле ссылкой на элемент Викиданных, который с полем связан. Формирует ссылку, даже если ранее по тексту ссылка на такой элемент была дана.

== Внесение изменений ==
При исправлении ошибки, пожалуйста, сначала добавьте '''тест''', который будет проваливаться из-за обнаруженной '''ошибки''', и только затем вносите исправление. При внесении исправления проверьте, чтобы все тесты проходили. Вносить исправление можно только, если оно не ломает другие тесты.

Добавление нового функционала рекомендуется делать у себя в '''песочнице''', скопировав в неё модуль. В правке копирования необходимо указать тот факт, что делается копирование, и сделать ссылку на оригинальный модуль в виде викитекста. При добавлении нового функционала сначала желательно добавить тест на этот функционал, затем добавить сам функционал, убедившись, что все тесты при этом проходят.

== Тесты ==
{{См. также|{{replace|{{FULLPAGENAME}}|/doc|}}/testcases}}
{{#invoke:{{replace|{{PAGENAME}}|/doc|}}/testcases|run|displayMode=table}}

В качестве интеграционных тестов использованы тесты модуля, который работает на основе текущего модуля.

{{TemplateTester|Модуль:CiteGost/testcases|только проваленные=1}}

== План разработки ==

{{To-do
| содержание =
* Реализовать форматирование сносок, подтверждающих поля.
* Возможность отображения только тех утверждений, которые подтверждены сносками.
* Ограничение количества сносок (по умолчанию 3-мя), подумать о возможности комбинирования сносок в троеточии.
* Сделать демку шаблона (в песочнице) сноски по QID.
* Более подробная документация с примерами.
* Подумать о возможности форматирования группы целиком (объединение полей заглавия и подзаголовка в форматируемую группу, в которую добавится ссылка). По логике, родительская группа будет полем ссылки.
}}

== См. также ==
* [[Модуль:WDBackend|WDBackend]] — модуль получения информации из Викиданных по задаваемой схеме.
* [[Модуль:WDSource|WDSource]] — модуль получения информации об источнике из соответствующего элемента Викиданных.

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

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

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

Буквица>D6194c-1cc: /* План разработки */ Вроде всё хорошо