Editoria11y Drupal sistemai

Pagrindinės funkcijos

Drupal modulis sujungia tikrintuvo biblioteką su redakcijos sistema ir prideda daug serverio pusės įrankių ataskaitoms, valdymui ir konfigūracijai

Drupal redaktorius su įterptiniais patarimais
Problemos aptinkamos tiek įkeliant puslapį naršyklėje, tiek rašymo metu CKEditor ir Gutenberg redaktoriuose.
Patarimas, nurodantis, kad nuoroda pavadinta tik „spustelėkite čia".
Patarimai gauna mygtukus pereiti į redaktorių, nepaisyti įspėjimo (aktyviam naudotojui) arba pažymėti jį kaip tinkamą (visiems naudotojams). Pasikartojantys įspėjimai siūlo viso puslapio ar visos svetainės veiksmus.
Pasirinktinių testų kūrimo sąsaja su laukais patarimo pavadinimui ir turiniui, taip pat elementų selektoriams ir išimtims.

CSA submodulis prideda:

  • Pasirinktinių testų kūrėjas
  • 40+ kūrėjų testų
  • Kontrasto tikrinimas
  • Svetainės naršytojai
  • Skaitomumo analizė
  • Padalinta konfigūracija kūrėjams/redaktoriams
Ataskaitų prietaisų skydelis, rodantis naujausias problemas ir puslapius su daugiausiai problemų.
Visos svetainės prietaisų skydelis rodo filtruojamas ir eksportuojamas įspėjimų bei atsisakymų ataskaitas.

Diegimas ir pagrindiniai sąrankos žingsniai

Komplektinė diegimo programa Drupal.org svetainėje apima kelis modulius:

  • Editoria11y: pagrindinis turinio tikrintuvas ir prietaisų skydelis.
  • Editoria11y CSA: kūrėjų testai ir prietaisų skydelio priežiūros įrankiai.
  • Editoria11y Export: CSV ataskaitų įrankiai.

Diekite kaip bet kurį kitą modulį, o tada atlikite šiuos pagrindinius žingsnius:

  1. Patikrinkite leidimus. Patikimi autoriai turėtų turėti „Pažymėti kaip tinkamą", „Pažymėti kaip nepaisomą" ir „Peržiūrėti prietaisų skydelį".
  2. Patikrinkite pagrindinius puslapius, ar nėra pasikartojančių ar nenaudingų įspėjimų. Arba pažymėkite juos kaip tinkamus tiesiogiai patarimo lange, arba sureguliuokite konfigūraciją, kad elementai būtų ignoruojami pagal selektorių.
  3. Ieškokite sunkiai matomų patarimų – ekrano ribose, sutrumpintų, už kitų elementų ar ant paslėptų elementų. Naudokite toliau pateiktus „Patarimo pozicionavimo taisymas" patarimus, kad ištaisytumėte.
  4. Jei svetainėje jau yra turinys ir turite CSA prenumeratą, apsilankykite prietaisų skydelio skirtuke „Atnaujinimas" ir naršykite svetainę, kad iš anksto užpildytumėte svetainės ataskaitas. Tai neprivaloma, tačiau senesni puslapiai nepasirodys ataskaitose, kol nebus naršomi arba jų neaplankys prisijungęs naudotojas.

Žiūrėkite vaizdo įrašo įžangą apie konfigūracijos parinktis (v2.4).

Slėpti nenaudingus įspėjimus

Gera konfigūracija slopina nenaudingus įspėjimus, kad turinio autoriai galėtų sutelkti dėmesį į problemas, kurias reikia spręsti.

Nors galite visiškai išjungti testus, paprastai geriau slėpti įspėjimus ant konkrečių elementų ar puslapių.

Kiekvieno testo vykdymo metu Editoria11y surenka vieną elementų rinkinį iš nustatymo „Tikrinti turinį šiuose konteineriuose" ir tada filtruoja jį kelis kartus. Štai kaip atrodo testo vykdymas:

  1. Atšaukti tikrinimą, jei konfigūracija draudžia tikrinimą šiame puslapyje arba šiam naudotojui.
  2. Surinkti elementus nurodytose puslapio srityse, pvz.:
    body > *:not('.ed11y-element')
    Editoria11y CSA naudotojams tai yra sritys skirtuke Kūrėjų testai.
  3. Pašalinti elementus, atitinkančius ignoruojamus selektorius, pvz.:
    .widgets, .utility-menu
    Editoria11y CSA naudotojams tai yra selektoriai skirtuke Kūrėjų testai.
  4. Vykdyti testus ir sinchronizuoti rezultatus su prietaisų skydeliu.
  5. Jei padalinta konfigūracija aktyvi ir naudotojas yra turinio redaktorius, filtruojami kūrėjų rezultatai:
    • Pašalinti rezultatus iš testų, nustatytų kaip „Tik kūrėjams".
    • Pašalinti rezultatus iš elementų, esančių už nurodytų turinio sričių ribų, pvz.:
      main, footer
    • Pašalinti rezultatus iš elementų, atitinkančių turinio ignoravimo selektorius.
    Atkreipkite dėmesį, kad antros „rinkimo" fazės nėra. Kūrėjų puslapio sritys turi apimti turinio sritis.
  6. Atidaryti skydelį ir piešti įspėjimus, jei konfigūracija atitinka automatinio atidarymo nustatymą.

