Skip to content

Clarify styling of navigation document #2708

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Clarify styling of navigation document #2708

wants to merge 9 commits into from

Conversation

mattgarrish
Copy link
Member

@mattgarrish mattgarrish commented Apr 8, 2025 •
edited by pr-preview bot
Loading

This pull request takes the two stray paragraphs about including the navigation document in the nav requirements and moves them to the existing section on using the nav doc in the spine. It also clarifies that when used in the spine, it is the author's responsibility to suppress list item numbering.

There is also a claim in the section that the hidden attribute is ignored by reading systems when they process the nav document, but when I tried to link this to where it's stated in the reading system specification I couldn't find anything. I've added an additional bullet to that specification to require that markup and styling to hide content in the spine is to be ignored.

Fixes #2687

Reading Systems: Preview | Diff

Preview | Diff

@mattgarrish mattgarrish requested review from shiestyle and wareid April 8, 2025 17:06
@mattgarrish mattgarrish requested a review from iherman as a code owner April 8, 2025 17:06
@github-project-automation github-project-automation bot moved this to In review in PM/EPUB issues Apr 8, 2025
iherman
iherman approved these changes Apr 9, 2025
View reviewed changes
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 wonder whether we should not create a test case for that MUST statement in RS right away, and not wait until the end... (as a general approach for such minor changes).

@mattgarrish
Copy link
Member Author

Ya, it's probably better to do that as we go than pick through the issues and spec later to figure out what's changed. Do you want to handle that part?

@iherman
Copy link
Member

iherman commented Apr 10, 2025

Ya, it's probably better to do that as we go than pick through the issues and spec later to figure out what's changed. Do you want to handle that part?

Yep. But do not wait for it to merge this PR. If I do not do it before it is otherwise ready, merge it and I will raise a new PR for the test references.

@iherman iherman mentioned this pull request Apr 10, 2025
Open
@iherman
Copy link
Member

iherman commented Apr 10, 2025

Ya, it's probably better to do that as we go than pick through the issues and spec later to figure out what's changed. Do you want to handle that part?

Yep. But do not wait for it to merge this PR. If I do not do it before it is otherwise ready, merge it and I will raise a new PR for the test references.

Actually

@iherman iherman added Spec-EPUB3 The issue affects the core EPUB 3.X Recommendation Spec-ReadingSystems The issue affects the EPUB Reading Systems 3.X Recommendation labels Apr 16, 2025
@iherman
Copy link
Member

iherman commented Apr 17, 2025

This was discussed during the pmwg meeting on 17 April 2025.

View the transcript

w3c/epub-specs#2708

wendyreid: clarification of styling documents.

mgarrish: has a Reading System requirement but cleaning it up but we had some authoring recommendation but didn't notice that the the Reading System in spine requirements. When you are using it in the spine its up to the author to style it. when a RS shows the TOC in their own UI they need to hide the line numbers.
… we never did put that as a requirement in the RS's when using the nav documents to ignore that part of styling.
… this is just reshuffling of the requirements documents.

SueNeu: both to the author and the RS that this is list style none, outside the spine they require that they need to supress the style. it wasn't stated clearly, when authoring in the nav and put it in the <spine> then you as a content document author must suppress the numbering style.

ivan: I have updated test suite to handle 3.4
… more important, testing period was long an tedious, this should be a lot better since we have backward compatible. When we add any normative change to document that will stay around we create the test right away. we don't want to wait to add all the tests at the end.
… makes everyones life easier.

mgarrish: similar with EPUBCheck

ivan: Merge it!

<rdeltour> +1 to what Matt just said :)

wendyreid: in reading it I am curious about <nav.xhtml> some creators will use that to include page list and landmarks.

mgarrish: ignored in both cases, or ignore <nav elements?
… for in spine reading systems should ignore it, could be hiding branches within it. RS should ignore it just use it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iherman iherman iherman approved these changes

@shiestyle shiestyle shiestyle approved these changes

@wareid wareid wareid approved these changes

Assignees
No one assigned
Labels
Spec-EPUB3 The issue affects the core EPUB 3.X Recommendation Spec-ReadingSystems The issue affects the EPUB Reading Systems 3.X Recommendation
Projects
PM/EPUB issues
Status: In review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Styling of nav lists in spine
4 participants
@mattgarrish @iherman @shiestyle @wareid