Skip to content

Commit 27a38a0

Browse files
committed
Typos and syntax
1 parent 26ab745 commit 27a38a0

24 files changed

+108
-42
lines changed

docs/CSS01-readiumcss_fundamentals.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ We’ve also made sure that, for most “hardcoded” styles you might add when
4646

4747
This last principle is important since the relationship between authors and Reading Systems’ developers has not been really great so far.
4848

49-
Therefore, feedback has been collected, samples have been used all along development, and decisions impacting authors have been openly discussed. A public documentation is also available.
49+
Therefore, feedback has been collected, samples have been used all along development, and decisions impacting authors have been openly discussed. All of this has been publicly documented during research and development.
5050

5151
More importantly, we must clearly state what is UA styles and user styles, and why `!important` is used. This process has a significant impact when it comes to transparency since it affects the cascade itself (see user settings recommendations). Should an author file an issue scoped to your implementation, please take the time to explain why you decided to differ and use `!important`, especially as such a decision can likely be backed by users’ feedback in many cases.

docs/CSS09-default_fonts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -490,9 +490,9 @@ font-family: "Latin Modern Math", "STIX Two Math", "XITS Math", "STIX Math", "Li
490490

491491
## EBPAJ patch for Japanese
492492

493-
The EBPAJ template only references fonts from MS Windows so Readium CSS has to reference fonts from other platforms and override authors’ stylesheets. What it does in this polyfill is keeping the default value used in EBPAJ templates and providing fallbacks for all platforms.
493+
The EBPAJ template only references fonts from MS Windows so Readium CSS has to reference fonts from other platforms and override authors’ stylesheets. What it does in this patch is keeping the default value used in EBPAJ templates and providing fallbacks for all platforms.
494494

495-
Implementers might want to load this polyfill only if they find one of the following metadata items in the OPF package:
495+
Implementers might want to load this patch only if they find one of the following metadata items in the OPF package:
496496

497497
- version 1: `<dc:description id="ebpaj-guide">ebpaj-guide-1.0</dc:description>`
498498
- version 1.1: `<meta property="ebpaj:guide-version">1.1</meta>`

docs/CSS11-user_prefs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Possible values: `readium-font-on` | `readium-font-off`
7676

7777
### Advanced Settings
7878

79-
Acts as an explicit switch to overrides publisher’s styles.
79+
Acts as an explicit switch to override the publisher’s styles.
8080

8181
It must be set if the user changes `font-family` or `font-size`.
8282

docs/CSS14-user_settings_recs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Users’ styles > Authors’ styles > Implementers’ styles
2727

2828
Which is why conceptualizing this issue as intents may help.
2929

30-
Typography is not just a set of settings though, it’s a complex system in which some settings impact other settings. For instance, font-size impacts line-height and line-length, which impacts the number of columns.
30+
Typography is not just a set of settings though, it’s a complex system in which some settings impact others. For instance, font-size impacts line-height and line-length, which impacts the number of columns.
3131

3232
It is up to implementers to pick their preferred approach (minimal set, presets, minimal set/presets with advanced settings, maximal set) since it is primarily an UX issue.
3333

@@ -59,7 +59,7 @@ For a11y-related typefaces (Open Dyslexic, bold style of sans-serif family), the
5959

6060
Declaring a `font-family` for `body`, `p` and `p.class` is so common that it should not be considered an intent per se. While `p.class` is debatable, it is so widespread in practice (some authoring tools output `font-family` for every paragraph style) that it can’t be considered an intent in pure CSS.
6161

62-
A different `font-family` can be set for headings (`h1`, `h2`, `h3` etc.), `blockquote`, `i`, `span`, etc.
62+
A different `font-family` can be set for headings (`h1`, `h2`, `h3`, etc.), `blockquote`, `i`, `span`, etc.
6363

6464
### What to do
6565

docs/CSS15-user_pref_insights.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This is really tricky as **there may be a cultural factor to take into account**
1212

1313
When asked directly, the vast majority of users will say they prefer basic settings (reading modes, typeface, and font size) over other options (maximum amount of settings possible, themes, customizable themes). Customizable themes and advanced settings are equally popular, at a distant second place.
1414

15-
Once again, this is a complex UX issue and your mileage may vary. On Android for instance, there is a lot of apps with advanced settings as the default, and millions of people use them. So it’s primarily about your UX proposal, people using it, etc.
15+
Once again, this is a complex UX issue and your mileage may vary. On Android for instance, there is a lot of apps with advanced settings as the default, and millions of people are using them daily. So it’s primarily about your UX proposal, people using it, etc.
1616

1717
Hopefully, Readium CSS was designed to take all those options into account: modules are take or leave, which implies you can build any UX from them.
1818

@@ -24,7 +24,7 @@ We’ve been running forms on this topic but answers can’t be taken at face va
2424

2525
People keeping the publisher’s typeface are in the minority (< 15%). Most users at least change the typeface occasionally (see reasons below), although they don’t necessarily do it for each ebook – some ebooks simply use the default typeface so it’s quite complex to measure.
2626

27-
What’s important is that **you’d better have some kind of bulletproof set of RS typefaces.** Bulletproof is the keyword here, since it is difficult to imagine a set that will satisfy everybody. There won’t be any silver bullet.
27+
What’s important is that **you’d better have some kind of bulletproof selection of RS typefaces.** Bulletproof is the keyword here, since it is difficult to imagine a selection that will satisfy everybody. There won’t be any silver bullet.
2828

2929
Since more people systematically change the publisher’s typeface than those who never do it, **implementers might end up with a huge share of users systematically changing the typeface and could adjust the UX accordingly** (global setting applying the typeface in all books).
3030

docs/CSS16-internationalization.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ This could well explain why the most popular Reading Apps tend to implement the
1212

1313
Occasionally, when an app does support a language, it can put some constraints on authors, as there is no other way to make sure the publication will be handled well otherwise e.g. specifying the `Hans` or `Hant` script for Chinese (`zh`).
1414

15+
We can’t overemphasize the importance of the internationalization process though, as the 24 languages we added extend support to 3,049,150,507 speakers, from the 1,150 people speaking Western Canadian Inuktitut, to the 1,200,000,000 speaking Chinese. In total, we can cover the needs of 5,262,900,507 speakers. Credit where credit is due, this wouldn’t have been possible if Operating Systems and browsers didn’t tackle this process upstream, added fonts for those languages and improved support in rendering engines.
16+
1517
## Resources
1618

1719
- [W3C Internationalization Working Group Home Page](https://www.w3.org/International/core/Overview)
@@ -208,7 +210,7 @@ The most information we have, the better the fix will be. Please feel free to go
208210

209211
### Sending feedback
210212

211-
We’re not saying you should do the implementation if we don’t support it at all or very well, but it is noteworthy that we can’t necessarily get all the details right, especially when we don’t know how to speak and write a language or script.
213+
We’re not saying you should implement a support of script yourself if we don’t support it at all or very well, but it is noteworthy that we can’t necessarily get all the details right, especially when we don’t know how to speak and write the language you wish were supported or improved.
212214

213215
If our font-stacks are not good enough, a solider one will help. If we don’t have any font-stack for a language, a basic one will do. Additionally, you can point us to libre/open-source fonts which you think should be recommended to implementers.
214216

docs/CSS17-i18n_typography.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ For vertical text the placement needs to be to the right or left of the line of
3232

3333
Bold and italic are not always appropriate for expressing emphasis, and some scripts have their own unique ways of doing it.
3434

35-
In Japanese, a sans-serif font or emphasis dots (horizontal writing) or sesame (vertical writing) may be used to express emphasis.
35+
In Japanese, a sans-serif font, or emphasis dots (horizontal writing) and sesame (vertical writing) may be used to express emphasis.
3636

3737
In the Amharic Script (Ethiopic), underlines, larger text or a different color may be used to express emphasis.
3838

@@ -54,7 +54,7 @@ Although CJK doesn’t use hyphenation, documents may contain other scripts whic
5454

5555
Typographic conventions for full text justification depend on the writing system, the content language, and the calligraphic style of the text. Some scripts have complex methods the rendering engine doesn’t necessarily support.
5656

57-
Kashida elongation is not supported for the Arabic script for instance (`text-justify`), but authors may be using the tatweel (see [i18n glossary doc](../docs/CSS26-i18n_glossary.md)) to elongate some words.
57+
Kashida elongation is not supported for the Arabic script for instance (`text-justify`), but authors may be using the tatweel joining character (see [i18n glossary doc](../docs/CSS26-i18n_glossary.md)) to elongate some words.
5858

5959
Chinese and Japanese are using `inter-character` justification for instance, while Latin uses `inter-word`.
6060

@@ -64,7 +64,7 @@ In some scripts like CJK, indents are really important. Implementers should not
6464

6565
## Vertical text
6666

67-
Implementers must not try to offer users with a setting allowing users to switch from the vertical to horizontal writing mode, and vice versa, unless they support alternate stylesheets and the publication provides one for each mode. Indeed, characters, punctuation, emphasis marks, quotes, and so on and so forth, depend on the writing mode used, and an automatic switch would provide users with a subpar experience.
67+
Implementers must not try to provide a setting allowing users to switch from the vertical to horizontal writing mode, and vice versa, unless they support alternate stylesheets and the publication provides one for each mode. Indeed, characters, punctuation, emphasis marks, quotes, and so on and so forth, depend on the writing mode used, and an automatic switch would provide users with a subpar experience.
6868

6969
It's common for content authors to want to mix short horizontal runs of text, such as the tate-chu-yoko i.e. 2-digit numbers (`text-combine-upright`) or acronyms (`text-orientation`), in a vertical text.
7070

docs/CSS19-api.md

+37-3
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,40 @@ A monospace font-stack relying on pre-installed fonts.
114114

115115
Default is `"Andale Mono", Consolas, monospace`.
116116

117+
### Default font-stacks for Japanese publications
118+
119+
```
120+
--RS__serif-ja
121+
```
122+
123+
A Mincho font-stack whose fonts with proportional latin characters are prioritized for horizontal writing.
124+
125+
Default is `"MS P明朝", "MS PMincho", "Hiragino Mincho Pro", "ヒラギノ明朝 Pro W3", "游明朝", "YuMincho", "MS 明朝", "MS Mincho", "Hiragino Mincho ProN", serif`.
126+
127+
```
128+
--RS__sans-serif-ja
129+
```
130+
131+
A Gothic font-stack whose fonts with proportional latin characters are prioritized for horizontal writing.
132+
133+
Default is `"MS Pゴシック", "MS PGothic", "Hiragino Kaku Gothic Pro W3", "ヒラギノ角ゴ Pro W3", "Hiragino Sans GB", "ヒラギノ角ゴシック W3", "游ゴシック", "YuGothic", "MS ゴシック", "MS Gothic", "Hiragino Sans", sans-serif`.
134+
135+
```
136+
--RS__serif-ja-v
137+
```
138+
139+
A Mincho font-stack whose fonts with fixed-width latin characters are prioritized for vertical writing.
140+
141+
Default is `"MS 明朝", "MS Mincho", "Hiragino Mincho Pro", "ヒラギノ明朝 Pro W3", "游明朝", "YuMincho", "MS P明朝", "MS PMincho", "Hiragino Mincho ProN", serif`.
142+
143+
```
144+
--RS__sans-serif-ja-v
145+
```
146+
147+
A Gothic font-stack whose fonts with fixed-width latin characters are prioritized for vertical writing.
148+
149+
Default is `"MS ゴシック", "MS Gothic", "Hiragino Kaku Gothic Pro W3", "ヒラギノ角ゴ Pro W3", "Hiragino Sans GB", "ヒラギノ角ゴシック W3", "游ゴシック", "YuGothic", "MS Pゴシック", "MS PGothic", "Hiragino Sans", sans-serif`.
150+
117151
### Base styles for all ebooks
118152

119153
```
@@ -314,7 +348,7 @@ It impacts `body`.
314348
--USER__view
315349
```
316350

317-
Enables scroll mode.
351+
Switches from the paged to the scroll view.
318352

319353
Scope: `html`
320354

@@ -468,7 +502,7 @@ Scope: `html`
468502
--USER__darkenImages
469503
```
470504

471-
A filter to darken mages in night mode. It behaves as a switch i.e. if it is present, the filter is enabled.
505+
A filter to darken images in night mode.
472506

473507
Scope: `html`
474508

@@ -478,7 +512,7 @@ It impacts all `img` elements in the DOM.
478512
--USER__invertImages
479513
```
480514

481-
A filter to invert images in night mode. It behaves as a switch i.e. if it is present, the filter is enabled.
515+
A filter to invert images in night mode.
482516

483517
Scope: `html`
484518

docs/CSS21-epub_compat.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ This metadata has an `ibooks:` prefix.
148148
Authors must add the following prefix attribute in their `<package>` first:
149149

150150
```
151-
prefix="ibooks: http://vocabulary.itunes.apple.com/rdf/ibooks/vocabulary-extensions-1.0/
151+
prefix="ibooks: http://vocabulary.itunes.apple.com/rdf/ibooks/vocabulary-extensions-1.0/"
152152
```
153153

154154
Then, they can use the ibooks-specific metadata.

docs/CSS25-performance_hacks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ The `contain` property indicates that **the element and its contents are, as muc
145145

146146
This allows the browser to recalculate layout, style, paint, size, or any combination of them for a limited area of the DOM and not the entire page. To put it simply, it lets developers limit the scope of the browser's styles, layout and paint work.
147147

148-
It was primarily meants for webpages which contain a lot of widgets that are all independent as it can be used to prevent one widget's CSS rules from changing other things on the page.
148+
It was primarily meant for webpages which contain a lot of widgets that are all independent as it can be used to prevent one widget's CSS rules from changing other things on the page.
149149

150150
### Usage
151151

docs/CSS26-i18n_glossary.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,9 @@ This glossary has been created from the <a href="https://www.w3.org/TR/jlreq/#te
300300
<dt>Ideographic numerals / Kansūji (漢数字)</dt>
301301
<dd>Ideographic characters representing numbers.</dd>
302302

303+
<dt>Inline cutting note / Warichu (割注)</dt>
304+
<dd>A note of two or more lines inserted in the text. It includes brackets which surround the note (JIS Z 8125)</dd>
305+
303306
<dt>Inseparable characters rule / Bunri kinshi (分離禁止)</dt>
304307
<dd>A line adjustment rule that prohibits inserting any space between specific combinations of characters. (JIS Z 8125)</dd>
305308

@@ -411,9 +414,6 @@ This glossary has been created from the <a href="https://www.w3.org/TR/jlreq/#te
411414
<dt>Vertical writing mode / Tate gumi (縦組)</dt>
412415
<dd>The process or the result of arranging characters on a line from top to bottom, of lines on a page from right to left, and/or of columns on a page from top to bottom. (JIS Z 8125)</dd>
413416

414-
<dt>Inline cutting note / Warichu (割注)</dt>
415-
<dd>A note of two or more lines inserted in the text. It includes brackets which surround the note (JIS Z 8125)</dd>
416-
417417
<dt>Widow Adjustment / Danraku matsubi shori (段落末尾処理)</dt>
418418
<dd>A method of line composition to adjust lines in a paragraph so that the last line consists of more than a given number of characters.</dd>
419419
</dl>

docs/ReadiumCSS_docs.epub

556 Bytes
Binary file not shown.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474

7575
<p>This last principle is important since the relationship between authors and Reading Systems’ developers has not been really great so far.</p>
7676

77-
<p>Therefore, feedback has been collected, samples have been used all along development, and decisions impacting authors have been openly discussed. A public documentation is also available.</p>
77+
<p>Therefore, feedback has been collected, samples have been used all along development, and decisions impacting authors have been openly discussed. All of this has been publicly documented during research and development.</p>
7878

7979
<p>More importantly, we must clearly state what is UA styles and user styles, and why <code>!important</code> is used. This process has a significant impact when it comes to transparency since it affects the cascade itself (see user settings recommendations). Should an author file an issue scoped to your implementation, please take the time to explain why you decided to differ and use <code>!important</code>, especially as such a decision can likely be backed by users’ feedback in many cases.</p>
8080
</section>

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -945,9 +945,9 @@ unicode-range: U+0500-052F;</code></pre>
945945
<section id="ebpaj-patch-for-japanese" class="level2">
946946
<h2 id="sigil_toc_id_130">EBPAJ patch for Japanese</h2>
947947

948-
<p>The EBPAJ template only references fonts from MS Windows so Readium CSS has to reference fonts from other platforms and override authors’ stylesheets. What it does in this polyfill is keeping the default value used in EBPAJ templates and providing fallbacks for all platforms.</p>
948+
<p>The EBPAJ template only references fonts from MS Windows so Readium CSS has to reference fonts from other platforms and override authors’ stylesheets. What it does in this patch is keeping the default value used in EBPAJ templates and providing fallbacks for all platforms.</p>
949949

950-
<p>Implementers might want to load this polyfill only if they find one of the following metadata items in the OPF package:</p>
950+
<p>Implementers might want to load this patch only if they find one of the following metadata items in the OPF package:</p>
951951

952952
<ul>
953953
<li>version 1: <code>&lt;dc:description id="ebpaj-guide"&gt;ebpaj-guide-1.0&lt;/dc:description&gt;</code></li>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
<section id="advanced-settings" class="level3">
100100
<h3 class="sigil_not_in_toc">Advanced Settings</h3>
101101

102-
<p>Acts as an explicit switch to overrides publisher’s styles.</p>
102+
<p>Acts as an explicit switch to override the publisher’s styles.</p>
103103

104104
<p>It must be set if the user changes <code>font-family</code> or <code>font-size</code>.</p>
105105

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848

4949
<p>Which is why conceptualizing this issue as intents may help.</p>
5050

51-
<p>Typography is not just a set of settings though, it’s a complex system in which some settings impact other settings. For instance, font-size impacts line-height and line-length, which impacts the number of columns.</p>
51+
<p>Typography is not just a set of settings though, it’s a complex system in which some settings impact others. For instance, font-size impacts line-height and line-length, which impacts the number of columns.</p>
5252

5353
<p>It is up to implementers to pick their preferred approach (minimal set, presets, minimal set/presets with advanced settings, maximal set) since it is primarily an UX issue.</p>
5454
</section>
@@ -93,7 +93,7 @@
9393

9494
<p>Declaring a <code>font-family</code> for <code>body</code>, <code>p</code> and <code>p.class</code> is so common that it should not be considered an intent <i>per se</i>. While <code>p.class</code> is debatable, it is so widespread in practice (some authoring tools output <code>font-family</code> for every paragraph style) that it can’t be considered an intent in pure CSS.</p>
9595

96-
<p>A different <code>font-family</code> can be set for headings (<code>h1</code>, <code>h2</code>, <code>h3</code> etc.), <code>blockquote</code>, <code>i</code>, <code>span</code>, etc.</p>
96+
<p>A different <code>font-family</code> can be set for headings (<code>h1</code>, <code>h2</code>, <code>h3</code>, etc.), <code>blockquote</code>, <code>i</code>, <code>span</code>, etc.</p>
9797
</section>
9898

9999
<section id="what-to-do" class="level3">

0 commit comments

Comments
 (0)