Editoria11y Drupalille

Ydintoiminnot

Drupal-moduuli kytkee tarkistuskirjaston Drupalin hallintakäyttöliittymään ja lisää useita palvelinpuolen työkaluja raportointia, hallintaa ja konfigurointia varten

Drupal-editori, jossa on upotettuja vinkkejä
Ongelmat havaitaan sekä sivun latautuessa etupäällä että reaaliajassa CKEditorissa ja Gutenbergissä.
Vinkki, jossa kerrotaan linkin nimeksi annettu vain "click here".
Jokaisessa työkaluvinkissä on painikkeet: hypätä editoriin, ohittaa varoitus (vain itselle) tai merkitä se OK:ksi (kaikille käyttäjille). Toistuvissa varoituksissa on myös sivukohtaiset ja sivustolaajuiset toiminnot.
Mukautettu testirakentajan käyttöliittymä, jossa näkyvät vinkin otsikon ja sisällön sekä elementtivalitsimien ja poissulkemisten kentät.

CSA-alimoduuli lisää:

  • Mukautettu testirakentaja
  • 40+ kehittäjätestiä
  • Kontrastintarkistus
  • Sivuston indeksoijat
  • Luettavuusanalyysi
  • Jaettu konfiguraatio kehittäjille/sisällöntuottajille
Raportointipaneeli, jossa näkyvät viimeisimmät ongelmat ja eniten ongelmia sisältävät sivut.
Sivustolaajuinen hallintapaneeli tarjoaa suodatettavia ja vietäviä raportteja varoituksista ja hylkäyksistä.

Asennus ja tärkeimmät käyttöönottovaiheet

Drupal.org:n pakattu asennusohjelma sisältää useita moduuleja:

  • Editoria11y: ydinsisällön tarkistin ja hallintapaneeli.
  • Editoria11y CSA: kehittäjätestit ja hallintapaneelin ylläpitotyökalut.
  • Editoria11y Export: CSV-raportointityökalut.

Asenna kuten mikä tahansa muu moduuli ja suorita sitten nämä keskeiset vaiheet:

  1. Tarkista käyttöoikeudet. Luotettujen tekijöiden tulisi saada "Merkitse OK:ksi," "Merkitse ohitetuksi" ja "Katso hallintapaneeli."
  2. Tarkista avainsivu toistuvien tai hyödyttömien varoitusten varalta. Merkitse ne joko OK:ksi työkaluvinkistä tai muuta konfiguraatiota ohittamaan elementit valitsimella.
  3. Etsi vaikeasti havaittavia vinkkejä – näytön ulkopuolella, katkaistu, muiden elementtien takana tai piilotetuissa elementeissä. Katso alta "Korjaa vinkin sijoittelu" -kohdan ohjeet.
  4. Jos sivustolla on jo sisältöä ja sinulla on CSA-tilaus, vieraile hallintapaneelin "Uudelleentarkistus"-välilehdellä ja indeksoi sivusto esitäyttääksesi sivustoraportit. Tämä on valinnaista, mutta vanhemmat sivut eivät näy raporteissa ennen kuin ne on indeksoitu tai kirjautunut käyttäjä vierailee niillä.

Katso videoon johdanto konfigurointivaihtoehdoista (v2.4).

Piilota hyödyttömät varoitukset

Hyvät konfiguraatiot vaimentavat hyödyttömät varoitukset, jotta sisällöntuottajat voivat keskittyä ongelmiin, jotka heidän pitäisi korjata.

Vaikka voit poistaa testit kokonaan käytöstä, on yleensä parempi piilottaa varoitukset tietyissä elementeissä tai sivuilla.

Jokaisen testisuorituksen aikana Editoria11y kerää yhden joukon elementtejä "Tarkista sisältö näissä säilöissä" -asetuksesta ja suodattaa sen useita kertoja. Näin testisuoritus näyttää:

  1. Tarkistus peruutetaan, jos konfiguraatio kieltää tarkistuksen tällä sivulla tai tälle käyttäjälle.
  2. Kerää elementit määritetyiltä sivualueilta, esim.:
    body > *:not('.ed11y-element')
    Editoria11y CSA -käyttäjille nämä ovat alueita Kehittäjätestit-välilehdellä.
  3. Pudota elementit, jotka vastaavat ohitettavia valitsimia, esim.:
    .widgets, .utility-menu
    Editoria11y CSA -käyttäjille nämä ovat valitsimia Kehittäjätestit-välilehdellä.
  4. Suorita testit ja synkronoi tulokset hallintapaneeliin.
  5. Jos jaettu konfiguraatio on aktiivinen ja käyttäjä on sisällöntuottaja, suodata kehittäjätulokset:
    • Pudota tulokset testeistä, jotka on asetettu "Vain kehittäjälle."
    • Pudota tulokset elementeistä, jotka ovat määritettyjen sisältöalueiden ulkopuolella, esim.:
      main, footer
    • Pudota tulokset elementeistä, jotka vastaavat sisällön ohitettavia valitsimia.
    Note that there is not a second "gather" phase. The developer page regions must include the content regions.
  6. Avaa paneeli ja näytä varoitukset, jos konfiguraatio edellyttää automaattista avaamista.

