search

nlbdev / nordic-epub3-dtbook-migrator

Tools for converting between a strict subset of DTBook and EPUB3.
http://nlbdev.github.io/nordic-epub3-dtbook-migrator/
GNU Lesser General Public License v2.1
8 stars 7 forks source link

Conflict between ACE and Nordic guidelines 2020-1 regarding endnotes #556

Open AlexanderHugestrand opened 1 year ago

AlexanderHugestrand commented 1 year ago 
<body>
  <section epub:type="endnotes" role="doc-endnotes">
    <ol>
      <li epub:type="endnote" role="doc-endnote">

ACE doesn't allow the role attribute on list items. Removing it will trigger rule nordic_opf_and_html_26b, saying that a note reference "must resolve a note".

martinpub commented 1 year ago

This is somewhat expected, see https://github.com/nlbdev/epub3-guidelines-update/issues/155. Accessibility best practices have changed since the publication of 2020-1, thus the ACE error. From the DAISY Accessible Publishing KB:

Should I use the doc-endnote role?

No. Use of the doc-endnote role is now deprecated due to a technical incompatibility with the core ARIA role module. ARIA does not allow roles from a module to satisfy the requirements of core roles, so although doc-endnote behaves like a list item, it technically does not fulfill the requirement that lists have list item children. That makes it invalid in both HTML list elements and as a child of the ARIA list role.

While AT uses should not experience any problems if you have already used the role, it is best to avoid it moving forward to avoid errors in your content.

The role is also generally redundant. If a section of notes is identified using the doc-endnotes role, users and assistive technologies will understand the list within the section contains the endnotes.

The section of 2020-1 dealing with notes is not explicit about the use of @doc-endnote, so I think the rule could be updated. Maybe it could look for a <li> or <p> with a @doc-endnote <section> as parent?

I'm not sure if total ACE (e.g. EPUB Accessibility) compliance is possible with 2020-1 (see e.g. https://github.com/nlbdev/epub3-guidelines-update/issues/49), so the priority of this issue might also be moved to the upcoming revision of the Nordic Guidelines. But noting that this issue is possible to fix within the framework of the current guidelines text.

Ping @AndersEkl @josteinaj @oscarlcarlsson etc.

josteinaj commented 1 year ago

If the role is needed for validation purposes, we might need to change it to a class instead of removing it.

martinpub commented 1 year ago

Maybe we can still use @epub:type "endnote" for that purpose? It's not deprecated in EPUB SSV 1.1. As noted in the specs, it will not fill any accessibility purpose, but what we're after here is semantics for production purposes.

There is no explicit conflict in the current guidelines, but an indirect one, 2020-1 says "Footnotes and endnotes are required to be handled in accordance with the recommendations in the Accessible Publishing Knowledge Base", and the example present currently in the KB is an endnotes section without any endnote semantics on the individual notes.

Perhaps this could wait until an update?

AndersEkl commented 1 year ago

For us, this is not a huge problem, as we rarely have notes in our material. But if it causes validation issues for the rest of you, maybe we should fix it?

martinpub commented 1 year ago

The issue is with ACE validation currently, but we will still have other ACE issues that cannot be amended in 2020-1 (e.g. unlabelled asides), so I'm not sure how prioritised this is. It depends on how quickly the revision work can start, and how to go about it (minor vs major update, etc.).

AndersEkl commented 1 year ago

Ah, ok... Then I think we can wait until we do a proper revision. Let's discuss that next week when I am in Malmö.