3.7.0 (#711)

Author: mickael-menu

CHANGELOG.md

@@ -2,7 +2,9 @@
 
 All notable changes to this project will be documented in this file. Take a look at [the migration guide](docs/Migration%20Guide.md) to upgrade between two major versions.
 
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [3.7.0]
 
 ### Added
 
@@ -1107,3 +1109,4 @@ progression. Now if no reading progression is set, the `effectiveReadingProgress
 [3.4.0]: https://github.com/readium/swift-toolkit/compare/3.3.0...3.4.0
 [3.5.0]: https://github.com/readium/swift-toolkit/compare/3.4.0...3.5.0
 [3.6.0]: https://github.com/readium/swift-toolkit/compare/3.5.0...3.6.0
+[3.7.0]: https://github.com/readium/swift-toolkit/compare/3.6.0...3.7.0

MAINTAINING.md

@@ -1,6 +1,15 @@
 # Maintaining the Readium Swift toolkit
 
-## Releasing a new version
+## Bumping the Minimum iOS Deployment Target
+
+To bump the minimum required iOS version, update these files:
+
+- `README.md`, section "Minimum Requirements"
+- `Package.swift`
+- `Support/Carthage/project.yml`
+- `Support/CocoaPods/*.podspec`
+
+## Releasing a New Version
 
 You are ready to release a new version of the Swift toolkit? Great, follow these steps:
 
@@ -14,42 +23,45 @@ You are ready to release a new version of the Swift toolkit? Great, follow these
         ```
     4. Try to run the Test App, adjusting the integration if needed.
     5. Delete the Git tag created previously.
-3. Update the [migration guide](Documentation/Migration%20Guide.md) in case of breaking changes.
-4. Issue the new release.
+3. Update the localized strings (`make update-locales`).
+4. Review the list of supported features in `README.md`.
+5. Update the [migration guide](Documentation/Migration%20Guide.md) in case of breaking changes.
+6. Issue the new release.
     1. Create a branch with the same name as the future tag, from `develop`.
     2. Bump the version numbers in the `Support/CocoaPods/*.podspec` files.
         * :warning: Don't forget to bump the version numbers of the Readium dependencies as well.
-    3. Bump the version numbers in `README.md`.
+    3. Bump the version numbers in `README.md`, and check the "Minimum Requirements" section.
     4. Bump the version numbers in `TestApp/Sources/Info.plist`.
     5. Close the version in the `CHANGELOG.md`, [for example](https://github.com/readium/swift-toolkit/pull/353/commits/a0714589b3da928dd923ba78f379116715797333#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4ed).
     6. Create a PR to merge in `develop` and verify the CI workflows.
-    7. Squash and merge the PR.
-    8. Tag the new version from `develop`.
-        ```shell
-        git checkout develop
-        git pull
-        git tag -a 3.0.1 -m 3.0.1
-        git push --tags
-        ```
-    9. Release the updated Podspecs:
+    7. Release the updated Podspecs:
         ```shell
         cd Support/CocoaPods
 
         pod repo add readium [email protected]:readium/podspecs.git
 
         pod repo push readium ReadiumInternal.podspec
+
         pod repo push readium ReadiumShared.podspec
+        
         pod repo push readium ReadiumStreamer.podspec
         pod repo push readium ReadiumNavigator.podspec
         pod repo push readium ReadiumOPDS.podspec
         pod repo push readium ReadiumLCP.podspec
         pod repo push readium ReadiumAdapterGCDWebServer.podspec
         pod repo push readium ReadiumAdapterLCPSQLite.podspec
         ```
-5. Verify you can fetch the new version from the latest Test App with `make spm|carthage|cocoapods version=3.0.1`
-7. Announce the release.
+    8. Squash and merge the PR.
+    9. Tag the new version from `develop`.
+        ```shell
+        git checkout develop
+        git pull
+        git tag -a 3.0.1 -m 3.0.1
+        git push --tags
+        ```
+7. Verify you can fetch the new version from the latest Test App with `make spm|carthage|cocoapods version=3.0.1`
+8. Announce the release.
     1. Create a new release on GitHub.
-    2. Publish a new TestFlight beta with LCP enabled.
-        * Click on "External Groups" > "Public Beta", then add the new build so that it's available to everyone.
-8. Merge `develop` into `main`.
-
+    2. Write a high-level summary of the changelog for the blog.
+    3. Post the blog summary on Discord's `#announcement`, with a link to the GitHub release.
+9. Merge `develop` into `main`.

README.md

@@ -7,53 +7,67 @@
 
 ## Features
 
-✅ Implemented      🚧 Partially implemented       📆 Planned      👀 Want to do      ❓ Not planned
+✅ Implemented      🚧 Partially implemented       📆 Planned      👀 Want to do      ❌ Not planned
 
 ### Formats
 
-| Format | Status |
-|---|:---:|
-| EPUB 2 | ✅ |
-| EPUB 3 | ✅ |
-| Readium Web Publication | 🚧 |
-| PDF | ✅ |
-| Readium Audiobook | ✅ |
-| Zipped Audiobook | ✅ |
-| Standalone audio files (MP3, AAC, etc.) | ✅ |
-| Readium Divina | 🚧 |
-| CBZ (Comic Book ZIP) | 🚧 |
-| CBR (Comic Book RAR) | ❓ |
-| [DAISY](https://daisy.org/activities/standards/daisy/) | 👀 |
+#### Ebook and Document Formats
+
+| Format                                                 | Status |
+|--------------------------------------------------------|:------:|
+| EPUB (reflowable)                                      |   ✅   |
+| EPUB (fixed-layout)                                    |   ✅   |
+| PDF                                                    |   ✅   |
+| Readium Web Publication                                |   🚧   |
+| [DAISY](https://daisy.org/activities/standards/daisy/) |   👀   |
+
+#### Audiobook Formats
+
+| Format                                                 | Status |
+|--------------------------------------------------------|:------:|
+| Readium Audiobook                                      |   ✅   |
+| Zipped Audiobook                                       |   ✅   |
+| Standalone audio files (MP3, AAC, etc.)                |   ✅   |
+| [DAISY](https://daisy.org/activities/standards/daisy/) |   👀   |
+
+#### Comic Formats
+
+| Format               | Status |
+|----------------------|:------:|
+| Readium Divina       |   ✅   |
+| CBZ (Comic Book ZIP) |   ✅   |
+| CBR (Comic Book RAR) |   ❌   |
 
 ### Features
 
 A number of features are implemented only for some publication formats.
 
-| Feature | EPUB (reflow) | EPUB (FXL) | PDF |
-|---|:---:|:---:|:---:|
-| Pagination | ✅ | ✅ | ✅ |
-| Scrolling | ✅ | 👀 | ✅ |
-| Right-to-left (RTL) | ✅ | ✅ |  ✅ |
-| Search in textual content | ✅ | ✅ | 👀 |
-| Highlighting (Decoration API) | ✅ | ✅ | 👀 |
-| Text-to-speech (TTS) | ✅ | ✅ | 👀 |
-| Media overlays | 📆 | 📆 | |
+| Feature                       | EPUB (reflow) | EPUB (FXL) | PDF |
+|-------------------------------|:-------------:|:----------:|:---:|
+| Pagination                    |       ✅      |     ✅     |  ✅ |
+| Scrolling                     |       ✅      |     👀     |  ✅ |
+| Right-to-left (RTL)           |       ✅      |     ✅     |  ✅ |
+| Search in textual content     |       ✅      |     ✅     |  👀 |
+| Highlighting (Decoration API) |       ✅      |     ✅     |  👀 |
+| Text-to-speech (TTS)          |       ✅      |     ✅     |  👀 |
+| Media overlays                |       📆      |     📆     |     |
 
 ### OPDS Support
 
-| Feature | Status |
-|---|:---:|
-| [OPDS Catalog 1.2](https://specs.opds.io/opds-1.2) | ✅ | 
-| [OPDS Catalog 2.0](https://drafts.opds.io/opds-2.0) | ✅ | 
-| [Authentication for OPDS](https://drafts.opds.io/authentication-for-opds-1.0.html) | 📆 |
-| [Readium LCP Automatic Key Retrieval](https://readium.org/lcp-specs/notes/lcp-key-retrieval.html) | 📆 |
+| Feature                                                                                           | Status |
+|---------------------------------------------------------------------------------------------------|:------:|
+| [OPDS Catalog 1.2](https://specs.opds.io/opds-1.2)                                                |   ✅   |
+| [OPDS Catalog 2.0](https://drafts.opds.io/opds-2.0)                                               |   ✅   |
+| [Authentication for OPDS](https://drafts.opds.io/authentication-for-opds-1.0.html)                |   📆   |
+| [OPDS Progression](https://github.com/opds-community/drafts/pull/91)                              |   📆   |
+| [Readium LCP Automatic Key Retrieval](https://readium.org/lcp-specs/notes/lcp-key-retrieval.html) |   📆   |
 
 ### DRM Support
 
-| Feature | Status |
-|---|:---:|
-| [Readium LCP](https://www.edrlab.org/projects/readium-lcp/) | ✅ |
-| [Adobe ACS](https://www.adobe.com/fr/solutions/ebook/content-server.html) | ❓ |
+| Feature                                                                   | Status |
+|---------------------------------------------------------------------------|:------:|
+| [Readium LCP](https://www.edrlab.org/projects/readium-lcp/)               |   ✅   |
+| [Adobe ACS](https://www.adobe.com/fr/solutions/ebook/content-server.html) |   ❌   |
 
 
 ## User Guides
@@ -87,7 +101,8 @@ Guides are available to help you make the most of the toolkit.
 
 | Readium   | iOS  | Swift compiler | Xcode |
 |-----------|------|----------------|-------|
-| `develop` | 13.4 | 6.0            | 16.2  |
+| `develop` | 15.0 | 6.0            | 16.4  |
+| 3.7.0     | 15.0 | 6.0            | 16.4  |
 | 3.0.0     | 13.4 | 5.10           | 15.4  |
 | 2.5.1     | 11.0 | 5.6.1          | 13.4  |
 | 2.5.0     | 10.0 | 5.6.1          | 13.4  |
@@ -113,7 +128,7 @@ If you're stuck, find more information at [developer.apple.com](https://develope
 Add the following to your `Cartfile`:
 
 ```
-github "readium/swift-toolkit" ~> 3.6.0
+github "readium/swift-toolkit" ~> 3.7.0
 ```
 
 Then, [follow the usual Carthage steps](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application) to add the Readium libraries to your project.
@@ -143,11 +158,11 @@ Add the following `pod` statements to your `Podfile` for the Readium libraries y
 source 'https://github.com/readium/podspecs'
 source 'https://cdn.cocoapods.org/'
 
-pod 'ReadiumShared', '~> 3.6.0'
-pod 'ReadiumStreamer', '~> 3.6.0'
-pod 'ReadiumNavigator', '~> 3.6.0'
-pod 'ReadiumOPDS', '~> 3.6.0'
-pod 'ReadiumLCP', '~> 3.6.0'
+pod 'ReadiumShared', '~> 3.7.0'
+pod 'ReadiumStreamer', '~> 3.7.0'
+pod 'ReadiumNavigator', '~> 3.7.0'
+pod 'ReadiumOPDS', '~> 3.7.0'
+pod 'ReadiumLCP', '~> 3.7.0'
 ```
 
 Take a look at [CocoaPods's documentation](https://guides.cocoapods.org/using/using-cocoapods.html) for more information.

Sources/LCP/Resources/it.lproj/Localizable.strings

@@ -0,0 +1,2 @@
+// DO NOT EDIT. File generated automatically from the it JSON strings of https://github.com/edrlab/thorium-locales/.
+

Sources/Shared/Resources/fr.lproj/W3CAccessibilityMetadataDisplayGuide.strings

@@ -75,7 +75,7 @@
 "readium.a11y.hazards-title" = "Points d'attention";
 "readium.a11y.hazards-unknown" = "La présence de risques est inconnue";
 "readium.a11y.legal-considerations-exempt-compact" = "Déclare être sous le coup d'une exemption dans certaines juridictions";
-"readium.a11y.legal-considerations-exempt-descriptive" = "Cette publication dééclare être sous le coup d'une exemption dans certaines juridictions";
+"readium.a11y.legal-considerations-exempt-descriptive" = "Cette publication déclare être sous le coup d'une exemption dans certaines juridictions";
 "readium.a11y.legal-considerations-no-metadata" = "Aucune information disponible";
 "readium.a11y.legal-considerations-title" = "Considérations légales";
 "readium.a11y.navigation-index-compact" = "Index";

Sources/Shared/Resources/it.lproj/W3CAccessibilityMetadataDisplayGuide.strings

@@ -28,7 +28,7 @@
 "readium.a11y.conformance-a-compact" = "Questa pubblicazione soddisfa gli standard minimi di accessibilità";
 "readium.a11y.conformance-a-descriptive" = "La pubblicazione contiene una dichiarazione di conformità che attesta il rispetto degli standard EPUB Accessibility e WCAG 2 Livello A";
 "readium.a11y.conformance-aa-compact" = "Questa pubblicazione soddisfa gli standard di accessibilità accettati";
-"readium.a11y.conformance-aa-descriptive" = "La pubblicazione contiene una dichiarazione di conformità che attesta il rispetto degli standard EPUB Accessibility e WCAG 2 Livello AAA";
+"readium.a11y.conformance-aa-descriptive" = "La pubblicazione contiene una dichiarazione di conformità che attesta il rispetto degli standard EPUB Accessibility e WCAG 2 Livello AA";
 "readium.a11y.conformance-aaa-compact" = "Questa pubblicazione supera gli standard di accessibilità";
 "readium.a11y.conformance-aaa-descriptive" = "La pubblicazione contiene una dichiarazione di conformità che attesta il rispetto degli standard EPUB Accessibility e WCAG 2 Livello AAA";
 "readium.a11y.conformance-certifier" = "La pubblicazione è stata certificata da ";

Support/Carthage/.xcodegen

@@ -81,7 +81,7 @@
           "target" : "ReadiumInternal"
         }
       ],
-      "deploymentTarget" : "13.4",
+      "deploymentTarget" : "15.0",
       "platform" : "iOS",
       "settings" : {
         "INFOPLIST_FILE" : "Info.plist",
@@ -106,7 +106,7 @@
           "target" : "ReadiumLCP"
         }
       ],
-      "deploymentTarget" : "13.4",
+      "deploymentTarget" : "15.0",
       "platform" : "iOS",
       "settings" : {
         "INFOPLIST_FILE" : "Info.plist",
@@ -120,7 +120,7 @@
       "type" : "framework"
     },
     "ReadiumInternal" : {
-      "deploymentTarget" : "13.4",
+      "deploymentTarget" : "15.0",
       "platform" : "iOS",
       "settings" : {
         "INFOPLIST_FILE" : "Info.plist",
@@ -151,7 +151,7 @@
           "target" : "ReadiumInternal"
         }
       ],
-      "deploymentTarget" : "13.4",
+      "deploymentTarget" : "15.0",
       "platform" : "iOS",
       "settings" : {
         "INFOPLIST_FILE" : "Info.plist",
@@ -182,7 +182,7 @@
           "target" : "ReadiumInternal"
         }
       ],
-      "deploymentTarget" : "13.4",
+      "deploymentTarget" : "15.0",
       "platform" : "iOS",
       "settings" : {
         "INFOPLIST_FILE" : "Info.plist",
@@ -215,7 +215,7 @@
           "target" : "ReadiumInternal"
         }
       ],
-      "deploymentTarget" : "13.4",
+      "deploymentTarget" : "15.0",
       "platform" : "iOS",
       "settings" : {
         "INFOPLIST_FILE" : "Info.plist",
@@ -249,7 +249,7 @@
           "sdk" : "CoreServices.framework"
         }
       ],
-      "deploymentTarget" : "13.4",
+      "deploymentTarget" : "15.0",
       "platform" : "iOS",
       "settings" : {
         "INFOPLIST_FILE" : "Info.plist",
@@ -277,7 +277,7 @@
           "target" : "ReadiumInternal"
         }
       ],
-      "deploymentTarget" : "13.4",
+      "deploymentTarget" : "15.0",
       "platform" : "iOS",
       "settings" : {
         "INFOPLIST_FILE" : "Info.plist",
@@ -379,6 +379,8 @@
 ../../Sources/LCP/Resources/en.lproj/Localizable.strings
 ../../Sources/LCP/Resources/fr.lproj
 ../../Sources/LCP/Resources/fr.lproj/Localizable.strings
+../../Sources/LCP/Resources/it.lproj
+../../Sources/LCP/Resources/it.lproj/Localizable.strings
 ../../Sources/LCP/Resources/prod-license.lcpl
 ../../Sources/LCP/Services
 ../../Sources/LCP/Services/CRLService.swift