Editoria11y untuk Drupal

Fitur inti

Modul Drupal menghubungkan perpustakaan pemeriksa ke backend editorial, dan menambahkan banyak alat sisi server untuk pelaporan, tata kelola, dan konfigurasi

Langkah instalasi dan pengaturan utama

Installer yang disertakan di Drupal.org menyertakan beberapa modul:

• Editoria11y: pemeriksa konten inti dan dasbor.
• Editoria11y CSA: uji pengembang dan alat pemeliharaan dasbor.
• Editoria11y Export: alat pelaporan CSV.

Instal seperti modul lainnya, lalu ikuti langkah-langkah utama ini:

1. Periksa izin. Penulis tepercaya harus memiliki "Mark OK," "Mark as Ignored," dan "View the dashboard."
2. Periksa halaman-halaman penting untuk peringatan yang berulang atau tidak membantu. Tandai sebagai OK dalam tooltip, atau sesuaikan konfigurasi untuk mengabaikan elemen berdasarkan selektor.
3. Cari tips yang sulit dilihat — di luar layar, terpotong, di belakang elemen lain, atau pada elemen tersembunyi. Gunakan tips di "Fix tip positioning" di bawah ini untuk memperbaiki.
4. Jika situs sudah memiliki konten, dan Anda memiliki langganan CSA, kunjungi tab "recheck" dasbor, dan crawl situs untuk memuat laporan situs terlebih dahulu. Ini opsional, tetapi halaman lama tidak akan muncul dalam laporan hingga di-crawl atau dikunjungi oleh pengguna yang sudah login.

Lihat pengenalan video tentang opsi konfigurasi (v2.4).

Sembunyikan peringatan yang tidak membantu

Konfigurasi yang baik menekan peringatan yang tidak membantu, sehingga penulis konten dapat fokus pada isu yang perlu diperbaiki.

Meskipun Anda dapat menonaktifkan pengujian sepenuhnya, biasanya lebih baik menyembunyikan peringatan pada elemen atau halaman tertentu.

Selama setiap pengujian, Editoria11y mengumpulkan satu set elemen dari pengaturan "Check content in these containers", kemudian memfilternya beberapa kali. Begini tampilan pengujian:

1. Batalkan pemeriksaan jika konfigurasi mencegah pemeriksaan pada halaman ini atau untuk pengguna ini.
2. Kumpulkan elemen di wilayah halaman yang ditentukan, mis.:
   body > *:not('.ed11y-element')
   Untuk pengguna Editoria11y CSA, ini adalah wilayah pada tab Developer tests.
3. Hapus elemen yang cocok dengan selektor pengabaian, mis.:
   .widgets, .utility-menu
   Untuk pengguna Editoria11y CSA, ini adalah selektor pada tab Developer tests.
4. Jalankan pengujian dan sinkronkan hasil ke dasbor.
5. Jika konfigurasi terpisah aktif dan pengguna adalah editor konten, saring hasil pengembang:
   • Hapus hasil dari pengujian yang disetel ke "Developer only."
   • Hapus hasil pada elemen dari luar wilayah konten yang ditentukan, mis.:
     main, footer
   • Hapus hasil pada elemen yang cocok dengan selektor abaikan konten.
   Note that there is not a second "gather" phase. The developer page regions must include the content regions.
6. Buka panel dan gambar peringatan jika konfigurasi cocok dengan pengaturan buka otomatis.

Abaikan peringatan

Pengujian dapat dikonfigurasi dalam perpustakaan sebagai kesalahan atau peringatan ("pemeriksaan manual"). Peringatan dapat diabaikan. Ada dua jenis pengabaian yang tersedia dari footer setiap tooltip:

• "Ignore" disimpan sebagai preferensi pengguna: peringatan kini disembunyikan untuk pengguna saat ini, tetapi hanya pengguna tersebut.
• "Mark OK" menyembunyikan peringatan untuk semua pengguna.

Kemampuan pengguna untuk mengabaikan peringatan dikontrol di tingkat peran dalam izin pengguna Drupal. Sebagian besar penulis harus diizinkan mengabaikan peringatan. Tidak ada gunanya memberi seseorang pemeriksaan manual jika mereka tidak bisa menandai item tersebut sebagai sudah diperiksa.

Abaikan elemen

Dua pengaturan konfigurasi ini adalah yang paling penting!

Tetapkan yang pertama untuk mencakup bagian mana pun dari konten halaman yang dapat diedit oleh penulis konten. Mis., jika mereka dapat mengedit area konten main, .sidebar, dan .footer-column-two, tetapkan selektor tersebut sebagai area pemeriksaan konten Anda.

Gunakan yang kedua untuk "menyingkirkan" subbagian. Mis., jika main berisi berbagai widget dan embed yang hanya dapat dimodifikasi oleh pengembang, buat daftarnya: .widget-1, .social-embed;

Jika Anda menggunakan konfigurasi terpisah, Anda akan melihat pasangan pengaturan serupa pada tab Developer Tests:

Hal penting yang perlu diketahui tentang area pemeriksaan pengembang adalah bahwa mereka tidak independen dari area pemeriksaan konten. Dalam konfigurasi terpisah, area pengembang diperiksa, dan kemudian hasilnya difilter untuk cocok dengan area konten. Area yang dikecualikan untuk pengembang juga akan dikecualikan untuk editor konten. Jangan kecualikan area konten yang dapat diedit!

Beberapa pengujian memungkinkan konfigurasi yang lebih tepat, untuk hanya menyembunyikan peringatan tertentu pada elemen yang terpengaruh. Cari di bawah:

• Uji konten: Tautan untuk diperiksa
• Uji konten: Embed untuk diperiksa
• Uji konten: Mendeteksi konten dinamis dan shadow
• Uji pengembang: Kontras

Sembunyikan untuk halaman atau pengguna tertentu

Cara termudah untuk melakukan ini adalah dengan meneruskan kelas CSS atau ID ke opsi-opsi ini:

Yang pertama akan mencegah pemeriksaan berjalan, dan toolbar tidak akan ditampilkan.

Yang kedua akan memulai pemeriksa dalam keadaan diminimalkan, dan secara otomatis menandai (untuk pengguna saat ini) semua isu sebagai "Diabaikan," bahkan jika berupa kesalahan. Ini memungkinkan pengujian berjalan dan memperbarui dasbor tanpa mengganggu pengguna.

Jika Anda ingin menggunakan ini untuk mengontrol pengguna mana yang melihat pemeriksa, Anda mungkin perlu menyesuaikan tema untuk menghasilkan kelas, mis. .user-247

Kelola hasil seluruh situs

Perbaiki tips yang tersembunyi atau di luar layar

Modul menyediakan kolom untuk dua opsi konfigurasi perpustakaan untuk mengubah cara penempatan tips:

Beberapa tema memiliki kolom atau widget yang menyembunyikan overflow horizontal atau vertikal. Perpustakaan secara otomatis mendeteksi kapan toggle akan berada di luar bagian yang terlihat dari halaman. Memberi tahu perpustakaan bahwa kontainer tertentu menyembunyikan overflow berarti ia juga akan mencoba memposisikan tips untuk elemen di kontainer tersebut di dalam batasnya.

Beberapa tema memiliki widget yang mengalihkan visibilitas konten, seperti akordion, tab, dan slideshow. Tips di dalam elemen-elemen ini juga akan disembunyikan. Menyediakan daftar selektor untuk widget-widget ini berarti Editoria11y akan berhenti sejenak saat pengguna mencoba melompat ke tips tersebut menggunakan tombol berikutnya atau sebelumnya. Tema dan modul Drupal kemudian dapat mengikuti petunjuk dari bagian perpustakaan tentang menangani tips pada konten tersembunyi untuk menampilkan konten yang tersembunyi.

Tulis konfigurasi Anda sendiri

Dalam PHP: modul Drupal menyediakan hook_editoria11y_alter_config untuk mengubah konten drupalSettings.editoria11y di modul atau tema. Misalnya:

Memodifikasi drupalSettings hanya membantu jika JS modul sudah diatur untuk meneruskan nilai tersebut ke perpustakaan. Untuk menambahkan parameter tambahan, Anda perlu memodifikasi objek JS options secara langsung. Modul memeriksa satu variabel JS global editoria11yOptionsOverride. Jika ini disetel, ia akan meneruskan objek options ke fungsi editoria11yOptions yang Anda sediakan di modul atau tema Anda. Anda sekarang dapat menetapkan salah satu dari parameter perpustakaan.