Editoria11y Drupal modulim
Pamata funkcijas
Drupal modulis savieno pārbaudītāja bibliotēku ar redakcijas aizmuguri un pievieno virkni servera puses rīkus atskaišu, pārvaldības un konfigurācijas vajadzībām
CSA apakšmodulis pievieno:
- Pielāgotu pārbaužu veidotājs
- 40+ izstrādātāju pārbaudes
- Kontrasta pārbaude
- Vietnes rāpuļprogrammas
- Lasāmības analīze
- Sadalītā konfigurācija izstrādātājiem/redaktoriem
Instalācija un galvenie iestatīšanas soļi
Komplektētais instalētājs Drupal.org vietnē ietver vairākus moduļus:
- Editoria11y: pamata satura pārbaudītājs un informācijas panelis.
- Editoria11y CSA: izstrādātāju pārbaudes un informācijas paneļa uzturēšanas rīki.
- Editoria11y Export: CSV atskaišu rīki.
Instalējiet kā jebkuru citu moduli un pēc tam veiciet šos galvenos soļus:
- Pārbaudiet atļaujas. Uzticamajiem autoriem vajadzētu būt "Atzīmēt kā OK," "Atzīmēt kā ignorētu" un "Skatīt informācijas paneli."
- Pārbaudiet galvenās lapas attiecībā uz atkārtotiem vai nenoderīgiem brīdinājumiem. Vai nu atzīmējiet tos kā OK rīka padomā, vai pielāgojiet konfigurāciju, lai ignorētu elementus pēc selektora.
- Meklējiet padomus, kas ir grūti saskatāmi — ārpus ekrāna, apgriezti, aiz citiem elementiem vai slēptos elementos. Izmantojiet padomus sadaļā "Padomu pozicionēšanas labošana" zemāk, lai labotu.
- Ja vietnē jau ir saturs un jums ir CSA abonements, apmeklējiet informācijas paneļa cilni "Pārpārbaudīt" un rāpojiet pa vietni, lai iepriekš ielādētu vietnes atskaites. Tas nav obligāti, bet vecākas lapas neparādīsies atskaitēs, kamēr tās netiks rāpinātas vai apmeklētas no pieteikušās lietotāja.
Skatiet video ievadu par konfigurācijas opcijām (v2.4).
Paslēpt nenoderīgus brīdinājumus
Labas konfigurācijas nomāc nenoderīgus brīdinājumus, lai satura autori varētu koncentrēties uz problēmām, kas jālabo.
Lai gan varat pilnībā izslēgt pārbaudes, parasti labāk ir paslēpt brīdinājumus par konkrētiem elementiem vai lapām.
Katras pārbaudes palaišanas laikā Editoria11y apkopo vienu elementu kopu no iestatījuma "Pārbaudīt saturu šajos konteineros" un pēc tam vairākas reizes filtrē to. Lūk, kā izskatās pārbaudes palaišana:
- Pārtraukt pārbaudi, ja konfigurācija neļauj pārbaudīt šajā lapā vai šim lietotājam.
-
Apkopot elementus norādītajos lapas reģionos,
piem.:
body > *:not('.ed11y-element')
Editoria11y CSA lietotājiem šie ir reģioni cilnē Izstrādātāju pārbaudes. -
Noņemt elementus, kas atbilst ignorēšanas selektoriem,
piem.:
.widgets, .utility-menu
Editoria11y CSA lietotājiem šie ir selektori cilnē Izstrādātāju pārbaudes. - Palaist pārbaudes un sinhronizēt rezultātus ar informācijas paneli.
-
Ja sadalītā konfigurācija ir aktīva un lietotājs ir satura redaktors, filtrēt izstrādātāju rezultātus:
- Noņemt rezultātus no pārbaudēm, kas iestatītas kā "Tikai izstrādātājiem."
- Noņemt rezultātus par elementiem ārpus norādītajiem satura
reģioniem, piem.:
main, footer - Noņemt rezultātus par elementiem, kas atbilst satura ignorēšanas selektoriem.
- Atvērt paneli un parādīt brīdinājumus, ja konfigurācija atbilst automātiskās atvēršanas iestatījumam.
Noraidīt brīdinājumus
Pārbaudes var konfigurēt bibliotēkā kā kļūdas vai brīdinājumus ("manuālās pārbaudes"). Brīdinājumus var noraidīt. Katrā rīka padoma kājenē ir pieejami divi noraidīšanas veidi:
- "Ignorēt" tiek saglabāts kā lietotāja preferences: brīdinājums tagad ir paslēpts pašreizējam lietotājam, bet tikai pašreizējam lietotājam.
- "Atzīmēt kā OK" paslēpj brīdinājumu visiem lietotājiem.
To, vai lietotājs var noraidīt brīdinājumu, kontrolē lomas līmenī Drupal lietotāju atļaujās. Lielākajai daļai autoru vajadzētu atļaut noraidīt brīdinājumus. Nav jēgas piešķirt kādam manuālo pārbaudi, ja viņš nevar atzīmēt elementu kā pārbaudītu.
Ignorēt elementus
Šie divi konfigurācijas iestatījumi ir vissvarīgākie!
Iestatiet pirmo, lai iekļautu visas lapas daļas, ko satura autori var rediģēt. Piem., ja viņi var rediģēt
main satura apgabalu, .sidebar un .footer-column-two, iestatiet šos
selektorus kā satura pārbaudes apgabalu.
Izmantojiet otro, lai "izslēgtu" apakšsadaļas. Piem., ja main satur dažādus logrīkus un iestrādājumus,
ko var modificēt tikai izstrādātāji, uzskaitiet tos: .widget-1, .social-embed;
Ja izmantojat sadalīto konfigurāciju, cilnē Izstrādātāju pārbaudes redzēsit līdzīgu iestatījumu pāri:
Galvenais, kas jāzina par izstrādātāju pārbaudes apgabaliem, ir tas, ka tie nav neatkarīgi no satura pārbaudes apgabaliem. Sadalītā konfigurācijā izstrādātāju apgabali tiek pārbaudīti, un pēc tam šie rezultāti tiek filtrēti, lai atbilstu satura apgabaliem. Visi apgabali, kas ir izslēgti izstrādātājiem, tiks izslēgti arī satura redaktoriem. Neizslēdziet rediģējamos satura apgabalus!
Dažas pārbaudes ļauj precīzāku konfigurāciju, lai paslēptu tikai noteiktus brīdinājumus par ietekmētajiem elementiem. Meklējiet tos sadaļā:
- Satura pārbaudes: Pārbaudāmās saites
- Satura pārbaudes: Pārbaudāmie iestrādājumi
- Satura pārbaudes: Dinamiskā un ēnu satura atklāšana
- Izstrādātāju pārbaudes: Kontrasts
Paslēpt konkrētām lapām vai lietotājiem
Vienkāršākais veids to izdarīt ir nodot CSS klases vai ID šīm opcijām:
Pirmā novērsīs pārbaužu palaišanu, un rīkjosla netiks rādīta.
Otrā sāks pārbaudītāju minimizētā stāvoklī un automātiski atzīmēs (pašreizējam lietotājam) visas problēmas kā "Ignorētas," pat ja tās ir kļūdas. Tas ļauj pārbaudēm darboties un atjaunināt informācijas paneli, netraucējot lietotāju.
Ja vēlaties to izmantot, lai kontrolētu, kuri lietotāji redz pārbaudītāju, jums, iespējams, jāpielāgo tēma, lai izvadītu klasi, piem. .user-247
Pārvaldīt vietnes mēroga rezultātus
Rāpināšana un rezultātu atjaunināšana
Editoria11y ir reāllaika uzraudzības rīks, nevis rāpuļprogramma. Tās vietnes mēroga atskaites atjauninās, kad autori apmeklē lapas, tāpēc regulāra rāpināšana parasti nav nepieciešama. CSA modulis ietver rāpuļprogrammu, bet tai vajadzētu būt nepieciešamai tikai šādos trīs gadījumos:
- Pirmoreiz instalējot Editoria11y esošā vietnē ar daudzām lapām. Lapas jāapmeklē, pirms tās parādīsies informācijas panelī, tāpēc ātra sākotnējā rāpināšana ietaupa laiku.
- Nozīmīgi tēmu vai moduļu atjauninājumi var labot (vai izraisīt) problēmas daudzās lapās, kas neparādīsies, kamēr tās netiks apmeklētas vai rāpinātas.
- Lielapjoma darbības administratora saskarnē, piemēram, lapu vai novirzīšanu dzēšana, mēdz atstāt aiz sevis rezultātus no lapām, kas vairs nepastāv vai ir pārvietotas. Šādos gadījumos palīdz izmantot cilnes "Atsvaidzināt" uzturēšanas darbības, lai atjauninātu lapu URL un atklātu un noņemtu dzēstās lapas.
Rāpināšanas laikā nevieni dati neatstāj jūsu vietni. CSA rāpuļprogramma nav mākoņa rīks; tā izmanto jūsu pārlūkprogrammu, lai ielādētu un pārbaudītu lapas jūsu pašu vietnē. Šīs pieejas trūkums ir tas, ka pārlūkprogrammas aptur fona cilnes. Rāpināšanas laikā jums jāpatur dators ieslēgts un nomodā. Plānojiet atvērt jaunu logu rāpuļprogrammai un atstāt to kā priekšplāna cilni šim logam, kamēr tā darbojas. Jūs varat turpināt strādāt citā logā. Rāpuļprogramma atjauninās savu novērtējumu pēc katras lapu paketes.
Atskaišu skatīšana
- Jaunākais ļauj pārlūkot pa atsevišķiem brīdinājumiem. Tas ļauj filtrēt, lai atrastu visas viena brīdinājuma tipa instances, vai redzēt, kuri brīdinājumi bieži parādās jaunākajā saturā, vai kuri autori joprojām pieļauj tādu pašu kļūdu.
- Lapas rāda brīdinājumu skaitu pa lapām, grupētas pēc lapas. Tas ļauj atrast lapas ar visvairāk problēmām un filtrēt pēc lapas atribūtiem, piemēram, satura veida un publicēšanas statusa.
- Brīdinājumi rāda problēmas pēc veida.
- Noraidījumi ļauj uzraudzīt, vai autori norāda pareizi, un satur "atiestatīšanas" pogas noraidīto brīdinājumu atjaunošanai.
- Eksports satur lapu, brīdinājumu un noraidījumu atskaišu versijas, ko var filtrēt, lai sagatavotu CSV lejupielādes. Nodrošina CSV eksporta apakšmodulis
- Atsvaidzināt satur informācijas paneļa uzturēšanas rīkus, lai noņemtu brīdinājumus no dzēstajām lapām, noņemtu brīdinājumus no parametrizētām pseidolapām, piemēram, /search?query=example, atjauninātu saglabātos lapu virsrakstus un URL, un palaistu manuālu rāpināšanu. Nodrošina CSA apakšmodulis
Labot slēptus vai ārpus ekrāna esošus padomus
Modulis nodrošina laukus divām bibliotēkas konfigurācijas opcijām, lai mainītu padomu izvietojumu:
Dažām tēmām ir kolonnas vai logrīki, kas slēpj horizontālo vai vertikālo pārplūšanu. Bibliotēka automātiski nosaka, kad pārslēdzējs atrastos ārpus lapas redzamās daļas. Norādot bibliotēkai, ka noteikti konteineri slēpj pārplūšanu, tā arī mēģinās pozicionēt padomus elementiem šajos konteineros to robežu iekšpusē.
Dažām tēmām ir logrīki, kas pārslēdz satura redzamību, piemēram, akordeoni, cilnes un slaidrādes. Padomi šo elementu iekšpusē arī tiks paslēpti. Selektoru saraksta nodrošināšana šiem logrīkiem nozīmē, ka Editoria11y īsi apstāsies, kad lietotājs mēģina pāriet uz šiem padomiem, izmantojot nākamā vai iepriekšējā pogu. Drupal tēmas un moduļi var pēc tam sekot norādījumiem no bibliotēkas sadaļas par darbību ar padomiem slēptā saturā, lai atklātu slēpto saturu.
Rakstīt savu konfigurāciju
PHP: Drupal modulis nodrošina hook_editoria11y_alter_config, lai mainītu
drupalSettings.editoria11y saturu modulī vai tēmā. Piemēram:
drupalSettings modificēšana palīdz tikai tad, ja moduļa JS jau ir iestatīts, lai nodotu šo vērtību bibliotēkai. Lai pievienotu papildu parametrus, jums ir jāmodificē JS options objekts tieši.
Modulis pārbauda vienu globālu JS mainīgo editoria11yOptionsOverride. Ja tas ir iestatīts, tas nodos options objektu editoria11yOptions funkcijai, ko esat nodrošinājis savā modulī vai tēmā. Tagad varat iestatīt jebkuru no bibliotēkas parametriem.
Rakstīt savas pārbaudes
Vispirms moduļa konfigurācijā pievienojiet 1 opcijai "Pielāgotās pārbaudes", lai tas zinātu, ka jāuzrauga pārbaudes.
Pēc tam izveidojiet Drupal JS bibliotēku ar savām pārbaudēm savā tēmā vai modulī, izmantojot bibliotēkas ceļvedi pielāgotu pārbaužu rakstīšanai.
Šeit ir strādājošs piemērs no Princeton, ar pielāgotu pārbaudi brīdinājumiem par Safe Links. Ievērojiet, ka tas piekļūst Editoria11y klasei caur Drupal.Ed11y.
Palīdzības saņemšana
Skatiet lapu Kontakti, lai uzzinātu par kopienas atbalsta iespējām. @itmaybejj parasti ir tiešsaistē Drupal Slack, kad saule spīd virs rietumu puslodes.
Lielākā daļa CSA ieguldījumu līmeņu ietver gada tikšanos, kas var ietvert tiešu palīdzību ar iestatīšanu un konfigurāciju