Editoria11y Drupalile

Põhifunktsioonid

Drupali moodul ühendab kontrolliteegi toimetamise taustaga ja lisab palju serveripoolseid tööriistu aruandluse, halduse ja konfiguratsiooni jaoks

Installimine ja põhilised seadistusetapid

Drupal.org-i komplekteeritud installeris on mitu moodulit:

• Editoria11y: põhiline sisukontrollija ja armatuurlaud.
• Editoria11y CSA: arendaja testid ja armatuurlaua haldustööriistad.
• Editoria11y Export: CSV aruandlusvahendid.

Installige nagu iga teine moodul ja võtke seejärel need põhilised sammud:

1. Kontrollige õigusi. Usaldusväärsed autorid peaksid omama õigusi „Mark OK", „Mark as Ignored" ja „View the dashboard."
2. Kontrollige põhilehti korduvate või mittevajalike hoiatuste suhtes. Märkige need tööriistavihjest OK-ks või kohandage konfiguratsiooni, et ignoreerida elemente selektori järgi.
3. Otsige vihjeid, mis on raskesti nähtavad — ekraanivälised, kärpitud, teiste elementide taga või peidetud elementidel. Kasutage allpool toodud „Fix tip positioning" nõuandeid parandamiseks.
4. Kui saidil on juba sisu ja teil on CSA tellimus, külastage armatuurlaua „recheck" vahekaarti ja roomake saiti, et eellaadida saidi aruanded. See on vabatahtlik, kuid vanemad lehed ei ilmu aruannetes enne, kui neid on roomatud või külastatakse sisselogitud kasutajaga.

Vaadake videot konfiguratsioonivõimaluste tutvustusega (v2.4).

Peida mittevajalikud hoiatused

Hea konfiguratsioon pärsib mittevajalikke hoiatusi, et sisuautorid saaksid keskenduda probleemidele, mida nad peaksid parandama.

Kuigi saate teste täielikult välja lülitada, on tavaliselt parem peita hoiatused konkreetsetel elementidel või lehtedel.

Iga testkäivituse ajal kogub Editoria11y ühe elementide komplekti seadest „Check content in these containers" ja filtreerib seda mitu korda. Testkäivitus näeb välja järgmiselt:

1. Tühista kontrollimine, kui konfiguratsioon takistab kontrollimist sellel lehel või selle kasutaja jaoks.
2. Kogu elemendid määratud lehe piirkondades, nt:
   body > *:not('.ed11y-element')
   Editoria11y CSA kasutajatele on need piirkonnad Arendaja testide vahekaardil.
3. Eemalda elemendid, mis vastavad ignoreerimisselektoritele, nt:
   .widgets, .utility-menu
   Editoria11y CSA kasutajatele on need selektorid Arendaja testide vahekaardil.
4. Käivitage testid ja sünkroniseerige tulemused armatuurlauale.
5. Kui jagatud konfiguratsioon on aktiivne ja kasutaja on sisuautor, filtreeri arendajate tulemused:
   • Eemalda testide tulemused, mis on seatud „Ainult arendajale."
   • Eemalda tulemused elementidelt väljaspool määratud sisu piirkondade hulgast, nt:
     main, footer
   • Eemalda tulemused elementidelt, mis vastavad sisu ignoreerimiselektoritele.
   Note that there is not a second "gather" phase. The developer page regions must include the content regions.
6. Avage paneel ja joonistage hoiatused, kui konfiguratsioon vastab automaatse avamise seadele.

Eira hoiatusi

