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 to the EPUB Accessibility - EU Accessibility Act Mapping #2590

Merged
merged 16 commits into from
Mar 19, 2024

Conversation

gregoriopellegrino
Copy link
Contributor

@gregoriopellegrino gregoriopellegrino commented Nov 5, 2023

We have updated the document in these parts:

  • reSpec metadata: reference working group
  • Abstract: information with respect to implementation
  • How EPUB conforming to EPUB accessibility guidelines cover European Accessibility Act requirements:
    • improvement of references to specifications
    • addition of a paragraph on Fixed Layouts (based on the wording of the Act)
  • Mappings:
    • 2.1.1.2.5 (v): addition of success criterion 1.4.12 Text Spacing and note on Fixed Layouts (based on the wording of the Act)
    • 2.1.1.2.6 (vi): addition of success criterion 1.2.1 Audio-only and Video-only (Prerecorded) and 1.2.2 Captions (Prerecorded)
    • 2.1.2.1.3 (iii): addition of success criterion 1.4.10 Reflow and note regarding Fixed Layouts (based on the wording of the Act)
  • Metadata to describe possible exemptions: added section to introduce metadata to describe possible exceptions to the law

See:

  • For EPUB Accessibility - EU Accessibility Act Mapping:

@iherman
Copy link
Member

iherman commented Nov 6, 2023

The text of the added notes usually say something like:

NOTE
Specific features (like flexibility and choice in the presentation of the content) of Fixed Layout EPUBs should be considered in the light of all applicable accessibility requirements.

I must admit I do not understand this sentence. Do you mean that these requirements should be "eased" for FXL? Or that the FXL authors should be specifically careful about these requirements?

I think we should try to find a better formulation...

Comment on lines 416 to 420
<p>Metadata standards for digital publishing ONIX (via <a href="https://ns.editeur.org/onix/en/196">Code List 196</a>)
and EPUB metadata (via <a href="https://www.w3.org/TR/epub-a11y-exemption/">The EPUB Accessibility exemption property</a>)
provide specific codes for communicating to the digital publishing supply chain (and the end user) any exceptions related
to specific publications. In any case economic operators will be responsible to provide the necessary documentation to
support the exception they invoke.</p>
Copy link
Member

Choose a reason for hiding this comment

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

I do not know about the politics here, but from a usual W3C style perspective it may be better to put here a formal reference to the exemption note, so that it would also appear in the references' section below.

Copy link
Member

Choose a reason for hiding this comment

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

em dashes might also help the sentence here, as the references to onix and epub don't flow with the rest: "Metadata standards for digital publishing — ... — provide specific codes..."

The specific standards might also be better written into a note after the paragraph. For example: "NOTE: Refer to ONIX Code List 196 [onix] and The EPUB Accessibility exemption property [epub-a11y-exemption] for more information on expressing these codes."

Copy link
Member

@iherman iherman left a comment

Choose a reason for hiding this comment

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

I have left some comments that are mostly editorial.

Copy link

@shiestyle shiestyle left a comment

Choose a reason for hiding this comment

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

Note for Fixed Layout should be improved for easy to understand.

@@ -58,8 +58,7 @@
disabilities to access goods and services, including ebooks, dedicated reading software, ereading
devices, and ecommerce.</p>

<p>The EAA has been approved on 27 June 2019, should be implemented by EU Member States within 28 June 2022
and will enter in force from 28 June 2025.</p>
<p>The EAA has been approved on 27 June 2019 and will come into force from 28 June 2025. The directive has already been implemented at national level in many member states and is being implemented in the remaining.</p>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<p>The EAA has been approved on 27 June 2019 and will come into force from 28 June 2025. The directive has already been implemented at national level in many member states and is being implemented in the remaining.</p>
<p>The EAA was approved on 27 June 2019 and will come into force from 28 June 2025. Many member states have already implemented the directive at the national level, with the remaining states currently in the process of implementing it.</p>

"has been" suggests a continuous state from the past (e.g., "has been approved since..." but I don't think that's what you want here). The second sentence doesn't need to be passive.

epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
<li>evaluation and certification of accessible EPUB publications.</li>
<li>conformance to Web Content Accessibility Guidelines;</li>
<li>specific EPUB requirements for accessibility;</li>
<li>evaluation and conformance reporting of accessible EPUB publications.</li>
</ul>

<p>Providing accessibility metadata facilitates informed decisions about the usability of an EPUB
Copy link
Member

Choose a reason for hiding this comment

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

Does this paragraph belong in this document? It also comes from the Accessibility standard's intro.

