Editoria11y til Drupal

Kernefunktioner

Drupal-modulet forbinder tjekkerbiblioteket med den redaktionelle backend og tilføjer mange serverside-værktøjer til rapportering, governance og konfiguration

Drupal-editor med inline-tips
Problemer opdages både ved sideindlæsning på frontend og mens du skriver i CKEditor og Gutenberg.
Tip viser at et link kun hedder klik her.
Tooltips får knapper til at hoppe ind i editoren, ignorere advarslen (for den aktive bruger) eller markere den som OK (for alle brugere). Gentagne advarsler tilbyder side- eller webstedsdækkende handlinger.
Brugerdefineret testbygger-grænseflade med felter til tip-titel og -indhold samt element-selektorer og udelukkelser.

CSA-undermodulet tilføjer:

  • En brugerdefineret testbygger
  • 40+ udviklertests
  • Kontrasttjek
  • Websteds-crawlere
  • Læsbarhedsanalyse
  • Opdelt konfiguration for udviklere/redaktører
Rapporteringsdashboard der viser seneste problemer og sider med flest problemer.
Et overordnet dashboard giver filtrerbare og eksporterbare rapporter over advarsler og afvisninger.

Installation og vigtige opsætningstrin

Det medfølgende installationsprogram på Drupal.org indeholder flere moduler:

  • Editoria11y: det centrale indholdstjek og dashboard.
  • Editoria11y CSA: udviklertests og vedligeholdelsesværktøjer til dashboardet.
  • Editoria11y Export: CSV-rapporteringsværktøjer.

Installér som ethvert andet modul, og tag derefter disse vigtige skridt:

  1. Tjek rettigheder. Betroede forfattere bør have "Markér OK", "Markér som ignoreret" og "Vis dashboardet".
  2. Tjek vigtige sider for gentagne eller unødvendige advarsler. Markér dem enten som OK i tooltippet, eller juster konfigurationen til at ignorere elementer via selektor.
  3. Led efter tips der er svære at se – uden for skærmen, afskåret, bag andre elementer eller på skjulte elementer. Brug tipsene i "Ret tip-placering" nedenfor for at løse det.
  4. Hvis webstedet allerede har indhold, og du har et CSA-abonnement, skal du besøge dashboardets "gentjek"-fane og crawle webstedet for at forhåndsindlæse rapporterne. Dette er valgfrit, men ældre sider vises ikke i rapporter, før de er crawlet eller besøgt af en logget ind bruger.

Se en videointroduktion til konfigurationsmulighederne (v2.4).

Skjul unødvendige advarsler

Gode konfigurationer undertrykker unødvendige advarsler, så indholdsforfattere kan fokusere på de problemer, de bør rette.

Selvom du kan slå tests helt fra, er det som regel bedre at skjule advarsler på specifikke elementer eller sider.

Under hver testkørsel indsamler Editoria11y et enkelt sæt elementer fra indstillingen "Tjek indhold i disse containere" og filtrerer det derefter flere gange. Sådan ser et testkørsel ud:

  1. Annullér tjek hvis konfigurationen forhindrer tjek på denne side eller for denne bruger.
  2. Indsaml elementer i angivne sideområder, f.eks.:
    body > *:not('.ed11y-element')
    For Editoria11y CSA-brugere er dette områderne på fanen Udviklertests.
  3. Fjern elementer der matcher ignorer-selektorer, f.eks.:
    .widgets, .utility-menu
    For Editoria11y CSA-brugere er dette selektorerne på fanen Udviklertests.
  4. Kør tests og synkroniser resultater til dashboardet.
  5. Hvis opdelt konfiguration er aktiv, og brugeren er indholdsredaktør, filtreres udviklerresultater:
    • Fjern resultater fra tests sat til "Kun udvikler".
    • Fjern resultater på elementer uden for angivne indholdsområder, f.eks.:
      main, footer
    • Fjern resultater på elementer der matcher indholdsignorer-selektorer.
    Bemærk at der ikke er en anden "indsamlings"-fase. Udviklerens sideområder skal inkludere indholdsområderne.
  6. Åbn panelet og tegn advarsler, hvis konfigurationen matcher en automatisk åbning-indstilling.

