Installimine & konfigureerimine

Eelkonfigureeritud versioonid

Kohandatud installimine

Oma implementatsiooni loomiseks laadige alla kohalik koopia (või viidake CDN versioonile) keeleplokist, JS min-failist ja CSS min-failist ning looge seejärel uus „Ed11y" eksemplar.

ESM/JS mooduli importide jaoks:

Kasutage .umd JavaScript-faile pärandbrauserite ja -süsteemide jaoks:

Parameetrid

Täielik integratsioon käivitatakse ainult sisselogitud toimetajate jaoks (te ei soovi, et külastajad näeksid kontrollijat!), ning see võib alistada mis tahes vaikimisi parameetreid.

Pange tähele, et kõikide parameetrite jaoks on olemas vaikeväärtused; lisage ainult need, mida soovite alistada.

Põhjalikult kohandatud implementatsioon võib välja näha järgmiselt:

Valmisintegratsioonid määravad sageli neid muutujaid lennult — näiteks laadivad lehti „assertive" režiimis, kui neid on hiljuti muudetud, ja lülituvad pärast mõnda minutit tagasi „polite" režiimi.

Teemastamine

Mitmed parameetrid võimaldavad teema valimist, värvide alistamist ja CSS-i süstimist.

Lisage ainult parameetrid, mida peate alistama, et tulevased uuendused oleksid lihtsamad.

Kasulikud JS-sündmused

Teemakujundajad saavad neid sündmusi haakida, et reageerida ja muuta lehte vastavalt vajadusele.

Tavapärases ilmumise järjekorras…

  • ed11yRunCustomTests: käivitatakse, kui tulemuste objekt on valmis kohandatud tulemuste süstimiseks. Pange tähele, et customTests parameeter peab olema seatud käitatavate kohandatud testifunktsioonide arvule (…tõenäoliselt üks…), et see sündmus käivituks. Üksikasjad järgmises jaotises.
  • ed11yResults: käivitatakse, kui kõik kontrollid on lõppenud. API integratsioonid saavad nüüd andmeid Ed11y.results objektist kätte.
  • ed11yPanelOpened: käivitatakse, kui paneel avaneb, automaatselt või käsitsi.
  • ed11yShowHidden: pakub data-ed11y-result numbrit ja viaJump boolean-väärtust. Käivitatakse ainult siis, kui „ed11yShowHidden" parameeter on seatud ja elemendi vanem vastab selektorile. Kasutatakse hoiatuste paljastamiseks mitte-veel-avatud konteinerites, nt akordionites, vahelehtedes ja karusellidel. Kasutuse näited järgmises jaotises.
  • ed11yPop: pakub data-ed11y-result ID-d ning viiteid result ja tip objektidele. Käivitatakse, kui tööriistavihje ilmub, võimaldades teil vihjeid käitusajal muuta.
  • ed11yShut: pakub data-ed11y-result ID-d. Käivitatakse, kui tööriistavihje sulgub.
  • ed11yDismissalUpdate: pakub laiendatud teavet, kui kasutaja lükkab hoiatuse tagasi või taastab selle. Kasutatakse API integratsioonides. Sündmuse objekt sisaldab:
    • dismissPage
    • dismissTest
    • dismissKey
    • dismissAction

Näited on leitavad järgmistes jaotistes.

Vihjete muutmine

Kui soovite ainult vihje teksti muuta, saab ed11yLang.en globaalse objekti üksusi (enne teegi kutsumist) või Ed11y.M objekti üksusi (pärast teegi kutsumist) otse alistada. Nt Drupali moodulis, kus aliasime keeleploki Drupal.ed11yLang-iks:

Drupal.ed11yLang.lang.testNames.title = "Palun kirjutage lühemaid pealkirju."

See kehtib kõigi lokaliseerimisfaili vaikevõtmete või aktiivse keelespetsiifilise tõlke kohta.

Drupali moodul lisab vihjetele kohandatud redigeerimislinke, kasutades editLinks parameetrit. Pange tähele „Lehe redaktorit" ja „Paigutuse redaktorit":

Tööriistavihje, kus on sisestatud „Lehe redaktor" ja „Paigutuse redaktor" lingid.

