Koa11y icon indicating copy to clipboard operation
Koa11y copied to clipboard

Have Guideline code link to meaningful information

Open TheJaredWilcurt opened this issue 7 years ago • 1 comments

Screenshot of an error message from a Koa11y Report

The guideline code shown at the top of this error message has a predictable pattern. We could grab the G17 part of it and use that to create a link to give the reader of the report more details about the guideline.

Here is a quick sketch of a possible implementation.

var guideline = 'WCAG2AAA.Principle1.Guideline1_4.1_4_6.G17.Fail';
var criteria = guideline.split('.')[4];
var url = 'https://www.w3.org/TR/WCAG20-TECHS/' + criteria +  '.html';
var link = '<a href="' + url + '">' + guideline + '</a>';

The above code needs more thorough testing. The spec pages include a lot more information, and links to resources on that topic. but could be too technical for most users. If we can find a plain English alternative that would be preferred.

TheJaredWilcurt avatar Sep 01 '17 17:09 TheJaredWilcurt

W3 has a lot of information on the guidelines I am not sure if it is usable

https://www.w3.org/WAI/WCAG20/quickref/?showtechniques=143#qr-visual-audio-contrast-contrast

ryanparrish avatar Sep 27 '17 00:09 ryanparrish