Atsisakyti įspėjimų

Bibliotekoje testai konfigūruojami kaip klaidos arba įspėjimai („rankinis patikrinimas"). Įspėjimų galima atsisakyti. Kiekvieno patarimo poraštėje galimi du atsisakymų tipai:

  • „Ignoruoti" saugoma kaip naudotojo nuostata: įspėjimas dabar paslėptas dabartiniam naudotojui, tačiau tik dabartiniam naudotojui.
  • „Pažymėti kaip tinkamą" paslepia įspėjimą visiems naudotojams.

Tai, ar naudotojas gali atsisakyti įspėjimo, kontroliuojama vaidmens lygiu Drupal naudotojo leidimuose. Daugeliui autorių turėtų būti leidžiama atsisakyti įspėjimų. Nėra prasmės priskirti kam nors rankinio patikrinimo, jei jie negali pažymėti elemento kaip patikrinto.

Ignoruoti elementus

Šie du konfigūracijos nustatymai yra svarbiausi!

Nustatykite pirmąjį taip, kad apimtų visas puslapio turinio dalis, kurias gali redaguoti autoriai. Pvz., jei jie gali redaguoti main turinio sritį, .sidebar ir .footer-column-two, nustatykite tuos selektorius kaip turinio tikrinimo sritį.

Naudokite antrąjį, kad „išbrauktumėte" poskyrius. Pvz., jei main yra įvairių valdiklių ir įterpinių, kuriuos gali keisti tik kūrėjai, surašykite juos: .widget-1, .social-embed;

Jei naudojate padalintą konfigūraciją, skirtuke Kūrėjų testai matysite panašią nustatymų porą:

Developer check area

Svarbiausia žinoti apie kūrėjų tikrinimo sritis yra tai, kad jos nėra nepriklausomos nuo turinio tikrinimo sričių. Padalintoje konfigūracijoje tikrinamos kūrėjų sritys, o tada tie rezultatai filtruojami pagal turinio sritis. Visos sritys, kurios neįtrauktos kūrėjams, taip pat nebus įtrauktos turinio redaktoriams. Neišskirkite redaguojamų turinio sričių!

Kai kurie testai leidžia tikslesnę konfigūraciją – slėpti tik tam tikrus įspėjimus paveiktuose elementuose. Ieškokite jų:

  • Turinio testai: tikrinamos nuorodos
  • Turinio testai: tikrinami įterpiniai
  • Turinio testai: dinaminio ir šešėlinio turinio aptikimas
  • Kūrėjų testai: kontrastas

Slėpti konkretiems puslapiams ar naudotojams

Paprasčiausias būdas tai padaryti – perduoti CSS klases ar ID šioms parinktims:

Pirmasis neleis vykdyti patikrinimų, ir įrankių juosta nebus rodoma.

Antrasis paleis tikrintuvo programą sumažintai ir automatiškai pažymės (dabartiniam naudotojui) visas problemas kaip „Ignoruojamas", net jei tai klaidos. Tai leidžia testams veikti ir atnaujinti prietaisų skydelį, netrukdant naudotojui.

Jei norite tai naudoti valdydami, kurie naudotojai mato tikrintuvo programą, gali reikėti sureguliuoti temą, kad ji išvestų klasę, pvz. .user-247

Valdyti visos svetainės rezultatus

Naršymas ir rezultatų atnaujinimas

Editoria11y yra realiojo laiko stebėjimo įrankis, o ne naršyklė. Jos visos svetainės ataskaitos atnaujinamos, kai autoriai peržiūri puslapius, todėl reguliarus naršymas paprastai nereikalingas. CSA modulis apima naršyklę, tačiau ji turėtų būti reikalinga tik šiose trijose situacijose:

  1. Pirmą kartą įdiegiant Editoria11y esamoje svetainėje su daugeliu puslapių. Puslapiai turi būti aplankyti prieš pasirodant prietaisų skydelyje, todėl greitas pradinis naršymas sutaupo laiko.
  2. Pagrindiniai temų ar modulių atnaujinimai gali išspręsti (arba sukelti) problemas daugelyje puslapių, kurios neparodytos, kol neaplankyta ar nenaršyta.
  3. Masiniai veiksmai administratoriaus sąsajoje, pvz., puslapių ar peradresavimų naikinimas, paprastai palieka rezultatus iš puslapių, kurių nebėra arba kurie perkelti. Tokiais atvejais padeda naudoti skirtuko „Atnaujinti" priežiūros veiksmus, kad atnaujintumėte puslapių URL ir aptiktumėte bei pašalintumėte ištrintus puslapius.

Naršymo metu jokie duomenys nepalieka jūsų svetainės. CSA naršyklė nėra debesies įrankis – ji naudoja jūsų naršyklę svetainės puslapiams įkelti ir tikrinti. Šio metodo trūkumas yra tas, kad naršyklės pristabdo foninius skirtukus. Naršymo metu kompiuteris turi būti įjungtas ir budinčiojo režime. Planuokite atidaryti naują langą naršyklei ir palikti ją kaip pirmojo plano skirtuką tame lange. Galite toliau dirbti kitame lange. Naršyklė atnaujins savo įvertinimą po kiekvienos puslapių partijos.

Peržiūrėti ataskaitas

  • Naujausi leidžia naršyti pagal atskirus įspėjimus. Tai leidžia filtruoti ir rasti visus to paties įspėjimo tipo atvejus, arba pamatyti, kurie įspėjimai dažnai pasirodo naujame turinyje, arba kurie autoriai vis dar turi įprotį daryti tą pačią klaidą.
  • Puslapiai rodo įspėjimų skaičių puslapyje, sugrupuotą pagal puslapį. Tai leidžia rasti puslapius su daugiausiai problemų ir filtruoti pagal puslapio atributus, pvz., turinio tipą ir paskelbimo būseną.
  • Įspėjimai rodo problemas pagal tipą.
  • Atsisakymai leidžia stebėti, ar autoriai tinkamai atsisako, ir turi „atstatymo" mygtukus atsisakytų įspėjimų atkūrimui.
  • Eksportas apima puslapių, įspėjimų ir atsisakymų ataskaitų versijas, kurias galima filtruoti, norint parengti CSV atsisiuntimus. Teikia CSV eksporto submodulis
  • Atnaujinimas apima prietaisų skydelio priežiūros įrankius, skirtus pašalinti įspėjimus iš ištrintų puslapių, pašalinti įspėjimus iš parametrizuotų pseudo-puslapių, pvz. /search?query=example, atnaujinti saugomus puslapių pavadinimus ir URL bei vykdyti rankinį naršymą. Teikia CSA submodulis

Taisyti paslėptus ar ne ekrane pateikiamus patarimus

Modulis teikia laukus dviem bibliotekos konfigūracijos parinktims, leidžiančioms keisti patarimų išdėstymą:

Kai kurios temos turi stulpelius ar valdiklius, slepiančius horizontalų ar vertikalų perpildymą. Biblioteka automatiškai aptinka, kai perjungimo mygtukas patektų už matomos puslapio dalies ribų. Nurodžius bibliotekai, kad tam tikri konteineriai slepia perpildymą, ji taip pat bandys pozicionuoti patarimus elementams tuose konteineriuose jų ribose.

Kai kurios temos turi valdiklius, perjungiančius turinio matomumą, pvz., akordeonai, skirtukai ir skaidrių demonstracijos. Patarimai šiuose elementuose taip pat bus paslėpti. Pateikus selektorių sąrašą šiems valdikliams, Editoria11y trumpam pristabdys, kai naudotojas bandys pereiti prie tų patarimų naudodamas mygtukus „kitas" ar „ankstesnis". Drupal temos ir moduliai gali tada vykdyti bibliotekos skyriaus nurodymus apie darbą su patarimais paslėptame turinyje, kad atskleistų paslėptą turinį.

Rašykite savo konfigūraciją

Drupal modulis teikia hook_editoria11y_alter_config, kad pakeistų drupalSettings.editoria11y turinį modulyje ar temoje. Pavyzdžiui:

drupalSettings modifikavimas padeda tik tuo atveju, jei modulio JS jau nustatytas perduoti tą reikšmę bibliotekai. Norint pridėti papildomų parametrų, reikia tiesiogiai modifikuoti JS objektą options. Modulis tikrina vieną globalų JS kintamąjį editoria11yOptionsOverride. Jei jis nustatytas, perduos objektą options jūsų pateiktai funkcijai editoria11yOptions jūsų modulyje ar temoje. Dabar galite nustatyti bet kurį iš bibliotekos parametrų.

Rašykite savo testus

Pirmiausia, modulio konfigūracijoje, pridėkite 1 prie parinkties „Pasirinktiniai testai", kad jis žinotų, ko laukti.

Tada sukurkite Drupal JS biblioteką su testais savo temoje ar modulyje, naudodami bibliotekos vadovą pasirinktinių testų rašymui.

Čia pateikiamas veikiantis Princeton pavyzdys – pasirinktinis testas, kad būtų perspėta apie Safe Links. Atkreipkite dėmesį, kad jis pasiekia Editoria11y klasę per Drupal.Ed11y.

Pagalba

Žr. kontaktų puslapį bendruomenės palaikymo galimybėms. @itmaybejj paprastai yra prisijungęs Drupal Slack platformoje, kai vakarų pusrutulyje saulė dar nenusileidusi.

Dauguma CSA įnašo lygių apima metinę konsultaciją, kuri gali apimti tiesioginę pagalbą diegiant ir konfigūruojant