Modify the parsing of the guide node in EPUB 2.0 to return the same results as landmarks in EPUB 3.x. #628
Conversation
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
…esults as landmarks in EPUB 3.x.
qnga
reviewed
Mar 21, 2025
readium/streamer/src/main/java/org/readium/r2/streamer/parser/epub/PackageDocument.kt
Show resolved
Hide resolved
readium/streamer/src/main/java/org/readium/r2/streamer/parser/epub/PackageDocument.kt
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Thank you for your contribution!
I think that makes a lot of sense, as landmarks is the replacement of the deprecated guide.
To make it more useful for integrators, I suggest some changes:
-
epub:typeis currently not parsed in EPUB 3landmarks, so it's not very useful. I suggest parsing it (+ test cases) using the link property keyhttp://www.idpf.org/2007/ops#typeas it's an EPUB extension and not RWPM-native. -
We should map the EPUB 2 types to the EPUB 3 ones, so that integrators can use the
landmarkswithout checking for the EPUB types. Here's some mapping suggestions. I highlighted the ones that are different.EPUB 2 EPUB 3 title-pagetitlepagetextbodymatteracknowledgementsacknowledgments(note diff orthography)notesendnotes(orfootnotes?)covercovertoctocindexindexglossaryglossarybibliographybibliographycolophoncolophoncopyright-pagecopyright-pagededicationdedicationepigraphepigraphforewordforewordloiloilotlotprefacepreface
readium/streamer/src/main/java/org/readium/r2/streamer/parser/epub/ManifestAdapter.kt
Outdated
Show resolved
Hide resolved
|
I opened a related discussion: readium/webpub-manifest#111 |
…nt and add it to the rels of the Link object for further use.
… files. Mapped types and used rels to return the same results as landmarks.
qnga
reviewed
Mar 24, 2025
readium/streamer/src/main/java/org/readium/r2/streamer/parser/epub/NavigationDocumentParser.kt
Outdated
Show resolved
Hide resolved
readium/streamer/src/main/java/org/readium/r2/streamer/parser/epub/PackageDocument.kt
Show resolved
Hide resolved
readium/streamer/src/main/java/org/readium/r2/streamer/parser/epub/PackageDocument.kt
Outdated
Show resolved
Hide resolved
readium/streamer/src/main/java/org/readium/r2/streamer/parser/epub/PackageDocument.kt
Show resolved
Hide resolved
mickael-menu
approved these changes
Mar 24, 2025
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.
In my app, we use EPUB files created with the EPUB 2.0 format, which require the
guidenode.However, the library currently ignores the
guidenode.So, I modified it to return the same results as
landmarksin the EPUB 3.x specification.