Хабадпедія:Система перевірки параметрів
Система перевірки параметрів дає змогу додати до шаблону опис параметрів, які він очікує отримати, і таким чином виявляти неправильне використання шаблону (неправильна кількість параметрів, пропуск обов'язкового параметра тощо).
Єхіда
У модулі Модуль: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 незалежно від системи перевірок, вилучає зі сторінки в «прихованому» режимі прихований вміст, і тому повідомлення про помилку зникає, навіть якщо воно має бути видимим. У цьому разі повідомлення знову з'явиться, щойно прихований елемент буде розкрито. Якщо ви знайшли сторінку, яка перебуває в одній із категорій помилок параметрів, але повідомлення на ній немає, пошукайте приховані елементи і спробуйте їх розкрити — можливо, шаблон із помилками міститься в такому елементі.