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

Should there be a TOC if supplemental materials are provided in an audio book? #408

Closed
GeorgeKerscher opened this issue Mar 6, 2019 · 10 comments

Comments

@GeorgeKerscher
Copy link

We decided that a Table of Contents is not required. We do not expect supplemental materials to be provided in an audio book, such as images, html pages, etc. However, if such supplemental information is provided as resources (not in the reading list/play order), then it would be impossible for the Reading System to do anything predictable with this supplemental material.

Therefore, the question is must a TOC be provided that links to the supplemental materials provided?

I was asked to put this in the issue tracker on Monday March 4, 2019.

@llemeurfr
Copy link
Contributor

The Table of Contents is the way for the user to navigate freely in the different sections of the publication. The manifest is the way for the User Agent to know what the publication contains. The manifest does not use the ToC other than for presenting in to the user.
With the proper rel attribute value associated with supplemental material listed in the resources section of the manifest, the UA will be able to do something perfectly predictable.
For instance, we can define a booklet rel value. The Audiobook UA will discover that and be able to present an "affordance", e.g. a button on the bottom-right of the audiobook cover. Activating the button will open the pdf or html booklet of the audiobook and display it on screen, with a close button. No ToC involved in this UX.

@iherman
Copy link
Member

iherman commented Mar 7, 2019

@GeorgeKerscher, per the current spec, the constraint we have is that entries added to the ToC must be within the publication's bounds. This includes any resource that is either in the readingOrder or in the resources lists within the manifest. Ie, if the author has supplementary material that are important information, but he/she does not want to put it into the default reading order, then it should be listed in resources and can then be added to the ToC as well.

Ie, I believe there is no problem, but I may not understand the issue...

@GeorgeKerscher
Copy link
Author

GeorgeKerscher commented Mar 7, 2019 via email

@iherman
Copy link
Member

iherman commented Mar 7, 2019

It seems that the question is “must” there be a TOC to access the supplemental resources, or are rel values sufficient to let the user know that there is something (who knows what) there

I'd prefer implementers comment on this...

@HadrienGardeur
Copy link

Here's my take on this:

  • while a rel can identify supplemental materials in resources, this relies on a UA implementing specific support for it
  • on the other hand, every UA should support the TOC, which means that content producers can make sure that supplemental materials are always accessible by the user that way
  • but this is very much a best practice regarding authoring, this doesn't feel like something that should be in a specification (aside from examples) and certainly not a MUST

@wareid
Copy link

wareid commented Mar 7, 2019

Thanks George for logging this!

I agree with @HadrienGardeur that relying on UAs to implement specific support for a new suite of rel values is potentially problematic, whereas TOCs are supported out of the box.

The spec should address this as an accessibility issue. I would be concerned that leaving it to a best practice gives publishers the opportunity not to include the content in an accessible way (in the TOC). It would be better to recommend that supplemental content outside of the cover be listed in the TOC, and that if that content is present, a content creator SHOULD include a TOC. This leaves it to UAs whether they will support the supplemental content, but it is still visible to the user.

@llemeurfr
Copy link
Contributor

llemeurfr commented Mar 7, 2019

The spec should address this as an accessibility issue.

@wareid, I don't see how accessibility this connected to this subject. If the UA knows what is the use of given supplemental content and can deal with it, it will do its best for all people, with disabilities or not.
And if an audiobook UA doesn't support let's say a PDF booklet, having it listed in the ToC won't add much to the equation.
More, PDF content is often not accessible and nothing in our specs tells anything about it.

@iherman
Copy link
Member

iherman commented Apr 9, 2019

This issue was discussed in a meeting.

  • No actions or resolutions
View the transcript Should there be a TOC if supplemental materials are provided in an audio book?
Wendy Reid: #408
Wendy Reid: issue 408: should there be a TOC? spec says there must be if supplemental content is present in the resources. Any opposition?
Avneesh Singh: +1
Garth Conboy: TOC is an ordered list; for many of these supplemental contents there is no specific order
Wendy Reid: if we don’t put it in the TOC it is not referenceable for a user agent
Garth Conboy: putting in TOC implies an order that it may not have
Avneesh Singh: it has some order; not entirely random
… alt text html file follows dame principle, must be in TOC
Marisa DeMeglio: reminds me of landmarks in EPUB - not necessarily inherent order
… don’t agree that supp content needs same treatment as alt content
Wendy Reid: supp content can be a list of charts or pics of an author
Avneesh Singh: concept is similar
Ivan Herman: why is supp material so special that having it listed in the resources is not enough?
Joshua Pyle: +1 to Ivan
Bill Kasdorf: +1 to resources
Wendy Reid: how should resources be represented in reading order?
George Kerscher: resources always referenced by something; having them in TOC is provides standard mechanism to get at them
Ivan Herman: resources is a list of references to files, each of which can have one to many rel values
… from that point on it’s up to the user agent to find
George Kerscher: is the rel value in the manifest?
Ivan Herman: yes, and there may be several values as well
Wendy Reid: See also https://github.com/w3c/wpub/issues/405
Brady Duga: want to avoid getting bad audiobook TOCs, prefer it be an optional requirement because reading system may be able to impose its own more accurate TOC
… TOC should not be required just to have a list of supp materials
George Kerscher: Brady has a very good point.
George Kerscher: TOC should be meaningful and something a RS can trust.
Laurent Le Meur: agreed, for textbooks we have a special rel called cover, that allows us to put it in a TOC or not. if there is a small set of supp content that we always find in audiobooks, let’s use rel values like we use cover
Wendy Reid: instead of a required TOC of supp content, we require rel value that is applicable to that type of content
George Kerscher: having a TOC that, when present, is good and utilizable, sounds like putting a requirement on the reading system to use it if present
Wendy Reid: if the publisher has gone to the effort, it is likely that the reading system should pay attention to it. But can’t define “good” TOC
Marisa DeMeglio: it might be confusing if treatment is different across reading systems
Laurent Le Meur: we are living with that with covers currently - reading systems deal with differently
… if the rel value is not in the TOC, then the reading system won’t see it? Best practice instead of requirement
Benjamin Young: not necessarily an ordered list; publishers can’t define order if we just have resources floating - needs to be expressible by publishers
Laurent Le Meur: need to define what is wanted - are there other things besides booklets?
Benjamin Young: if this is a foundational data model that we are going to share, we may have publications with a whole host of supp content
Avneesh Singh: if there is an order that publisher want to define for supp content TOC is compulsory
Ivan Herman: if there is supp content that has an order, there is no need to make TOC is compulsory, because that is what will be used. The toc doesn’t really make sense for content that is not in order. Unnecessary to require TOC “if x and y are true”, for example.
George Kerscher: consistency between base spec an audiobook spec would be great, as much as possible.
Brady Duga: the more I hear about potential use cases, the less I think we should use TOC for supp materials, and tackle when we discuss synchronized media
… textbook and audio appear at the same time, for example
Marisa DeMeglio: we have an issue currently regarding alternative media, like adding synchronized media to an audiobook (audiobook with text use case)
Wendy Reid: we should create a mechanism to enable this, but also for when this doesn’t happen
Marisa DeMeglio: maybe we should have the information in more than one place, even though that can be a bummer for reading systems
Wendy Reid: will revisit this topic soon

@wareid
Copy link

wareid commented Jun 17, 2019

Discussed in the meeting on June 17, 2019.

Closing this issue in favour of the discussion on rel values in #405 and will make the requirement for a TOC in audiobooks with supplemental content a SHOULD.

@wareid wareid closed this as completed Jun 17, 2019
@iherman
Copy link
Member

iherman commented Jun 18, 2019

This issue was discussed in a meeting.

  • RESOLVED: Close #408, supplemental content will be identified in the manifest with rel values, and TOCs will be a SHOULD in the spec - best practices to follow
View the transcript Issue #408: Should there be a TOC if supplemental materials are provided in an audio book?
Wendy Reid: #408
Wendy Reid: should we require a toc if there’s supplemental material in the audiobook?
… or so we create a bunch of rel values
Laurent Le Meur: I’m in favor of closing this issue, and that we will rely on @rel
Wendy Reid: we’d have to create those rel values, right?
Laurent Le Meur: we need to know which values would be useful
George Kerscher: I don’t have a problem with @rel
… was the proposal to require a TOC?
Wendy Reid: the proposal was to require toc if there was supplemental material
George Kerscher: that’s ok. We do need more work on TOC.
… toc should be a should :)
Proposed resolution: Close #408, supplemental content will be identified in the manifest with rel values, and TOCs will be a SHOULD in the spec - best practices to follow (Wendy Reid)
Wendy Reid: here’s the proposal ^
Laurent Le Meur: +1
Luc Audrain: +1
George Kerscher: +1
Marisa DeMeglio: +1
Rachel Comerford: +1
Charles LaPierre: +1
Bill Kasdorf: +1
Resolution #1: Close #408, supplemental content will be identified in the manifest with rel values, and TOCs will be a SHOULD in the spec - best practices to follow
Luc Audrain: there is an issue about rel values which need to be discussed later
… and we need rel for cover
Wendy Reid: we’ll address that as we see what’s needed

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

5 participants