Skip to content

accessibility guide - #3098

Open
Alex-Jordan wants to merge 1 commit into
openwebwork:WeBWorK-2.21from
Alex-Jordan:accessibility-guide
Open

accessibility guide#3098
Alex-Jordan wants to merge 1 commit into
openwebwork:WeBWorK-2.21from
Alex-Jordan:accessibility-guide

Conversation

@Alex-Jordan

Copy link
Copy Markdown
Contributor

This has issues, and I need to ask for everyone's (@drgrice1, @pstaabp, @somiaj, @dlglin) input to make this acceptable for a first release. Anyone else who wants to jump in? (@dpvc, @taniwallach, @glarose?) Perhaps it is easiest to contribute to this just by making a GitHub suggestion. But PRs to my branch are welcome.

This started out as a Claude-built summary of WeBWorK's accessibility. It was not great. I rewrote almost all of it except for the "Guidance for problem authors and editors" section. In that section, I added a thing or two, removed several things, and left other things as Claude wrote them even though I know they are bad. I'm especially wary of the graphTool section. The problem is I'm struggling to describe to people well how they should go about writing problems well, and even more with how to tell people how to convert existing problems to a more accessible form. I'm wondering if those of you who have worked more with the editor could take a stab at those sections. There is the conversion tool to PGML. The PG critic. The various links to sample problems, PGML help, and POD.

@drgrice1 drgrice1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the graphTool, this states that it has no non-visual interaction model, and that is NOT true anymore.

@drgrice1 drgrice1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, on the Plots::Plot usage, how is using that with a good alternate text any different than using a static image with a good alternate text? I don't think that this should discourage using the Plots::Plot approach. Note that Plots::Plot does not generate interactive graphs.

@Alex-Jordan

Copy link
Copy Markdown
Contributor Author

Those are the areas in particular that I left as Claude wrote them, knowing they are bad. I'm expecting them to be removed or replaced, I just don't know what to say if there is still anything to say. Are there known accessibility cautions to give about using either of them? I guess I should have just cleared the Claude text and left placeholder text.

@drgrice1

Copy link
Copy Markdown
Member

I do not know that the functionality of the graphTool is perfect, and I am certain it will still need more work. But just saying it is not accessible completely defeats the purpose of the work that I recently did on it.

Comment thread doc/AccessibilityGuide.md
- There is a Student Orientation that ships with WeBWorK, which orients students
to navigation and accessibility features.
- Site navigation is built with accessibility and user experience in mind.
- Answer blanks have labeling and other accessible features.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@drgrice1 Did you ever look at the issue where labels to answer blanks were lost when mathquill hid the original answer blank that had a label but didn't copy that label over to the mathquil blank?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. I will try to look into that.

@Alex-Jordan

Copy link
Copy Markdown
Contributor Author

For GraphTool, do you think one of the following options are good?

  • Remove mention of GraphTool.
  • Write about how GraphTool has had recent accessibility improvements, and we expect it to be largely accessible. But field testing reports are welcome.
  • Write about how GraphTool has had recent accessibility improvements with respect to keyboard operation, but non-sighted users may still have difficulty.

Or you can make an edit as a suggestion in the diff, and I'll just approve it.

Comment thread doc/AccessibilityGuide.md
Comment on lines +36 to +37
- Timed tests may have their times adjusted, and students can be assigned an
"accommodation factor" to expand all timed tests by the same factor.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really an accessibility feature?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe not, but it's something that I thought would be of interest to a disability services department that would be reading this. (BTW, that's more the audience that this is for, not faculty or students.)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Alex-Jordan in that case would it be worth mostly mentioning that problems accessibility can vary based on how it is authored, and make a second guide for authors?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The point is to make disability services staff feel comfortable that solutions exist for converting inaccessible problems to accessible ones. Whatever accomplishes that. But we don't have time to write a comprehensive separate authoring guide right now.

@drgrice1

Copy link
Copy Markdown
Member

@Alex-Jordan: I think that the second option for the GraphTool sounds right.

@Alex-Jordan

Copy link
Copy Markdown
Contributor Author

@Alex-Jordan: I think that the second option for the GraphTool sounds right.

OK, I'll make an edit like that and push soon.

@Alex-Jordan
Alex-Jordan force-pushed the accessibility-guide branch from 64b652f to ab116e9 Compare July 27, 2026 17:09
@somiaj

somiaj commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

I would suggest updating the information on alt tags and clarify that it is for static images. For graphs generated using PGgraphmacros.pl graphs or PGlateximage.pl/PGtikz.pl graphs, mention these just generate static images which follow the alt tag guide lines. But for generated graphs, I would encourage the use of using plots.pl to generate generate graphs with its default jsxgraph output. In that case the alt tag isn't really an alt tag, it is an aira-description which won't have character limits and unsure of the long_description is something that is needed for that.

@Alex-Jordan

Copy link
Copy Markdown
Contributor Author

I would suggest updating the information on alt tags and clarify that it is for static images. For graphs generated using PGgraphmacros.pl graphs or PGlateximage.pl/PGtikz.pl graphs, mention these just generate static images which follow the alt tag guide lines. But for generated graphs, I would encourage the use of using plots.pl to generate generate graphs with its default jsxgraph output. In that case the alt tag isn't really an alt tag, it is an aira-description which won't have character limits and unsure of the long_description is something that is needed for that.

Could I invite you to write what it should say, and either suggest that here in GitHub, or open a PR to my branch? This accessibility guide surveys so many things (like plots.pl) that I don't know much about.

@dlglin

dlglin commented Jul 27, 2026

Copy link
Copy Markdown
Member

Should we be including what accessibility checks WW has passed? We should be able to say something about the interface meeting accessibility standards of certain automated checkers as of the 2.21 release.

@Alex-Jordan

Copy link
Copy Markdown
Contributor Author

Should we be including what accessibility checks WW has passed? We should be able to say something about the interface meeting accessibility standards of certain automated checkers as of the 2.21 release.

By all means, please do :)

I don't have time to conduct a thorough review. I don't want to write "WeBWorK conforms to WCAG X.Y level Z" without actually checking everything in that standard. But I don't mind if someone else wants to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants