Project

General

Profile

Actions

Bug #18921

closed

Add Editoria11y plugin?

Added by Matt Gold 7 months ago. Updated 2 months ago.

Status:
Resolved
Priority name:
Normal
Assignee:
Category name:
WordPress Plugins
Target version:
Start date:
2023-09-27
Due date:
% Done:

0%

Estimated time:
Deployment actions:

git submodule update wp-content/plugins/cac-plugin-packages


Description

I was having a conversation with Charlie, who mentioned that the OpenLab has found this plugin useful: https://editoria11y.princeton.edu/

Boone, do you have experience with this? Luke, Laurie, Scott - can you please take a look and see whether it is something you think we should add?


Files

Actions #1

Updated by Matt Gold 3 months ago

Hi all -- I want to give this a bump. We've heard from the OpenLab team that this works well on the OL. Especially given urgent accessibility concerns at CUNY, I want to argue that we should add this and also include it in the teaching template unless there are any objections

Actions #2

Updated by Boone Gorges 3 months ago

  • Assignee changed from Boone Gorges to Raymond Hoh
  • Target version set to 2.3.1

Plugin added in https://github.com/cuny-academic-commons/cac/commit/fd7777fd87b77459609a45425dc0f9d586482e18

Laurie, could you provide some details about whether and how the plugin should be included in packages? See Dashboard > Plugins > Plugin Packages. Should it just be in teaching? If so, where in the list? What should the descriptive text be?

Once those details are decided, I may ask Ray to implement as part of cac-plugin-packages.

Actions #3

Updated by Matt Gold 3 months ago

Thank you, Boone.

Actions #4

Updated by Boone Gorges 3 months ago

  • Target version changed from 2.3.1 to 2.3.2
Actions #5

Updated by Laurie Hurson 3 months ago

Hi All,

Apologies for the delay.

I will install the plugin on the teaching template site so it is activated on all future templated sites.

I think it should be added to both the Teaching and Digital Tools plugin packages.

I might even go as far as installing on every site that is created, similar to imsanity and other accessibility and technical plugins we have auto-activated. It looks really helpful for content authors by flagging important issues such as missing header text, ambiguous link text... Perhaps ill test it first and then circle back with feedback on how distracting the notifications/pop ups are.

Copy for plugin packages below:

- Editoria11y: AKA editorial ally, is a user-friendly tool that provide instant feedback on the accessibility and readability of web pages and posts.

Actions #7

Updated by Boone Gorges 3 months ago

Thanks, Laurie!

I think it should be added to both the Teaching and Digital Tools plugin packages.

I might even go as far as installing on every site that is created, similar to imsanity and other accessibility and technical plugins we have auto-activated. It looks really helpful for content authors by flagging important issues such as missing header text, ambiguous link text... Perhaps ill test it first and then circle back with feedback on how distracting the notifications/pop ups are.

If you want it activated on every new site, just activate it on every template. As for the plugin packages, I'll hold off until I've got some post-testing thoughts from you.

Actions #8

Updated by Laurie Hurson 3 months ago

Hi All,

This plugin is pretty helpful and not intrusive. The tool flags headings,link text, image alt text issues pretty seamlessly. I think there is some overlap with what WP Accessibility flags (esp in relation to images) but I don't think that's a problem.

I think it would be ideal if this plugin was active on all new sites. I activated it on the conference and academic templates. I am not sure I have access to the site used as part of the "default template" so cannot activate it there. Does some one else have access to the "default" site to activate?

Should we also consider activating on all current sites?

Actions #9

Updated by Laurie Hurson 3 months ago

Forgot to upload screenshots of views of the plugin running with the block editor.

It does function somewhat like "spellcheck" for accessibility as it says on the website. It flags items so you can view the issue and correct. Though if you knew nothing about accessibility some of the manual check guidelines and questions might be confusing (e.g. "Is this link meaningful and concise?").

I think any confusion could be cleared up with documentation. This raises a question: could we embed a "more info" link somewhere within the alerts to link to our documentation? Not pressing now, but wanted to flag that as a option/idea.

Actions #10

Updated by Boone Gorges 3 months ago

I think it would be ideal if this plugin was active on all new sites. I activated it on the conference and academic templates. I am not sure I have access to the site used as part of the "default template" so cannot activate it there. Does some one else have access to the "default" site to activate?

Laurie, I've made you an Administrator on default-template.commons.gc.cuny.edu.

Actions #11

Updated by Laurie Hurson 3 months ago

Thanks Boone.

I activated it on all template sites (teaching, academic, conference, and default) so I think it will be active on all new sites.

It might make the most sense if it is listed as part of the Teaching and Digital Tools Packages.

Actions #12

Updated by Raymond Hoh 3 months ago

  • Category name set to WordPress Plugins
  • Status changed from Assigned to Staged for Production Release
  • Deployment actions updated (diff)

I've added Editoria11y to the Teaching and Digital Tools plugin packages in https://github.com/cuny-academic-commons/cac/commit/22ad8b73a3add3f843e3f3d1184d88e384f6d018 . Boone, I've added a note to the Deployment Actions section of the ticket because the git submodule will need updating once deployed.

Actions #13

Updated by Matt Gold 3 months ago

Thank you, all!

Actions #14

Updated by Laurie Hurson 3 months ago

Thanks all!

Just confirming: the plugin is activated on all template sites and it looks like the updates to the plugin packages will go live in the 2/13 release.

Actions #15

Updated by Raymond Hoh 3 months ago

it looks like the updates to the plugin packages will go live in the 2/13 release.

That's correct, Laurie, unless we need to add Editoria11y to the plugin packages before then.

Actions #16

Updated by Boone Gorges 2 months ago

  • Status changed from Staged for Production Release to Resolved
Actions

Also available in: Atom PDF