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

Requirement (MUST vs SHOULD) for Media Overlays is unclear #2271

Closed
dlazin opened this issue May 11, 2022 · 5 comments
Closed

Requirement (MUST vs SHOULD) for Media Overlays is unclear #2271

dlazin opened this issue May 11, 2022 · 5 comments
Labels
EPUB33 Issues addressed in the EPUB 3.3 revision Spec-ReadingSystems The issue affects the EPUB Reading Systems 3.3 Recommendation

Comments

@dlazin
Copy link
Contributor

dlazin commented May 11, 2022

https://w3c.github.io/epub-specs/epub33/rs/#confreq-rs-epub3-mo says:

Reading systems with the capability to render prerecorded audio SHOULD support media overlays [epub-33].

But then:

When a reading system loads a package document, it MUST refer to the manifest item elements' [epub-33] media-overlay attributes to discover the corresponding media overlays for EPUB content documents.

Reading systems MUST support playback for XHTML content documents, and MAY support SVG content documents.

Playback MUST start...

This makes it sound like (full/proper) support for MOs is optional, but RSes still need to do all the processing. I don't think that's what's intended. I assume we mean "if you are going to support MOs, then here is what is a requirement for support." Elsewhere, we use language like "If a reading system supports scripting...". I think we should sprinkle such language throughout the MO section, assuming my interpretation is correct.

@iherman
Copy link
Member

iherman commented May 12, 2022

I agree with your second interpretation, ie, that "If the reading system support scripting then..."

Instead of sprinkle such language all around (which may lead to fairly convoluted sentences) what about making this clear in the intro section? Eg, by changing the first paragraph right after the yellow box to something like:

If a reading system does not support media overlays, all normative requirements in this section can be ignored. In particular, such a reading system MUST ignore both:

@mattgarrish ?

@mattgarrish mattgarrish added the Spec-ReadingSystems The issue affects the EPUB Reading Systems 3.3 Recommendation label May 13, 2022
@mattgarrish
Copy link
Member

I'm not sure I see the problem here. If you have to ignore the media-overlay attribute and all SMIL files if you don't support media overlays, which is what the following paragraph says, then by extension none of the processing and playback requirements for the SMIL files apply.

@mattgarrish
Copy link
Member

Would it help if we added "Reading system conformance" as a new section 2 and briefly explained that the expected support requirements for each feature are defined at the beginning of each section? We jump right into indivudal features and support right now, but a clear explanation of why wouldn't hurt.

That would also provide the opportunity to say once that recommended support means that the processing requirements can be ignored when not supported.

@iherman
Copy link
Member

iherman commented Jun 5, 2022

@mattgarrish @dlazin isn't this issue solved, ie, can it be closed? @dlazin has changed the status of the relevant tests...

@dlazin
Copy link
Contributor Author

dlazin commented Jun 5, 2022

Yes; this wasn't about the tests, but #2305 addresses the issue here.

@dlazin dlazin closed this as completed Jun 5, 2022
@mattgarrish mattgarrish added the EPUB33 Issues addressed in the EPUB 3.3 revision label Jul 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EPUB33 Issues addressed in the EPUB 3.3 revision Spec-ReadingSystems The issue affects the EPUB Reading Systems 3.3 Recommendation
Projects
None yet
Development

No branches or pull requests

3 participants