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

Extract data on EPUB fallback mechanisms #76

Closed
rdeltour opened this issue Oct 13, 2017 · 4 comments
Closed

Extract data on EPUB fallback mechanisms #76

rdeltour opened this issue Oct 13, 2017 · 4 comments

Comments

@rdeltour
Copy link
Member

From @mattgarrish

It would also help to know if the publication is using any epub fallbacks, as they are not accessibility supported and need to be reviewed:

  • fallback attribute on manifest items
  • bindings element in the package doc
  • epub:switch in the content
  • epub:trigger in the content

Not necessarily harmful, but more often than not harmful. What I'm doing is reporting their presence with a warning that they need to be checked to ensure that they aren't being used in a way that accessibility depends on them: using accessible alternatives as fallbacks for spine and switch, disabling default controls after trigger support is established, etc.

@rdeltour rdeltour added this to the Beta 2 milestone Oct 13, 2017
@rdeltour rdeltour self-assigned this Oct 13, 2017
@clapierre
Copy link

In EPUB 3.1 epub:switch and epub:trigger were removed so if these appear in EPUB 3.1 files they would be violations, now we will need to handle these in previous versions of EPUB. Not sure if you were thinking at this stage with ACE to always just handle these and let EPUBCheck deal with if these should even exist depending on the version of EPUB.

@rdeltour
Copy link
Member Author

Not sure if you were thinking at this stage with ACE to always just handle these and let EPUBCheck deal with if these should even exist depending on the version of EPUB.

Yeah, that would be the idea: Ace doesn't report validation errors, just accessibility violations. So it would be EpubCheck's responsibility to flag them as error in EPUB 3.1, and Ace would just extract the data if present.
Ace currently runs OK in several otherwise invalid EPUBs.

@clapierre
Copy link

Agreed as long as there is a clear line of understanding what ACE does and does not do we should be fine.
Thanks

@mattgarrish
Copy link

It would be interesting if epubcheck could be integrated with ace so you didn't have to run them separately (e.g., a separate error section that shows epubchecks output). It's a missing piece in knowing whether 4.1.1 succeeds or not.

But this is going off topic into feature requests.

rdeltour added a commit that referenced this issue Oct 29, 2017
Report the following Package properties in the `properties` section:
- `hasBindings` will report the presence of a `bindings` element in the Package Doc
- `hasManifestFallbacks` will report the presence of any manifest fallback

Report the following Content Doc elements in the `data` sections:
- `epub:trigger` elements in the `data['epub-triggers']` array
- `epub:switch` elements in the `data['epub-switches']` array

Closes #76
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants