Update docs

+ Switch from | to / so that Github pages do not try creating tables for possible values

Author: JayPanoz

css/dist/ReadMe.md

@@ -27,10 +27,6 @@ Disabled user settings:
 - `hyphens`;
 - `letter-spacing`.
 
-Added user settings:
-
-- `font-variant-ligatures` (mapped to `--USER__ligatures` CSS variable).
-
 ## CJK
 
 Chinese, Japanese, Korean, and Mongolian can be either written `horizontal-tb` or `vertical-*`. Consequently, there are stylesheets for horizontal and vertical writing modes.
@@ -52,6 +48,7 @@ Disabled user settings:
 
 - `text-align`;
 - `hyphens`;
+- `ligatures`;
 - paragraphs’ indent;
 - `word-spacing`.
 
@@ -88,6 +85,7 @@ Disabled user settings:
 - `column-count` (number of columns);
 - `text-align`;
 - `hyphens`;
+- `ligatures`;
 - paragraphs’ indent;
 - `word-spacing`.
 

css/src/ReadiumCSS-after-rtl.css

@@ -13,8 +13,8 @@
 @import "modules/user-settings-submodules/ReadiumCSS-paraSpacing_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-paraIndent_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-wordSpacing_pref.css";
-@import "modules/user-settings-submodules/ReadiumCSS-variableFont_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-ligatures_pref.css";
+@import "modules/user-settings-submodules/ReadiumCSS-variableFont_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-imageFilters_pref.css";
 @import "modules/ReadiumCSS-fs_normalize.css";
 @import "modules/ReadiumCSS-iPadOS_patch.css";

css/src/ReadiumCSS-after.css

@@ -16,8 +16,8 @@
 @import "modules/user-settings-submodules/ReadiumCSS-paraIndent_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-wordSpacing_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-letterSpacing_pref.css";
-@import "modules/user-settings-submodules/ReadiumCSS-variableFont_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-ligatures_pref.css";
+@import "modules/user-settings-submodules/ReadiumCSS-variableFont_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-imageFilters_pref.css";
 @import "modules/ReadiumCSS-fs_normalize.css";
 @import "modules/ReadiumCSS-iPadOS_patch.css";

docs/CSS06-stylesheets_order.md

