Add a (simple) PDF profile #97
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # PDF Profile | ||
|
|
||
| **Editors:** | ||
|
|
||
| * Michael Benowitz ([NYPL](https://www.nypl.org)) | ||
| * Laurent Le Meur ([EDRLab](https://www.edrlab.org)) | ||
|
|
||
| **Participate:** | ||
|
|
||
| * [GitHub readium/webpub-manifest](https://github.com/readium/webpub-manifest) | ||
| * [File an issue](https://github.com/readium/webpub-manifest/issues) | ||
|
|
||
| ## Example | ||
|
|
||
| ```json | ||
| { | ||
| "@context": "http://readium.org/webpub-manifest/context.jsonld", | ||
|
|
||
| "metadata": { | ||
| "@type": "http://schema.org/Book", | ||
| "conformsTo": "https://readium.org/webpub-manifest/profiles/pdf", | ||
| "title": "Moby-Dick", | ||
| "author": "Herman Melville", | ||
| "language": "en" | ||
| }, | ||
|
|
||
| "links": [ | ||
| {"rel": "self", "href": "http://example.org/manifest.json", "type": "application/webpub+json"}, | ||
| ], | ||
|
|
||
| "readingOrder": [ | ||
| { | ||
| "href": "http://example.org/mobydick-part1.pdf", | ||
| "type": "application/pdf", | ||
| }, | ||
| { | ||
| "href": "http://example.org/mobydick-part2.pdf", | ||
| "type": "application/pdf", | ||
| } | ||
| ], | ||
|
|
||
| "resources": [ | ||
| {"rel": "cover", "href": "http://example.org/cover.jpeg", "type": "image/jpeg", "height": 600, "width": 300} | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ## Introduction | ||
|
|
||
| The goal of this specification is to provide a profile of the [Readium Web Publication Manifest](https://readium.org/webpub-manifest) dedicated to pdf documents. | ||
|
|
||
| It is mostly used as a basis for the specification of a method for protecting PDF files using LCP, i.e. [LCP for PDF](https://readium.org/lcp-specs/notes/lcp-for-pdf.html). | ||
|
|
||
| This profile relies on: | ||
|
|
||
| * a declaration of [conformance with this Profile](#1-declaring-conformance-with-the-pdf-profile), | ||
| * some [restrictions on the resources of the reading order](#2-restrictions-on-the-resources-of-the-reading-order), | ||
|
Member
There was a problem hiding this comment. It's a single restriction currently. |
||
|
|
||
| ## 1. Declaring conformance with the PDF Profile | ||
|
|
||
| To declare that it conforms to the PDF Profile, a Readium Web Publication Manifest <strong class="rfc">must</strong> include a `conformsTo` key in its `metadata` section, with `https://readium.org/webpub-manifest/profiles/pdf` as value. | ||
|
Member
There was a problem hiding this comment. This should be modified to say "with |
||
|
|
||
| ## 2. Restrictions on resources in the reading order | ||
|
|
||
| In addition to the normal requirements of a `readingOrder`, all Link Objects <strong class="rfc">must</strong> point strictly to PDF resources, with no fragment identifier. | ||
|
|
||
| > **Note** | ||
|
llemeurfr marked this conversation as resolved.
Outdated
|
||
| > While this specification defines the possibility to insert several PDF files into the reading order, the current versions of the Readium toolkits only support one item. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be "PDF documents" instead of lowercase pdf.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done