Skip to content

Conversation

@richard-hajek
Copy link

Pull Request Checklist

Issue

https://otwarchive.atlassian.net/browse/AO3-7131

Purpose

This PR addresses AO3-7131, bad accessibility of help modals.

I have some concerns:

  • This PR does the "bare minimum" fix as described in the AO3-7131
  • BUT a better solution would require a major undertaking of restructuring the help modals
  • AND there's a fresh comment in the source code, from Dec 2025, indicating that the entire function will be replaced anyway for help pages, so a bare minimum fix might work
# TODO: AO3-7208 Make help modals dynamic and translatable and use link_to_help_modal instead of this method 

Testing Instructions

Described in AO3-7131, I tested using KDE built in screen reader and Firefox.

Credit

Richard Hajek, he/him, assigned in Jira

@slavalamp
Copy link
Contributor

According to the ticket, the links should only have the aria-label attribute, not both title and aria-label. The title attribute is not very accessible, since it can't be seen on mobile devices and screen reader behavior is inconsistent with it

The new method link_to_help_modal already exists, it's right after link_to_help in the same file, so the attribute should be replaced there too.

(from the ticket)

It will take a while to come up with a good naming system for the links, but we can make the underlying changes and add new link text in one location as a test/proof of concept.

The Tag Search page, referenced in “Steps to reproduce”/”What happens,” has one help link for the “Tag name” field that can be used for this purpose. We can change the link name from “Tag search text help” to “Tag name search help.”

Now that the "locale preferences" help modal is prepared for localization and using the new method, it might be a good idea to do it with that one instead, with a new link name like "Locale preferences help"

Also, you should fix style issues that Rubocop finds - use double quotes and add the space where it's missing after a colon in this case. There's a bit of info on Rubocop in the wiki (Reviewdog and RuboCop, Previewing Reviewdog comments) and you can look up info on specific guidelines using their names if you need examples - e.g. Style/StringLiterals

@richard-hajek
Copy link
Author

Thanks for the review! I'll get on it

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants