w3c / dpub-aria

Digital Publishing WAI-ARIA Module
https://w3c.github.io/dpub-aria/
11 stars 10 forks source link

update doc-pagebreak definition #24

Closed mattgarrish closed 4 years ago

mattgarrish commented 4 years ago

This PR makes a couple of changes to the doc-pagebreak definition:


Preview | Diff

apgrover commented 4 years ago

I have a few questions about this new definition:

Does the change from title to aria-label in the example reflect the requirement for Accessible Name Required: True discussed in #17? So including title alone would not satisfy that requirement?

Also based on the revised example, is it required that <hr> be used for page breaks or does <span> continue to work as well? Our page breaks are inline <span> elements because of the way we match the print equivalent break points in the text. <hr> doesn't seem possible for these inline break points since <p> only takes phrasing content.

mattgarrish commented 4 years ago

So including title alone would not satisfy that requirement?

No, the change in definition and example haven't invalidated any prior work. You can use title, as it is part of the name calculation. The title attribute just doesn't reflect the naming purpose it serves as well as aria-label, and title has a bad reputation for other reasons (links).

The only reason I changed the example to hr is because it inherits from separator which is the default role of hr. You can use it on span or div, too, as those accept any role. I don't mind keeping span as a second example if that helps.

mattgarrish commented 4 years ago

I've updated the example to show the following three equivalent patterns:

<hr id="pg04" role="doc-pagebreak" aria-label="4"/>

<span id="pg04" role="doc-pagebreak" title="4"/>

<div id="pg04" role="doc-pagebreak">4</div>
apgrover commented 4 years ago

Thanks so much for the clarification and additional examples! Much appreciated.