-
Notifications
You must be signed in to change notification settings - Fork 63
Support for roll in layout
#2788
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
base: main
Are you sure you want to change the base?
Conversation
Bumped layout and content dimensions out of the FXL section as they're shared across document types
|
I've opened a draft PR for now since this is my first attempt in a long time to work with ReSpec and I'm still missing at least the EPUB RS side of things. I'm tempted to follow what I've done in this first commit and bring the |
sueneu
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! I am delighted to see item level overrides. They will be useful for front and backmatter. I do have questions about how the item-level overrides will work and what the fall backs could be.
Could this PR be approved and we refined the document as we move forward?
|
I'm worried about the structure with these edits. If you go directly to the fixed layout section, for example, you'll miss the section about setting the content dimensions, and without a parallel "scrolled layouts" section you seem to have to piece together that you need to set dimensions by reading through the section to check where scrolled documents has been added to the text. I think pulling the layout property out of FXL is fine, but the section name might be useful to change. When it's not under the property settings heading it loses some context (e.g., maybe change it to "Layout control" or "Layout preferences"). But is a scrolled document even a new thing that needs defining if a scrolled layout is just a different means of reading a set of fixed layout documents? It's not really a new layout of the content but a different type of flow setting for FXLs. If the only difference is that you can't set some fxl properties when setting scrolled, is there a way of defining scrolled within the existing fxl section, or of having a scrolled layouts section that links across to how to set the dimensions for FXLs while excluding the properties? I expect presenting "scrolled document" as something new when they're just FXLs in a different context is going to be confusing. |
My goal was to avoid repeating this information by moving it to the top. We could add a section that references this in FXL and add a section for "scrolled publications" as well, but it would end up mostly empty.
I'm fine with any suggesting that you might have for renaming these sections.
It's a new thing with different constraints from Fixed Layout:
If you look at it from another angle:
|
I didn't change anything for item level overrides and I'm not a big fan of them, they're not well-supported in RS and can provide a very inconsistent experience. They're also less useful in the spine than if we could provide the same info in the manifest. |
Sure, the presentation of the fixed dimension documents is different, I'm not arguing that, but you're not defining anything new about the layout of a content document. We have documents with reflowable text and we have documents with fixed dimensions. Those fixed dimension documents in turn are either used within fixed layout displays or scrolled displays. That's the similarity I want to try and capture better if we can. I see the problem in having fixed layout document be the container for both definitions, but what I was trying to get at is whether there is a way to define a common root for both type of documents. For example, something like:
Then we don't have the content document dimensions floating at the same level as both fixed and reflowable layouts and we don't have to reference out to apply this info to both. And the scrolled section might not need a lot of explanation, but I still think it's better to have something than rely solely on a property value to introduce these. Assume readers know nothing and are going to want to understand when and how to apply scrolled layouts. |
I see, so it's mostly about the way we organize the spec then. I'm fine with your suggestion, we could group them under a shared section where they would share the content document dimensions section. For scrolled layouts, there's something else that I haven't tackled yet: we want to include a paragraph dedicated to backward compatibility with what some of the publishers in Japan are currently doing. |
|
Overall looks good, but +1 to the structure Matt proposed. Ideally the top level would be "Fixed layouts", with "Prepaginated" and "Scrolled" subsections, but fixed layout as a term likely has too much baggage to be used that way. |
Right, sorry for confusingly using fixed layouts in my first post. It's the fixed dimension documents that are the commonality between the two and that I think we can leverage to make a section fitting for both. |
|
I've re-organized things based on @mattgarrish feedback. I would personally drop the reflowable layout section entirely (see #2754) and only keep |
|
I must admit I am confused by the terminology. The confusion comes with the term "scrolled". At first read, the way I would understand Then comes the confusion: how does this relate to Actually, it is not clear to me why having (I understand the current terms are not ideal for this approach, but that is history. We will have to live with that.) I claim no expertise in this area, so I may miss something essential. But then it must be clear in the spec what I miss, because I find the current proposal confusing... |
|
@iherman if we're talking about continuously scrolled comics specifically, the use of HTML as a container and the requirement to set content dimensions in HTML are mostly things that get in the way but that we need to use because EPUB is designed that way. Ideally, we would:
Support for comics is very painful in EPUB because our requirements often get in the way of what authors, publishers and reading systems would really like to do.
We've already had this discussion a few times now:
We can have this whole discussion all over again (we've been going at it for a few years by now), but we had somehow reached consensus that it's better to have continuously scrolled publications as a separate thing from reflowable/pre-paginated and include a note about backward compatibility with what has been used in the past in Japan. |
|
As a point of reference, here's what I think would be the ideal solution: https://readium.org/webpub-manifest/profiles/divina#:~:text=Example%201%3A%20A%20scrolled%20publication%20that%20contains%20two%20episodes We can't reach that point with EPUB because of our restrictions with bitmaps in spine. FYI, this is what South Korea has adopted as a national (TTA) standard (I can share their spec if needed). |
|
Going somewhat on an aside, but it would help to be clearer that properties apply only to the categories they're listed under. Having two fixed dimension layouts might get people thinking they could set the orientation, for example. (We don't have to fix that all in this PR, though.) As it is, you can set any rendering property because you can mix layouts in a publication, but only the properties specific to a layout apply to documents in that rendering. That's why the existing flow properties can get confusing. And can we ban spine overrides for scrolled layouts in the interest of simplicity, or is it necessary to mix layouts? |
You'll notice that I skipped them in this PR and that's on purpose. I think that spine overrides for layouts are harmful and should be dropped from the spec completely: #2749 The only use case where they might be useful would be in fallbacks (as we discussed two weeks ago I think), but we can't use them in fallbacks because they're in the spine instead of the manifest.
I don't think that authors should be able to set an orientation at all, it's potentially harmful and goes against EAA requirements: #2751 |
Yes, I spotted that there wasn't a spine override for scrolled and am happy to live without one, but I believe you can still override a global scrolled setting to put reflowable or pre-paginated documents into a scrolled layout, right? (Or did I miss a restriction?) Seems really messy. I can see the use for having a few fixed layout documents in a reflowable publication, but I never really understood the need for reflowable in a fixed layout publication. It might be too late to deprecate them, but let's at least avoid proliferating it as a practice. |
Yeah it's a mess and we really want to avoid that. I wasn't sure how to introduce a restriction since my preference would be to just deprecate the whole thing. |
|
I think this could be done in the layout overrides section. It might be as simple as changing the first sentence to:
|
|
Re bike shedding: I myself love the term "rotulus" (see Wikipedia), it expresses quite well what we are talking about. However, we have to acknowledge that it may create problems insofar as it is a fairly mysterious word for non-English speakers (I must admit I did not remember this word either; my spell checker considers it as an unknown word, too). I looked for synonyms, the ones I could gather were "scroll", "roll" (sometimes with adjectives like "vertical roll", "document roll", "parchment roll"), "codex", "volumen". Out of these, "roll", or possibly "document roll" may be a good compromise. |
|
I am not sure if this is the best place to list out replacement ideas, but
I am not really sure what the best place is. I made a Google Doc with some
items that came from the meeting, and I have just added yours. Doc with
comments enabled is here
<https://docs.google.com/document/d/1FgC98D6O7T_lW_eb541jOKoAxP5XsKLoqtB7eQV6Lfo/edit?usp=sharing>,
but I have no idea how long that will survive now that it is a publicly
scrapable link.
…On Sat, Sep 13, 2025 at 12:01 AM Ivan Herman ***@***.***> wrote:
*iherman* left a comment (w3c/epub-specs#2788)
<#2788 (comment)>
Re bike shedding: although I myself love the term "rotulus" (see Wikipedia
<https://en.wikipedia.org/wiki/Rotulus>), it expresses quite well what we
are talking about. However, we have to acknowledge that it may create
problems insofar as it is a fairly unknown word for non-English speakers (I
must admit I did not remember this word either; my spell checker considers
it as an unknown word).
I looked for synonyms, the ones I could gather were "scroll", "roll"
(sometimes with adjectives like "vertical roll", "document roll",
"parchment roll"), "codex", "volumen". Out of these, "roll", or possibly
"document roll" may be a good compromise.
—
Reply to this email directly, view it on GitHub
<#2788 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AA246ZHNBRPQYVEYTQ3S4FT3SO6MZAVCNFSM6AAAAACF2YW5QWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTEOBXG4YDMNJTGE>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
I've opened both of these issues. I'll wait until we make progress on them before updating this PR any further. |
scrolled in layoutroll in layout
|
I've updated the PR based on our resolution for #2791 |
|
As suggested by @iherman, I'm happy to have this merged after a review from @mattgarrish as long as we keep in mind that our on-going discussion about images in spine (#2792) could heavily impact this PR. You can look at the examples that I've shared in #2792 (comment) to compare it with this PR. |
|
I haven't had a chance yet to review this again, but I noticed a couple of things while resolving the merge conflicts:
|
Works for me, I'll update the PR accordingly.
I wouldn't work on that one yet because it might be temporary. If we accept images in spines, I don't think that we'll need to group them at all. Since we're meeting in a month at TPAC and there seems to be no strong objection so far to images in spine, it's worth being patient. |
|
This was discussed during the pmwg meeting on 09 October 2025. View the transcriptPR for Support for roll in layout<shiestyle> w3c/epub-specs#2788 CharlesL1: One question, we have a new rendition layout role, comics used to be fixed, right? Hadrien: pre-paginated is the current value, the expectation is you may find one or the other shiestyle: Roll will not have spread LaurentLM: In the PR, it says "fixed dimensions", but in our case it is 1 fixed dimension Hadrien: But you are confusing viewport and images LaurentLM: I am not sure if I am speaking about images Hadrien: Which is why I am not pushing the PR at the moment, since a lot changes with images in spine LaurentLM: So why is it fixed dimensions? Hadrien: It doesn't matter, we will probably discard a lot of it shiestyle: We still have time before TPAC, we should finalize there Hadrien: Looks like we only have the week before TPAC given schedules, do you really want to discuss images in spine then? shiestyle: we will have another meeting before tpac Hadrien: So you want to discuss images in spine during that call? It will take the entire call shiestyle: We can arrange it |
|
This was discussed during the pmwg meeting on 10 November 2025. View the transcriptImages in spine<shiestyle> #2792 #2825 w3c/epub-specs#2788 shiestyle: The first topic is images in spine Hadrien: I think this has been contentious, we've discussed for a long time, it came up when we first discussed FXL duga: So you often point out that there aren't really accessible comics, or they are hard to do Hadrien: Not saying it should be illegal, it would be disappointing to those producing that content LaurentLM: In every specification, certain things are triggered by certain metadata, roll comics are triggered by specific metadata Hadrien: There is a difference between partially accessible comics vs fully accessible comics, we don't know what makes a fully accessible comic LaurentLM: Just adding HTML to comics doesn't make it accessible rdeltour: I have a simple question, does it have to be EPUB Hadrien: First question is good, we see some places saying EPUB is not the solution. But one option to discuss, do we do something more like web publications, SK is doing JSON with metadata and some controls wendyreid: I think I share Romain's question, does this have to be EPUB? wendyreid: One of the underlying parts of this discussion is, philosophically, what we think EPUB is? wendyreid: Do we think that, as the group that maintains EPUB, who do we serve and who do we follow? wendyreid: We try to strike balance between what industry wants and what readers need wendyreid: And lately also government regulations wendyreid: On the surface, about images in spine, questions what do we want EPUB to be wendyreid: Many of us fought for EPUB to be the accessible standard, accessible by default. wendyreid: Images in spine is where we need to make decision, in order of priority, where do we put things? wendyreid: Does accessibility trump everything? wendyreid: Disappointing that some markets didn't choose EPUB as the standard, for variety of reasons wendyreid: But companies releasing apps with PDF or CBZ are not thinking about accessibility wendyreid: in their application or business model wendyreid: That's a choice that they made in their business wendyreid: But do we want to make that choice for EPUB wendyreid: We know there are many inaccessible EPUBs out there, because businesses made that decision. But for EPUB, you have to make a *choice* to make inaccessible. We give all the tools, they choose not use. wendyreid: But here we would give them a tool to make inaccessible content. wendyreid: Make that possible. fantasai: What are the implementation challenges with having images in spine vs in HTML Hadrien: Apps that implement this, they don't use webviews, they use platform APIs, with HTML they need to find ways to render those images, if its SVG they need to rasterize the images fantasai: Is there or has their been an effort to create a profile for HTML that prioritizes images? Hadrien: Japan has it, it's not used by everyone even in Japan, it's something you know if you're in industry, but it has no official status fantasai: Would it make sense to standardize on that? Hadrien: Possibly, it falls on the line of having an alternate profile or best practices document fantasai: The HTML file would need to conform in a spec, it would validate, for reading systems would know to parse as an image, but we have the additional structure, the framework for creating accessible content is still there Hadrien: The reality would be it might be fragmented, but would move people in the right direction possibly ivan: To put things in perspective, the approach Romain suggested is how we published the audiobook standard Hadrien: The first is to use meta:refines, refine the image using it's id to provide description gpellegrino: We can have images in spine with fallbacks, I suggest we leave the spec as is, we advise on how to make comics rdeltour: For the sake of completeness, in one of the slides you mention was the objective was to link a page to an image, maybe it's also possible to use the nav doc, may also be used to link the pages to the document seth: I have missed some of the previous meetings, we've heard a lot from reading systems people, I never hear from publishers Hadrien: A page in a comic can have a lot of information, you'd need to describe each panel, and even within panels Hadrien: Some of it is cost, some of it is technical, there's needs beyond just screenreader users ivan: I want to come back to what Gregorio said, and the spec of today allows what you need as allowing an HTML file as fallback, I may have misunderstood the second part, this may only be valid for roll comics <fantasai> +1 ivan ivan: it relates to what Hadrien said, falling back to an HTML file, seems to be only a rudimentary way to handle accessibility for an image <rdeltour> +1 gpellegrino: Ivan, my proposal was not to allow this way only for roll content, since it's already allowed for any content in the spine <ivan> +1 fantasai: I wanted to scope the question down to sighted users who need accessibility support? Laurent: No fantasai: If we want EPUB to be able to do this, is images in spine getting us closer or further to that? Hadrien: We're years away from being able to do what you describe, its too early to say, I don't think it would be a step in the wrong direction to add images in spine wendyreid: Discussed in fixed layout accessibility task force about that. How do we make this possible? wendyreid: We have some proposals, to solve what Elika described wendyreid: Discussing side-by-side content wendyreid: parallel content that's related to each other wendyreid: I don't think we're as far away from this as we think we are wendyreid: There are reading systems already that do side-by-side content (forgot name) wendyreid: One that allows fixed layout and relayout together wendyreid: A lot of it, unfortunately, it's about tooling. wendyreid: Lack of will to make this happen wendyreid: Especially nowadays, with AI, offers us a lot of ways to automate this that previously would have been fully manual wendyreid: Only a few years ago, alt text for comics would have been fully manual, now can automate much of it wendyreid: Image detection of panels wendyreid: Etc. wendyreid: I'm reluctant to say that it's not possible. It's increasingly possible. wendyreid: Alternate format providers are already doing this work, just mainstream publishers are not wendyreid: So I'm reluctant to give in on this. wendyreid: We have the technology. Some of the tools already exist. wendyreid: A lot more publishers can do in content development that they're not doing. wendyreid: And more on reading system side that could make it possible wendyreid: I've seen scrolled fixed layout content in EPUB readers. It's not impossible. wendyreid: Doesn't mean we should make provisions in the spec to sacrifice our principles shiestyle: We have 10 minutes left, we want to conclude this topic in TPAC, maybe gpellegrino's proposal, using the spec as is Hadrien: I think some people don't like image in spine with HTML fallback but its the current spec, having a best practice document that describes how to do this, that is doable [Seth asks question about tooling and alternate text in Japanese] seth: Can someone from the Japanese publishing community share why they don't produce accessible content, is it tooling or something else? toshiakikoike: When preparing alt text for manga, just the speech bubble text is not sufficient, but people make prepare the description of the story, we can't prepare that content without the author ここには日本の出版社の人がいると思うので、聞きたい。漫画はなぜアクセシビリティをサポートしないのか。どういう理由があるのか? Ito-san: Japanese publishers don't have the right to produce that type of content, only authors can shiestyle: I'll explain this a bit more tomorrow, manga content is generally out of scope 漫画のアクセシビリティというのは、何を情報として含めるのかが難しい。ただセリフをテキストに変えさえすれば、漫画のコマに含まれている情報を正確に伝えることができたというのかというと、そうではないとも思っていまる。 Hadrien: Just wanted to reply to Wendy's comment, and it leads into the next discussion ivan: The way I read the standard now, for each image you'd have an HTML fallback, ideally one HTML with the alt text, making the publisher's lives easier, but you can't refer to a fragment in a fallback Tomikura-san: What accessibility features do people want? Hadrien: We hear from people that there is interest, people want access to what their friends are reading |
|
This was discussed during the pmwg meeting on 10 November 2025. View the transcriptImage in Spine (cont.)<shiestyle> #2792 #2825 w3c/epub-specs#2788 fantasai: Did we conclude on the images-in-spine issue? Should there be a resolution? ivan: Agree that having a resolution is what we need Hadrien: So, saying you'd have a single HTML with all the text, and you'd have the fallback point to a fragmentID ivan: Yes Hadrien: If we do that, that opens a lot of other questions duga: That fundamentally changes fallbacks and the spine and how this works. ivan: Ok, but we have a problem. Hadrien: Yes, it is impractical wendyreid: I would agree it was impractical if 1) it wasn't already how things happen and 2) if person who is making epub had to hand-write every HTML document Hadrien: My suggestion comes from pragmatic viewpoint which is what's out there rdeltour: If we knew how well fallbacks are supported in reading systems gpellegrino: I think the time is not right for thinking about solutions for comics etc. So opening the possibility to just images in spine maybe problematic. So suggest we continue as we have now, postponing the discussion, and we can open a task force thinking about a11y and comics gpellegrino: Maybe inside the a11y task force we already have gpellegrino: but I wouldn't take it up right now ivan: I agree ivan: Laurent, is it possible for you to take a typical example which has fallbacks with HTML and has a relatively large number of images, and turn it into a test case for our test suite? LaurentLM: Yes ivan: It would be a valuable addition to our test suite. Romain is right, we have a basic test, but we don't have a good stress test. ivan: With that, I think repeating what Elika said, I think we should have a vote and have a resolution on what we put for advice for this type of documents LaurentLM: I totally agree, and disagree with Gregorio LaurentLM: We don't validate 3.4 today. So we have time to make a pre-recommendation, and ask reading systems to support what's in the spec <gpellegrino> +1 to Laurent LaurentLM: We can easily make the evolution to support fallbacks if we know this is the right direction. LaurentLM: So let's make a pre-recommendation that is a resolution of this LaurentLM: And then when we make 3.4 we will be ready, and reading systems will be ready ACTION: LaurentLM to add a images-with-fallbacks stress test to test suite wendyreid: Something to consider is images with XHTML fallbacks, those happen to have alt text which is great, how do I signal to reading system that I want the fallback instead of the images? LaurentLM: There's a simple way. If there is a version of a comic with some accessibility description, then the publisher should put it as the first choice. Image as a fallback. LaurentLM: Favorite of the publisher should be first. Hadrien: That doesn't work. Many have put HTML first and images as fallback because it works in more systems, e.g. Apple Books can't work with images in spine. duga: Would go a step farther and say, if you have an accessible HTML document, you've made an accessible comic, don't put an image in the spine <Hadrien> +1 for what brady just said duga: You spent a lot of effort making that. wendyreid: So maybe better resolution is, we're keeping the spec as-is, but we are in agreement that comics deserves better guidance, so we want to write that guidance. Hadrien: And want to acknowledge what has been done for last 10 years, in millions of files. fantasai: Brady covered what I wanted to say, if we are writing best practices, if you do it clearly enough, but if its clear enough readers that use images can extract them, enabling that functionality PROPOSED: Write a best practices document for comics content as a separate working group note. No change to the specification for images in spine. <fantasai> +1 <Hadrien> +1 <duga> +1 <shiestyle> +1 <ivan> +1 <wendyreid> +1 <rdeltour> +1 <ikkwong> +1 <toshiakikoike> +1 <gpellegrino> +1 <MasakazuKitahara> +1 <LaurentLM> +1 RESOLUTION: Write a best practices document for comics content as a separate working group note. No change to the specification for images in spine. ivan: Should I close the issue? discussion? Hadrien: Connected to this resolution is roll documents. ivan: I will mark the issue as needing to be closed, and chairs can figure it out [discussion of what to discuss] |
|
@mattgarrish I know that you wanted to merge that PR to avoid further conflicts. Based on our discussions in Kobe, I moved back to a draft where FXL and roll documents are not covered under the same section ("Fixed dimension documents") anymore. I can add an example in that section as a placeholder or we can merge things as-is and work in a new PR, whatever works best for you. Since we'd like to deprecate a number of |
|
Ya, if you want to merge this that's fine with me. I don't have an issue with keeping the layouts separate, but I still find that section (not specifically what you've done) kind of scattershot so I'd like to propose some more changes to it, too (like we have an intro that doesn't mention any of the layouts, and then an intro to fixed layouts but not one for reflowable; the content dimensions might fit under the layout property definition; etc.). I'll make a branch off this and see what I can do to make it read better. Shouldn't take me long and I wouldn't expect it would make major merge conflicts for any properties you want to deprecate. |
|
I've extended the example a bit more (to illustrate the typical use case for roll documents) and fixed a typo identified by @sueneu. There's a conflict with the Once merged, I'll create a separate PR to tackle back compatibility with what some Japanese publishers are currently doing. |
rendition:layout:rollPreview | Diff