Add ruby user submodule

This module allows for the hiding of ruby annotations in CJK. Resolves #140

Author: JayPanoz

css/ReadiumCSS-config.css

@@ -44,6 +44,9 @@
 @custom-selector :--darken-filter [style*="readium-darken-on"];
 @custom-selector :--invert-filter [style*="readium-invert-on"];
 
+/* Hiding ruby */
+@custom-selector :--no-ruby [style*="readium-noRuby-on"];
+
 /* Accessibility normalization */
 @custom-selector :--a11y-normalize [style*="readium-a11y-on"];
 

css/dist/cjk-horizontal/ReadiumCSS-after.css

@@ -370,6 +370,11 @@ screen and (min-device-width: 36em) and (max-device-width: 47em) and (orientatio
   font-variant:none;
 }
 
+:root[style*="readium-advanced-on"][style*="readium-noRuby-on"] body rt,
+:root[style*="readium-advanced-on"][style*="readium-noRuby-on"] body rp{
+  display:none;
+}
+
 :root[style*="readium-advanced-on"]{
   --USER__typeScale:1.2;
 }

css/dist/cjk-vertical/ReadiumCSS-after.css

@@ -351,6 +351,11 @@ body{
   font-variant:none;
 }
 
+:root[style*="readium-advanced-on"][style*="readium-noRuby-on"] body rt,
+:root[style*="readium-advanced-on"][style*="readium-noRuby-on"] body rp{
+  display:none;
+}
+
 :root[style*="readium-advanced-on"]{
   --USER__typeScale:1.2;
 }

css/src/ReadiumCSS-after-cjk-horizontal.css

@@ -13,4 +13,5 @@
 @import "modules/user-settings-submodules/ReadiumCSS-lineHeight_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-paraSpacing_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-letterSpacing_pref.css";
+@import "modules/user-settings-submodules/ReadiumCSS-ruby_pref.css";
 @import "modules/ReadiumCSS-fs_normalize.css";

css/src/ReadiumCSS-after-cjk-vertical.css

@@ -12,4 +12,5 @@
 @import "modules/user-settings-submodules/ReadiumCSS-lineHeight_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-paraSpacing-vertical_pref.css";
 @import "modules/user-settings-submodules/ReadiumCSS-letterSpacing_pref.css";
+@import "modules/user-settings-submodules/ReadiumCSS-ruby_pref.css";
 @import "modules/ReadiumCSS-fs_normalize.css";

css/src/modules/user-settings-submodules/ReadiumCSS-ruby_pref.css

@@ -0,0 +1,12 @@
+/* Readium CSS
+   Ruby display pref
+
+   A submodule managing the display of ruby text for user settings
+   Part of “User Overrides Advanced” class – “advanced settings” flag required.
+
+   Repo: https://github.com/readium/readium-css */
+
+:root:--advanced-settings:--no-ruby body rt,
+:root:--advanced-settings:--no-ruby body rp {
+  display: none;
+}

docs/CSS11-overrides_classification.md

@@ -45,6 +45,7 @@ The following settings are optional but should be applied by any means necessary
 - letter-spacing;
 - word-spacing;
 - arabic ligatures;
+- hiding ruby (CJK);
 - accessibility normalization;
 - type scale.
 

docs/CSS12-user_prefs.md

@@ -159,6 +159,22 @@ Override class: User settings advanced (optional but should be applied by any me
 
 To disable the normalization, you can either set an empty string as a value or remove the property.
 
+### Hiding Ruby Text
+
+Users may want to hide ruby annotations for accessibility reasons.
+
+```
+--USER__no-ruby
+```
+
+Supported value: `readium-noRuby-on`
+
+Required flag: `--USER__advancedSettings: readium-advanced-on`
+
+Override class: User settings advanced (optional but should be applied by any means necessary if provided to users)
+
+To disable the hiding and show ruby annotations, you can either set an empty string as a value of remove the property.
+
 ## List of variables 
 
 ### Layout 
@@ -456,6 +472,10 @@ User settings to disable are:
 - `--USER__paraIndent`;
 - `--USER__wordSpacing`.
 
+User settings to add are:
+
+- `--USER__noRuby`.
+
 Finally, `--USER__letterSpacing` should be treated as an exception. We are aware it can be useful in Japanese, but don’t know what the situation is as regards Chinese and Korean. **It’s up to implementers to decide whether it should be enabled or disabled for each of these languages.**
 
 #### Vertical writing mode
@@ -470,4 +490,8 @@ User settings to disable are:
 - `--USER__paraIndent`;
 - `--USER__wordSpacing`.
 
+User settings to add are:
+
+- `--USER__noRuby`.
+
 Finally, `--USER__letterSpacing` should be treated as an exception. We are aware it can be useful in Japanese, but don’t know what the situation is as regards Chinese and Korean. **It’s up to implementers to decide whether it should be enabled or disabled for each of these languages.**

docs/CSS19-api.md

@@ -198,6 +198,22 @@ It impacts font style, weight and variant, text decoration, super and subscripts
 
 * * *
 
+```
+:--no-ruby
+```
+
+Preset: `--USER__noRuby: readium-noRuby-on`
+
+Scope: `html`
+
+Required flag: `:--advancedSettings`
+
+Override class: User settings advanced (optional but should be applied by any means necessary if provided to users)
+
+This will hide ruby annotations i.e. `rt` and `rb`.
+
+* * *
+
 **Warning:** if you customize those flags, all ReadiumCSS `dist` stylesheets must be rebuilt.
 
 ## Reading System Styles