Merge pull request #216 from readium/develop

Version 2

Author: JayPanoz

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,64 @@
+name: Bug report
+description: File a bug report to help improve Readium CSS
+labels: []
+type: "Bug"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filing a bug report! Please [search for existing issues](https://github.com/readium/css/issues?q=is:issue) before submitting.
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the bug
+      description: Also, please let us know what your expectations were.
+      placeholder: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: bug-steps
+    attributes:
+      label: How to reproduce?
+      description: |
+        Step by step explanation to reproduce the issue in the Test App.
+
+        If you can, drag and drop:
+        - the publication used to reproduce the problem, after zipping it.
+        - screenshots or a screencast showing the issue
+
+      placeholder: |
+        1. Open book X
+        2. Go to chapter Y
+        3. Swipe left twice
+        4. See error
+        ...
+    validations:
+      required: true
+  - type: input
+    id: bug-readium-css-version
+    attributes:
+      label: Readium CSS version
+      description: What version of Readium CSS are you running?
+    validations:
+      required: true
+  - type: input
+    id: bug-platforms
+    attributes:
+      label: Platforms
+      description: On which platform(s) did you reproduce the problem?
+    validations:
+      required: true
+  - type: input
+    id: bug-browsers
+    attributes:
+      label: Browsers
+      description: On which browser(s) did you reproduce the problem?
+    validations:
+      required: true
+  - type: textarea
+    id: bug-additional
+    attributes:
+      label: Additional context
+      description: |
+        Share additional code showing how you use Readium, if relevant. Output logs are useful as well.
+        If you already went through the codebase to find the bug, you can explain your findings here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/issue_template.md

@@ -20,6 +20,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         ref: ${{ github.head_ref }}
+        fetch-depth: 0  # Fetch complete git history
     - name: Use Node.js
       uses: actions/setup-node@v4
       with:
@@ -29,5 +30,5 @@ jobs:
     - run: npm run build --if-present
     - uses: stefanzweifel/git-auto-commit-action@v5
       with:
-        file_pattern: "css/dist/**"
+        file_pattern: "css/dist/** package-lock.json"
         commit_message: Update dist

.github/pull_request_template.md

@@ -0,0 +1 @@
+v20

.github/workflows/node.js.yml

@@ -1,52 +1,52 @@
-# readium-css
+# Readium CSS
 
 [![Readium Logo](https://readium.org/assets/logos/readium-logo.png)](https://readium.org)
 
-A set of reference stylesheets for EPUB Reading Systems, starting with Readium 2.
+A set of reference stylesheets for EPUB Reading Systems.
 
 Readium CSS provides styles for reflowable text: 
 
 - paged and scrolled views;
 - a “patch” for HTML5 Suggested Rendering specific to publications (e.g. extra styles for hyphenation, breaks, etc.);
 - default styles for unstyled ebooks;
-- reading modes (day, night, and sepia);
-- themes;
+- theming;
 - user settings;
 - a set of baselines and recommendations for accessibility, overrides, and internationalization.
 
 ## License
 
 BSD-3-Clause (http://opensource.org/licenses/BSD-3-Clause)
 
-See [license.txt](https://github.com/readium/readium-css/blob/master/LICENSE).
+See [license.txt](https://github.com/readium/css/blob/master/LICENSE).
 
 ## Scope of this project
 
 The primary goal of Readium CSS is to provide Reading System implementers with reliable and modern styles for reflowable EPUB 2 and EPUB 3 files. In addition, it should provide good interoperability in the existing ecosystem, while not overriding authors’ styles unless strictly necessary.
 
-Readium CSS stylesheets were not designed and should not be used for fixed-layout EPUB, nor other file formats like FB2, PRC, Mobi, TEI, etc. Works in progress like Web Publications or Portable Web Publications are also out of scope.
+Readium CSS stylesheets were not designed and should not be used for fixed-layout EPUB, nor other file formats like FB2, PRC, Mobi, TEI, etc.
 
 Some issues, which may be raised during development, will be documented so that they can serve as a reference for revisions of the EPUB specification, and even future specifications.
 
-## Testing
+## Implementations
 
-An [iOS test app](https://github.com/readium/r2-testapp-swift) for the Swift implementation of Readium 2 is using Readium CSS and can be [downloaded on the App Store](https://itunes.apple.com/us/app/r2-reader/id1363963230?mt=8).
+Readium CSS is implemented in the [Readium Mobile](https://github.com/readium/mobile) and [Readium Web](https://github.com/readium/web) projects.
 
-An [Android test app](https://github.com/readium/r2-testapp-kotlin) for the Kotlin implementation of Readium 2 is using Readium CSS. Stable builds are [available on Google Play](https://play.google.com/store/apps/details?id=org.readium.r2reader). To follow the development of this app, [join the beta channel](https://play.google.com/apps/testing/org.readium.r2reader).
+You will find it in:
 
-The Readium Desktop app is using Readium CSS and [is available for Linux, MacOS and Windows](https://github.com/edrlab/readium-desktop/releases).
+- [ts-toolkit](https://github.com/readium/ts-toolkit)
+- [swift-toolkit](https://github.com/readium/swift-toolkit)
+- [kotlin-toolkit](https://github.com/readium/kotlin-toolkit)
 
-You can also use the [webpub manifest prototype](https://github.com/HadrienGardeur/webpub-manifest/tree/gh-pages/examples/paged-viewer) with the [RS-streamer-js](https://github.com/edrlab/r2-streamer-js) in a local development environment. Please note you’ll have to manually inject stylesheets and apply settings via the console, or design and code scripts if you want a GUI (user settings menu).
+External use include:
 
-## Other known implementations
-
-There is no external implementation of Readium CSS so far.
-
-Consequently, if you are encountering rendering issues with Readium (iOS apps, Android apps, or the Readium Chrome App), please report them on the [github section dedicated to the proper Readium project](https://github.com/readium) (readium-js, readium-shared-js, readium-sdk, etc.).
+- [Thorium Desktop](https://github.com/edrlab/thorium-reader)
+- [Thorium Web](https://github.com/edrlab/thorium-web)
+- [Zotero](https://github.com/zotero/reader)
+- [Vital Source](https://www.vitalsource.com/)
 
 ## Development
 
-Active development is pulled in branch `develop` first, and then made available in the main branch when sufficiently tested and deemed stable.
+Active development is pulled in branch `develop`.
 
 ### Init
 
@@ -88,4 +88,4 @@ npm run test:approve
 
 Documentation [can be accessed in docs](docs).
 
-[You can alternatively download it as an EPUB file](https://github.com/readium/readium-css/raw/master/docs/ReadiumCSS_docs.epub).
+[You can alternatively download it as an EPUB file](https://github.com/readium/css/raw/master/docs/ReadiumCSS_docs.epub).

.nvmrc

@@ -10,8 +10,10 @@
     <li><a href="CSS08-defaults.html">Defaults</a></li>
     <li><a href="CSS09-default_fonts.html">Typefaces and font-stacks</a></li>
     <li><a href="CSS10-libre_fonts.html">Open Source and Libre Fonts We Can Recommend</a></li>
+    <li><a href="CSS10b-variable_fonts.html">Variable fonts</a></li>
+    <li><a href="CSS10c-custom_fonts.html">Using custom fonts with Readium CSS</a></li>
     <li><a href="CSS11-overrides_classification.html">User Overrides’ Classification</a></li>
-    <li><a href="CSS12-user_prefs.html">User Settings, Reading Modes and Themes</a></li>
+    <li><a href="CSS12-user_prefs.html">User Settings and Themes</a></li>
     <li><a href="CSS13-a11y_settings_baseline.html">Baseline for a11y-related user settings</a></li>
     <li><a href="CSS14-user_settings_recs.html">Recommendations for User Settings Management</a></li>
     <li><a href="CSS15-user_pref_insights.html">User Preferences’ insights</a></li>
@@ -27,5 +29,6 @@
     <li><a href="CSS25-performance_hacks.html">CSS Performance Hacks</a></li>
     <li><a href="CSS26-i18n_glossary.html">i18n glossary</a></li>
     <li><a href="CSS27-considered_features.html">Features that were considered but not implemented</a></li>
+    <li><a href="CSS28-migration_guide.html">Migration Guide</a></li>
   </ol>
 </nav>