Hylkää varoitukset

Kirjastossa testit voidaan asettaa virheiksi tai varoituksiksi ("manuaaliset tarkistukset"). Varoitukset voidaan hylätä. Jokaisen työkaluvinkin alapalkissa on kaksi hylkäystapaa:

  • "Ohita" tallennetaan käyttäjäkohtaisesti: varoitus piiloutuu vain kyseiseltä käyttäjältä.
  • "Merkitse OK:ksi" piilottaa varoituksen kaikilta käyttäjiltä globaalisti.

Käyttäjän kyky hylätä varoitus hallitaan Drupalin käyttöoikeuksissa roolien tasolla. Useimmilla tekijöillä pitäisi olla oikeus hylätä varoituksia. Ei ole mitään mieltä antaa jollekulle manuaalinen tarkistus, jos he eivät voi merkitä kohdetta tarkistetuksi.

Ohita elementit

Nämä kaksi konfigurointiasetusta ovat tärkeimmät!

Aseta ensimmäinen sisältämään kaikki sivun osat, joita sisällöntuottajat voivat muokata. Esim. jos he voivat muokata main-sisältöaluetta, .sidebar-aluetta ja .footer-column-two-aluetta, aseta nämä valitsimet sisältöalueeksesi.

Käytä toista "poistamaan" alakohtia. Esim. jos main sisältää erilaisia widgettejä ja upotuksia, joita vain kehittäjät voivat muokata, listaa ne: .widget-1, .social-embed;

Jos käytät jaettua konfiguraatiota, näet vastaavan asetusparin Kehittäjätestit-välilehdellä:

Developer check area

Keskeistä kehittäjätarkistusalueista on tietää, että ne eivät ole riippumattomia sisältötarkistusalueista. Jaetussa konfiguraatiossa kehittäjäalueet tarkistetaan, ja sitten tulokset suodatetaan vastaamaan sisältöalueita. Kaikki kehittäjiltä suljetut alueet suljetaan myös sisällöntuottajilta. Älä sulje muokattavia sisältöalueita!

Jotkin testit mahdollistavat tarkemman konfiguroinnin, jotta voidaan piilottaa vain tietyt varoitukset kyseisistä elementeistä. Etsi niitä kohdan alta:

  • Sisältötestit: Tarkistettavat linkit
  • Sisältötestit: Tarkistettavat upotukset
  • Sisältötestit: Dynaamisen ja shadow-sisällön havaitseminen
  • Kehittäjätestit: Kontrasti

Piilota tietyiltä sivuilta tai käyttäjiltä

Helpoin tapa tehdä tämä on välittää CSS-luokat tai ID:t näihin vaihtoehtoihin:

Ensimmäinen estää tarkistusten suorittamisen, eikä työkalupalkki näy.

Toinen käynnistää tarkistimen minimoituna ja merkitsee automaattisesti (nykyiselle käyttäjälle) kaikki ongelmat "Ohitetuksi", vaikka ne olisivat virheitä. Tämä mahdollistaa testien suorittamisen ja hallintapaneelin päivittymisen häiritsemättä käyttäjää.

Jos haluat käyttää näitä hallitsemaan, ketkä käyttäjät näkevät tarkistimen, sinun saattaa täytyä muokata teemasasi tulostamaan luokka, esim. .user-247

Sivustolaajuisten tulosten hallinta

Tulosten indeksointi ja päivittäminen

Editoria11y on reaaliaikainen valvontatyökalu, ei indeksoija. Sen sivustolaajuiset raportit päivittyvät sitä mukaa kuin sisällöntuottajat vierailevat sivuilla, joten säännöllinen indeksointi ei yleensä ole tarpeen. CSA-moduuli sisältää indeksoijan, mutta sitä tarvitaan vain näissä kolmessa tilanteessa:

  1. Kun Editoria11y asennetaan ensimmäistä kertaa olemassa olevalle sivustolle, jolla on monta sivua. Sivujen täytyy tulla vierailluiksi ennen kuin ne näkyvät hallintapaneelissa, joten nopea alkuindeksointi säästää aikaa.
  2. Suuret päivitykset teemoihin tai moduuleihin saattavat korjata (tai aiheuttaa) ongelmia monilla sivuilla, jotka eivät näy ennen kuin niitä vieraillaan tai indeksoidaan.
  3. Hallintaliittymän joukkotoiminnot, kuten sivujen tai uudelleenohjausten poistaminen, jättävät usein jäljelle tuloksia sivuilta, joita ei enää ole tai jotka ovat siirtyneet. Näissä tapauksissa käytä "Päivitä"-välilehden ylläpitotoimintoja: päivitä sivujen URL-osoitteet sekä tunnista ja poista poistettujen sivujen tiedot.

