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

Clarify the rule on OCF resources not declared in Package Documents? #563

Closed
rdeltour opened this issue Jun 15, 2015 · 3 comments
Closed
Labels
EPUB32 Issues from 3.0.1 resolved in the EPUB 3.2 specification Topic-OCF The issue affects the OCF section of the core EPUB 3 specification
Milestone

Comments

@rdeltour
Copy link
Member

Strictly speaking, EPUB 3.0.1 says this is allowed (or rather, it doesn't say otherwise). However, people (legitimately IMO) asked that EpubCheck reports that as warnings.

Can the spec try to be clearer on which resource it allows being undeclared? e.g. introduce a safe place to put such resources, like in a top-level directory which doesn't contain a Package Document, and disallow undeclared resources in other locations.

See also the thread "validation issue with ancillary resources" in the epub-working-group mailing list, and also w3c/epubcheck#58

@rdeltour rdeltour added the Topic-OCF The issue affects the OCF section of the core EPUB 3 specification label Jun 15, 2015
@mattgarrish mattgarrish modified the milestone: EPUB 3.1 Nov 3, 2015
@mattgarrish
Copy link
Member

Now that we're saying foreign resources are allowed without fallbacks so long as they aren't used in the direct rendering does that make this issue go away?

There's no need to hide a foreign resource to avoid a fallback requirement anymore, in other words, so we should report "other stuff" as warnings by requiring all resources be listed in the manifest unless they have a specific spec exemption somewhere.

It might need to be run past the ESC group, though, as they're using that exemption to hide configuration files, but I don't think they need to do that with this change, either.

@mgylling
Copy link

mgylling commented May 31, 2016

@rdeltour: in addition to the changes Matt reference above, we also have a suggestion for a property to help EpubCheck distinguish between intentional and non-intentional files in the package.

@mattgarrish
Copy link
Member

Closing this issue as the working group resolved on the July 6 call not to change the rules but that epubcheck should be changed to only emit a info message about resources that are not in the manifest, linked or "manifest free" (rendition mapping doc).

@mattgarrish mattgarrish added the EPUB32 Issues from 3.0.1 resolved in the EPUB 3.2 specification label Aug 14, 2018
rdeltour added a commit to w3c/epubcheck that referenced this issue Dec 22, 2022
EPUBCheck used to report any resource found in the the container but not
listed in the manifest as a warning (since #58 was fixed, in v1.1). But
the EPUB specification does not require that.

This commit downgrades the severity of `OPF-003` to a usage report.

See also #1452
See also w3c/epub-specs#563
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EPUB32 Issues from 3.0.1 resolved in the EPUB 3.2 specification Topic-OCF The issue affects the OCF section of the core EPUB 3 specification
Projects
None yet
Development

No branches or pull requests

3 participants