<p>While it has always been possible to create EPUB publications with a high degree of accessibility, this
document also establishes formal requirements for contents to be certified as accessible. These
<p>While it has always been possible to create EPUB publications with a high degree of accessibility,
this document establishes the formal accessibility requirements that content must meet to be declared
Copy link
Member

Choose a reason for hiding this comment

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

This paragraph also looks like a copy. It's talking about "this document" establishing the requirements for the EPUB Accessibility standard.

I think this whole section needs some rewriting to focus more on how the EPUB Accessibility standard matches the requirements of the EAA. Otherwise, maybe the title needs changing as I don't get a connection from this text to the EAA.

Comment on lines 109 to 113
<p>The EPUB format provides the ability to create reflowable publications (whose content adapts to the user's viewport,
depending also on the user's chosen graphical characteristics, such as font size, line spacing, etc.), but it also
allows the creation of EPUB Fixed Layout in which each element is positioned absolutely on the page (mainly used
for publications such as comics, illustrated children’s books and art books). Specific features of Fixed Layout EPUBs
should be considered in the light of all applicable accessibility requirements.</p>
Copy link
Member

Choose a reason for hiding this comment

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

This is a long sentence. Maybe break it up like this (also offering a possible rewrite for the last sentence, but not sure if that's exactly what you're after, or if it should be in a note, so feel free to ignore!):

Suggested change
<p>The EPUB format provides the ability to create reflowable publications (whose content adapts to the user's viewport,
depending also on the user's chosen graphical characteristics, such as font size, line spacing, etc.), but it also
allows the creation of EPUB Fixed Layout in which each element is positioned absolutely on the page (mainly used
for publications such as comics, illustrated children’s books and art books). Specific features of Fixed Layout EPUBs
should be considered in the light of all applicable accessibility requirements.</p>
<p>The EPUB format provides the ability to create reflowable publications whose content adapts to the user's viewport, including the user's chosen graphical characteristics, such as font size, line spacing, etc. It also
allows the creation of fixed layout content in which each element is positioned absolutely on the page (mainly used
for publications such as comics, illustrated children’s books and art books). Specific features of fixed layouts (e.g., zooming of text) present challenges for accessibility, however. Authors need to consider these challenges and how best they can mitigate them before employing fixed layouts. Refer to the EPUB Fixed Layout Guidelines for more information.</p>

Comment on lines 323 to 324
<li>WCAG Principle <a href="https://www.w3.org/TR/WCAG2/#robust">4 Robust</a> (level
A);</li>
Copy link
Member

Choose a reason for hiding this comment

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

These references are kind of confusing. Principles contain all levels of success criteria. Do you mean only the level A requirements of Robust principle here? Or can the level reference just be deleted as unnecessary?

<section id="exemptions">
<h2>Metadata to describe possible exemptions</h2>

<p>The European Accessibility Act foresee three possible exemptions to meeting its requirements:</p>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<p>The European Accessibility Act foresee three possible exemptions to meeting its requirements:</p>
<p>The European Accessibility Act foresees three possible exemptions to meeting its requirements:</p>

Copy link
Contributor

@wareid wareid left a comment

Choose a reason for hiding this comment

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

Approved (as long as the already suggested changes are applied!).

@gregoriopellegrino
Copy link
Contributor Author

Thank you for all the feedback received.

We have done a major revision of the document and present you with the new draft. We have tried to make the introduction part more explicit and clear and we have tried to make the mapping section more readable.

We look forward to your further comments to finalize it.

For EPUB Accessibility - EU Accessibility Act Mapping:

@iherman
Copy link
Member

iherman commented Feb 21, 2024

For some reasons the 'diff' does not work. Note that the preview shows a respec error, which may explain why the diff fails.

Copy link
Member

@iherman iherman left a comment

Choose a reason for hiding this comment

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

All my comments are strictly editorial

epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
@mattgarrish
Copy link
Member

Note that the preview shows a respec error

The error says that the status section must contain at least one custom paragraph. When did that become a requirement and what are we supposed to make up to satisfy it?

@iherman
Copy link
Member

iherman commented Feb 21, 2024

At the moment

<section id="sotd"></section>

has been removed. (See #2590 (comment)). I would expect the error will go away if that is put back...

@mattgarrish
Copy link
Member

I would expect the error will go away if that is put back...

Ah, right, I was looking at a different version locally that still had the section. I thought this was a new requirement to pad the sotd.

Copy link
Member

@mattgarrish mattgarrish left a comment

Choose a reason for hiding this comment

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

Looking better. Just some editorial comments.

epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
<p>In order to outline how to make fully accessible EPUBs, the <a href="https://www.w3.org/TR/epub-a11y-11/"
>EPUB Accessibility</a> guidelines have been drafted to address two key needs in the EPUB
ecosystem:</p>
<p>The <a href="https://www.w3.org/TR/epub-a11y-11/">EPUB Accessibility</a> specifications [epub-a11y-11] address the following key areas for making fully accessible EPUB publications:</p>
Copy link
Member

Choose a reason for hiding this comment

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

You need to use two square brackets for citations: [[epub-a11y-11]]


<ul>
<li>discoverability of accessibility features of publications;</li>
<li>evaluation and certification of accessible EPUB publications.</li>
<li>conformance to Web Content Accessibility Guidelines;</li>
Copy link
Member

Choose a reason for hiding this comment

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

You're referring to WCAG here, at least by using caps, so there should be a reference.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, what does it mean?

respect to quality certification and enable it.</p>


<p>The EPUB Accessibility defines requirements for accessibility metadata. In this way consumers can examine the accessibility characteristics of the content and make well-informed decisions on whether an EPUB publication is appropriate for each need before buying, borrowing or downloading it.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<p>The EPUB Accessibility defines requirements for accessibility metadata. In this way consumers can examine the accessibility characteristics of the content and make well-informed decisions on whether an EPUB publication is appropriate for each need before buying, borrowing or downloading it.
<p>The EPUB Accessibility specification also defines requirements for accessibility metadata. In this way consumers can examine the accessibility characteristics of the content and make well-informed decisions on whether an EPUB publication is appropriate for each need before buying, borrowing or downloading it.

epub33/epub-a11y-eaa-mapping/index.html Outdated Show resolved Hide resolved
<p>The EPUB Accessibility does not target a single version of EPUB (most commercially available publications
are in EPUB 3 or EPUB 2 format). It is designed to be applicable to all EPUB publications conforming to
any version or profile, including future versions of the standard.</p>

<p>The EPUB allows to create both reflowable and Fixed Layout publications.</p>
Copy link
Member

Choose a reason for hiding this comment

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

"The EPUB" is confusing. This should probably be "EPUB 3", or a specific reference to 3.3 with a citation.

<p>The EPUB Accessibility does not target a single version of EPUB (most commercially available publications
are in EPUB 3 or EPUB 2 format). It is designed to be applicable to all EPUB publications conforming to
any version or profile, including future versions of the standard.</p>

<p>The EPUB allows to create both reflowable and Fixed Layout publications.</p>
Copy link
Member

Choose a reason for hiding this comment

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

Also, "Fixed Layout" shouldn't be capitalized (here and elsewhere). We don't use capitalized terms in the specification anymore.


<p>In a reflowable EPUB the content adapts to the user's viewport, depending also on the user's chosen graphical characteristics, such as font size, line spacing, text color, etc.; while in Fixed Layout EPUBs each element is positioned absolutely on the page (as it is usually an exact replica of the paper version) and the user has not the ability to change the text formatting.</p>

<p>EPUB Fixed Layout are mainly used for publications in which the meaning is layout-driven such as comics, illustrated children’s books and art books.</p>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<p>EPUB Fixed Layout are mainly used for publications in which the meaning is layout-driven such as comics, illustrated children’s books and art books.</p>
<p>Fixed layouts are mainly used for EPUB publications in which the meaning is layout-driven such as comics, illustrated children’s books and art books.</p>


<p>EPUB Accessibility specification defines the requirements necessary to make an EPUB publication fully accessible including to the ones defined by the Web Content Accessibility Guidelines (WCAG) and adding the ones related with the specific characteristic of ebooks and digital publications.</p>

<p>Web Content Accessibility Guidelines (WCAG) offer a broad framework of requirements for making digital content accessible to all, addressing a wide range of problems and providing solutions. WCAG guidelines cover several aspects, including multimedia content, interactive content, and basic web page structure.</p>
Copy link
Member

Choose a reason for hiding this comment

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

WCAG should be cited here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, what does it mean?

nitedog and others added 2 commits March 18, 2024 19:15
Mostly editorial work; a few changes in the mapping too.
@gregoriopellegrino gregoriopellegrino merged commit 34132cd into main Mar 19, 2024
2 checks passed
@gregoriopellegrino gregoriopellegrino deleted the fxl-a11y-eaa-revision branch March 19, 2024 16:21
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.

6 participants