webpub-manifest icon indicating copy to clipboard operation
webpub-manifest copied to clipboard

Update EPUB profile documentation

Open kristojorg opened this issue 3 years ago • 5 comments

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.

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?

kristojorg avatar Apr 21 '22 16:04 kristojorg

cc @HadrienGardeur @llemeurfr

mickael-menu avatar May 06 '22 08:05 mickael-menu

Is it possible to merge this? I recently tripped myself up reading the docs and wondering why I had a presentation.layout property in my WebpubManifest... then I came to github and found this PR I made last year. Would be great to have this in the documentation.

kristojorg avatar Mar 17 '23 10:03 kristojorg

I can't merge this myself, but I'll mention it in one of our calls next week.

mickael-menu avatar Mar 17 '23 11:03 mickael-menu

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?

kristojorg avatar Mar 17 '23 11:03 kristojorg

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 https://github.com/readium/webpub-manifest/pull/95

HadrienGardeur avatar Mar 21 '23 09:03 HadrienGardeur

This has been deprecated by https://github.com/readium/webpub-manifest/pull/89

HadrienGardeur avatar Jun 26 '24 08:06 HadrienGardeur