Afvis advarsler

Tests kan konfigureres i biblioteket som fejl eller advarsler ("manuelle tjek"). Advarsler kan afvises. Der er to typer afvisninger tilgængelige i bunden af hver tooltip:

  • "Ignorér" gemmes som en brugerpræference: advarslen er nu skjult for den aktuelle bruger, men kun for den aktuelle bruger.
  • "Markér OK" skjuler advarslen for alle brugere.

Om en bruger kan afvise en advarsel styres på rolleniveau i Drupals brugerrettigheder. De fleste forfattere bør have lov til at afvise advarsler. Der er ingen mening i at tildele nogen et manuelt tjek, hvis de ikke kan markere elementet som tjekket.

Ignorér elementer

Disse to konfigurationsindstillinger er de vigtigste!

Sæt den første til at inkludere alle dele af siden, som indholdsforfattere kan redigere. F.eks., hvis de kan redigere main-indholdsområdet, .sidebar og .footer-column-two, så angiv disse selektorer som dit indholdsområde.

Brug den anden til at "fjerne" underafsnit. F.eks., hvis main indeholder diverse widgets og embeds, som kun udviklere kan ændre, så list dem: .widget-1, .social-embed;

Hvis du bruger opdelt konfiguration, vil du se et lignende par indstillinger på fanen Udviklertests:

Udvikler-tjek-område

Det vigtigste at vide om udvikler-tjek-områderne er, at de ikke er uafhængige af indholdsområderne. I en opdelt konfiguration tjekkes udviklerområderne, og derefter filtreres resultaterne til at matche indholdsområderne. Områder der er udelukket for udviklere, vil også være udelukket for indholdsredaktører. Udeluk ikke redigerbare indholdsområder!

Nogle tests giver mulighed for mere præcis konfiguration, så kun bestemte advarsler skjules på berørte elementer. Find dem under:

  • Indholdstests: Links der skal tjekkes
  • Indholdstests: Embeds der skal tjekkes
  • Indholdstests: Registrering af dynamisk indhold og shadow-indhold
  • Udviklertests: Kontrast

Skjul for specifikke sider eller brugere

Den nemmeste måde at gøre dette på er at videregive CSS-klasser eller ID'er til disse muligheder:

Den første forhindrer tjek i at køre, og værktøjslinjen vises ikke.

Den anden starter tjekkeren minimeret og markerer automatisk (for den aktuelle bruger) alle problemer som "Ignoreret", selv hvis de er fejl. Dette gør det muligt for tests at køre og opdatere dashboardet uden at forstyrre brugeren.

Hvis du vil bruge disse til at styre, hvilke brugere der ser tjekkeren, skal du muligvis justere dit tema til at udskrive en klasse, f.eks. .user-247

Administrer resultater for hele webstedet

Crawling og opdatering af resultater

Editoria11y er et realtidsovervågningsværktøj, ikke en crawler. Rapporterne for hele webstedet opdateres, når forfattere besøger sider, så regulær crawling er normalt ikke nødvendig. CSA-modulet inkluderer en crawler, men den bør kun være nødvendig i disse tre situationer:

  1. Når Editoria11y først installeres på et eksisterende websted med mange sider. Sider skal besøges, før de vises på dashboardet, så en hurtig indledende crawl sparer tid.
  2. Store opdateringer af temaer eller moduler kan rette (eller forårsage) problemer på mange sider, som ikke vises, før de besøges eller crawles.
  3. Massehandlinger i administrationsgrænsefladen som sletning af sider eller omdirigeringer har en tendens til at efterlade resultater fra sider, der ikke længere eksisterer eller er flyttet. I disse tilfælde hjælper det at bruge vedligeholdelseshandlingerne på fanen "Opdater" til at opdatere side-URL'er og finde og fjerne slettede sider.

