Update EPUB profile documentation #86
Closed
Conversation
This file contains 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 PR adds documentation about the `metadata.presentation.layout` presentation hint to the EPUB profile. This property is already defined in the [EPUB extension schema](https://github.com/readium/webpub-manifest/blob/master/schema/extensions/epub/metadata.schema.json). I also removed language suggesting that the property defaults to `fixed` for images or videos. Since the EPUB extension defines that resources in the `readingOrder` can only be HTML files, the property will always default to `reflowable` unless otherwise noted by changing either the `metadata.presentation.layout` property in the Webpub Manifest, or the `properties.layout` property on the resource link itself. One additional question: Fixed layout EPUB resources are required to have a `meta` tag indicating the viewport size: `<meta name="viewport" content="width=1200, height=900"/>`. Would it make sense to encourage those creating Webpub Manifests for FXL EPUBS to include a `height` and `width` on the link object for the FXL resource?
|
Is it possible to merge this? I recently tripped myself up reading the docs and wondering why I had a |
|
I can't merge this myself, but I'll mention it in one of our calls next week. |
|
Thanks @mickael-menu ! I also asked a related question in a discussion here. The overlap between things things is maybe why this PR hasn't been approved? |
|
Since we're working on the EPUB profile in another branch, I think I'll take the opportunity to cover that topic as well through #95 |
|
This has been deprecated by #89 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds documentation about the
metadata.presentation.layoutpresentation hint to the EPUB profile. This property is already defined in the EPUB extension schema.I also removed language suggesting that the property defaults to
fixedfor images or videos. Since the EPUB extension defines that resources in thereadingOrdercan only be HTML files, the property will always default toreflowableunless otherwise noted by changing either themetadata.presentation.layoutproperty in the Webpub Manifest, or theproperties.layoutproperty on the resource link itself.One additional question: Fixed layout EPUB resources are required to have a
metatag indicating the viewport size:<meta name="viewport" content="width=1200, height=900"/>. Would it make sense to encourage those creating Webpub Manifests for FXL EPUBS to include aheightandwidthon the link object for the FXL resource?