Skip to content

Commit b6d9b98

Browse files
committed
Update docs
1 parent 02c6088 commit b6d9b98

7 files changed

Lines changed: 57 additions & 3 deletions

File tree

docs/CSS12-user_prefs.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,21 @@ Supported value: `readium-normalize-on`
101101

102102
Override class: None.
103103

104+
### iOS Scaling Patch
105+
106+
Acts as an explicit switch to force iOS patching of scaling issues so that `--USER__fontSize` can work as expected. This should be applied only when the site is requested in its mobile version on iOS and iPadOS.
107+
108+
```
109+
--USER__iOSPatch
110+
```
111+
112+
Supported value: `readium-iOSPatch-on`
113+
114+
Override class: None.
115+
104116
### iPadOS Zoom Patch
105117

106-
Acts as an explicit switch to force iPadOS patching of zoom issues so that `--USER__fontSize` can work as expected. This should be applied only when the site is requested in its desktop version on iPadOS – mobile version is completely fine.
118+
Acts as an explicit switch to force iPadOS patching of zoom issues so that `--USER__fontSize` can work as expected. This should be applied only when the site is requested in its desktop version on iPadOS.
107119

108120
```
109121
--USER__iPadOSPatch

docs/CSS19-api.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,18 @@ Override class: None. This flag can be used to force font-size normalization if
8888

8989
* * *
9090

91+
```
92+
:--ios-patch
93+
```
94+
95+
Preset: `--USER__iOSPatch: readium-iOSPatch-on`
96+
97+
Scope: `html`
98+
99+
Override class: None. This flag is used to activate patching of iOS scaling issues in Safari, which can happen on rotate for instance.
100+
101+
* * *
102+
91103
```
92104
:--ipadOS-patch
93105
```

docs/CSS28-migration_guide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,11 @@ It doesn’t need any change at the implementation level, and should work out of
108108

109109
As a side-effect of this new implementation, please note the `--USER__typeScale` setting is no longer available.
110110

111-
Due to iPadOS “desktop-class experience” interventions, a patch has to be applied when the site is requested (by default) in desktop version, and only in this version (mobile website is fine without it). The selector for the flag can be configured (`:--ipadOS-patch`) and is `[style*="readium-iPadOSPatch-on"]` by default.
111+
iOS and iPadOS require patches to be applied to be able to use the font-size user setting properly, as the management of zooming and scaling has numerous and complex heuristics issues depending on the platform, and the way the site is requested (mobile or desktop).
112+
113+
iOS and iPadOS both require a patch to be applied when the site is requested in mobile version, and only in this version. The selector for the flag can be configured (`:--ios-patch`) and is `[style*="readium-iOSPatch-on"]` by default.
114+
115+
Due to iPadOS “desktop-class experience” interventions, another patch has to be applied when the site is requested (by default) in desktop version, and only in this version (mobile website is fine without it). The selector for the flag can be configured (`:--ipadOS-patch`) and is `[style*="readium-iPadOSPatch-on"]` by default.
112116

113117
Starting version `2.0.0-beta.12` the previous and deprecated implementation of font-size is exposed under a flag that can be configured (`:--deprecated-font-size`) and is `[style*="readium-deprecatedFontSize-on"]` by default. This can be used if you need some time to switch to the new implementation, or simply prefer to use the old one. The font-size normalize is no longer applied by default though, and is relying on another flag (`:--fs-normalize`) with `[style*="readium-normalize-on"]` as default.
114118

docs/ReadiumCSS_docs.epub

221 Bytes
Binary file not shown.

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,18 @@ root.style.setProperty("name of var", "");</code></pre>
119119
<p>Override class: None.</p>
120120
</section>
121121

122+
<section id="ios-scale-patch" class="level3">
123+
<h3 class="sigil_not_in_toc">iOS Scaling Patch</h3>
124+
125+
<p>Acts as an explicit switch to force iOS patching of scaling issues so that <code>--USER__fontSize</code> can work as expected. This should be applied only when the site is requested in its mobile version on iOS and iPadOS.</p>
126+
127+
<pre><code>--USER__iOSPatch</code></pre>
128+
129+
<p>Supported value: <code>readium-iOSPatch-on</code></p>
130+
131+
<p>Override class: None.</p>
132+
</section>
133+
122134
<section id="ipados-zoom-patch" class="level3">
123135
<h3 class="sigil_not_in_toc">iPadOS Zoom Patch</h3>
124136

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,16 @@
9090

9191
<hr/>
9292

93+
<pre><code>:--ios-patch</code></pre>
94+
95+
<p>Preset: <code>--USER__iOSPatch: readium-iOSPatch-on</code></p>
96+
97+
<p>Scope: <code>html</code></p>
98+
99+
<p>Override class: None. This flag is used to activate patching of iOS scaling issues in Safari, which can happen on rotate for instance.</p>
100+
101+
<hr/>
102+
93103
<pre><code>:--ipadOS-patch</code></pre>
94104

95105
<p>Preset: <code>--USER__iPadOSPatch: readium-iPadOSPatch-on</code></p>

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,11 @@
126126

127127
<p>As a side-effect of this new implementation, please note the <code>--USER__typeScale</code> setting is no longer available.</p>
128128

129-
<p>Due to iPadOS “desktop-class experience” interventions, a patch has to be applied when the site is requested (by default) in desktop mode, and only in this mode (mobile website is fine without it). The selector for the flag can be configured (<code>:--ipadOS-patch</code>) and is <code>[style*="readium-iPadOSPatch-on"]</code> by default.</p>
129+
<p>iOS and iPadOS require patches to be applied to be able to use the font-size user setting properly, as the management of zooming and scaling has numerous and complex heuristics issues depending on the platform, and the way the site is requested (mobile or desktop).</p>
130+
131+
<p>iOS and iPadOS both require a patch to be applied when the site is requested in mobile version, and only in this version. The selector for the flag can be configured (<code>:--ios-patch</code>) and is <code>[style*="readium-iOSPatch-on"]</code> by default.</p>
132+
133+
<p>Due to iPadOS “desktop-class experience” interventions, another patch has to be applied when the site is requested (by default) in desktop mode, and only in this mode (mobile website is fine without it). The selector for the flag can be configured (<code>:--ipadOS-patch</code>) and is <code>[style*="readium-iPadOSPatch-on"]</code> by default.</p>
130134

131135
<p>Starting version <code>2.0.0-beta.12</code> the previous and deprecated implementation of font-size is exposed under a flag that can be configured (<code>:--deprecated-font-size</code>) and is <code>[style*="readium-deprecatedFontSize-on"]</code> by default. This can be used if you need some time to switch to the new implementation, or simply prefer to use the old one. The font-size normalize is no longer applied by default though, and is relying on another flag (<code>:--fs-normalize</code>) with <code>[style*="readium-normalize-on"]</code> as default.</p>
132136

0 commit comments

Comments
 (0)