Editoria11y for Drupal

Kjernefunksjoner

Drupal-modulen kobler kontrollerbiblioteket til den redaksjonelle backend-en, og legger til en rekke serverside-verktøy for rapportering, styring og konfigurasjon

Drupal-redigerer med innebygde tips
Problemer oppdages både ved innlasting av frontend og mens du skriver i CKEditor og Gutenberg.
Tips som viser at en lenke bare heter klikk her.
Verktøytips får knapper for å hoppe til redigereren, ignorere varselet (for den aktive brukeren) eller merke det som OK (for alle brukere). Gjentatte varsler tilbyr handlinger på sidenivå eller nettstedsnivå.
Grensesnitt for bygger av egendefinerte tester med felt for tittel og innhold i tipset, samt elementselektorer og eksklusjoner.

CSA-undermodulen legger til:

  • En bygger for egendefinerte tester
  • 40+ utviklertester
  • Kontrastkontroll
  • Nettstedsgjennomsøkere
  • Lesbarhetsanalyse
  • Delte konfigurasjoner for utviklere/redaktører
Rapporteringspanel som viser nylige problemer og sider med flest problemer.
Et nettstedsglobalt panel gir filtrerbare og eksporterbare rapporter over varsler og avvisninger.

Installasjon og viktige konfigurasjonstrinn

Samlepakken på Drupal.org inneholder flere moduler:

  • Editoria11y: kjernen for innholdskontroll og panel.
  • Editoria11y CSA: utviklertester og vedlikeholdsverktøy for panelet.
  • Editoria11y Export: CSV-rapporteringsverktøy.

Installer som enhver annen modul, og gjør deretter disse viktige trinnene:

  1. Sjekk tillatelser. Betrodde forfattere bør ha «Merk som OK», «Merk som ignorert» og «Se panelet».
  2. Sjekk viktige sider for gjentakende eller unyttige varsler. Merk dem enten som OK i verktøytipset, eller juster konfigurasjonen til å ignorere elementer etter selektor.
  3. Se etter tips som er vanskelige å se – utenfor skjermen, avkuttet, bak andre elementer eller på skjulte elementer. Bruk tipsene i «Fiks tipplassering» nedenfor for å løse dette.
  4. Hvis nettstedet allerede har innhold og du har et CSA-abonnement, besøk panelfanen «recheck» og gjennomsøk nettstedet for å forhåndsinnlaste nettstedsrapportene. Dette er valgfritt, men eldre sider vil ikke vises i rapportene før de er gjennomsøkt eller besøkt av en innlogget bruker.

Se en videoinnføring i konfigurasjonsalternativene (v2.4).

Skjul unyttige varsler

Gode konfigurasjoner undertrykker unyttige varsler, slik at innholdsforfattere kan fokusere på problemer de bør fikse.

Selv om du kan slå av tester helt, er det vanligvis bedre å skjule varsler på bestemte elementer eller sider.

Under hver testkjøring samler Editoria11y inn ett sett med elementer fra innstillingen «Sjekk innhold i disse beholderne», og filtrerer det deretter flere ganger. Slik ser en testkjøring ut:

  1. Avbryt sjekking hvis konfigurasjonen forhindrer sjekking på denne siden eller for denne brukeren.
  2. Samle elementer i angitte sideregioner, f.eks.:
    body > *:not('.ed11y-element')
    For Editoria11y CSA-brukere er dette regionene på fanen Utviklertester.
  3. Fjern elementer som samsvarer med ignoreringsselektorer, f.eks.:
    .widgets, .utility-menu
    For Editoria11y CSA-brukere er dette selektorene på fanen Utviklertester.
  4. Kjør tester og synkroniser resultater til panelet.
  5. Hvis delt konfigurasjon er aktiv og brukeren er en innholdsredaktør, filtrer utviklerresultatene:
    • Fjern resultater fra tester satt til «Kun utvikler».
    • Fjern resultater på elementer utenfor angitte innholdsregioner, f.eks.:
      main, footer
    • Fjern resultater på elementer som samsvarer med innholdsignoreringsselektorer.
    Merk at det ikke er en andre «samle»-fase. Utviklerens sideregioner må inkludere innholdsregionene.
  6. Åpne panelet og tegn varsler hvis konfigurasjonen samsvarer med en innstilling for automatisk åpning.