Indeksoinnin aikana sivustosi data ei poistu. CSA-indeksoija ei ole pilvipalvelu; se käyttää selaintasi lataamaan ja tarkistamaan sivuja omalla sivustollasi. Tämän lähestymistavan haittapuoli on, että selaimet keskeyttävät taustalla olevat välilehdet. Sinun täytyy pitää tietokoneesi päällä ja aktiivisena indeksoinnin aikana. Avaa uusi ikkuna indeksoijaa varten ja jätä se ikkunan ensisijaiseksi välilehdeksi. Voit jatkaa työskentelyä toisessa ikkunassa. Indeksoija päivittää arvionsa jokaisen sivuerän jälkeen.

Raporttien katselu

  • Viimeisimmät: selaa yksittäisiä varoituksia. Tämä mahdollistaa esimerkiksi suodattamisen löytääksesi kaikki saman varoitustyypin esiintymät, tai nähdäksesi mitkä varoitukset esiintyvät usein viimeaikaisessa sisällössä, tai mitkä tekijät vielä toistuvasti tekevät samoja virheitä.
  • Sivut: varoitusten määrät sivuittain. Voit suodattaa eniten ongelmia sisältäviä sivuja ominaisuuksien kuten sisältötyypin ja julkaisutilan mukaan.
  • Varoitukset näyttää ongelmat tyypeittäin.
  • Hylkäykset: seuraa hylkäyksiä ja palauta hylättyjä varoituksia "palauta"-painikkeella.
  • Vie sisältää versiot Sivut-, Varoitukset- ja Hylkäykset-raporteista, jotka voidaan suodattaa CSV-latausten valmistelemiseksi. Tarjoaa CSV Export -alimoduuli
  • Päivitä: hallintapaneelin ylläpitotyökalut — pudota poistettujen sivujen varoitukset, parametrisoitujen pseudosivujen (esim. /search?query=example) varoitukset, päivitä sivujen otsikot ja URL-osoitteet sekä suorita manuaalinen indeksointi. Tarjoaa CSA-alimoduuli

Piilotettujen tai näytön ulkopuolella olevien vinkkien korjaaminen

Moduuli tarjoaa kentät kahdelle kirjaston konfigurointivaihtoehdolle vinkkien sijoittelun muuttamiseksi:

Jotkin teemat sisältävät sarakkeita tai widgettejä, jotka piilottavat vaaka- tai pystyvierityksen. Kirjasto havaitsee automaattisesti, milloin vaihtokytkimen asettaminen menisi sivun näkyvän osan ulkopuolelle. Kertomalla kirjastolle, että tietyt säilöt piilottavat ylivalumisen, se yrittää myös sijoittaa vinkit kyseisten säilöjen sisällä oleville elementeille niiden reunojen sisäpuolelle.

Jotkin teemat sisältävät widgettejä, jotka vaihtavat sisällön näkyvyyttä, kuten akordeonit, välilehdet ja diaesitykset. Näiden elementtien sisällä olevat vinkit ovat myös piilotettuja. Näiden widgettien valitsimelistan antaminen tarkoittaa, että Editoria11y odottaa hetken, kun käyttäjä yrittää hypätä näihin vinkkeihin seuraava- tai edellinen-painikkeella. Drupal-teemat ja -moduulit voivat sitten noudattaa kirjastoosion ohjeita piilotetun sisällön vinkkien käsittelystä paljastamaan piilotettu sisältö.

Kirjoita oma konfiguraatiosi

PHP:ssä: Drupal-moduuli tarjoaa hook_editoria11y_alter_config-koukun muuttamaan drupalSettings.editoria11y-sisältöä moduulissa tai teemassa. Esimerkiksi:

drupalSettings:in muokkaaminen auttaa vain, jos moduulin JS on jo asetettu välittämään kyseinen arvo kirjastolle. Lisäparametrien lisäämiseksi sinun täytyy muokata JS:n options-objektia suoraan. Moduuli tarkistaa yhden globaalin JS-muuttujan editoria11yOptionsOverride. Jos tämä on asetettu, se välittää options-objektin editoria11yOptions-funktiolle, jonka olet toimittanut moduulissasi tai teemassasi. Voit nyt asettaa mitä tahansa kirjaston parametreista.

Kirjoita omat testisi

Ensin lisää moduulin konfiguraatiossa 1 "Mukautetut testit" -vaihtoehtoon, jotta se tietää odottaa testejä.

Luo sitten Drupal JS -kirjasto testeillesi teemassasi tai moduulissasi käyttäen kirjaston ohjetta mukautettujen testien kirjoittamiseen.

Tässä toimiva esimerkki Princetonilta mukautetusta testistä Safe Links -varoitukselle. Huomaa, että se käyttää Editoria11y-luokkaa Drupal.Ed11y.:n kautta.

Tuki

Katso yhteystiedot-sivulta yhteisön tukivaihtoehdot. @itmaybejj on yleensä verkossa Drupal Slackissa, kun aurinko paistaa läntisellä pallonpuoliskolla.

Useimpiin CSA-tukitasoihin sisältyy vuosittainen katselmus, joka voi tarjota suoraa apua asennuksessa ja konfiguroinnissa