Хабадтекст:Система проверки параметров
Система проверки параметров позволяет добавить к шаблону описание параметров, которые он ожидает получить, и таким образом выявлять неправильное использование шаблона (неверное количество параметров, пропуск обязательного параметра и т. д.).
Модуль
В модуле Модуль:ParamValidator (документация) две функции: основная функция получает frame, переданный из шаблона. Функция находит название шаблона и с помощью модуля Модуль:ReadTd считывает templatedata (далее — TD) шаблона. Если считывание не удаётся, функция возвращает ошибку и завершает работу.
Функция перебирает параметры, переданные шаблону (с помощью frame.getParent()), и сверяет их с информацией в TD, а также наоборот, и выдаёт различные ошибки:
- Параметр с неверным именем (то есть не объявленный в TD)
- То же, когда у параметра нет значения
- Числовой параметр (то есть «позиционный»: между двумя вертикальными чертами нет знака =), не объявленный в TD
- То же без значения
- «Устаревший» параметр (deprecated)
- То же без значения
- Отсутствует обязательный параметр (required) (передан ли он без значения или не передан вовсе)
- Параметр несоответствующего типа (например, параметр, определённый как numeric, получает непустое значение, не являющееся допустимым числом)
Модуль возвращает таблицу Lua, которая может быть пустой, если ошибок нет, или содержать поля для каждого из описанных типов ошибок, причём в каждом поле — список параметров, в которых обнаружена ошибка.
Вторая функция получает frame шаблона и единственный параметр с именем options. Этот параметр — строка, которая должна содержать допустимый объект JSON, описывающий конфигурацию, которая задаёт проверки. Подробности описаны в следующем абзаце. Функция вызывает функцию проверки, а затем «спаивает» список найденных ошибок с конфигурацией и создаёт единую строку. Если ошибок не найдено — пустую строку. Если найдены — опции точно определяют эту строку. Эта строка и есть вывод функции.
Операция «спаивания» состоит из двух этапов: сначала для каждой найденной ошибки к результату добавляется строка, заданная для этой ошибки (строка может быть пустой, если нужно игнорировать определённые типы ошибок), а затем определённые «макросы» (то есть заранее заданные строки — полный список см. в документации модуля) заменяются вычисленными значениями, такими как название проверяемого шаблона, или список параметров, в которых соответствующая проверка обнаружила ошибку, или список их значений.
Опции — общее описание
Опции — это строка, которая интерпретируется как допустимый объект JSON. У объекта один уровень вложенности, то есть он содержит список именованных полей. Значение каждого поля — одна строка. Большинство строк содержат строку, которую нужно вернуть для определённого типа ошибки, и ещё несколько полей содержат «инструкции по работе» для модуля. Точное описание находится в документации модуля.
Опции, используемые системой в Хабадпедии
В Хабадпедии параметры для модуля находятся в другом модуле: Модуль:PV-options. Эти параметры делятся на три группы в зависимости от пространства имён страницы, на которой размещён проверяемый шаблон: в большинстве пространств имён список параметров пуст, и шаблон, находящийся в таком пространстве имён, вообще не проверяется. Пространства имён, в которых проверка всё же проводится, делятся на два типа, и разница между ними — в категории, которая добавляется к сообщению: в части пространств имён это категория Категория:Ошибки параметров вне основного пространства, а в другой части добавляются три разные категории: Категория:Ошибки параметров, Категория:Ошибки параметров в шаблоне XXXX (по шаблону) и [[:קטגוריה:שגיאות פרמטריות <תיאור השגיאה>>]]. Пример последней категории — Категория:Ошибки параметров: использование устаревшего параметра. По состоянию на май 2018 года пространства имён первого типа («вне основного пространства») — 2, 4, 12, 108, 118, 446, 828, 2300, 2302, 2600: Участник, Хабадпедия, Справка, Книга, Черновик, Инструкция, Модуль, Гаджет, Определение гаджета и Тема.
Пространства имён второго типа («как основное пространство») — 0, 6, 10, 14, 100: основное пространство статей, Файл, Шаблон, Категория и Портал.
Во всех остальных пространствах имён, и в частности во всех пространствах обсуждения, включая те, что относятся к перечисленным пространствам, модуль ничего не проверяет.
Помимо категории, в проверяемых пространствах модуль выдаёт сообщение об ошибке. Это сообщение «скрыто» от участников, которые не включили гаджет «Показывать сообщения об ошибках от системы проверки параметров» (в разделе «Мониторинг»). Редакторы, включившие гаджет, увидят в левом верхнем углу страницы окошко (или несколько окошек) с сообщением об ошибке. Сообщение содержит объяснение ошибки, включающее название шаблона и тип ошибки, и список соответствующих параметров. Кроме того, сообщение содержит кнопки «Скрыть» (скрытие сообщения) и «Отметить». Нажатие на «Отметить», как правило, обводит шаблон, в котором возникла ошибка, красной рамкой и перемещает окошко с сообщением к тому месту страницы, где находится шаблон. Это полезно главным образом тогда, когда сообщение касается ошибки в шаблоне, который встречается на странице более одного раза, и редактор хочет увидеть, какое из вхождений шаблона содержит ошибку.
Несколько моментов, на которые следует обратить внимание:
- Если шаблон с ошибкой находится внутри скрытого элемента (то есть такого:
| Пример скрытого элемента |
|---|
|
А я — Хоху Хихи, кто здесь знает, как меня зовут? |
), сообщение об ошибке может не появиться. Если вы попали на страницу с категорией ошибки, но без сообщения, стоит поискать на странице скрытые элементы и раскрыть их все
- Другие шаблоны и модули также могут добавлять одну из категорий ошибок (возможно, больше одной), в частности шаблоны, использующие Модуль:Карточка. В таких случаях категория появится, а сообщение — нет, и, как правило, сам шаблон на странице отображаться не будет (хотя, разумеется, в режиме редактирования он на странице присутствует).
Отображение и гаджеты
Всё отображение управляется с помощью CSS-класса, упомянутого в предыдущем разделе: «paramvalidator-wrapper». Этот класс определён в MediaWiki:common.css со скрытым режимом отображения. В двух конкретных пространствах имён, «пространстве участника» и «пространстве черновиков», для этого класса задано иное определение: там он определён в видимом и «плавающем» режиме отображения, то есть сообщение показывается в фиксированном месте страницы, независимо от положения содержащего его элемента или от прокрутки.
В MediaWiki:Common.js есть фрагмент кода, который, когда элемент этого класса находится на странице в видимом режиме отображения, добавляет к нему кнопки для скрытия сообщения и для отметки шаблона, в котором найдены ошибки. Если страница содержит несколько шаблонов, подпадающих под систему проверок и содержащих ошибки, «плавающие» сообщения отображаются одно поверх другого, и нужно закрыть каждое сообщение, чтобы прочитать то, что под ним. Для удобства на случай, когда страница содержит несколько сообщений, добавлена кнопка «Закрыть все», которая закрывает их все.
Чтобы видеть сообщения об ошибках в других пространствах (то есть не участника и не черновиков), нужно установить (в «Настройки > Гаджеты») гаджет «Показывать сообщения об ошибках от системы проверки параметров», который меняет режим отображения сообщения со «скрытого» на «плавающий» во всех пространствах имён.
Кроме того, существует ещё один гаджет, который показывает сообщение об ошибке при сохранении страницы, содержащей шаблон с ошибкой. Если установлены оба гаджета, второй гаджет (сообщение при сохранении) не оказывает никакого действия.
Скрытые элементы
Речь идёт об элементах, использующих механизм «скрытия» в Хабадпедии. Такие элементы обычно выглядят так:
| Заголовок скрытого элемента |
|---|
|
Содержимое скрытого элемента — может содержать шаблон, подпадающий под систему проверок |
Когда скрытый элемент содержит шаблон с ошибкой параметров, общий JS-код, работающий в системе MediaWiki независимо от системы проверок, удаляет со страницы в «скрытом» режиме скрытое содержимое, и поэтому сообщение об ошибке исчезает, даже если оно должно быть видимым. В этом случае сообщение снова появится, как только скрытый элемент будет раскрыт. Если вы нашли страницу, которая находится в одной из категорий ошибок параметров, но сообщения на ней нет, поищите скрытые элементы и попробуйте их раскрыть — возможно, шаблон с ошибками находится в таком элементе.