Avvis varsler

Tester kan konfigureres i biblioteket som feil eller advarsler («manuelle sjekker»). Advarsler kan avvises. Det finnes to typer avvisninger tilgjengelig fra bunnteksten i hvert verktøytips:

  • «Ignorer» lagres som en brukerpreferanse: varselet er nå skjult for gjeldende bruker, men kun for gjeldende bruker.
  • «Merk som OK» skjuler varselet for alle brukere.

Om en bruker kan avvise et varsel styres på rollenivå i Drupals brukertillatelser. De fleste forfattere bør ha lov til å avvise varsler. Det er ingen hensikt med å tildele noen en manuell sjekk hvis de ikke kan merke elementet som kontrollert.

Ignorer elementer

Disse to konfigurasjonsinnstillingene er de viktigste!

Sett den første til å inkludere alle deler av siden som innholdsforfattere kan redigere. F.eks., hvis de kan redigere main-innholdsområdet, .sidebar og .footer-column-two, angi disse selektorene som innholdskontrollområde.

Bruk den andre til å «slå ut» delseksjoner. F.eks., hvis main inneholder ulike widgeter og innebygde elementer som kun utviklere kan endre, list dem opp: .widget-1, .social-embed;

Hvis du bruker delt konfigurasjon, vil du se et lignende par innstillinger på fanen Utviklertester:

Utviklerkontrollområde

Det viktigste å vite om utviklerkontrollområdene er at de ikke er uavhengige av innholdskontrollområdene. I en delt konfigurasjon sjekkes utviklerområdene, og deretter filtreres resultatene for å samsvare med innholdsområdene. Alle områder som er ekskludert for utviklere, vil også ekskluderes for innholdsredaktører. Ikke ekskluder redigerbare innholdsområder!

Noen tester tillater mer presis konfigurasjon, for å kun skjule bestemte varsler på berørte elementer. Se etter dem under:

  • Innholdstester: Lenker å sjekke
  • Innholdstester: Innebygde elementer å sjekke
  • Innholdstester: Oppdage dynamisk og shadow-innhold
  • Utviklertester: Kontrast

Skjul for bestemte sider eller brukere

Den enkleste måten å gjøre dette på er ved å sende CSS-klasser eller ID-er til disse alternativene:

Den første vil forhindre at sjekker kjøres, og verktøylinjen vil ikke vises.

Den andre starter kontrolleren minimert og merker automatisk (for gjeldende bruker) alle problemer som «Ignorert», selv om de er feil. Dette gjør at testene kan kjøre og oppdatere panelet uten å forstyrre brukeren.

Hvis du vil bruke disse til å styre hvilke brukere som ser kontrolleren, kan det hende du må justere temaet ditt til å sende ut en klasse, f.eks. .user-247

Administrer nettstedsglobale resultater

Gjennomsøking og oppdatering av resultater

Editoria11y er et sanntids overvåkingsverktøy, ikke en nettstedsgjennomsøker. Nettstedsglobale rapporter oppdateres når forfattere ser på sider, så regelmessig gjennomsøking er vanligvis ikke nødvendig. CSA-modulen inkluderer en gjennomsøker, men den bør kun trenges i disse tre situasjonene:

  1. Når Editoria11y installeres for første gang på et eksisterende nettsted med mange sider. Sider må besøkes før de vises på panelet, så en rask innledende gjennomsøking sparer tid.
  2. Store oppdateringer av temaer eller moduler kan fikse (eller forårsake) problemer på mange sider som ikke vil vises før de besøkes eller gjennomsøkes.
  3. Massehandlinger i admingrensesnittet som å slette sider eller omdirigeringer har en tendens til å etterlate resultater fra sider som ikke lenger finnes eller har blitt flyttet. I slike tilfeller hjelper det å bruke vedlikeholdshandlingene i «Oppdater»-fanen for å oppdatere side-URL-er og oppdage og fjerne slettede sider.

