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.

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

Add property for exempt resources #2507

Closed
wants to merge 6 commits into from
Closed

Add property for exempt resources #2507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
91f6a2c
add property for exempt resources
mattgarrish Dec 16, 2022
af9f41b
fix broken terminology ref
mattgarrish Dec 16, 2022
d1eeeb5
typo
mattgarrish Dec 17, 2022
d8cd549
updated note
mattgarrish Dec 17, 2022
95039b5
add usage recommendation
mattgarrish Dec 17, 2022
fa2b580
fix broken link
mattgarrish Dec 17, 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
9 changes: 9 additions & 0 deletions epub33/core/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1247,6 +1247,12 @@ <h3>Exempt resources</h3>
resources (i.e., the requirement for a fallback for the foreign content document covers any
rendering issues within it). As the resource is not referenced from an EPUB content document, it
automatically becomes exempt from fallbacks.</p>

<div class="note">
<p>Resources that fall under this latter exemption should be identified in the manifest using the
<code>exempt</code> property on their [^item^] entry to avoid their being flagged by EPUB
Comment on lines +1252 to +1253
Copy link
Member

Choose a reason for hiding this comment

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

This "fall under this latter exemption" is a bit vague. Isn't it better to make it more explicit and refer to exceptions that are not content-specific?

conformance checkers. Refer to <a href="#sec-exempt"></a> for more information.</p>
</div>
</section>

<section id="sec-resource-fallbacks">
Expand Down Expand Up @@ -4932,6 +4938,9 @@ <h6>Resource properties</h6>
<li><a href="#sec-switch">switch</a></li>
</ul>

<p>EPUB creators SHOULD set the <a href="#sec-exempt">exempt</a> property whenever a resource
referenced by an <code>item</code> element matches its definition.</p>

<aside class="example" id="example-item-properties-scripted-mathml"
title="Identifying a scripted content document with embedded MathML">
<pre class="synopsis">&lt;item
Expand Down
37 changes: 37 additions & 0 deletions epub33/core/vocab/item-properties.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,43 @@ <h4>cover-image</h4>
</table>
</section>

<section id="sec-exempt">
<h4>exempt</h4>

<table class="tabledef" id="exempt">
<tbody>
<tr>
<th>Name:</th>
<td>
<code>exempt</code>
</td>
</tr>
<tr>
<th>Description:</th>
<td>
<p>The <code>exempt</code> property indicates that the [=publication resource=]
is an [=exempt resource=] (e.g., is used as script input or is included in the
[=EPUB container=] for non-rendering purposes).</p>
<p>If [=EPUB creators=] do not set this property, acknowledging the resources are
included by design, reading systems and [=EPUB conformance checkers=] may flag the
resources as unused if they cannot find references to them.</p>
Comment on lines +57 to +59
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure I understand the "acknowledging the resources are included by design" remark here.

</td>
</tr>
<tr>
<th>Applies to:</th>
<td>All publication resources that meet the <a href="#confreq-foreign-no-fallback">exempt
resources condition</a> that allows unreferenced resources.</td>
</tr>
<tr>
<th>Cardinality:</th>
<td>
<code>Zero or more</code>
</td>
</tr>
</tbody>
</table>
</section>

<section id="sec-mathml">
<h4>mathml</h4>

Expand Down