Skip to content

Update Display of accessibility metadata following Guide 2.0 #2536

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

Closed
gautierchomel opened this issue Sep 11, 2024 · 10 comments · Fixed by #2937
Closed

Update Display of accessibility metadata following Guide 2.0 #2536

gautierchomel opened this issue Sep 11, 2024 · 10 comments · Fixed by #2937
Assignees

Comments

@gautierchomel
Copy link
Member

User Experience Guide for accessibility metadata 2.0 first public draft is available. The set of documents includes:

Thorium pioneered the display of such information in a reading system, but the way it is presented is now outdated.

We should implement this significant update so it can be used to test and provide feedback.

@gautierchomel
Copy link
Member Author

gautierchomel commented Oct 1, 2024

For implementation & testing:

@gautierchomel
Copy link
Member Author

gautierchomel commented Oct 1, 2024

Also, there is a localization JSON available from W3C: https://github.com/w3c/publ-a11y/blob/main/UX-Guide-Metadata/draft/localizations/en-US/display_guide_vocabulary_w3c_en-US.json

Future localizations to be added.

It is intended to work with the techniques documents (Code IDs of the techniques are Keys of the JSON).

Example:
THEN display "Appearance can be modified". Is refering to "visual-adjustments-modifiable": {

A display of JSON values is available at https://rawcdn.githack.com/w3c/publ-a11y/91141c948fcb1b40ed13dc0b58567307a44474a4/UX-Guide-Metadata/draft/localizations/index.html

@gautierchomel
Copy link
Member Author

Thorium should use Compact sentences with no titles for categories and keep things as simple as a list.

Example:

  • Appearance can be modified
  • Not fully readable in read-aloud and braille
  • Navigation by table of contents, index, landmarks, and page list
  • This publication meets minimum accessibility standards

@gautierchomel gautierchomel self-assigned this Oct 23, 2024
@gautierchomel
Copy link
Member Author

gautierchomel commented Dec 6, 2024

The guide is still being refined by editors.

An exemple processor is available from a dedicated daisy repo

Our Rare_EPUB_test_suit/package.opf
produces the following output:

Visual adjustments
Appearance can be modified
Supports nonvisual reading
Readable in read aloud or dynamic braille
Conformance

This publication is certified by EDRLab

The certifier's credential is Certifier credential

Detailed Conformance Information

This publication claims to meet EPUB Accessibility 1.1 WCAG 2.1 Level AA

The publication was certified by EDRLab with a credential of Certifier credential

Prerecorded audio
Audio only
Navigation
Navigation by table of contents, index, supports page navigation, and headings
Charts, diagrams, math, and formulas

Accessible chemistry content

Accessible math content

Hazards
No hazards
Accessibility summary
This is the accessibility summary. This EPUB is for testing purposes, accessibility metadata presented are not true but only present to check how they would display into the reading system.
Legal considerations
No legal considerations
Additional accessibility information

@gautierchomel
Copy link
Member Author

gautierchomel commented Dec 6, 2024

IMHO our implementation should differ to avoid titles with only one element and include detail element for more information. Something like

Reading modes
Appearance can be modified
Readable in read aloud or dynamic braille
Prerecorded audio
Navigation
Navigation by table of contents, index, supports page navigation, and headings
Additional accessibility information
Contents

Accessible chemistry content

Accessible math content

Hazards
No hazards
Accessibility summary
This is the accessibility summary. This EPUB is for testing purposes, accessibility metadata presented are not true but only present to check how they would display into the reading system.
Conformance

This publication is certified by EDRLab

The certifier's credential is Certifier credential

Detailed Conformance Information

This publication claims to meet EPUB Accessibility 1.1 WCAG 2.1 Level AA

The publication was certified by EDRLab with a credential of Certifier credential

Legal considerations
No legal considerations

@gautierchomel
Copy link
Member Author

We could even get ride of titles (Reading modes, Navigation, etc.)

@gautierchomel
Copy link
Member Author

Should we have a Readium component for that?

@gautierchomel
Copy link
Member Author

I suggest assigning myself to update locals for now (

) as a first step and open an issue to discuss what to do in the future.

gautierchomel added a commit that referenced this issue Dec 13, 2024
Very partial update implementation of display guide 2.0.
See #2536
@gautierchomel
Copy link
Member Author

gautierchomel commented Apr 10, 2025

Swift implementation mapping for reference.
@mickael-menu commented that RWPM is so close to EPUB that applying the EPUB techniques was the easiest path to follow.

@gautierchomel
Copy link
Member Author

Choices made on the way:

  • sentence construction that includes concatenation was ignored because of Localized placeholders #688 issue. That concerns certfier prefixed information in 3.2 Conformance
  • As the order is free to implementors, it was decided to use the following: Ways of reading, Navigation, Rich content, Hazards, Conformance, Legals, Additional and Summary.

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 a pull request may close this issue.

2 participants