Lihtsustatud versioon koodist, mis seda parameetrit seab:

Drupali moodul kasutab seejärel ed11yPop sündmust, et dünaamiliselt näidata ja peita redigeerimislinki konteksti põhjal, kui vihjeid näidatakse.

See sündmus pakub viiteid result ja tip objektidele:

Kohandatud testid

Kui customTests parameeter on arv, käivitab Editoria11y kontrollimisel „ed11yRunCustomTests" sündmuse ja peatub kuni 500ms, kuulates seda arvu „ed11yResume" sündmusi.

Seda saab kasutada nii paljude kohandatud teste sisaldavate skriptide väljakutsumiseks, kui soovite, mis saavad oma tulemused tulemuste massiivi suruda enne vihjete joonistamist.

Näiteks kui soovite luua selle vihje, et märkida linke, mis on kleebitud e-kirjadest varjatud URL-idega:

Vihje tekstiga „URL on Safe Link kodeeritud"

Toimige järgmiselt:

  1. Lisage kuulaja ed11yRunCustomTests sündmuse jaoks
  2. Leidke sobivad elemendid
  3. Määratlege vihje sõnum
  4. Käivitage „resume" sündmus, et lasta Editoria11y-l vihjet joonistada:

Peidetud või ekraanil nähtamatu sisu hoiatuste käsitlemine

Paljud interaktiivsed komponendid (vahelehed, liugurid, akordionid) peidavad sisu. Editoria11y teabepaneel sisaldab järgmise/eelmise nuppu, et otse probleemidele hüpata. Kui Editoria11y arvab, et probleemi tööriistavihje on praegu nähtamatu, hoiatab ta kasutajat midagi valesti olevat ja tõstab esile esimese nähtava eellase — nt akordioni ümber oleva div-i.

Ideaalis muudab teie teema need elemendid nähtavaks enne Editoria11y nähtavuse kontrollimist, nii et kõik toimib nagu võluväel teie kasutajatele — karusellis liiguvad automaatselt edasi ja akordionid avanevad automaatselt probleemi kuvamiseks.

Selleks, kui paneel esimest korda avaneb (nt kõikide probleemidega akordionipaneelide lahtivoltimiseks), lisage JS-sündmuse kuulaja ed11yPanelOpened jaoks, seejärel tehke querySelectorAll asjakohaste ed11y-element-result elementide jaoks ja käivitage seejärel funktsioon, mida teie teema kasutab lehe selle osa paljastamiseks.

Siin on jQuery-põhine näide. Kui paneel avaneb, keelab see kleepuva menüü (et elemendid ei oleks kaetud), seejärel otsib kõiki ed11y-element-result elemente suletud akordioni üksuste sees ja simuleerib klõpsu nende lülitusnupul:

Sisu paljastamiseks ainult konkreetsele vihjele hüppamisel paneeli „järgmine" nupu kaudu (nt suletud vaheleheküljel või järgmisel karusellislaidil), peate seadma nii hiddenHandlers asjakohastele CSS-selektoritele kui ka checkVisible väärtusele TRUE oma parameetrites. Seejärel lisage sündmuse kuulaja ed11yShowHidden sündmuse jaoks. See käivitatakse, kui Editoria11y tunneb ära, et vihje asub konteineri sees, millel on üks loetletud hiddenHandlers selektoritest suvandite loendis. See JS-sündmus sisaldab selle vihje ID-d, mida ta kavatseb avada. Editoria11y peatub seejärel lühidalt pärast selle sündmuse käivitamist, et anda teie JS-ile aega element nähtavaks muuta.

Siin on näide Penn State'i implementatsioonist. See otsib elemendi, mis vastab antud ID-le, seejärel leiab selle vanem-interaktiivse komponendi konteineri ja käivitab selle sündmuse lüliti aktiveerimiseks:

Viimane märkus: mõned teemad ei ole nähtavuse kontrollimisega ühilduvad — nt <main> konteineril on kõrgus 0px. Sellised saidid peaksid keelama kõik nähtavuse kontrollimised, seades checkVisible väärtuseks false.