Хабадпедия:Система проверки параметров/Исправление ошибок
В Хабадпедии широко используются шаблоны. Система проверки параметров проверяет, соответствуют ли переданные шаблону параметры его определению, и выявляет неправильное использование шаблона (неверное число параметров, пропуск параметра, который обязательно указывать, и т. д.), чтобы его можно было исправить. Ошибки параметров можно увидеть в Категории:Ошибки параметров, зайти в проблемные статьи и исправить.
Включение системы
Чтобы включить систему проверки параметров так, чтобы она показывала вам сообщения об ошибках, заходят в Настройки ← Гаджеты, прокручивают вниз и включают «Показывать сообщения об ошибках системы проверки параметров» под заголовком «Мониторинг». Вот и всё.
С этого момента в каждой статье, где есть ошибка параметров, в верхнем меню появится кнопка, сообщающая, что на странице есть ошибки параметров в одном или нескольких шаблонах. Число означает количество шаблонов в статье, в которых есть ошибка.
При нажатии на кнопку открывается форма, показывающая список шаблонов с ошибками на странице с перечнем ошибок в каждом шаблоне. В верхней части формы несколько кнопок:
- Показ ошибок: показ сообщения об ошибках параметров в шаблоне перед каждым шаблоном с ошибками
- Скрытие ошибок скрытие сообщений об ошибках в тексте статьи — ошибки в самой форме по-прежнему отображаются
- Пояснения и указания — ссылка на эту страницу
- Прекратить получать сообщения отключение гаджета. Его можно снова включить в любое время через Настройки ← Гаджеты
Под кнопками — список шаблонов, содержащих ошибку. Справа от сообщения — стрелка, указывающая вниз: нажатие на стрелку переносит к месту на странице, где находится шаблон с ошибкой, а над шаблоном появляется сообщение об ошибке для этого шаблона.
По окончании исправления ошибки рекомендуется использовать описание правки «исправление параметров» (есть в поле описаний правок) и тем самым пометить исправление. Пометка помогает собирать информацию об исправлениях ошибок и тем самым может помочь понять, отчего возникают ошибки.
Работа с ошибками
Это страница указаний и пояснений по исправлению ошибок параметров в шаблонах, помеченных системой. Во многих случаях исправление такой ошибки устраняет дефект в отображении страницы, означающий, что часть информации, добавленной редакторами на страницу, не отображается или отображается неправильно, а возможно, даже нарушает отображение страницы. Есть также лёгкие технические ошибки, которые фактически вовсе не влияют на отображение страницы. Их тоже стоит исправлять, поскольку это помогает поддерживать «чистую кухню». И когда их исправляют, это делается во многом для того, чтобы «поддерживать чистую кухню», чтобы облегчить обнаружение и быструю обработку новых ошибок, многие из которых относятся к первому типу. Последний «тип» ошибок — временные ошибки, возникающие после изменения самого шаблона. Всегда или почти всегда такое изменение сопровождается техническим исправлением шаблонов на страницах с помощью бота, и, как правило, обрабатывать такие ошибки вручную не нужно.
На странице может быть одна ошибка или несколько ошибок. Когда на странице несколько шаблонов с ошибкой параметров, для каждого такого шаблона появится сообщение, причём в каждом сообщении указано название шаблона со ссылкой на сам шаблон и ошибки — одна или более. Ссылка на шаблон полезна, чтобы прочитать документацию и пояснения по правильному использованию шаблона, в котором на текущей странице есть ошибка, и чтобы найти другие страницы, где этот шаблон стоит без ошибки.
Исправление шаблонов обычно выполняется в редакторе исходного кода, и первый шаг к исправлению ошибки — найти шаблон в исходном коде.
Поиск шаблона с ошибкой
Часто ошибка находится в шаблоне типа «информационный шаблон», например {{Личность}} и его производные, который встречается на странице ровно один раз, и найти его легко и просто по названию шаблона, указанному в сообщении об ошибке. Напротив, такие шаблоны, как {{Примечание}}, {{Общая ссылка}} и другие, могут встречаться на странице многократно, и найти конкретный шаблон, в котором есть ошибка, не так быстро.
Чтобы помочь, воспользуемся «Показом ошибок». При нажатии на него сообщения об ошибках размещаются на странице над шаблоном, а сам шаблон обводится красной рамкой. Нужно найти текст перед шаблоном или после него и найти этот текст в редакторе исходного кода, и «непокорный» шаблон, как правило, окажется рядом с ним.
Поиск примечания, содержащего шаблон с ошибкой
Дело немного усложняется, когда ошибка находится в шаблоне, который сам содержится в примечании: сообщение и красная рамка появятся в разделе «Примечания», тогда как ошибка находится в тексте, в том месте, где стоит {{Примечание}} или тег ref. Чтобы найти вики-код, в котором ошибка, сначала нажмём «Отметка». Примечание, которое нужно исправить, будет отмечено в разделе «Примечания». Теперь нужно нажать на число рядом с примечанием с ошибкой — это число ссылается на текст. Находят ссылку на примечание в виде [16], и снова находят текст поблизости, переходят в режим редактирования и находят примечание, а в нём — шаблон, содержащий ошибки.
Если включена бета-возможность «Предварительный просмотр примечания» (в Настройки ← Бета), наведение мыши на ссылку на примечание из текста покажет сообщение об ошибке во всплывающем окне предварительного просмотра.
Вспомогательные инструменты
При работе с ошибками параметров полезным вспомогательным инструментом является мастер шаблонов:
- Находят и выделяют на странице шаблон, в котором есть ошибка. Нужно следить за тем, чтобы выделить точно, начиная с {{, открывающих шаблон, и до }}, закрывающих его.
- На панели инструментов нажмите кнопку мастера, которая выглядит так: {{}}
- Мастер шаблонов найдёт определения соответствующего шаблона, загрузит текущий шаблон и отметит ошибочные поля розовым фоном
- Мастер снимет окраску, когда поле будет исправлено. Когда все поля свободны от ошибок, то есть больше нет полей, отображаемых розовым, подтверждают, и шаблон на странице исправлен.
Пример возможной ошибки и объяснение исправления: допустим, у шаблона есть обязательный параметр под названием «общий вес». На странице стоит «обший вес = 47 тонн». Из-за опечатки в названии параметра возникнут две ошибки: отсутствует обязательный параметр и параметр с ошибочным названием. В мастере шаблонов мы сможем найти правильное значение для параметра с ошибочным названием, которое будет показано красным, тогда как параметр с правильным названием пуст. Перенос правильного значения в правильный параметр выполняется несколькими движениями мыши. Есть ряд ошибок, которые мастер исправляет автоматически — просто выделением шаблона, открытием мастера и нажатием «Подтвердить».
Распространённые виды ошибок и работа с ними
Параметры [1] не указаны в определении шаблона"
(или другое число; а также два числа)
- В шаблоне, где параметры основаны на названии
Параметр, основанный на названии, должен содержать вертикальную черту (|), чтобы отделить его от предыдущего параметра, точное название параметра (любое отклонение от его точного названия в определении шаблона, как оно указано на странице шаблона, не сработает) и знак равенства (=) после названия параметра, чтобы отделить название параметра от заполненного содержания.
Сообщение об ошибке показывается в нескольких случаях:
- Когда значение параметра дано без указания его названия. Исправление — добавление названия параметра и знака равенства (
=). Пример: сообщение об ошибке и его исправление (ссылка не активна). - Когда стоит лишняя вертикальная черта, шаблон считывает требование параметра; но когда он не появляется сразу после неё, система распознаёт ошибку. В таком случае нужно удалить лишнюю черту. Иногда черта стоит в изображении, вставленном в шаблон, чтобы управлять размером изображения: если размер стандартный, нужно удалить
|250px(пример ошибки и её исправления) (ссылка не активна); если размер нестандартный — нужно поставить на изображение внутреннюю ссылку, так:[[קובץ:aaa.jpg|150px]] - Ещё одна возможность — знак равенства не поставлен после названия параметра, например:
|תאריך לידה ט"ו באדר ב' תשכ"זвместо|תאריך לידה=ט"ו באדר ב' תשכ"ז. В таком случае нужно добавить знак равенства между названием параметра и заполненным содержанием.
- В шаблоне, где параметры основаны на положении
Возможно, параметров больше, чем принимает шаблон. Например, параметры шаблона ссылки на «Хабад Инфо» таковы: {{קישור לחב"ד אינפו|שם הכתב|כותרת הכתבה|מזהה הכתבה|תאריך פרסום}}; если мы заполним шаблон {{קישור לחב"ד אינפו|שם הכתב|כותרת הכתבה|מזהה הכתבה|תאריך פרסום||}}, то получим сообщение Параметры [5, 6] не указаны в определении шаблона, поскольку у шаблона нет пятого и шестого параметров.
«Параметры [любимое блюдо] не указаны в определении шаблона»
Эта ошибка появляется, когда введено название параметра, не указанное в определении шаблона. Попробуйте проверить в истории версий, когда он был добавлен, — иногда речь идёт о неправильном изменении, вызванном незнанием, и тогда стоит просто исправить на правильное название. Если речь идёт о добавлении нового параметра, попробуйте проверить на странице шаблона, нет ли похожего параметра, который может подойти.
«Использование устаревших параметров»
В целом — не трогать. Это временная ошибка, возникающая в ходе преобразования шаблонов. Она известна тем, кто занимается шаблоном, и находится в работе.
«Отсутствуют обязательные параметры [3]»
Ошибка состоит в том, что один или несколько параметров (содержимое скобок указывает на положение параметра или его название), определённых в шаблоне как обязательные (например: идентификатор статьи на новостном сайте; без идентификатора статьи от ссылки на главную страницу сайта нет пользы), не введены. Решение — заполнить их. Если вы не можете найти правильное значение для отсутствующего параметра, вы не сможете исправить эту ошибку.
Дублирование параметров
Есть две разные ошибки типа «дублирование параметров».
Первая появляется, когда при использовании шаблона один и тот же параметр передаётся больше одного раза: {{שם התבנית| פרמטר 1 = א | פרמטר 1 = ב}}, или {{שם התבנית| פרמטר 1 = א | פרמטר 1 = א}}, или {{שם התבנית| פרמטר 1 = א | פרמטר 1 =}}. Эта ошибка не связана с «системой проверки параметров», действующей в Хабадпедии (и поэтому может появляться и в шаблонах, не входящих в систему), и отлавливается самим вики-движком. Страницы, на которых есть такая ошибка, появятся в Категории:Страницы, использующие дублирующиеся параметры в вызовах шаблонов. Хотя эта ошибка «не относится» к системе, в принципе она похожа на ошибки, которые отлавливает система, поэтому сама категория связана с верхней частью Категории:Ошибки параметров. Пояснения и руководство по исправлению этой ошибки приводятся на странице категории.
Вторая ошибка типа «дублирование параметров» немного сложнее: эта ошибка может возникнуть, когда один параметр определён как «алиас» (alias, или на иврите «кинуй») другого параметра и оба параметра получают значение. Определение находится в templatedata шаблона и означает, что значение можно передать шаблону с помощью любого из двух параметров, как удобнее редактору. Если, например, в шаблоне определён первый параметр, основанный на порядке (параметр 1), с алиасом «содержание», два следующих вызова должны давать один и тот же результат: {{שם התבנית | מה פה קורה פה? }} или {{שם התבנית | תוכן = מה פה קורה פה? }}. Когда шаблону передают и параметр, и алиас, или в примере {{שם התבנית| מה פה קורה פה? | תוכן = אף אחד יודע. }}, неясно, какое из двух значений шаблон должен использовать, и результат может отличаться от намерения редактора. Ошибка такого типа появится в Категории:Ошибки параметров — дублирование параметров, и чтобы исправить её, нужно проверить в templatedata, какой параметр служит «алиасом» другого параметра, ввести нужное значение только в один из них, а другой удалить из вызова шаблона или по крайней мере очистить от содержания. В примере мы изменим вхождение шаблона на странице на {{שם התבנית| תוכן = מה פה קורה פה? אף אחד יודע. }}. В Хабадпедии, как правило, алиасы не используются, и эта ошибка редка.