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

<article> label is the same for every annotation by the same author #6185

Open
Tracked by #6151
acelaya opened this issue Feb 7, 2024 · 2 comments
Open
Tracked by #6151

<article> label is the same for every annotation by the same author #6185

acelaya opened this issue Feb 7, 2024 · 2 comments

Comments

@acelaya
Copy link
Contributor

acelaya commented Feb 7, 2024

Currently, each annotation uses an <article> element, which can improve navigation for assistive technology users. However, the article elements have identical labels and headings for annotations by the same person. As a result, when interacting with the annotations through the list of landmarks or headings, landmarks are announced the same for annotations by the same user.

To improve the accessibility and ease navigation between annotations, consider:

  • Wrapping the articles in an unordered list (<ul>) tag with each article in a list item (<li>) tag so that the total number of annotations and position may be determined by assistive technology
  • Changing the article heading to indicate both who added the annotation and the number, e.g. “Annotation 1 by Lisa Liskovoi”, “Annotation 2 by Lisa Liskovoi”, etc.
  • Adding an aria-labelledby attribute and linking it to the article heading (the heading that indicates who posted the annotation)
  • Adding an aria-describedby attribute to the article and associating it with the highlighted portion of the annotation.
  • To improve accessibility further, an aria-describedby attribute can be added to the edit, reply, and delete buttons to associate them with the annotation as well.
@acelaya acelaya changed the title <article> label is the same for every annotation by the same author, making landmark navigation more difficult <article> label is the same for every annotation by the same author Feb 7, 2024
@acelaya acelaya self-assigned this Feb 7, 2024
@acelaya acelaya moved this to In Progress in Accessibility improvements Feb 7, 2024
@acelaya acelaya moved this from In Progress to Todo in Accessibility improvements Feb 7, 2024
@acelaya acelaya moved this from Todo to In Progress in Accessibility improvements Feb 9, 2024
@acelaya
Copy link
Contributor Author

acelaya commented Feb 12, 2024

I think we can't do any of the last three points around using aria-labelledby, because the highlighted text and the annotation card live in different frames.

@acelaya acelaya moved this from In Progress to Todo in Accessibility improvements Feb 12, 2024
@acelaya acelaya removed their assignment Feb 13, 2024
@robertknight
Copy link
Member

See #6305 for some ideas around things we could add to the label to disambiguate annotations by the same author.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

No branches or pull requests

2 participants