Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Have Guideline code link to meaningful information #28

Open
TheJaredWilcurt opened this issue Sep 1, 2017 · 1 comment
Open

Have Guideline code link to meaningful information #28

TheJaredWilcurt opened this issue Sep 1, 2017 · 1 comment

Comments

@TheJaredWilcurt
Copy link
Member

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.

@ryanparrish
Copy link

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

@TheJaredWilcurt TheJaredWilcurt added this to Groomed in Koa11y 4 Board Oct 27, 2017
@TheJaredWilcurt TheJaredWilcurt moved this from Groomed to Moved to v4 in Koa11y 3 Board Oct 27, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Koa11y 3 Board
Moved to v4
Development

No branches or pull requests

2 participants