Teste saab teegis konfigureerida vigadena või hoiatustena („käsitsi kontrollimised"). Hoiatusi saab eiraada. Igas tööriistavihje jaluses on saadaval kahte tüüpi eiramisi:

• „Ignoreeri" salvestatakse kasutajaeelistusena: hoiatus on nüüd peidetud praeguse kasutaja jaoks, kuid ainult praeguse kasutaja jaoks.
• „Märgi OK" peidab hoiatuse kõigi kasutajate jaoks.

See, kas kasutaja saab hoiatust eiraada, on kontrollitud rolli tasemel Drupali kasutajaõigustes. Enamikul autoritest peaks olema lubatud hoiatusi eiraada. Pole mõtet määrata kellelegi käsitsi kontrollimist, kui nad ei saa elementi kontrollituks märkida.

Ignoreeri elemente

Need kaks konfiguratsiooniseadet on kõige olulisemad!

Seadke esimene nii, et see hõlmab kõiki lehe sisu osi, mida sisuautorid saavad muuta. Nt kui nad saavad muuta main sisu ala, .sidebar-i ja .footer-column-two-d, seadke need selektorid oma sisu kontrollialaks.

Kasutage teist „välja lõikamiseks". Nt kui main sisaldab erinevaid vidinaid ja manustusi, mida saavad muuta ainult arendajad, loetlege need: .widget-1, .social-embed;

Kui kasutate eraldatud konfiguratsiooni, näete sarnast seadete paari arendaja testide vahekaardil:

Arendaja kontrollialade kohta on oluline teada, et need ei ole sõltumatud sisu kontrollialadest. Eraldatud konfiguratsioonis kontrollitakse arendaja alasid ja seejärel filtreeritakse tulemused vastavalt sisu aladele. Kõik arendajate jaoks välja arvatud alad arvatakse välja ka sisuautorite jaoks. Ärge arvake välja muudetavaid sisualasid!

Mõned testid võimaldavad täpsemat konfiguratsiooni, et peita ainult teatud hoiatused mõjutatud elementidel. Otsige neid järgmiste alt:

• Sisu testid: Kontrollitavad lingid
• Sisu testid: Kontrollitavad manustused
• Sisu testid: Dünaamilise ja shadow-sisu tuvastamine
• Arendaja testid: Kontrastsus

Peida konkreetsete lehtede või kasutajate jaoks

Lihtsaim viis selleks on edastada CSS-klassid või ID-d nendele suvanditele:

Esimene takistab kontrollimise käivitamist ja tööriistariba ei kuvata.

Teine käivitab kontrollija minimeeritult ja automaatselt märgib (praeguse kasutaja jaoks) kõik probleemid „Ignoreerituks," isegi kui need on vead. See võimaldab testide käivitamist ja armatuurlaua uuendamist, ilma kasutajat häirimata.

Kui soovite seda kasutada selleks, et kontrollida, millised kasutajad kontrollijat näevad, peate võib-olla kohandama oma teemat klassi väljastamiseks, nt .user-247

Halda ülelaiuseid tulemusi

Paranda peidetud või ekraanivälist tööriistavihjet

Moodul pakub välju kahele teegi konfiguratsioonisuvandile, et muuta vihjete paigutust:

Mõned teemad on veergude või vidinate kujul, mis peidavad horisontaalseid või vertikaalseid ületäiteid. Teek tuvastab automaatselt, millal lüliti jääks lehe nähtava osa väljapoole. Teegile ütlemine, et teatud konteinerid peidavad ületäite, tähendab, et see üritab ka nende konteinerite elementide vihjeid paigutada nende piiride sisse.

Mõnel teemal on komponendid, mis lülitavad sisu nähtavuse ümber, nagu akordionid, vahelehed ja slaidiesitlused. Nende elementide sees olevad vihjed on samuti peidetud. Nende vidinate selektorite loendi esitamine tähendab, et Editoria11y peatub lühidalt, kui kasutaja üritab nendele vihjetele hüpata järgmise või eelmise nupu abil. Drupali teemad ja moodulid saavad seejärel järgida teegi jaotise juhiseid peidetud sisuga vihjete käsitlemisel, et peidetud sisu paljastada.

Kirjutage oma konfiguratsioon

PHP-s: Drupali moodul pakub hook_editoria11y_alter_config-i, et muuta drupalSettings.editoria11y sisu moodulis või teemas. Näiteks:

drupalSettings-i muutmine aitab ainult siis, kui mooduli JS on juba seadistatud seda väärtust teegile edastama. Täiendavate parameetrite lisamiseks peate muutma JS options objekti otse. Moodul kontrollib üht globaalset JS muutujat editoria11yOptionsOverride. Kui see on seatud, edastab see options objekti teie moodulis või teemas pakutud editoria11yOptions funktsioonile. Nüüd saate seada mis tahes teegi parameetreid.