Skip to content

Commit 49d1f54

Browse files
committed
Update docs
1 parent ea339b7 commit 49d1f54

7 files changed

Lines changed: 77 additions & 6 deletions

File tree

docs/CSS12-user_prefs.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,30 @@ Supported value: `readium-noRuby-on`
169169

170170
To disable the hiding and show ruby annotations, you can either set an empty string as a value of remove the property.
171171

172+
### Experimental Features Flags
173+
174+
Experimental flags are used to opt-in to and test improvements to existing features. That way they can also be disabled without having to wait on a quickfix in case they are creating new issues.
175+
176+
```
177+
--RS__experimentalHeaderFiltering
178+
```
179+
180+
Supported value: `readium-experimentalHeaderFiltering-on`
181+
182+
This attempts to filter out paragraphs that are implicitly headings or part of headers.
183+
184+
To disable the experimental header filtering, you can either set an empty string as a value or remove the property.
185+
186+
```
187+
--RS__experimentalZoom
188+
```
189+
190+
Supported value: `readium-experimentalZoom-on`
191+
192+
This attempts to filter out elements that are sized using viewport units and should not be scaled directly.
193+
194+
To disable the experimental zoom, you can either set an empty string as a value or remove the property.
195+
172196
## List of variables
173197

174198
### Layout

docs/CSS28-migration_guide.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,4 +257,13 @@ As of version `2.0.0-beta.22`, ReadiumCSS provides an experimental stylesheet fo
257257

258258
As well as the patching of zoom for iOS and iPadOS. **Note there is no fallback in case the `zoom` CSS property is not supported.**
259259

260-
Typically, you would use zoom for all web publications, and the rest of the styles if the web publication’s accessibility metadata contains feature `displayTransformability`.
260+
Typically, you would use zoom for all web publications, and the rest of the styles if the web publication’s accessibility metadata contains feature `displayTransformability`.
261+
262+
## Experimental Features Flags
263+
264+
As of version `2.0.0-beta.23`, ReadiumCSS provides flags as a way to opt-in to and test improvements to existing features. That way they can also be disabled without having to wait on a quickfix in case they are creating new issues.
265+
266+
- `--RS__experimentalHeaderFiltering: readium-experimentalHeaderFiltering-on`: attempts to filter out paragraphs that are implicitly headings or part of headers
267+
- `--RS__experimentalZoom: readium-experimentalZoom-on`: attemps to filter out elements that are sized using viewport units and should not be scaled directly
268+
269+
These flags are expected to be found on `:root`.

docs/ReadiumCSS_docs.epub

459 Bytes
Binary file not shown.

docs/ReadiumCSS_docs/OEBPS/Text/Section-012.xhtml

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,6 @@ root.style.setProperty("name of var", "");</code></pre>
172172

173173
<p>Supported value: <code>readium-a11y-on</code></p>
174174

175-
<p>Override class: User settings advanced (optional but should be applied by any means necessary if provided to users)</p>
176-
177175
<p>To disable the normalization, you can either set an empty string as a value or remove the property.</p>
178176
</section>
179177

@@ -185,11 +183,31 @@ root.style.setProperty("name of var", "");</code></pre>
185183
<pre><code>--USER__no-ruby</code></pre>
186184

187185
<p>Supported value: <code>readium-noRuby-on</code></p>
188-
189-
<p>Override class: User settings advanced (optional but should be applied by any means necessary if provided to users)</p>
186+
187+
<p>To disable the hiding and show ruby annotations, you can either set an empty string as a value of remove the property.</p>
188+
</section>
189+
190+
<section id="experimental-features-flags" class="level3">
191+
<h3 class="sigil_not_in_toc">Experimental Features Flags</h3>
190192

193+
<p>Experimental flags are used to opt-in to and test improvements to existing features. That way they can also be disabled without having to wait on a quickfix in case they are creating new issues</p>
194+
195+
<pre><code>--RS__experimentalHeaderFiltering</code></pre>
196+
197+
<p>Supported value: <code>readium-experimentalHeaderFiltering-on</code></p>
198+
199+
<p>This attempts to filter out paragraphs that are implicitly headings or part of headers.</p>
200+
191201
<p>To disable the hiding and show ruby annotations, you can either set an empty string as a value of remove the property.</p>
192-
</section>
202+
203+
<pre><code>--RS__experimentalZoom</code></pre>
204+
205+
<p>Supported value: <code>readium-experimentalZoom-on</code></p>
206+
207+
<p>This attempts to filter out elements that are sized using viewport units and should not be scaled directly.</p>
208+
209+
<p>To disable the experimental zoom, you can either set an empty string as a value of remove the property.</p>
210+
</section>
193211
</section>
194212

195213
<section id="list-of-variables" class="level2">

docs/ReadiumCSS_docs/OEBPS/Text/Section-028.xhtml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,17 @@ const backgroundColor = defaultColors.RS__backgroundColor;</code></pre>
309309

310310
<p>Typically, you would use zoom for all web publications, and the rest of the styles if the web publication’s accessibility metadata contains feature <code>displayTransformability</code>.</p>
311311
</section>
312+
313+
<section id="experimental-flags" class="level2">
314+
<h2 id="sigil_toc_id_219">Experimental Flags</h2>
315+
316+
<p>As of version <code>2.0.0-beta.23</code>, ReadiumCSS provides flags as a way to opt-in to and test improvements to existing features. That way they can also be disabled without having to wait on a quickfix in case they are creating new issues.</p>
317+
318+
<ul>
319+
<li><code>--RS__experimentalHeaderFiltering: readium-experimentalHeaderFiltering-on</code>: attempts to filter out paragraphs that are implicitly headings or part of headers</li>
320+
<li><code>--RS__experimentalZoom: readium-experimentalZoom-on</code>: attemps to filter out elements that are sized using viewport units and should not be scaled directly</li>
321+
</ul>
322+
</section>
312323
</section>
313324
</body>
314325
</html>

docs/ReadiumCSS_docs/OEBPS/Text/nav.xhtml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -759,6 +759,9 @@
759759
<li>
760760
<a href="../Text/Section-028.xhtml#sigil_toc_id_218">Experimental Web Publications stylesheet</a>
761761
</li>
762+
<li>
763+
<a href="../Text/Section-028.xhtml#sigil_toc_id_219">Experimental Features Flags</a>
764+
</li>
762765
</ol>
763766
</li>
764767
</ol>

docs/ReadiumCSS_docs/OEBPS/toc.ncx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1389,6 +1389,12 @@
13891389
</navLabel>
13901390
<content src="Text/Section-028.xhtml#sigil_toc_id_218"/>
13911391
</navPoint>
1392+
<navPoint id="navPoint231">
1393+
<navLabel>
1394+
<text>Experimental Features Flags</text>
1395+
</navLabel>
1396+
<content src="Text/Section-028.xhtml#sigil_toc_id_219"/>
1397+
</navPoint>
13921398
</navPoint>
13931399
</navMap>
13941400
</ncx>

0 commit comments

Comments
 (0)