Editoria11y pre Drupal

Základné funkcie

Modul pre Drupal prepojuje knižnicu nástroja na kontrolu s redakčným backendom a pridáva mnohé serverové nástroje na reportovanie, správu a konfiguráciu

Inštalácia a kľúčové kroky nastavenia

Balený inštalátor na Drupal.org obsahuje niekoľko modulov:

• Editoria11y: základný nástroj na kontrolu obsahu a dashboard.
• Editoria11y CSA: vývojárske testy a nástroje na údržbu dashboardu.
• Editoria11y Export: nástroje na CSV reportovanie.

Nainštalujte ako akýkoľvek iný modul a potom vykonajte tieto kľúčové kroky:

1. Skontrolujte oprávnenia. Dôveryhodní autori by mali mať oprávnenia „Označiť ako OK", „Označiť ako ignorované" a „Zobraziť dashboard".
2. Skontrolujte kľúčové stránky na repetitívne alebo nepomocné upozornenia. Buď ich označte ako OK v tooltipe, alebo upravte konfiguráciu na ignorovanie prvkov podľa selektora.
3. Hľadajte tipy, ktoré je ťažké vidieť — mimo obrazovky, orezané, skryté za inými prvkami alebo na skrytých prvkoch. Na ich opravu použite tipy v sekcii „Oprava umiestnenia tipov" nižšie.
4. Ak web už obsahuje obsah a máte predplatné CSA, navštívte záložku „recheck" na dashboarde a prehľadajte web na predbežné načítanie správ webu. Toto je voliteľné, ale staršie stránky sa nebudú zobrazovať v správach, kým ich neprehľadáte alebo nenavštívi prihlásený používateľ.

Pozrite si video predstavenie konfiguračných možností (v2.4).

Skryť nepomocné upozornenia

Dobrá konfigurácia potláča nepomocné upozornenia, aby sa autori obsahu mohli sústrediť na problémy, ktoré by mali opraviť.

Aj keď môžete testy úplne vypnúť, zvyčajne je lepšie skryť upozornenia na konkrétnych prvkoch alebo stránkach.

Počas každého testovacieho behu Editoria11y zhromaždí jednu sadu prvkov z nastavenia „Kontrolovať obsah v týchto kontajneroch" a potom ju niekoľkokrát filtruje. Takto vyzerá testovací beh:

1. Zrušiť kontrolu, ak konfigurácia zabraňuje kontrole na tejto stránke alebo pre tohto používateľa.
2. Zhromaždiť prvky v určených oblastiach stránky, napr.:
   body > *:not('.ed11y-element')
   Pre používateľov Editoria11y CSA sú to oblasti na záložke Vývojárske testy.
3. Odstrániť prvky zodpovedajúce selektorom ignorovania, napr.:
   .widgets, .utility-menu
   Pre používateľov Editoria11y CSA sú to selektory na záložke Vývojárske testy.
4. Spustiť testy a synchronizovať výsledky s dashboardom.
5. Ak je aktívna rozdelená konfigurácia a používateľ je editor obsahu, filtrovať výsledky pre vývojárov:
   • Odstrániť výsledky z testov nastavených na „Len pre vývojárov".
   • Odstrániť výsledky prvkov mimo určených obsahových oblastí, napr.:
     main, footer
   • Odstrániť výsledky prvkov zodpovedajúcich selektorom ignorovania obsahu.
   Note that there is not a second "gather" phase. The developer page regions must include the content regions.
6. Otvoriť panel a zobraziť upozornenia, ak konfigurácia zodpovedá nastaveniu automatického otvorenia.

Odmietnutie upozornení

