3.1.0

Warning

Starting now, minor releases (a.B.c) of the Readium toolkit may include minor breaking changes, such as dependency upgrades or small API modifications. Major version numbers are reserved for significant architectural changes.

Resources

• Migration guide

Changelog

Added

Shared

• Implementation of the W3C Accessibility Metadata Display Guide specification to facilitate displaying accessibility metadata to users. See the dedicated user guide.
• Support for W3C's Text & data mining Reservation Protocol in our metadata models.
• Support for accessibility exemption metadata, which allows content creators to identify publications that do not meet conformance requirements but fall under exemptions in a given juridiction.
• Support for EPUB Accessibility 1.1 conformance profiles.

Navigator

• The EpubNavigatorFragment.Configuration.disablePageTurnsWhileScrolling property disables horizontal swipes for navigating to previous or next resources when scroll mode is enabled. When set to true, you must implement your own mechanism to move to the next resource (contributed by @tm-bookshop).

Streamer

• The EPUB 2 <guide> element is now parsed into the RWPM landmarks subcollection when no EPUB 3 landmarks navigation document is declared (contributed by @erkasraim).

Changed

• Upgraded to Kotlin 2.1.20 and Gradle 8.13.
• Jetifier is not required anymore, you can remove android.enableJetifier=true from your gradle.properties if you were using Readium as a local clone.

Shared

• go-toolkit#92 The accessibility feature printPageNumbers is deprecated in favor of pageNavigation.

Fixed

Navigator

• Fixed a race condition causing EPUB decorations to be applied twice when opening a publication.
• Fixed support of Readium Web Publication packages conforming to the EPUB profile (contributed by @ddfreiling).

Commits

• Dependency updates by @stevenzeck in #576
• Update to SDK 35 by @stevenzeck in #575
• Kotlin 2.x by @stevenzeck in #574
• Remove deprecated symbols by @qnga in #589
• Add a new experimental EPUB FXL navigator by @qnga in #567
• Update KTLint by @stevenzeck in #585
• Cleanup old media and media2 usages by @stevenzeck in #593
• Update Kotlin and media3 by @stevenzeck in #597
• Remove nanohttp libs and koi-async dependency by @qnga in #603
• Merge main into develop by @qnga in #606
• Speed up initialization of ExoPlayerEngine by @mickael-menu in #620
• Remove Jetifier by @mickael-menu in #610
• Fix a race condition when initializing the EPUB navigator by @mickael-menu in #622
• Modify the parsing of the guide node in EPUB 2.0 to return the same results as landmarks in EPUB 3.x. by @erkasraim in #628
• feat: add option to disable horizontal swiping when scroll is true. by @tm-bookshop in #624
• Modified XmlParser to correctly parse CDATA. by @erkasraim in #633
• Various accessibility metadata changes by @mickael-menu in #635
• Add support for TDM Reservation Protocol metadata by @mickael-menu in #634
• Update dependencies by @stevenzeck in #637
• Update Room and enable KSP2 by @stevenzeck in #640
• fix: webpub EPUBs by @ddfreiling in #642
• Fix streaming with LCP documentation by @mickael-menu in #645
• W3C Accessibility Metadata Display Guide by @mickael-menu in #644
• Update the issue template by @mickael-menu in #648
• Update README by @mickael-menu in #646
• 3.1.0 by @mickael-menu in #654

New Contributors

• @erkasraim made their first contribution in #628
• @tm-bookshop made their first contribution in #624
• @ddfreiling made their first contribution in #642

Full Changelog: 3.0.3...3.1.0