Skip to content

Commit 14f1044

Browse files
authored
Merge pull request #66 from readium/develop
Improve a11y of docs
2 parents 8110925 + d290e99 commit 14f1044

11 files changed

Lines changed: 1260 additions & 1247 deletions

docs/CSS03-injection_and_pagination.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,13 @@ The spread will consequently switch to a single page once the user sets a `font-
8484

8585
The following illustrations are the two models you’ll have to deal with.
8686

87-
![Single Page Model](assets/Page-Model.jpg)
87+
![The single page model relies on the column width of the :root element. Line-length is constrained by the max-width of the body element, including its padding. Finally an auto margin centers the content.](assets/Page-Model.jpg)
8888

8989
A single page is just a column which can grow to the entire width of the web view/iframe since it is declared for `html`.
9090

9191
Page margins are part of `body`, hence `--RS__maxLineLength`. Contents are centered using the `auto` value for `body` margins.
9292

93-
![Two-Column Spread Model](assets/spread-model.jpg)
93+
![The two-column spread model is somehow simpler in the sense the column width is the minimum value that must be reached for this model to be applied. We are relying on left and right padding instead of column-gap for gutters.](assets/spread-model.jpg)
9494

9595
In the spread model, i.e. two columns, the `--RS__colWidth` is a floor: once the minimum width available (viewport) can’t contain 2 columns (the value is computed from the `font-size` user setting), we switch to the single page model.
9696

@@ -218,7 +218,7 @@ Indeed, columns are automatically laid out on the `y-axis` (vertical) with such
218218

219219
We consequently use a “Fragmented Model”, as it differs significantly from the “Pagination Model”, especially the column-axis.
220220

221-
![Fragmented Model](assets/Fragmented-Model.jpg)
221+
![The fragmented Model is kind of a superset of the single page model in the vertical direction, with extra padding added to the root element for extra horizontal gutters.](assets/Fragmented-Model.jpg)
222222

223223
One can think of the fragmented model as the single page model rotated 90% clockwise. The only difference is that `padding` is added to the `:root` (`html`) element so that text doesn’t run from edge to edge.
224224

docs/CSS08-defaults.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ In which, `--RS__lineHeightCompensation` is a factor whose default is `1`. Indee
182182

183183
The results we could get for the vast majority of fonts can be described as good in terms of typographic color. Here is Iowan Old Style for instance.
184184

185-
![Iowan Old Style dynamic leading](assets/dynamic-leading.jpg)
185+
![Comparison of the algorithm using four different font-sizes with the Iowan Old Style typeface. We can notice that the leading applied is solider as font-size increases, which results in a relatively even distribution of typographic color. This is confirmed by the computed values retrieved in the tool ReadiumCSS provides for testing.](assets/dynamic-leading.jpg)
186186

187187
This isn’t a perfect solution though, and this algorithm may be revisited in the future.
188188

docs/CSS10-libre_fonts.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ An extended selection of 12 typefaces are recommended to offer implementers some
117117

118118
#### Charis SIL
119119

120-
![Charis SIL](assets/charis-sil.png)
120+
![Charis SIL compared to Charter. The typeface appears a little bit bolder but shares Charter’s metrics. When comparing an entire paragraph, it is really hard to tell which is which as they originate from the same “master.”](assets/charis-sil.png)
121121

122122
Global info:
123123

@@ -143,7 +143,7 @@ OpenType Features: none.
143143

144144
#### Faustina
145145

146-
![Faustina](assets/faustina.png)
146+
![Faustina compared to Charter. The typeface looks smaller and feels definitely condensed. When comparing an entire paragraph, the fact its x-height is larger becomes really visible as it allows for a shorter line-length while appearing larger in weight. Those specificities may help on narrow screens.](assets/faustina.png)
147147

148148
Global info:
149149

@@ -169,7 +169,7 @@ OpenType Features: none.
169169

170170
#### IBM Plex Serif
171171

172-
![IBM Plex Serif](assets/plex-serif.png)
172+
![IBM Plex Serif compared to Charter. The typeface is definitely wider, larger and bolder. When comparing an entire paragraph, this become obvious in the sense fewer words fit on a line. This could become an advantage on larger screens, as the user won’t have to increase font-size.](assets/plex-serif.png)
173173

174174
Global info:
175175

@@ -195,7 +195,7 @@ OpenType Features: none.
195195

196196
#### Merriweather
197197

198-
![Merriweather](assets/merriweather.png)
198+
![Merriweather compared to Iowan Old Style. Although more condensed, the typeface has been designed for screens and offers a larger x-height and bolder strokes. This shows when comparing an entire paragraph, as fewer words fit on a line and an extra line is even created.](assets/merriweather.png)
199199

200200
Global info:
201201

@@ -221,7 +221,7 @@ OpenType Features: none.
221221

222222
#### PT Serif
223223

224-
![PT Serif](assets/pt-serif.png)
224+
![PT Serif compared to Charter. The typeface looks slightly larger and makes for a sharper substitute. When comparing an entire paragraph, it is visibly larger but fits the same amount of words on each line.](assets/pt-serif.png)
225225

226226
Global info:
227227

@@ -247,7 +247,7 @@ OpenType Features: none.
247247

248248
#### Vollkorn
249249

250-
![Vollkorn](assets/vollkorn.png)
250+
![Vollkorn compared to Bembo (ET variant). The typeface is significantly larger and bolder; its vertical alignement is also a lot lower. When comparing an entire paragraph, those traits become obvious and offer a better design for reading on screens.](assets/vollkorn.png)
251251

252252
Global info:
253253

@@ -275,7 +275,7 @@ OpenType Features: small caps, numeric figure values, numeric spacing values (an
275275

276276
#### Clear Sans
277277

278-
![Clear Sans](assets/clear-sans.png)
278+
![Clear Sans compared to Trebuchet MS. The typeface appears a little bit smaller and the aperture of some glyphs like lowercase D appear more enclosed. When comparing an entire paragraph, it feels a little bit smaller but some letters like capital I are easier to differentiate, which is a plus for accessibility.](assets/clear-sans.png)
279279

280280
Global info:
281281

@@ -301,7 +301,7 @@ OpenType Features: none.
301301

302302
#### Fira Sans
303303

304-
![Fira Sans](assets/fira-sans.png)
304+
![Fira Sans compared to Arial. The typeface is decidedly more condensed, and its letter-spacing larger. When comparing an entire paragraph, the metrics of both fonts don’t look that much different, but Fira Sans brings the extra personality some users require in a bookish context.](assets/fira-sans.png)
305305

306306
Global info:
307307

@@ -327,7 +327,7 @@ OpenType Features: none.
327327

328328
#### Libre Franklin
329329

330-
![Libre Franklin](assets/libre-franklin.png)
330+
![Libre Franklin compared to San Fransisco, the Apple’s system typeface. Libre Franklin appears a little bit thinner and feels definitely larger. When comparing an entire paragraph, it shows, although it is capable of keeping the same amount of words on each line.](assets/libre-franklin.png)
331331

332332
Global info:
333333

@@ -353,7 +353,7 @@ OpenType Features: none.
353353

354354
#### Merriweather Sans
355355

356-
![Merriweather Sans](assets/merriweather-sans.png)
356+
![Merriweather Sans compared to San Fransisco, the Apple’s system typeface. It appears bolder and feels decidedly larger. This is remarkable when comparing an entire paragraph, especially as its design is less neutral.](assets/merriweather-sans.png)
357357

358358
Global info:
359359

@@ -379,7 +379,7 @@ OpenType Features: none.
379379

380380
#### PT Sans
381381

382-
![PT Sans](assets/pt-sans.png)
382+
![PT Sans compared to Seravek. The typeface appears more condensed. When comparing an entire paragraph, it also feels a little bit thinner but fits the same amount of words on each line and share some of Seravek’s traits.](assets/pt-sans.png)
383383

384384
Global info:
385385

@@ -405,7 +405,7 @@ OpenType Features: none.
405405

406406
#### Source Sans Pro
407407

408-
![Source Sans Pro](assets/source-sans-pro.png)
408+
![Source Sans Pro compared to Seravek. Its x-height is noticeably – but not remarkably – larger. When comparing an entire paragraph, both feel like they share some common traits, despite very visible differences in the drawing of their glyphs.](assets/source-sans-pro.png)
409409

410410
Global info:
411411

docs/ReadiumCSS_docs.epub

1.54 KB
Binary file not shown.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,15 +127,15 @@
127127
<p>The following illustrations are the two models you’ll have to deal with.</p>
128128

129129
<figure class="fullbleed">
130-
<img src="../Images/Page-Model.jpg" alt="Single Page Model"/>
130+
<img src="../Images/Page-Model.jpg" alt="The single page model relies on the column width of the :root element. Line-length is constrained by the max-width of the body element, including its padding. Finally an auto margin centers the content."/>
131131
</figure>
132132

133133
<p>A single page is just a column which can grow to the entire width of the web view/iframe since it is declared for <code>html</code>.</p>
134134

135135
<p>Page margins are part of <code>body</code>, hence <code>--RS__maxLineLength</code>. Contents are centered using the <code>auto</code> value for <code>body</code> margins.</p>
136136

137137
<figure class="fullbleed">
138-
<img src="../Images/spread-model.jpg" alt="Two-Column Spread Model"/>
138+
<img src="../Images/spread-model.jpg" alt="The two-column spread model is somehow simpler in the sense the column width is the minimum value that must be reached for this model to be applied. We are relying on left and right padding instead of column-gap for gutters."/>
139139
</figure>
140140

141141
<p>In the spread model, i.e. two columns, the <code>--RS__colWidth</code> is a floor: once the minimum width available (viewport) can’t contain 2 columns (the value is computed from the <code>font-size</code> user setting), we switch to the single page model.</p>
@@ -346,7 +346,7 @@ body {
346346
<p>We consequently use a “Fragmented Model”, as it differs significantly from the “Pagination Model”, especially the column-axis.</p>
347347

348348
<figure class="fullbleed">
349-
<img src="../Images/Fragmented-Model.jpg" alt="Fragmented Model"/>
349+
<img src="../Images/Fragmented-Model.jpg" alt="The fragmented Model is kind of a superset of the single page model in the vertical direction, with extra padding added to the root element for extra horizontal gutters."/>
350350
</figure>
351351

352352
<p>One can think of the fragmented model as the single page model rotated 90% clockwise. The only difference is that <code>padding</code> is added to the <code>:root</code> (<code>html</code>) element so that text doesn’t run from edge to edge.</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@
192192
<p>The results we could get for the vast majority of fonts can be described as good in terms of typographic color. Here is Iowan Old Style for instance.</p>
193193

194194
<figure>
195-
<img src="../Images/dynamic-leading.jpg" alt="Iowan Old Style dynamic leading."/>
195+
<img src="../Images/dynamic-leading.jpg" alt="Comparison of the algorithm using four different font-sizes with the Iowan Old Style typeface. We can notice that the leading applied is solider as font-size increases, which results in a relatively even distribution of typographic color. This is confirmed by the computed values retrieved in the tool ReadiumCSS provides for testing."/>
196196

197197
</figure>
198198

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<h4 class="sigil_not_in_toc">Charis SIL</h4>
218218

219219
<figure class="fullbleed">
220-
<img src="../Images/charis-sil.png" alt=""/>
220+
<img src="../Images/charis-sil.png" alt="Charis SIL compared to Charter. The typeface appears a little bit bolder but shares Charter’s metrics. When comparing an entire paragraph, it is really hard to tell which is which as they originate from the same “master.”"/>
221221
</figure>
222222

223223
<p>Global info:</p>
@@ -263,7 +263,7 @@
263263
<h4 class="sigil_not_in_toc">Faustina</h4>
264264

265265
<figure class="fullbleed">
266-
<img src="../Images/faustina.png" alt=""/>
266+
<img src="../Images/faustina.png" alt="Faustina compared to Charter. The typeface looks smaller and feels definitely condensed. When comparing an entire paragraph, the fact its x-height is larger becomes really visible as it allows for a shorter line-length while appearing larger in weight. Those specificities may help on narrow screens."/>
267267
</figure>
268268

269269
<p>Global info:</p>
@@ -309,7 +309,7 @@
309309
<h4 class="sigil_not_in_toc">IBM Plex Serif</h4>
310310

311311
<figure class="fullbleed">
312-
<img src="../Images/plex-serif.png" alt=""/>
312+
<img src="../Images/plex-serif.png" alt="IBM Plex Serif compared to Charter. The typeface is definitely wider, larger and bolder. When comparing an entire paragraph, this become obvious in the sense fewer words fit on a line. This could become an advantage on larger screens, as the user won’t have to increase font-size."/>
313313
</figure>
314314

315315
<p>Global info:</p>
@@ -355,7 +355,7 @@
355355
<h4 class="sigil_not_in_toc">Merriweather</h4>
356356

357357
<figure class="fullbleed">
358-
<img src="../Images/merriweather.png" alt=""/>
358+
<img src="../Images/merriweather.png" alt="Merriweather compared to Iowan Old Style. Although more condensed, the typeface has been designed for screens and offers a larger x-height and bolder strokes. This shows when comparing an entire paragraph, as fewer words fit on a line and an extra line is even created."/>
359359
</figure>
360360

361361
<p>Global info:</p>
@@ -401,7 +401,7 @@
401401
<h4 class="sigil_not_in_toc">PT Serif</h4>
402402

403403
<figure class="fullbleed">
404-
<img src="../Images/pt-serif.png" alt=""/>
404+
<img src="../Images/pt-serif.png" alt="PT Serif compared to Charter. The typeface looks slightly larger and makes for a sharper substitute. When comparing an entire paragraph, it is visibly larger but fits the same amount of words on each line."/>
405405
</figure>
406406

407407
<p>Global info:</p>
@@ -447,7 +447,7 @@
447447
<h4 class="sigil_not_in_toc">Vollkorn</h4>
448448

449449
<figure class="fullbleed">
450-
<img src="../Images/vollkorn.png" alt=""/>
450+
<img src="../Images/vollkorn.png" alt="Vollkorn compared to Bembo (ET variant). The typeface is significantly larger and bolder; its vertical alignement is also a lot lower. When comparing an entire paragraph, those traits become obvious and offer a better design for reading on screens."/>
451451
</figure>
452452

453453
<p>Global info:</p>
@@ -497,7 +497,7 @@
497497
<h4 class="sigil_not_in_toc">Clear Sans</h4>
498498

499499
<figure class="fullbleed">
500-
<img src="../Images/clear-sans.png" alt=""/>
500+
<img src="../Images/clear-sans.png" alt="Clear Sans compared to Trebuchet MS. The typeface appears a little bit smaller and the aperture of some glyphs like lowercase D appear more enclosed. When comparing an entire paragraph, it feels a little bit smaller but some letters like capital I are easier to differentiate, which is a plus for accessibility."/>
501501
</figure>
502502

503503
<p>Global info:</p>
@@ -543,7 +543,7 @@
543543
<h4 class="sigil_not_in_toc">Fira Sans</h4>
544544

545545
<figure class="fullbleed">
546-
<img src="../Images/fira-sans.png" alt=""/>
546+
<img src="../Images/fira-sans.png" alt="Fira Sans compared to Arial. The typeface is decidedly more condensed, and its letter-spacing larger. When comparing an entire paragraph, the metrics of both fonts don’t look that much different, but Fira Sans brings the extra personality some users require in a bookish context."/>
547547
</figure>
548548

549549
<p>Global info:</p>
@@ -589,7 +589,7 @@
589589
<h4 class="sigil_not_in_toc">Libre Franklin</h4>
590590

591591
<figure class="fullbleed">
592-
<img src="../Images/libre-franklin.png" alt=""/>
592+
<img src="../Images/libre-franklin.png" alt="Libre Franklin compared to San Fransisco, the Apple’s system typeface. Libre Franklin appears a little bit thinner and feels definitely larger. When comparing an entire paragraph, it shows, although it is capable of keeping the same amount of words on each line."/>
593593
</figure>
594594

595595
<p>Global info:</p>
@@ -635,7 +635,7 @@
635635
<h4 class="sigil_not_in_toc">Merriweather Sans</h4>
636636

637637
<figure class="fullbleed">
638-
<img src="../Images/merriweather-sans.png" alt=""/>
638+
<img src="../Images/merriweather-sans.png" alt="Merriweather Sans compared to San Fransisco, the Apple’s system typeface. It appears bolder and feels decidedly larger. This is remarkable when comparing an entire paragraph, especially as its design is less neutral."/>
639639
</figure>
640640

641641
<p>Global info:</p>
@@ -681,7 +681,7 @@
681681
<h4 class="sigil_not_in_toc">PT Sans</h4>
682682

683683
<figure class="fullbleed">
684-
<img src="../Images/pt-sans.png" alt=""/>
684+
<img src="../Images/pt-sans.png" alt="PT Sans compared to Seravek. The typeface appears more condensed. When comparing an entire paragraph, it also feels a little bit thinner but fits the same amount of words on each line and share some of Seravek’s traits."/>
685685
</figure>
686686

687687
<p>Global info:</p>
@@ -727,7 +727,7 @@
727727
<h4 class="sigil_not_in_toc">Source Sans Pro</h4>
728728

729729
<figure class="fullbleed">
730-
<img src="../Images/source-sans-pro.png" alt=""/>
730+
<img src="../Images/source-sans-pro.png" alt="Source Sans Pro compared to Seravek. Its x-height is noticeably – but not remarkably – larger. When comparing an entire paragraph, both feel like they share some common traits, despite very visible differences in the drawing of their glyphs."/>
731731
</figure>
732732

733733
<p>Global info:</p>

docs/ReadiumCSS_docs/OEBPS/Text/cover.xhtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ div {text-indent: 0; text-align: center; margin: 0; padding: 0;}
1616

1717
<body id="cover" xml:lang="en">
1818
<div id="cover-image">
19-
<img src="../Images/cover.jpg" alt=""/>
19+
<img src="../Images/cover.jpg" alt="Readium CSS, Implementers’ documentation."/>
2020
</div>
2121
</body>
2222
</html>

docs/ReadiumCSS_docs/OEBPS/Text/nav.xhtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@
357357
</li>
358358
<li>
359359
<a href="../Text/Section-013.xhtml#sigil_toc_id_169">Vestibular disorders</a>
360-
</li>
360+
</li>
361361
<li>
362362
<a href="../Text/Section-013.xhtml#sigil_toc_id_142">Internationalization</a>
363363
</li>

docs/ReadiumCSS_docs/OEBPS/content.opf

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="utf-8" ?>
2-
<package unique-identifier="epub-id-1" version="3.0" xmlns="http://www.idpf.org/2007/opf">
2+
<package prefix="schema: http://schema.org/" unique-identifier="epub-id-1" version="3.0" xmlns="http://www.idpf.org/2007/opf">
33
<metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
44
<dc:title>Readium CSS Implementers’ doc</dc:title>
55
<dc:creator id="cre">Readium</dc:creator>
@@ -8,8 +8,21 @@
88
<dc:language>en</dc:language>
99
<dc:identifier id="epub-id-1">urn:uuid:91cab77e-946f-4814-9e61-8494a5d5cb0f</dc:identifier>
1010
<meta name="cover" content="cover_jpg"/>
11-
<meta property="dcterms:modified">2019-06-13T18:30:22Z</meta>
11+
<meta property="dcterms:modified">2019-06-28T16:43:31Z</meta>
1212
<meta content="0.9.5" name="Sigil version"/>
13+
<meta property="schema:accessibilityFeature">displayTransformability</meta>
14+
<meta property="schema:accessibilityFeature">readingOrder</meta>
15+
<meta property="schema:accessibilityFeature">structuralNavigation</meta>
16+
<meta property="schema:accessibilityFeature">unlocked</meta>
17+
<meta property="schema:accessibilityFeature">alternativeText</meta>
18+
<meta property="schema:accessibilityHazard">noFlashing</meta>
19+
<meta property="schema:accessibilityHazard">noSound</meta>
20+
<meta property="schema:accessibilityHazard">noMotionSimulation</meta>
21+
<meta property="schema:accessMode">textual</meta>
22+
<meta property="schema:accessMode">visual</meta>
23+
<meta property="schema:accessModeSufficient">textual,visual</meta>
24+
<meta property="schema:accessModeSufficient">textual</meta>
25+
<meta property="schema:accessibilitySummary">The publication should meet EPUB Accessibility 1.0 requirements and WCAG 2.0 Level AA.</meta>
1326
</metadata>
1427
<manifest>
1528
<item href="toc.ncx" id="ncx" media-type="application/x-dtbncx+xml"/>

0 commit comments

Comments
 (0)