@@ -59,7 +59,7 @@ The following modules must be appended after the author’s stylesheets (`Readiu
     11. `ReadiumCSS-paraIndent_pref.css` (does not apply to CJK scripts)
     12. `ReadiumCSS-wordSpacing_pref.css` (does not apply to CJK scripts)
     13. `ReadiumCSS-letterSpacing_pref.css` (does not apply to RTL scripts, except in vertical writing mode)
-    14. `ReadiumCSS-arabicLigatures_pref.css` (RTL only)
+    14. `ReadiumCSS-ligatures_pref.css` (RTL only)
     15. `ReadiumCSS-variableFont_pref.css` (this contains optical sizing, weight and width prefs)
     16. `ReadiumCSS-ruby_pref.css` (CJK only)
     17. `ReadiumCSS-imageFilters_pref.css`

docs/CSS08-defaults.md

@@ -261,7 +261,7 @@ The typeface for code snippets. The value can be another variable e.g. `var(-RS_
 
 The scale to be used for computing all elements’ `font-size`. Since those font sizes are computed dynamically, you can set a smaller type scale when the user sets one of the largest font sizes.
 
-Possible values: `1` | `1.067` | `1.125` | `1.2` (suggested default) | `1.25` | `1.333` | `1.414` | `1.5` | `1.618`
+Possible values: `1` / `1.067` / `1.125` / `1.2` (suggested default) / `1.25` / `1.333` / `1.414` / `1.5` / `1.618`
 
 * * *
 

docs/CSS11-overrides_classification.md

@@ -43,7 +43,7 @@ The following settings are optional but should be applied by any means necessary
 - paragraph indent;
 - letter-spacing;
 - word-spacing;
-- arabic ligatures;
+- ligatures;
 - hiding ruby (CJK);
 - accessibility normalization;
 - font optical sizing (requires a variable font);

docs/CSS12-user_prefs.md

@@ -69,7 +69,7 @@ Allows to switch between paged and scroll view.
 --USER__view
 ```
 
-Supported values: `readium-paged-on` | `readium-scroll-on`
+Supported values: `readium-paged-on` / `readium-scroll-on`
 
 Override class: Chrome (should be applied by any means necessary)
 
@@ -249,7 +249,7 @@ The user can set `text-align` and `hyphens` for body copy contents.
 --USER__textAlign
 ```
 
-Possible values: `left` (LTR) or `right` (RTL) | `start` (logical property resolving to `left` in LTR, `right` in RTL) | `justify`
+Possible values: `left` (LTR) or `right` (RTL) / `start` (logical property resolving to `left` in LTR, `right` in RTL) / `justify`
 
 Override class: User settings advanced (optional but should be applied by any means necessary if provided to users)
 
@@ -261,7 +261,7 @@ Note: the value `start` can be used to let all rendering engines, excepted Tride
 --USER__bodyHyphens
 ```
 
-Possible Values: `auto` | `none`
+Possible Values: `auto` / `none`
 
 Override class: User settings advanced (optional but should be applied by any means necessary if provided to users)
 
@@ -279,9 +279,9 @@ The user can set `font-family`, `font-size` and `line-height` for body copy cont
 --USER__fontFamily
 ```
 
-Possible values: `var(--RS__oldStyleTf)` | `var(--RS__modernTf)` | `var(--RS__sansTf)` | `var(--RS__humanistTf)` | `<string>`
+Possible values: `var(--RS__oldStyleTf)` / `var(--RS__modernTf)` / `var(--RS__sansTf)` / `var(--RS__humanistTf)` / `<string>`
 
-For Japanese, possible values become: `var(--RS__serif-ja)` (horizontal writing) | `var(--RS__sans-serif-ja)` (horizontal writing) | `var(--RS__serif-ja-v)` (vertical writing) | `var(--RS__sans-serif-ja-v)` (vertical writing) | `<string>`
+For Japanese, possible values become: `var(--RS__serif-ja)` (horizontal writing) / `var(--RS__sans-serif-ja)` (horizontal writing) / `var(--RS__serif-ja-v)` (vertical writing) / `var(--RS__sans-serif-ja-v)` (vertical writing) / `<string>`
 
 Required flag: none
 
@@ -365,13 +365,13 @@ Recommended values: a range from `0` to `0.5rem`. Increments are left to impleme
 
 Override class: User settings advanced (optional but should be applied by any means necessary if provided to users)
 
-#### Arabic Ligatures
+#### Ligatures
 
 ```
 --USER__ligatures
 ```
 
-Possible values: `none` | `common-ligatures`
+Possible values: `none` / `common-ligatures`
 
 Override class: User settings advanced (optional but should be applied by any means necessary if provided to users)
 
@@ -391,7 +391,7 @@ Rendering engines and browsers enable optical sizing by default for fonts that h
 
 When optical sizing is used, small text sizes are often rendered with thicker strokes and larger serifs, whereas larger text is often rendered more delicately with more contrast between thicker and thinner strokes.
 
-Possible values: `none` | `auto` (default)
+Possible values: `none` / `auto` (default)
 
 Required flag: none
 
@@ -417,7 +417,7 @@ Override class: User settings advanced (optional but should be applied by any me
 --USER__fontWidth
 ```
 
-Possible values: `ultra-condensed` | `extra-condensed` | `condensed` | `semi-condensed` | `normal` | `semi-expanded` | `expanded` | `extra-expanded` | `ultra-expanded` | `percentage` e.g. `50%`, `125%`
+Possible values: `ultra-condensed` / `extra-condensed` / `condensed` / `semi-condensed` / `normal` / `semi-expanded` / `expanded` / `extra-expanded` / `ultra-expanded` / `percentage` e.g. `50%`, `125%`
 
 **Warning: the percentage values depend on the variable font you may be using.** You can use services such as [Wakamai Fondue](https://wakamaifondue.com) to get the values.
 
@@ -453,7 +453,7 @@ This will apply a `mix-blend-mode` of `multiply` with a transparent background t
 --USER__darkenImages
 ```
 
-Possible values: `readium-darken-on` | `percentage` e.g. `50%`.
+Possible values: `readium-darken-on` / `percentage` e.g. `50%`.
 
 This will apply a `brightness` filter with the percentage value it’s given, or a preset of `80%` if using it as a flag. 
 
@@ -463,7 +463,7 @@ This will apply a `brightness` filter with the percentage value it’s given, or
 --USER__invertImages
 ```
 
-Possible values: `readium-invert-on` | `percentage` e.g. `50%`.
+Possible values: `readium-invert-on` / `percentage` e.g. `50%`.
 
 This will apply an `invert` filter with the percentage value it’s given, or a preset of `100%` if using it as a flag.
 
@@ -473,7 +473,7 @@ If you want to only invert gaiji (valid Japanese character as `img`), you can us
 --USER__invertGaiji
 ```
 
-Possible values: `readium-invertGaiji-on` | `percentage` e.g. `50%`.
+Possible values: `readium-invertGaiji-on` / `percentage` e.g. `50%`.
 
 This will apply an `invert` filter with the percentage value it’s given, or a preset of `100%` if using it as a flag, only to `img class="gaiji"`.
 

docs/CSS14-user_settings_recs.md

@@ -215,11 +215,11 @@ It is very rare authors’ will use those CSS properties for body copy. They may
 
 In any case, implementers should force those settings for body copy.
 
-## Ligatures (Arabic & Persian scripts)
+## Ligatures
 
 ### User’s intent
 
-The user intends to disable ligatures. This setting applies to the Arabic and Persian scripts, and is believed to help dyslexic readers as `word-spacing` in Latin.
+The user intends to disable ligatures. This setting applies to the Latin, Arabic and Persian scripts. In the two latter, it is believed to help dyslexic readers as `word-spacing` in Latin.
 
 ### Author’s intent
 

docs/CSS16-internationalization.md

@@ -156,7 +156,7 @@ Several parts of the UI must follow the direction (`rtl`) of the primary languag
 - user settings e.g. text align;
 - implementers might want to localize the interface based on the language set at the system level, or at least fall back to English.
 
-Moreover, some user settings should be removed if used (`letter-spacing`) and another one added (arabic ligatures in `ar` and `fa`).
+Moreover, some user settings should be removed if used (`letter-spacing`).
 
 #### CJK
 

docs/CSS18-further_details.md

@@ -48,7 +48,7 @@ The typeface for code snippets. The value can be another variable e.g. `var(-RS_
 
 The scale to be used for computing all elements’ `font-size`. Since those font sizes are computed dynamically, you can set a smaller type scale when the user sets one of the largest font sizes.
 
-Possible values: `1` | `1.067` | `1.125` (suggested default) | `1.2` | `1.25` | `1.333` | `1.414` | `1.5` | `1.618`
+Possible values: `1` / `1.067` / `1.125` (suggested default) / `1.2` / `1.25` / `1.333` / `1.414` / `1.5` / `1.618`
 
 The suggested default will accomodate most configurations, from small to large screens.