Skip to content

Clarify nav content rules and RS processing of elements#1485

Merged
mattgarrish merged 6 commits intomainfrom
fix/issue-976
Feb 15, 2021
Merged

Clarify nav content rules and RS processing of elements#1485
mattgarrish merged 6 commits intomainfrom
fix/issue-976

Conversation

@mattgarrish
Copy link
Member

@mattgarrish mattgarrish commented Jan 27, 2021

This PR fixes two problems with the current nav doc definition:

  • it exempts nav elements without an epub:type attribute from the content model restrictions since their use by reading systems is generally unrealistic anyway.
  • it sets out specific requirements for reading system handling of nav elements (must for toc, should for page-list when present, and may for everything else) as our current requirement to provide access to all the nav elements is sure to fail all reading systems when it comes time for testing

Reading Systems spec: preview diff

Fixes #976
Fixes #975


Preview | Diff

Copy link
Contributor

@wareid wareid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment, but otherwise looks good.

Copy link
Member

@iherman iherman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am fine with the changes.

However: the RS says something about the page-list and toc. It seems to be entirely silent on what it should do with the landmark nav element, although that is defined in the content document, alongside with page-list and toc. I must admit I do not know what a RS is expected to do with it... Should we give at least some guidance for RS-s?

@mattgarrish
Copy link
Member Author

mattgarrish commented Jan 28, 2021

I must admit I do not know what a RS is expected to do with it...

Nothing specifically, so I consider it part of the "MAY" section.

It's supposed to help RSes implement their own interface -- like providing a mapping for a dedicated toc button. That's the "efficient access" part of the definition. But other than skipping to the body matter when a book opens I don't know how much the links are even used.

We can't mandate reading systems implement behaviours or buttons, and otherwise there isn't a specific user-facing expectation. I haven't seen a reading system that lets users pull up the landmarks, for example, so it'd probably be hard to bump it up to a recommendation and also find implementations.

@iherman
Copy link
Member

iherman commented Jan 28, 2021

I must admit I do not know what a RS is expected to do with it...

Nothing specifically, so I consider it part of the "MAY" section.

O.k. I may be very picky, but I just may be the average reader: maybe it is worth adding (e.g., as a remark in parentheses) that this the "MAY" remark also applies to the landmark nav element, although that value of epub:type is explicitly defined in the spec.

But, again, I may just be too picky.

@GeorgeKerscher
Copy link

GeorgeKerscher commented Jan 28, 2021 via email

@mattgarrish
Copy link
Member Author

mattgarrish commented Jan 28, 2021

maybe it is worth adding ... that this the "MAY" remark also applies to the landmark nav element

I'm fine either way. I've added this for now:

It MAY provide users access to the links in the landmarks nav element [EPUB-33] and MAY use the links to enable functionality in the application.

If there exists another implementation that gives users direct access to the links we could always consider moving it to a recommendation.

I hear students say they wish publishers had a landmark at the beginning of a chapter that identifies all the essentials they should learn in this chapter.

You could probably do this with the learning-objectives or learning-outcomes semantics. It could also be done with ARIA within each chapter if there were better access to ARIA landmarks.

Base automatically changed from master to main February 4, 2021 05:42
@mattgarrish mattgarrish merged commit cd4bf82 into main Feb 15, 2021
@mattgarrish
Copy link
Member Author

Merged this as we need a clarification. We can always review the requirements if testing shows they're unrealistic.

@mattgarrish mattgarrish deleted the fix/issue-976 branch February 25, 2021 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Nav doc: when is epub:type necessary Nav doc: access to all nav elements?

4 participants