Editoria11y dla Drupala

Podstawowe funkcje

Moduł Drupal łączy bibliotekę narzędzia sprawdzającego z zapleczem redakcyjnym i dodaje wiele narzędzi po stronie serwera do raportowania, zarządzania i konfiguracji

Instalacja i kluczowe kroki konfiguracji

Zbiorczy instalator dostępny na Drupal.org zawiera kilka modułów:

• Editoria11y: główne narzędzie do sprawdzania treści i panel raportowania.
• Editoria11y CSA: testy deweloperskie i narzędzia do utrzymania panelu.
• Editoria11y Export: narzędzia do raportowania w formacie CSV.

Zainstaluj jak każdy inny moduł, a następnie wykonaj te kluczowe kroki:

1. Sprawdź uprawnienia. Zaufani autorzy powinni mieć uprawnienia „Mark OK", „Mark as Ignored" i „View the dashboard".
2. Sprawdź kluczowe strony pod kątem powtarzających się lub nieprzydatnych powiadomień. Oznacz je jako OK w podpowiedzi lub dostosuj konfigurację, by ignorować elementy za pomocą selektora.
3. Szukaj podpowiedzi, które są trudne do zauważenia – poza ekranem, obciętych, ukrytych za innymi elementami lub na ukrytych elementach. Skorzystaj z wskazówek w sekcji „Napraw pozycjonowanie podpowiedzi" poniżej.
4. Jeśli serwis zawiera już treści i posiadasz subskrypcję CSA, przejdź do zakładki „recheck" w panelu i przeskanuj serwis, aby wstępnie załadować raporty. To opcjonalne, ale starsze strony nie pojawią się w raportach, dopóki nie zostaną przeskanowane lub odwiedzone przez zalogowanego użytkownika.

Obejrzyj wideo wprowadzenie do opcji konfiguracji (v2.4).

Ukryj nieprzydatne powiadomienia

Dobra konfiguracja tłumi nieprzydatne powiadomienia, dzięki czemu autorzy treści mogą skupić się na problemach, które powinni naprawić.

Choć można całkowicie wyłączyć testy, zazwyczaj lepiej jest ukryć powiadomienia dla konkretnych elementów lub stron.

Podczas każdego uruchomienia testów Editoria11y gromadzi jeden zestaw elementów z ustawienia „Sprawdzaj treść w tych kontenerach", a następnie kilkukrotnie go filtruje. Tak wygląda przebieg testu:

1. Anuluj sprawdzanie, jeśli konfiguracja uniemożliwia sprawdzanie na tej stronie lub dla tego użytkownika.
2. Zbierz elementy w określonych regionach strony, np.:
   body > *:not('.ed11y-element')
   Dla użytkowników Editoria11y CSA są to regiony widoczne na zakładce Testy deweloperskie.
3. Odrzuć elementy pasujące do selektorów ignorowanych, np.:
   .widgets, .utility-menu
   Dla użytkowników Editoria11y CSA są to selektory na zakładce Testy deweloperskie.
4. Uruchom testy i zsynchronizuj wyniki z panelem.
5. Jeśli aktywna jest konfiguracja rozdzielona i użytkownik jest redaktorem treści, przefiltruj wyniki deweloperskie:
   • Odrzuć wyniki testów oznaczonych jako „Tylko dla deweloperów".
   • Odrzuć wyniki dotyczące elementów spoza określonych regionów treści, np.:
     main, footer
   • Odrzuć wyniki dotyczące elementów pasujących do selektorów ignorowanych dla treści.
   Zwróć uwagę, że nie ma drugiej fazy „zbierania". Regiony stron deweloperskich muszą zawierać regiony treści.
6. Otwórz panel i wyświetl powiadomienia, jeśli konfiguracja pasuje do ustawienia automatycznego otwierania.

Odrzucanie powiadomień