Ingen data forlader dit websted under en crawl. CSA-crawleren er ikke et cloud-værktøj; den bruger din browser til at indlæse og tjekke siderne på dit eget websted. Ulempen ved denne tilgang er, at browsere pauser baggrundsfaner. Du skal holde din computer tændt og vågen under en crawl. Planlæg at åbne et nyt vindue til crawleren og lade det være forgrundsvinduet, mens den arbejder. Du kan fortsætte med at arbejde i et andet vindue. Crawleren opdaterer sit estimat efter hver batch af sider.

Visning af rapporter

  • Seneste giver mulighed for at udforske individuelle advarsler. Dette gør det muligt at filtrere for at finde alle forekomster af samme advarselstype, se hvilke advarsler der hyppigt optræder i nyt indhold, eller hvilke forfattere der stadig har en vane med at lave den samme fejl.
  • Sider viser antal advarsler per side, grupperet efter side. Dette gør det muligt at finde sider med flest problemer og filtrere efter sideattributter som indholdstype og publiceringsstatus.
  • Advarsler viser problemer efter type.
  • Afvisninger giver mulighed for at overvåge, om forfattere afviser korrekt, og har "nulstil"-knapper til at gendanne afviste advarsler.
  • Eksport indeholder versioner af rapporterne Sider, Advarsler og Afvisninger, som kan filtreres til forberedelse af CSV-downloads. Leveres af CSV Export-undermodulet
  • Opdater indeholder vedligeholdelsesværktøjer til dashboardet til at fjerne advarsler fra slettede sider, fjerne advarsler fra parameteriserede pseudosider som /search?query=example, opdatere gemte sidetitler og URL'er og køre en manuel crawl. Leveres af CSA-undermodulet

Ret skjulte eller tips uden for skærmen

Modulet indeholder felter til to af bibliotekets konfigurationsmuligheder for at ændre, hvordan tips placeres:

Nogle temaer har kolonner eller widgets, der skjuler vandret eller lodret overflow. Biblioteket registrerer automatisk, når en skifteknap ville falde uden for den synlige del af siden. Ved at fortælle biblioteket, at bestemte containere skjuler overflow, vil det også forsøge at placere tips for elementer i disse containere inden for deres grænser.

Nogle temaer har widgets, der skifter synlighed af indhold, såsom harmonikaer, faner og slideshows. Tips inde i disse elementer vil også være skjulte. Ved at angive en liste over selektorer for disse widgets vil Editoria11y holde en kort pause, når en bruger forsøger at hoppe til disse tips med en næste- eller forrige-knap. Drupal-temaer og -moduler kan derefter følge vejledningen fra bibliotekets afsnit om håndtering af tips på skjult indhold for at afdække det skjulte indhold.

Skriv din egen konfiguration

I PHP: Drupal-modulet indeholder en hook_editoria11y_alter_config til at ændre indholdet af drupalSettings.editoria11y i et modul eller tema. For eksempel:

Ændring af drupalSettings hjælper kun, hvis modulets JavaScript allerede er sat op til at videregive den værdi til biblioteket. For at tilføje yderligere parametre skal du ændre JavaScript-options-objektet direkte. Modulet tjekker for én global JavaScript-variabel kaldet editoria11yOptionsOverride. Hvis denne er sat, vil det videregive options-objektet til en editoria11yOptions-funktion, som du har defineret i dit modul eller tema. Du kan nu angive alle bibliotekets parametre.

Skriv dine egne tests

Først skal du i modulkonfigurationen tilføje 1 til indstillingen "Brugerdefinerede tests", så det ved, at det skal holde øje med testene.

Opret derefter et Drupal JavaScript-bibliotek med dine tests i dit tema eller modul ved hjælp af bibliotekets guide til at skrive brugerdefinerede tests.

Her er et fungerende eksempel fra Princeton på en brugerdefineret test, der advarer om Safe Links. Bemærk at den tilgår Editoria11y-klassen via Drupal.Ed11y.

Få hjælp

Se kontakt-siden for mulighederne for fællesskabsstøtte. @itmaybejj er normalt online på Drupal Slack, når solen er oppe på den vestlige halvkugle.

De fleste CSA-bidragsniveauer inkluderer et årligt check-in, som kan omfatte direkte hjælp med opsætning og konfiguration