Шаблон:ChangelogItem

Описание

Что делает

Шаблон генерирует строку для чейндждога. В content можно вставить форматированный текст, рисунки и галереи рисунков.

Как это работает. Шаблон получает в версию и дату изменения, в models перечень затронутых изменением моделей через запятую, а в content информацию об изменении. В результате генерирутся несколько форматированных строк, которые вставляются в страницу, откуда был вызван шаблон.

Кроме этого, если страницу, куда был вставлен шаблон, вызвать с параметром-моделью, то шаблон ChangelogItem выведет только те изменения, которые затрагивают это устройство. Таким образом формируется список изменений для модели. Можно передать только одну модель.

Проверка ошибок. Так же для каждой линейки есть инклюд с перечнем поделей, который вставлен в общий список изменений, чтобы было удобно копировать названия, а ещё с использованием этого инклюда происходит проверка написания модели. Если модель написана неверно, снизу пункта будет выведено текущее написание, окрашенное в красный цвет. Для проверки используется Шаблон: Check, который ищет по инклюду Wbincludes: CheckModels.

Живые примеры использования

Реле:

• Wbincludes: WB-MR Models — список моделей реле
• Wbincludes:WB-MR: Changelog — общий список изменений в прошивке для всех реле
• WB-MR6C v.3: Changelog — страница со списком изменений в прошивке реле WB-MR6C v.3

Программисту

Что делать

Так как списки изменений разбиты по типам устройств (реле, датчики и т.п.), то надо определиться, куда мы будем писать изменения, потом:

1. Открыть инклюд общего списка изменения для нужного типа устройств, список инклюдов.
2. Внести по образцу новый пункт, указать:
   • release — статус прошивки testing/stable
   • version — версия прошивки
   • date — дата выпуска прошивки в русском формате ДД.ММ.ГГГГ
   • models — наименования затронутых моделей через запятую с подчеркиванием на конце, например, WB-MR6C_
   • content — описание изменения, можно использовать форматированный текст, картинки и галереи.

Параметр {{{1}}} не удалять — это для индивидуального списка.

Стараемся выдержать одинаковый стиль: добавлено, исправлено и т.п. Если где-то написано по-другому — поправь.

Прошивка из testing

Пример:

{{ChangelogItem
| {{{1}}}
| release = testing
| version = 1.18.4
| date = 26.04.2022
| models = WB-MR6C_, WB-MR6C v.2_, WB-MR6C v.3_
| content=
Добработка безопасного режима
}}

Запись о тестовой версии прошивки

Прошивка из stable

То же самое, что и для testing, но нужно указать release = stable:

{{ChangelogItem
| {{{1}}}
| release = stable
| version = 1.18.4
| date = 26.04.2022
| models = WB-MR6C_, WB-MR6C v.2_, WB-MR6C v.3_
| content=
Добработка безопасного режима
}}

Запись о стабильной версии прошивки

Готовый список моделей

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

Список моделей для реле

Обработка ошибок в названии модели

Если модель указана неверно, она будет продублирована под описанием изменения и окрашена в красный цвет.

В названии модели ошибка

Техписателю

При выходе новой модели устройства:

1. Добавить название модели в инклюд, по которому происходит проверка правильности написания модели. Список инклюдов.
2. Создать сраницу изменений в прошивке устройства, в названии указать модель.

   Например, страница WB-MR6C v.3: Changelog выглядит так:

   {{DISPLAYTITLE: Изменения в прошивке WB-MR6C v.3}}
   == Общее ==
   {{Wbincludes:Changelog Update Devices}}
   
   == Список изменений ==
   {{Wbincludes:WB-MR: Changelog|WB-MR6C v.3_}}