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

Manifest fallbacks #1877

Closed
llemeurfr opened this issue Oct 28, 2021 · 6 comments · Fixed by #1911
Closed

Manifest fallbacks #1877

llemeurfr opened this issue Oct 28, 2021 · 6 comments · Fixed by #1911
Labels
EPUB33 Issues addressed in the EPUB 3.3 revision Spec-EPUB3 The issue affects the core EPUB 3.3 Recommendation Topic-PackageDoc The issue affects package documents

Comments

@llemeurfr
Copy link

llemeurfr commented Oct 28, 2021

The Manifest Fallbacks section is (still) difficult to understand.

One reason is that the examples related to fallbacks are currently placed before this section. My first proposal is therefore to move examples after the fallbacks section, at the same headings level.

We could clean it up a little bit more: the specification of fallbacks is split between the section about the item element (fallbacks from core resources) and the fallbacks section (fallbacks from foreign resources). It would IMHO be better to move the sentence "EPUB Creators MAY provide fallbacks for Core Media Type Resources (e.g., to provide a static alternative to a Scripted Content Document)." to the fallbacks section and rephrase the introductory sentence of the item section as "The fallback attribute takes an IDREF [XML] that identifies a fallback for the Publication Resource referenced from the item element, as defined in "§ 2.3.2.4.3 Manifest Fallbacks".

Also, example 29 is very difficult to understand by reading the explanation. Looking at the code I understand the following: "In the following example, an EPUB Creator inserts a reference to a local audio file directly into the spine. For this reference to be valid, a fallback to a Core Media Type Resource has to be provided, in this case an XHTML document containing a reference to the audio file.".

In this example, the item identified by "#audio01-xhtml" is not included. This does not help understanding the situation. And moving the spine extract to the start of the sample would also be helpful for the reader.

Plus, this example does not correspond to any valid use case: we've never seen audio resources in the spine, audiobooks are created in a different way. Replacing the audio file by something that EPUB creators are inclined to put in the spine would be clearer (but what?).

@dauwhe
Copy link
Contributor

dauwhe commented Oct 28, 2021

Agreed, with the added complication that I'm not aware of a reading system that processes manifest fallbacks. See #1464.

@llemeurfr
Copy link
Author

Sure, clearing the feature from the spec would be better, but as it is there (even if possibly flagged discouraged), it must be correctly explained.

@mattgarrish
Copy link
Member

Replacing the audio file by something that EPUB creators are inclined to put in the spine would be clearer (but what?).

A JPEG is probably the only thing that might have at least some real-world precedent. Maybe not for opening out of a hyperlink, but images in spine have been requested in the past to stop having to specify the fallbacks.

@mattgarrish mattgarrish added the Topic-PackageDoc The issue affects package documents label Oct 28, 2021
@shiestyle
Copy link

Yes, we hope images in spine will be accepted in order to make simpler structure FXL contents like Manga.
In my understanding, we keep this restriction because we should also take care about accessibility for such no XHTML&CSS EPUBs.

@mattgarrish
Copy link
Member

My first proposal is therefore to move examples after the fallbacks section, at the same headings level.

I'd actually suggest we go the other way and move manifest fallbacks into a subsection of the item element, otherwise the examples become detached from both and floats between bindings. The net result would be that manifest fallbacks occur before the examples with the concept more tightly bound to the item element.

Otherwise, the suggested cleanup sounds fine.

@llemeurfr
Copy link
Author

move manifest fallbacks into a subsection of the item element

fine by me.

A JPEG is probably the only thing that might have at least some real-world precedent.

I agree.

@mattgarrish mattgarrish added the EPUB33 Issues addressed in the EPUB 3.3 revision label Dec 17, 2021
@mattgarrish mattgarrish added the Spec-EPUB3 The issue affects the core EPUB 3.3 Recommendation label Sep 14, 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-EPUB3 The issue affects the core EPUB 3.3 Recommendation Topic-PackageDoc The issue affects package documents
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants