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

Does spine listing requirement apply to nav doc? #545

Closed
mattgarrish opened this issue Jun 15, 2015 · 4 comments
Closed

Does spine listing requirement apply to nav doc? #545

mattgarrish opened this issue Jun 15, 2015 · 4 comments
Labels
status: needs review Needs to be reviewed by a team member before further processing
Milestone

Comments

@mattgarrish
Copy link
Member

If a landmark entry references the toc in navigation document:

<li><a epub:type="toc" href="#toc">Table of Contents</a></li>

But the navigation document is not listed in the spine, is it correct that this warning be issued:

WARNING(RSC-011): .\English-Language-GCSE-for-AQA.epub/EPUB/Text/nav.xhtml(52,52): Found a reference to a resource that is not a spine item.

It's not technically a requirement that the nav doc load in the spine.

@rdeltour
Copy link
Member

You're right, it shouldn't be a WARNING....It should actually be an ERROR! Publications says

All EPUB Content Documents linked to from the EPUB Navigation Document must be listed in the spine

Right?

@rdeltour rdeltour added this to the 4.0 milestone Jun 16, 2015
@rdeltour rdeltour self-assigned this Jun 16, 2015
@rdeltour rdeltour added the status: needs review Needs to be reviewed by a team member before further processing label Jun 16, 2015
@mattgarrish
Copy link
Member Author

Right, but that rule was added without consideration of this case (to address the CFI linking problem and a desire for all content documents to be in-spine).

Is it the case that landmarks must load in the content area of the reading system? I really don't know the answer, as we don't say.

But, if so, then you're right it should be an error. If not, since the nav doc can open outside of the spine as xhtml, and clicking the link could simply scroll you back up to the toc, is it really an error?

@rdeltour
Copy link
Member

I would suggest that if the Nav Doc is not in the spine, then the landmark nav should not (must not, actually) link to it. RS all have a built-in way to render and access the Nav Doc anyway.

In other words, I think this Nav Doc rule makes sense, and s/b enforced as such in EpubCheck (making RSC-011 an ERROR).
This doesn't prevent opening a new epub-rev issue if you feel the rule is too restrictive.

Agreed?

@mattgarrish
Copy link
Member Author

Right, this is the wrong forum, and I'm not sure I care enough to pursue it. :)

It's a niche case, as no other content document gets spine exclusion.

rdeltour added a commit that referenced this issue Aug 28, 2015
This is mandated in both EPUB 2.0.1 and EPUB 3:

- EPUB Publications 3.0.1 says (in section 3.4.12 "The spine Element"):

> All EPUB Content Documents that are linked to from EPUB Content
> Documents in the spine must themselves be listed in the spine.

- Open Packaging Format 2.0.1 says (in section 2.4 "Spine"):

> All OPS Content Documents that are part of the publication (i.e.
are listed in the manifest) which are potentially reachable by any
reference mechanism allowed in this specification must be included in
the spine.

Note: False negatives will be raised when a Content Document is in the
manifest but not linked from any other document. Checking the existence
of a chain of links from an in-spine document is difficult with the
current object model, and the case is allegedly rather rare.

See also #545.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: needs review Needs to be reviewed by a team member before further processing
Projects
None yet
Development

No branches or pull requests

2 participants