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

Update guidance around roles and epub:type #1682

Merged
merged 4 commits into from
Jun 2, 2021
Merged

Conversation

mattgarrish
Copy link
Member

This PR tries to better match the SEM-001 technique to what we now recommend and validate - namely that role and epub:type do not have to appear together.

I've made the section focus on the use of ARIA role and noted that roles are only a requirement for user interface components.

The epub:type explanation is now in a separate subsection.

Suggestions on how to improve the text welcome.

Copy link
Contributor

@clapierre clapierre left a comment

Choose a reason for hiding this comment

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

<p>EPUB Creators only have to use ARIA roles for interactive controls per <a href="https://www.w3.org/TR/WCAG/#name-role-value"&gt;success criterion 4.1.2</a> (i.e., they are not required to add roles to landmarks and other document structures to conform).</p>

Doesn't this imply the author shouldn't use role="doc-chapter" , role="doc-glossary", etc. since they are not required to add roles to landmarks and other document structures?

Not sure I like this. We want to encourage authors to use these, as this goes beyond the traditional ARIA role and adds semantic structure to the documents which will be leveraged as AT and reading systems evolve.

We are currently working on this with DAISY and the TIES group to determine the current DPUB ARIA roles exposed to AT and how this can be improved for a better overall experience.

@mattgarrish
Copy link
Member Author

Doesn't this imply the author shouldn't use role="doc-chapter" , role="doc-glossary", etc. since they are not required to add roles to landmarks and other document structures?

The techniques are supposed to explain how to meet WCAG for EPUB-specific peculiarities, so it's already a bit unclear why we're discussing ARIA roles when there's nothing different about them.

I'm tempted to throw out any discussion of them and simply leave the section clarifying epub:type.

Would that be less concerning to you?

@mattgarrish
Copy link
Member Author

Have a look at the revised text. I've only kept the epub:type differentiation prose and noted that requirements for roles are not satisfied by using epub:type.

Copy link
Contributor

@clapierre clapierre left a comment

Choose a reason for hiding this comment

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

I like this a lot better Matt. We can then come out with some Best practices around the use of DPUB ARIA roles which won't look to be in conflict with this.

Thanks!

@mattgarrish
Copy link
Member Author

I'm going to merge this change now as it's been a week since we discussed. Please open a new issue if you find anything you want changed.

@mattgarrish mattgarrish merged commit f8f8f74 into main Jun 2, 2021
@mattgarrish mattgarrish deleted the fix/a11y-epub-type branch June 2, 2021 11:09
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.

None yet

2 participants