devex icon indicating copy to clipboard operation
devex copied to clipboard

$10k project idea #5 - CKEditor, aXe & Accessibility

Open mgifford opened this issue 6 years ago • 3 comments

CKEditor is a very common WYSIWYG editor. It's built into Drupal 8 by default. Accessible content could be more easily create in sites if there was an easy way to assist authors to identify problems. This is part of ATAG 2.0. Fortunately, there is a module to do this already. Unfortunately, they built it on a depreciated JavaScript library. So, this accessibility engine needs to be swapped out for another one. At this point aXe-Core seems to be the most likely. See:

https://github.com/cksource/ckeditor-plugin-a11ychecker/issues/204#issuecomment-228303907

The goal is to replace this engine. Unfortunately, it is unclear exactly how complicated this task is. Ideally the first $10k contract will provide a working prototype that can be contributed back to the CKEditor community as a patch for review. The minimum requirement for this contract is delivery of a document which outlines the steps which are required to address this problem and fleshing out what problems might arise.

mgifford avatar May 05 '18 15:05 mgifford

tinyMCE does about the same thing as CKEditor and may be an alternative place to start instead. Ideally either editor would use an alternative markup language other than html. Storing/displaying user edited html is just asking for Cross-site scripting vulnerabilities.

Maybe markdown and simpleMDE as a base instead? Replacing CKEditor in Drupal with simpleMDE as a base would make a good project.

chrislongtin avatar May 11 '18 18:05 chrislongtin

I'm totally for looking for projects like this that would benefit the government (and everyone else). I totally hear you on markdown. For most of government communications, I think that this is all that is needed.

Some example projects from this:

  • Adding aXe-core to TinyMCE - https://www.tinymce.com/docs/plugins/a11ychecker/
  • Evaluate & document MarkDown filter like https://www.drupal.org/project/markdown
  • Evaluate & document simpleMDE implementation for Drupal https://www.drupal.org/project/simplemde

First challenge is to see if there is already an effort for this in the community and then build on it.

mgifford avatar May 11 '18 18:05 mgifford

From Medium post: https://medium.com/@mgifford/i-would-definitely-update-it-with-or-without-covid-19-e326e1882603

Update on issue from May 2020

#5 — CKEditor & Axe, still needs to be done.

MaryBethBaker avatar May 18 '20 16:05 MaryBethBaker