Testy można skonfigurować w bibliotece jako błędy lub ostrzeżenia („ręczne sprawdzenia"). Ostrzeżenia można odrzucić. Dostępne są dwa typy odrzuceń z poziomu stopki każdej podpowiedzi:

• „Ignore" jest zapisywane jako preferencja użytkownika: powiadomienie jest teraz ukryte dla bieżącego użytkownika, ale tylko dla niego.
• „Mark OK" ukrywa powiadomienie dla wszystkich użytkowników.

To, czy użytkownik może odrzucić powiadomienie, jest kontrolowane na poziomie roli w uprawnieniach użytkowników Drupal. Większość autorów powinna mieć możliwość odrzucania powiadomień. Nie ma sensu przypisywać komuś ręcznego sprawdzenia, jeśli nie może oznaczyć elementu jako sprawdzonego.

Ignorowanie elementów

Te dwa ustawienia konfiguracyjne są najważniejsze!

Ustaw pierwsze pole tak, aby obejmowało wszystkie części strony, które autorzy treści mogą edytować. Np. jeśli mogą edytować obszar main, .sidebar i .footer-column-two, podaj te selektory jako obszar sprawdzania treści.

Drugie pole służy do „wyłączenia" podsekcji. Np. jeśli main zawiera różne widżety i osadzenia, które mogą modyfikować tylko deweloperzy, wymień je: .widget-1, .social-embed;

Jeśli korzystasz z konfiguracji rozdzielonej, na zakładce Testy deweloperskie zobaczysz podobną parę ustawień:

Kluczowa kwestia dotycząca obszarów sprawdzania deweloperskiego: nie są one niezależne od obszarów sprawdzania treści. W konfiguracji rozdzielonej sprawdzane są obszary deweloperskie, a następnie wyniki są filtrowane pod kątem obszarów treści. Obszary wykluczone dla deweloperów będą również wykluczone dla redaktorów treści. Nie wykluczaj edytowalnych obszarów treści!

Niektóre testy umożliwiają dokładniejszą konfigurację, pozwalając ukryć określone powiadomienia tylko dla wybranych elementów. Szukaj ich w sekcjach:

• Testy treści: Linki do sprawdzenia
• Testy treści: Osadzenia do sprawdzenia
• Testy treści: Wykrywanie treści dynamicznej i shadow DOM
• Testy deweloperskie: Kontrast

Ukryj dla konkretnych stron lub użytkowników

Najprostszym sposobem jest przekazanie klas CSS lub identyfikatorów do tych opcji:

Pierwsze pole uniemożliwi uruchamianie sprawdzeń i pasek narzędzi nie będzie wyświetlany.

Drugie pole uruchomi narzędzie w trybie zminimalizowanym i automatycznie oznaczy (dla bieżącego użytkownika) wszystkie problemy jako „Zignorowane", nawet jeśli są błędami. Pozwala to na uruchamianie testów i aktualizację panelu bez przeszkadzania użytkownikowi.

Jeśli chcesz użyć tych opcji do kontrolowania, którzy użytkownicy widzą narzędzie, może być konieczne dostosowanie motywu tak, aby wypisywał klasę, np. .user-247

Zarządzanie wynikami w całym serwisie

Napraw ukryte lub poza ekranem podpowiedzi

Moduł udostępnia pola dla dwóch opcji konfiguracyjnych biblioteki, pozwalających zmienić sposób pozycjonowania podpowiedzi:

Niektóre motywy mają kolumny lub widżety ukrywające poziome lub pionowe przepełnienie (overflow). Biblioteka automatycznie wykrywa, gdy przełącznik wypadałby poza widoczną część strony. Poinformowanie biblioteki, że określone kontenery ukrywają overflow, sprawi, że będzie ona również próbowała pozycjonować podpowiedzi dla elementów w tych kontenerach wewnątrz ich granic.

Niektóre motywy mają widżety przełączające widoczność treści, takie jak akordeony, zakładki i pokazy slajdów. Podpowiedzi wewnątrz tych elementów będą również ukryte. Podanie listy selektorów tych widżetów sprawi, że Editoria11y zatrzyma się na chwilę, gdy użytkownik spróbuje przejść do tych podpowiedzi za pomocą przycisku dalej lub wstecz. Motywy i moduły Drupal mogą wtedy postępować zgodnie ze wskazówkami z sekcji biblioteki dotyczącej obsługi podpowiedzi na ukrytej treści, aby odsłonić ukrytą treść.

Napisz własną konfigurację

W PHP: moduł Drupal udostępnia hook_editoria11y_alter_config do zmiany zawartości drupalSettings.editoria11y w module lub motywie. Na przykład:

Modyfikacja drupalSettings działa tylko wtedy, gdy moduł JS jest już skonfigurowany do przekazywania tej wartości do biblioteki. Aby dodać dodatkowe parametry, należy bezpośrednio zmodyfikować obiekt JS options. Moduł sprawdza istnienie jednej globalnej zmiennej JS o nazwie editoria11yOptionsOverride. Jeśli jest ustawiona, przekaże obiekt options do funkcji editoria11yOptions, którą dostarczyłeś w swoim module lub motywie. Możesz teraz ustawiać dowolne parametry biblioteki.