3.1.1

Warning

Minor releases (a.B.c) of the Readium toolkit may now 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

Fixed

• #662 Fixed duplicate class when using readium-adapter-pdfium.

Commits

• Allow blank issues by @mickael-menu in #655
• Fix duplicate class with the PDFium adapter by @mickael-menu in #663
• fix: corrected typo 'spread-node' to 'spread-none' by @BienBoy in #664
• 3.1.1 by @mickael-menu in #665

New Contributors

• @BienBoy made their first contribution in #664

Full Changelog: 3.1.0...3.1.1

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

3.0.3

Resources

• Migration guide

Changelog

Fixed

LCP

• Fixed IllegalArgumentException when trying to decrypt the end of a CbcLcpResource.

Commits

• Fix LcpDecryptor and FileZipLicenseContainer by @qnga in #602
• 3.0.3 by @qnga in #605

Full Changelog: 3.0.2...3.0.3

3.0.2

Resources

• Migration guide

Changelog

Fixed

Navigator

• Fixed the value of the scroll setting when switching from a reflowable EPUB to a fixed-layout one.

LCP

• Fixed IndexOutOfBoundsException occurring when an LCP-protected EPUB contains incorrect original lengths in its META-INF/encryption.xml file.

Commits

• Fix value of navigator.overscroll.value.scroll in fxl mode by @qnga in #587
• Fix CBC decryption when originalLength is wrong by @qnga in #592
• 3.0.2 by @mickael-menu in #594

Full Changelog: 3.0.1...3.0.2

3.0.1

Resources

• Migration guide

Changelog

Fixed

Shared

• Improved performance when accessing a publication from the Shared Storage.

Navigator

• Fixed crash in the image navigator.

What's Changed

• Improve footnotes handling by @qnga in #571
• Fix crash in the image navigator by @mickael-menu in #582
• Speed up access to shared storage by @qnga in #581
• 3.0.1 by @mickael-menu in #583

Full Changelog: 3.0.0...3.0.1

3.0.0

Resources

• Migration guide

Changelog

If you upgrade from a 2.x version, you might want to check out the Changelog of the alpha and beta versions as well.

Fixed

Navigator

• Fixed computing the total progression of audiobook locators.
• Fixed starting the TTS from the current resource in a fixed-layout EPUB.

What's Changed

• Fix audiobook locators' total progression by @mickael-menu in #553
• Fix TTS in a fixed-layout EPUB by @mickael-menu in #555
• Migrate away from JCenter by @mickael-menu in #557
• Try to fix Exoplayer illegal state by @qnga in #556
• Import android-pdf-viewer as a JAR instead of an AAR by @mickael-menu in #562
• Promote the Preferences API to stable by @mickael-menu in #568
• 3.0.0 by @mickael-menu in #569

Full Changelog: 3.0.0-beta.2...3.0.0

2.4.3

Resources

• Migration guide
• API Reference

Changelog

This release is the same as 2.4.2, with a fix for Maven Central.

• Bump to Kotlin 1.9.24.
• Remove JCenter dependencies.

2.4.2

Resources

• Migration guide
• API Reference

Changelog

• Bump to Kotlin 1.9.24.
• Remove JCenter dependencies.

3.0.0-beta.1

Resources

• Migration guide
• API Reference

Changelog

⚠️ Please consult the migration guide to assist you in handling the breaking changes in this latest major release.

Deprecated

Navigator

• All the completion parameters of the Navigator APIs are removed.

Changed

• All the APIs using or returning a Date objects are now using a custom Instant type.

Shared

• The Link property key for archive-based publication assets (e.g. an EPUB/ZIP) is now https://readium.org/webpub-manifest/properties#archive instead of archive.

LCP

• #493 The LCP module does not require the Bluetooth permissions anymore to derive the device name.

Fixed

Navigator

• #325 Top EPUB selections no longer break when dragging the selection handles.
• Fixed applying preferences while the EPUB navigator fragment is being recreated.

What's Changed

• Prevent Opds2Sniffer from reading the whole blob by @qnga in #482
• Various improvements in LcpService by @qnga in #483
• Fix various crashes by @mickael-menu in #484
• Don't read content whose length is unknown in sniffing by @qnga in #485
• Downgrade to jsoup 1.16.1 by @mickael-menu in #489
• Fix opening LCP-protected publication in restricted mode by @qnga in #494
• Fix a bunch of thread violations by @mickael-menu in #490
• Remove completion from Navigator APIs by @mickael-menu in #488
• Prevent reporting the current position while loading a locator by @mickael-menu in #487
• Enable core library desugaring by @mickael-menu in #496
• Fix various EPUB positioning issues by @mickael-menu in #499
• Fix handling EPUB noteref with nested elements by @mickael-menu in #503
• Fix broken EPUB selection in paginated mode by @mickael-menu in #502
• Make possible crashes of PSPDFKit more explicit by @qnga in #495
• Revamp format specifications and other changes by @qnga in #500
• Replace Date with Instant by @mickael-menu in #506
• Documentation by @mickael-menu in #486
• Fix applying preferences while recreating EPUB fragments by @mickael-menu in #507
• Change LCP device name strategy by @mickael-menu in #508
• Support for the new 2.x LCP Profiles by @mickael-menu in #510
• 2.4.1 by @mickael-menu in #511
• Deprecate media1 and media2 navigators by @mickael-menu in #512
• Rename archive Link property by @mickael-menu in #514
• 3.0.0-beta.1 by @mickael-menu in #515

Full Changelog: 3.0.0-alpha.2...3.0.0-beta.1

2.4.1

Resources

• Migration guide
• API Reference

Changelog

Added

LCP

• #509 Support for the new 2.x LCP Profiles.