Instalēšana & konfigurēšana

Iepriekš konfigurētās versijas

Pielāgota instalācija

Lai izveidotu savu ieviešanu, lejupielādējiet lokālu kopiju (vai izmantojiet CDN versiju) ar valodas pakotni, JS min failu un CSS min failu, pēc tam izveidojiet jaunu "Ed11y" instanci.

Priekš ESM/JS moduļu importa:

Izmantojiet .umd JavaScript failus mantotajām pārlūkprogrammām un sistēmām:

Parametri

Pilna ieviešana tiks aktivizēta tikai pieteikušos redaktoriem (jūs nevēlaties, lai vietnes apmeklētāji redzētu jūsu pārbaudītāju!), un var pārrakstīt jebkuru no noklusējuma parametriem.

Ņemiet vērā, ka noklusējumi ir norādīti visiem parametriem; iekļaujiet tikai tos, ko vēlaties pārrakstīt.

Stipri pielāgota ieviešana varētu izskatīties šādi:

Gatavās integrācijas bieži iestata šos mainīgos darba laikā — piem., ielādējot lapas "assertive" režīmā, kad tās nesen rediģētas, un pārslēdzot atpakaļ uz "polite" pēc dažām minūtēm.

Tematizācija

Vairāki parametri ļauj izvēlēties tēmu, pārrakstīt krāsas un injicēt CSS.

Iekļaujiet tikai tos parametrus, kas jāpārraksta, lai nākotnes atjauninājumi būtu vieglāki.

Noderīgi JS notikumi

Tematizētāji var pievienot šos notikumus, lai reaģētu un pēc vajadzības modificētu lapu.

Tipiskajā parādīšanās secībā…

  • ed11yRunCustomTests: tiek izsūtīts, kad objekts Results ir gatavs pielāgoto rezultātu injicēšanai. Ņemiet vērā, ka parametram customTests jābūt iestatītam uz palaižamo pielāgoto pārbaudes funkciju skaitu (…iespējams, viens…), lai šis notikums tiktu izsūtīts. Sīkāk nākamajā sadaļā.
  • ed11yResults: tiek izsūtīts, kad visas pārbaudes ir pabeigtas. API integrācijas tagad var izgūt datus no objekta Ed11y.results.
  • ed11yPanelOpened: tiek izsūtīts, ja panelis tiek atvērts automātiski vai manuāli.
  • ed11yShowHidden: sniedz data-ed11y-result skaitli un viaJump Būla vērtību. Tiek izsūtīts tikai tad, ja ir iestatīts parametrs "ed11yShowHidden" un elementa vecākelements atbilst selektoram. Tiek izmantots, lai atklātu brīdinājumus vēl neatvērtos konteineros, piem., akordeonos, cilnēs un karuseļos. Lietošanas piemēri nākamajā sadaļā.
  • ed11yPop: sniedz data-ed11y-result ID, kā arī atsauces uz result un tip objektiem. Tiek izsūtīts, kad parādās rīka padoms, ļaujot modificēt padomus izpildes laikā.
  • ed11yShut: sniedz data-ed11y-result ID. Tiek izsūtīts, kad rīka padoms tiek aizvērts.
  • ed11yDismissalUpdate: sniedz papildinformāciju, kad lietotājs noraida vai atjauno brīdinājumu. Izmantots API integrācijām. Notikuma objekts satur:
    • dismissPage
    • dismissTest
    • dismissKey
    • dismissAction

Piemērus var atrast šādās sadaļās.

Padomu modificēšana

Ja vēlaties tikai modificēt padoma tekstu, objekta ed11yLang.en global (pirms bibliotēkas izsaukšanas) vai Ed11y.M (pēc bibliotēkas izsaukšanas) elementus var tieši pārrakstīt. Piem., Drupal modulī, kur mēs izveidojām valodas pakotnes aizstājvārdu kā Drupal.ed11yLang:

Drupal.ed11yLang.lang.testNames.title = "Please write shorter headings."

Tas attiecas uz jebkuru no noklusējuma atslēgām lokalizācijas failā vai aktīvo valodas specifisko tulkojumu.

Drupal modulis arī pievieno pielāgotas rediģēšanas saites padomiem, izmantojot parametru editLinks. Ievērojiet "Lapas redaktors" un "Izkārtojuma redaktors:"

Rīka padoms ar ievietotajām saitēm "Lapas redaktors" un "Izkārtojuma redaktors".

Vienkāršota tā parametra iestatīšanas koda versija:

Drupal modulis pēc tam izmanto notikumu ed11yPop, lai dinamiski parādītu un paslēptu rediģēšanas saiti atkarībā no konteksta, kad tiek parādīti padomi.

Šis notikums sniedz atsauces uz result un tip objektiem:

Pielāgotas pārbaudes

Ja parametrs customTests ir skaitlis, Editoria11y izsūtīs notikumu "ed11yRunCustomTests" pārbaudes laikā un pēc tam apturēsies uz līdz 500ms, gaidot tik daudz "ed11yResume" notikumu.

To var izmantot, lai izsauktu tik daudz skriptu ar pielāgotām pārbaudēm, cik vēlaties, kas var nostumt savus rezultātus rezultātu masīvā pirms padomu zīmēšanas.

Piemēram, ja vēlaties izveidot šo padomu, lai atzīmētu saites, kas ielīmētas no e-pastiem ar aizēnotiem URL:

Padoms ar uzrakstu "URL ir Safe Link kodēts"

Jums vajadzētu:

  1. Pievienot klausītāju notikumam ed11yRunCustomTests
  2. Atrast atbilstošos elementus
  3. Definēt padoma ziņojumu
  4. Izsūtīt "resume" notikumu, lai Editoria11y zīmētu padomu:

Brīdinājumu apstrāde slēptā vai izmēros ierobežotā saturā

Daudzi interaktīvie komponenti (cilnes, slaidrādes, akordeoni) slēpj saturu. Editoria11y informācijas panelis ietver nākamā/iepriekšējā pogas, lai tieši pārietu uz problēmām. Ja Editoria11y uzskata, ka problēmas rīka padoms pašlaik nav redzams, tas brīdinās lietotāju, ka kaut kas nav kārtībā, un pēc tam iezīmēs pirmo redzamo priekšteci — piem., div ap akordeonu.

Ideālā gadījumā jūsu tēma padarīs šos elementus redzamus pirms Editoria11y redzamības pārbaudes, lai viss vienkārši darbotos kā burvība jūsu lietotājiem — karuseļi automātiski virzās uz priekšu un akordeoni automātiski atveras, lai parādītu problēmu.

Lai to izdarītu, kad panelis pirmo reizi tiek atvērts (piem., izvēršot visus akordeonus ar problēmām), pievienojiet JS notikumu klausītāju ed11yPanelOpened, pēc tam veiciet querySelectorAll attiecīgajiem ed11y-element-result elementiem, un pēc tam aktivizējiet jebkuru funkciju, ko jūsu tēma izmanto, lai atklātu šo lapas daļu.

Šeit ir jQuery balstīts piemērs. Kad panelis tiek atvērts, tas atspējo lipīgo izvēlni (lai elementi nebūtu pārklāti), pēc tam meklē jebkurus ed11y-element-result elementus slēgtu akordeonam vienumu iekšpusē un simulē klikšķi uz to pārslēgšanas pogas:

Lai atklātu saturu tikai pārejot uz konkrētu padomu, izmantojot paneļa pogu "nākamais" (piem., slēgtā cilnē vai nākamajā karuseļa slaidā), jums būs jāiestata gan hiddenHandlers uz attiecīgajiem CSS selektoriem, gan checkVisible uz TRUE savos parametros. Pēc tam pievienojiet notikumu klausītāju notikumam ed11yShowHidden. Tas tiek aktivizēts, ja Editoria11y atpazīst, ka padoms atrodas konteinerā ar kādu no norādītajiem hiddenHandlers selektoriem opciju sarakstā. Šis JS notikums ietvers to padomu ID, ko tas gatavojas atvērt. Editoria11y pēc tam īsi apstāsies pēc šī notikuma izsūtīšanas, lai dotu jūsu JS laiku padarīt elementu redzamu.

Šeit ir piemērs no Penn State ieviešanas. Tas meklē elementu, kas atbilst norādītajam ID, pēc tam atrod tā vecākelementu interaktīvo komponentu konteineru un aktivizē tā notikumu, lai aktivizētu tā pārslēgšanu:

Pēdējā piezīme: dažas tēmas vienkārši nav saderīgas ar redzamības pārbaudi — piem., konteineram <main> ir augstums 0px. Šādām vietnēm jāatspējo visa redzamības pārbaude, iestatot checkVisible uz false.