Skip to content

Clarify that ocf processing files are not listed in the manifest #2506

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

Merged
merged 2 commits into from
Dec 30, 2022
Merged

Clarify that ocf processing files are not listed in the manifest #2506

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdaecf4
Clarify that ocf processing files are not listed in the manifest
mattgarrish Dec 16, 2022
37cb0cd
add extra clarification
mattgarrish Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions epub33/core/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1676,6 +1676,9 @@ <h4>File and directory structure</h4>
<p>The file name <code>mimetype</code> in the root directory is reserved for use by [=OCF ZIP
containers=], as explained in <a href="#sec-container-zip"></a>.</p>

<p>Files in the <code>META-INF</code> directory and the <code>mimetype</code> file are not
[=publication resources=] so MUST NOT be listed in the [=EPUB manifest|manifest=].</p>

<p>[=EPUB creators=] MAY locate all other files within the OCF abstract container in any location
descendant from the root directory, provided they are not within the <code>META-INF</code>
directory. EPUB creators MUST NOT reference files in the <code>META-INF</code> directory from an
Expand Down Expand Up @@ -4788,15 +4791,20 @@ <h4>The <code>manifest</code> element</h4>

<p id="confreq-rendition-manifest">[=EPUB creators=] MUST list all publication resources in the
<code>manifest</code>, regardless of whether they are [=container resources=] or [=remote
resources=]. Moreover, the <code>manifest</code> MUST only list publication resources.</p>
resources=].</p>

<p>Note that the <code>manifest</code> is not self-referencing: EPUB creators MUST NOT specify an
<code>item</code> element that refers to the [=package document=] itself.</p>

<div class="note">
<p>Failure to provide a complete manifest of resources may lead to rendering issues. [=Reading
systems=] might not unzip such resources or could prevent access to them for security
reasons.</p>
<p>The manifest is only for listing publication resources. [=Linked resources=] and <a
href="#sec-container-file-and-dir-structure">the special files for processing the OCF
Container</a> (i.e., files in the <code>META-INF</code> directory, and the
<code>mimetype</code> file) are restricted from inclusion.</p>

<p>Failure to provide a complete manifest of publication resources may lead to rendering issues.
[=Reading systems=] might not unzip such resources or could prevent access to them for
security reasons.</p>
</div>
</section>

Expand Down Expand Up @@ -11779,6 +11787,9 @@ <h3>Substantive changes since <a href="https://www.w3.org/TR/2022/CR-epub-33-202
Recommendation</a></h3>

<ul>
<li>16-Dec-2022: Clarified that the special files for processing the OCF container are not listed in
the manifest, so the restriction that the manifest only list publication resources is not
needed. See <a href="https://github.com/w3c/epub-specs/pull/2506">pull request 2506</a>.</li>
<li>12-Dec-2022: Clarified that fixed layout height and width declarations must be in the first
<code>viewport meta</code> tag. See <a href="https://github.com/w3c/epub-specs/pull/2503"
>pull request 2503</a>.</li>
Expand Down