Testy možno konfigurovať v knižnici ako chyby alebo varovania („manuálne kontroly"). Varovania možno odmietnuť. Z päty každého tooltipu sú k dispozícii dva typy odmietnutí:

• „Ignorovať" je uložené ako predvoľba používateľa: upozornenie je teraz skryté pre aktuálneho používateľa, ale len pre neho.
• „Označiť ako OK" skryje upozornenie pre všetkých používateľov.

To, či môže používateľ odmietnuť upozornenie, je kontrolované na úrovni roly v oprávneniach Drupalu. Väčšina autorov by mala mať povolené odmietať upozornenia. Nemá zmysel priradiť niekomu manuálnu kontrolu, ak nemôže označiť položku ako skontrolovanú.

Ignorovanie prvkov

Tieto dve konfiguračné nastavenia sú najdôležitejšie!

Nastavte prvé tak, aby zahŕňalo všetky časti obsahu stránky, ktoré môžu autori upravovať. Napr. ak môžu upravovať oblasť obsahu main, .sidebar a .footer-column-two, nastavte tieto selektory ako oblasť kontroly obsahu.

Druhé použite na „vyradenie" podsekcií. Napr. ak main obsahuje rôzne widgety a vložený obsah, ktoré môžu upravovať iba vývojári, uveďte tieto: .widget-1, .social-embed;

Ak používate rozdelenú konfiguráciu, uvidíte podobný pár nastavení na záložke Vývojárske testy:

Kľúčová vec, ktorú treba vedieť o oblastiach kontroly pre vývojárov, je, že nie sú nezávislé od oblastí kontroly obsahu. V rozdelené konfigurácii sú kontrolované oblasti pre vývojárov a potom sú tieto výsledky filtrované podľa oblastí obsahu. Akékoľvek oblasti vylúčené pre vývojárov budú vylúčené aj pre editorov obsahu. Nevylučujte editovateľné oblasti obsahu!

Niektoré testy umožňujú presnejšiu konfiguráciu na skrytie len určitých upozornení na postihnutých prvkoch. Hľadajte ich pod:

• Obsahové testy: Odkazy na kontrolu
• Obsahové testy: Vložený obsah na kontrolu
• Obsahové testy: Detekcia dynamického a shadow obsahu
• Vývojárske testy: Kontrast

Skryť pre konkrétne stránky alebo používateľov

Najjednoduchší spôsob je odovzdanie CSS tried alebo ID do týchto možností:

Prvá zabráni spusteniu kontrol a panel sa nezobrazí.

Druhá spustí kontrolu minimalizovanú a automaticky označí (pre aktuálneho používateľa) všetky problémy ako „Ignorované", aj keď sú to chyby. To umožňuje beh testov a aktualizáciu dashboardu bez obťažovania používateľa.

Ak chcete tieto nastavenia použiť na kontrolu, ktorí používatelia vidia kontrolu, možno budete musieť upraviť tému na výstup triedy, napr. .user-247

Správa celositových výsledkov

Oprava skrytých alebo mimo-obrazovkových tipov

Modul poskytuje polia pre dve konfiguračné možnosti knižnice na zmenu umiestnenia tipov:

Niektoré témy majú stĺpce alebo widgety, ktoré skrývajú horizontálne alebo vertikálne pretečenie. Knižnica automaticky detekuje, keď by prepínač spadol mimo viditeľnú časť stránky. Informovanie knižnice o tom, že určité kontajnery skrývajú pretečenie, znamená, že sa tiež pokúsi umiestniť tipy pre prvky v týchto kontajneroch vnútri ich hraníc.

Niektoré témy majú widgety, ktoré prepínajú viditeľnosť obsahu, ako sú akordeóny, karty a prezentácie. Tipy vnútri týchto prvkov budú tiež skryté. Poskytnutie zoznamu selektorov pre tieto widgety znamená, že Editoria11y krátko pozastaví, keď sa používateľ pokúsi skočiť na tieto tipy pomocou tlačidla ďalší alebo predchádzajúci. Témy a moduly Drupalu môžu potom sledovať pokyny zo sekcie knižnice o práci s tipmi na skrytom obsahu na zobrazenie skrytého obsahu.

Napíšte vlastnú konfiguráciu

V PHP: modul Drupal poskytuje hook_editoria11y_alter_config na zmenu obsahu drupalSettings.editoria11y v module alebo téme. Napríklad:

Modifikácia drupalSettings pomáha iba vtedy, ak je JS modulu už nastavený na odovzdávanie tejto hodnoty knižnici. Na pridanie ďalších parametrov musíte priamo modifikovať JS objekt options. Modul kontroluje jednu globálnu JS premennú editoria11yOptionsOverride. Ak je táto nastavená, odovzdá objekt options funkcii editoria11yOptions, ktorú ste poskytli vo vašom module alebo téme. Teraz môžete nastaviť ľubovoľné z parametrov knižnice.