Ingen data forlater nettstedet ditt under en gjennomsøking. CSA-gjennomsøkeren er ikke et skyverktøy; den bruker nettleseren din til å laste og sjekke sidene på ditt eget nettsted. Ulempen med denne tilnærmingen er at nettlesere pauser bakgrunnsfaner. Du må holde datamaskinen på og våken under en gjennomsøking. Planlegg å åpne et nytt vindu for gjennomsøkeren og la det være forgrunnen for det vinduet mens det arbeider. Du kan fortsette å arbeide i et annet vindu. Gjennomsøkeren vil oppdatere estimatet etter hver gruppe av sider.

Vise rapporter

  • Nylige gjør det mulig å utforske individuelle varsler. Dette lar deg for eksempel filtrere for å finne alle forekomster av samme varseltype, se hvilke varsler som dukker opp hyppig i nylig innhold, eller hvilke forfattere som fortsatt har en vane med å gjøre samme feil.
  • Sider viser varselantall per side, gruppert etter side. Dette lar deg finne sider med flest problemer og filtrere etter sideattributter som innholdstype og publiseringsstatus.
  • Varsler viser problemer etter type.
  • Avvisninger gjør det mulig å overvåke om forfattere avviser korrekt, og har «tilbakestill»-knapper for å gjenopprette avviste varsler.
  • Eksporter inneholder versjoner av rapportene Sider, Varsler og Avvisninger som kan filtreres for å forberede CSV-nedlastinger. Levert av undermodulen CSV Export
  • Oppdater inneholder vedlikeholdsverktøy for panelet for å fjerne varsler fra slettede sider, fjerne varsler fra parameteriserte pseudosider som /search?query=example, oppdatere lagrede sidetitler og URL-er, og kjøre en manuell gjennomsøking. Levert av undermodulen CSA

Fiks skjulte eller utenfor skjermen-tips

Modulen gir felt for to av bibliotekets konfigurasjonsalternativer for å endre hvordan tips plasseres:

Noen temaer har kolonner eller widgeter som skjuler horisontal eller vertikal overflyt. Biblioteket oppdager automatisk når en veksler vil falle utenfor den synlige delen av siden. Å fortelle biblioteket at visse beholdere skjuler overflyt betyr at det også vil forsøke å plassere tips for elementer i disse beholderne innenfor grensene deres.

Noen temaer har widgeter som veksler synligheten av innhold, som trekkspill, faner og lysbildefremvisninger. Tips inne i disse elementene vil også bli skjult. Å gi en liste over selektorer for disse widgetene betyr at Editoria11y vil pause kort når en bruker prøver å hoppe til disse tipsene ved hjelp av en neste- eller forrige-knapp. Drupal-temaer og -moduler kan deretter følge instruksjonene fra bibliotekets seksjon om håndtering av tips på skjult innhold for å avsløre det skjulte innholdet.

Skriv din egen konfigurasjon

I PHP: Drupal-modulen gir en hook_editoria11y_alter_config for å endre innholdet i drupalSettings.editoria11y i en modul eller et tema. For eksempel:

Å endre drupalSettings hjelper bare hvis modul-JS-en allerede er satt opp til å sende den verdien til biblioteket. For å legge til ytterligere parametere må du endre JS-options-objektet direkte. Modulen ser etter én global JS-variabel kalt editoria11yOptionsOverride. Hvis denne er satt, vil den sende options-objektet til en editoria11yOptions-funksjon du har oppgitt i modulen eller temaet ditt. Du kan nå angi hvilken som helst av bibliotekets parametere.

Skriv dine egne tester

Først, i modulkonfigurasjonen, legg til 1 i alternativene for «Egendefinerte tester» slik at den vet at den skal se etter testene.

Opprett deretter et Drupal JS-bibliotek med testene dine i temaet eller modulen din, ved hjelp av bibliotekveiledningen for å skrive egendefinerte tester.

Her er et fungerende eksempel fra Princeton, om en egendefinert test for å varsle om Safe Links. Merk at den tilganger Editoria11y-klassen gjennom Drupal.Ed11y.

Få hjelp

Sjekk kontakt-siden for støttealternativer fra fellesskapet. @itmaybejj er som regel pålogget Drupal Slack når sola er oppe på den vestlige halvkule.

De fleste CSA-bidragsnivåene inkluderer en årlig gjennomgang, som kan omfatte direkte hjelp til oppsett og konfigurasjon