Editoria11y за Drupal

Основни функции

Drupal модулът свързва библиотеката на проверката с редакционния бекенд и добавя много сървърни инструменти за отчитане, управление и конфигурация

Инсталиране и основни стъпки за настройка

Пакетният инсталатор в Drupal.org включва няколко модула:

• Editoria11y: основният проверител на съдържание и табло.
• Editoria11y CSA: тестове за разработчици и инструменти за поддръжка на таблото.
• Editoria11y Export: инструменти за CSV отчети.

Инсталирайте като всеки друг модул и след това предприемете следните ключови стъпки:

1. Проверете разрешенията. Доверените автори трябва да имат „Mark OK," „Mark as Ignored" и „View the dashboard."
2. Проверете ключови страници за повтарящи се или неполезни сигнали. Маркирайте ги като OK в подсказката или настройте конфигурацията да игнорира елементи по селектор.
3. Търсете подсказки, които се виждат трудно — извън екрана, отрязани, зад други елементи или на скрити елементи. Използвайте съветите в „Поправяне на позиционирането на подсказки" по-долу.
4. Ако сайтът вече има съдържание и имате CSA абонамент, посетете таба „recheck" в таблото и обходете сайта, за да предварително заредите отчетите. Това е по избор, но по-старите страници няма да се появят в отчетите, докато не бъдат обходени или посетени от влязъл потребител.

Вижте видео въведение към опциите за конфигурация (v2.4).

Скриване на неполезни сигнали

Добрите конфигурации потискат неполезните сигнали, за да могат авторите на съдържание да се фокусират върху проблемите, които трябва да поправят.

Въпреки че можете да изключите изцяло тестовете, обикновено е по-добре да скриете сигналите на конкретни елементи или страници.

По време на всяко стартиране на тест Editoria11y събира единичен набор от елементи от настройката „Проверка на съдържание в тези контейнери" и след това ги филтрира многократно. Ето как изглежда едно стартиране на тест:

1. Проверката не стартира, ако конфигурацията я е изключена за тази страница или потребител.
2. Събиране на елементи в посочени области на страницата, напр.:
   body > *:not('.ed11y-element')
   За потребители на Editoria11y CSA, това са областите в таба Developer tests.
3. Изключване на елементи, съответстващи на игнорирани селектори, напр.:
   .widgets, .utility-menu
   За потребители на Editoria11y CSA, това са селекторите в таба Developer tests.
4. Изпълнение на тестовете и синхронизиране на резултатите с таблото.
5. При активна разделена конфигурация и потребител тип редактор на съдържание, резултатите за разработчици се филтрират:
   • Изключване на резултати от тестове, зададени само за разработчици.
   • Изключване на резултати за елементи извън посочените области за съдържание, напр.:
     main, footer
   • Изключване на резултати за елементи, съответстващи на игнорираните селектори за съдържание.
   Обърнете внимание, че няма втора фаза на „събиране". Областите за разработчици трябва да включват областите за съдържание.
6. Отваряне на панела и показване на сигнали, ако конфигурацията съответства на настройка за автоматично отваряне.

Скриване на сигнали

Тестовете могат да се конфигурират в библиотеката като грешки или предупреждения („ръчни проверки"). Предупрежденията могат да се скриват. Предлагат се два вида скриване от долната лента на всяка подсказка:

• „Ignore" се съхранява като потребителско предпочитание: сигналът сега е скрит за текущия потребител, но само за него.
• „Mark OK" скрива сигнала за всички потребители.

Дали потребителят може да скрие сигнал се контролира на ниво роля в разрешенията на Drupal. На повечето автори трябва да бъде разрешено да скриват сигнали. Няма смисъл да се назначава ръчна проверка, ако те не могат да маркират елемента като проверен.

Игнориране на елементи

Тези две настройки за конфигурация са най-важните!

Задайте първото, за да включите всички части от съдържанието на страницата, които авторите могат да редактират. Напр. ако могат да редактират областта main, .sidebar и .footer-column-two, задайте тези селектори като вашата зона за проверка.

Използвайте второто, за да „изключите" подраздели. Напр. ако main съдържа различни джаджи и вградени елементи, които само разработчиците могат да променят, избройте ги: .widget-1, .social-embed;

Ако използвате разделената конфигурация, ще видите подобна двойка настройки в таба Developer Tests:

Ключовото нещо, което трябва да знаете за областите за проверка от разработчици, е, че те не са независими от областите за проверка на съдържанието. В разделена конфигурация областите за разработчици се проверяват, а след това резултатите се филтрират спрямо областите за съдържание. Всички области, изключени за разработчиците, ще бъдат изключени и за авторите. Не изключвайте редактируеми области за съдържание!

Някои тестове позволяват по-прецизна конфигурация, за да скриете само определени сигнали на засегнатите елементи. Търсете ги под:

• Тестове за съдържание: Връзки за проверка
• Тестове за съдържание: Вградени елементи за проверка
• Тестове за съдържание: Засичане на динамично и shadow съдържание
• Тестове за разработчици: Контраст

Скриване за конкретни страници или потребители

Най-лесният начин да направите това е чрез подаване на CSS класове или ID-та на тези опции:

Първото ще предотврати изпълнението на проверки и лентата с инструменти няма да се покаже.

Второто ще стартира проверката в минимизиран режим и ще маркира автоматично (за текущия потребител) всички проблеми като „Ignored," дори ако са грешки. Това позволява тестовете да се изпълняват и да актуализират таблото, без да безпокоят потребителя.

Ако искате да използвате тези настройки, за да контролирате кои потребители виждат проверката, може да се наложи да настроите темата си да изведе клас, напр. .user-247

Управление на резултати за целия сайт

Коригиране на позиционирането на подсказки

Модулът предоставя полета за две от опциите за конфигурация на библиотеката за промяна на начина на позициониране на подсказките:

Някои теми имат колони или джаджи, които скриват хоризонталното или вертикалното препълване. Библиотеката автоматично засича кога превключвателят ще излезе извън видимата част на страницата. Указването на библиотеката, че определени контейнери скриват препълването, означава, че тя ще се опита да позиционира подсказките за елементи в тези контейнери в рамките на техните граници.

Някои теми имат джаджи, превключващи видимостта на съдържание, като акордеони, табове и слайдшоута. Подсказките вътре в тези елементи също ще бъдат скрити. Предоставянето на списък с селектори за тези джаджи означава, че Editoria11y ще направи кратка пауза, когато потребител се опита да прескочи до тези подсказки с бутон „напред" или „назад". Drupal темите и модулите след това могат да следват указанията от раздела на библиотеката за работа с подсказки за скрито съдържание.

Напишете собствена конфигурация

В PHP: Drupal модулът предоставя hook_editoria11y_alter_config за промяна на съдържанието на drupalSettings.editoria11y в модул или тема. Например:

Промяната на drupalSettings помага само ако модулният JS вече е настроен да предава тази стойност на библиотеката. За добавяне на допълнителни параметри трябва да промените обекта JS options директно. Модулът проверява за една глобална JS променлива editoria11yOptionsOverride. Ако е зададена, тя ще предаде обекта options на функция editoria11yOptions, която сте предоставили в своя модул или тема. Вече можете да задавате всеки от параметрите на библиотеката.