Skip to content

Commit ab2306a

Browse files
committed
Remove highlights mention from docs
1 parent 17238c2 commit ab2306a

12 files changed

Lines changed: 18 additions & 106 deletions

File tree

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Readium CSS provides styles for reflowable text:
1212
- reading modes (day, night, and sepia);
1313
- themes;
1414
- user settings;
15-
- media overlays and user highlights;
1615
- a set of baselines and recommendations for accessibility, overrides, and internationalization.
1716

1817
**Readium CSS is currently in alpha** (version `1.0.0-beta.1`).

css/ReadMe.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ Readium CSS is a set of reference stylesheets for EPUB Reading Systems. It provi
77
- default styles;
88
- reading modes (night, sepia, etc.);
99
- themes;
10-
- user settings;
11-
- media overlays and user highlights.
10+
- user settings.
1211

1312
**Note:** Readium CSS stylesheets were not designed and should not be used for fixed-layout EPUB, nor other file formats like FB2, PRC, Mobi, TEI, etc.
1413

css/src/modules/ReadiumCSS-os_a11y.css

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@
2929
}
3030

3131
/* For links, hyperlink keyword is automatically set */
32-
33-
/* Should we also set user highlights? */
3432
}
3533

3634
@media screen and (-ms-high-contrast: white-on-black) {

docs/CSS02-quickstart.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ Readium CSS is a set of reference stylesheets for EPUB Reading Systems. It provi
99
- default styles;
1010
- reading modes (night, sepia, etc.);
1111
- themes;
12-
- user settings;
13-
- media overlays and user highlights.
12+
- user settings.
1413

1514
**Note:** Readium CSS stylesheets were not designed and should not be used for fixed-layout EPUB, nor other file formats like FB2, PRC, Mobi, TEI, etc.
1615

docs/CSS08-defaults.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ Defaults is currently made of 5 stylesheets:
77
- 1 base stylesheet for all ebooks;
88
- 1 default reading mode stylesheet for all ebooks (day mode);
99
- 1 default stylesheet for unstyled ebooks;
10-
- 1 stylesheet for user highlights and media overlays;
1110
- 1 stylesheet to deal with the OS’ a11y modes.
1211

1312
**Note:** The default stylesheet should not be appended if there are author styles in the EPUB file.
@@ -362,41 +361,7 @@ An optional primary accentuation `color` you could use for headings or any other
362361

363362
An optional secondary accentuation `color` you could use for any element of your choice.
364363

365-
## User highlights and media overlays
366-
367-
### Highlights
368-
369-
You can use classic [insert famous highlighters’ brand] colors in all their neon glory:
370-
371-
- yellow;
372-
- green;
373-
- orange;
374-
- pink.
375-
376-
There’s no blue since it is too close to the default `::selection`.
377-
378-
Ideally, you should offer users the possibility to switch colors when highlighting as they might use a color pattern to manage different types of highlights/notes.
379-
380-
There’s a class syntax you can use to differentiate highlights: `.readiumCSS-{color}-highlight` e.g. `.readiumCSS-yellow-highlight` or `.readiumCSS-pink-highlight`.
381-
382-
Values are declared in `rgba` so that those colors don’t have to be redefined in night modes.
383-
384-
At first sight, contrast is OK for those colors in default and night mode, but it will obviously depend on the `background-color` and `color` values you’re using for themes.
385-
386-
### Media Overlays
387-
388-
We’re using the same one as Readium 1 for interop reasons.
389-
390-
```
391-
.readiumCSS-mo-active-default {
392-
background-color: yellow !important;
393-
color: black !important;
394-
}
395-
```
396-
397-
It has been prefixed with `readiumCSS-` but you can get rid of it if needed.
398-
399-
### OS’ a11y modes
364+
## OS’ a11y modes
400365

401366
This stylesheet is intended to deal with a11y settings users can set at the OS level, whenever possible:
402367

docs/ReadiumCSS_docs.epub

-611 Bytes
Binary file not shown.

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@
2828

2929
<li>themes;</li>
3030

31-
<li>user settings;</li>
32-
33-
<li>media overlays and user highlights.</li>
31+
<li>user settings.</li>
3432
</ul>
3533

3634
<p><strong>Note:</strong> Readium CSS stylesheets were not designed and should not be used for fixed-layout EPUB, nor other file formats like FB2, PRC, Mobi, TEI, etc.</p>

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

Lines changed: 11 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@
2424

2525
<li>1 default stylesheet for unstyled ebooks;</li>
2626

27-
<li>1 stylesheet for user highlights and media overlays;</li>
28-
2927
<li>1 stylesheet to deal with the OS’ a11y modes.</li>
3028
</ul>
3129

@@ -374,65 +372,22 @@
374372
</section>
375373
</section>
376374

377-
<section id="user-highlights-and-media-overlays" class="level2">
378-
<h2 id="sigil_toc_id_134">User highlights and media overlays</h2>
379-
380-
<section id="highlights" class="level3">
381-
<h3 class="sigil_not_in_toc">Highlights</h3>
382-
383-
<p>You can use classic [insert famous highlighters’ brand] colors in all their neon glory:</p>
384-
385-
<ul>
386-
<li>yellow;</li>
387-
388-
<li>green;</li>
389-
390-
<li>orange;</li>
375+
<section id="os-a11y-modes" class="level2">
376+
<h2 id="sigil_toc_id_134">OS’ a11y modes</h2>
377+
378+
<p>This stylesheet is intended to deal with a11y settings users can set at the OS level, whenever possible:</p>
391379

392-
<li>pink.</li>
393-
</ul>
394-
395-
<p>There’s no blue since it is too close to the default <code>::selection</code>.</p>
396-
397-
<p>Ideally, you should offer users the possibility to switch colors when highlighting as they might use a color pattern to manage different types of highlights/notes.</p>
398-
399-
<p>There’s a class syntax you can use to differentiate highlights: <code>.readiumCSS-{color}-highlight</code> e.g. <code>.readiumCSS-yellow-highlight</code> or <code>.readiumCSS-pink-highlight</code>.</p>
400-
401-
<p>Values are declared in <code>rgba</code> so that those colors don’t have to be redefined in night modes.</p>
402-
403-
<p>At first sight, contrast is OK for those colors in default and night mode, but it will obviously depend on the <code>background-color</code> and <code>color</code> values you’re using for themes.</p>
404-
</section>
405-
406-
<section id="media-overlays" class="level3">
407-
<h3 class="sigil_not_in_toc">Media Overlays</h3>
408-
409-
<p>We’re using the same one as Readium 1 for interop reasons.</p>
410-
411-
<pre><code>.readiumCSS-mo-active-default {
412-
background-color: yellow !important;
413-
color: black !important;
414-
}</code></pre>
415-
416-
<p>It has been prefixed with <code>readiumCSS-</code> but you can get rid of it if needed.</p>
417-
</section>
418-
419-
<section id="os-a11y-modes" class="level3">
420-
<h3 class="sigil_not_in_toc">OS’ a11y modes</h3>
421-
422-
<p>This stylesheet is intended to deal with a11y settings users can set at the OS level, whenever possible:</p>
423-
424-
<ul>
425-
<li>high-contrast mode;</li>
380+
<ul>
381+
<li>high-contrast mode;</li>
426382

427-
<li>inverted colors;</li>
383+
<li>inverted colors;</li>
428384

429-
<li>monochrome;</li>
385+
<li>monochrome;</li>
430386

431-
<li>reduced motion.</li>
432-
</ul>
387+
<li>reduced motion.</li>
388+
</ul>
433389

434-
<p>For <code>monochrome</code>, we’ll have to adjust reading modes (night, sepia, etc.) in their specific stylesheet; we’ll see if we can at least manage some more global settings in there.</p>
435-
</section>
390+
<p>For <code>monochrome</code>, we’ll have to adjust reading modes (night, sepia, etc.) in their specific stylesheet; we’ll see if we can at least manage some more global settings in there.</p>
436391
</section>
437392
</section>
438393
</body>

docs/ReadiumCSS_docs/OEBPS/Text/nav.xhtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@
169169
<a href="../Text/Section-008.xhtml#sigil_toc_id_58">Default</a>
170170
</li>
171171
<li>
172-
<a href="../Text/Section-008.xhtml#sigil_toc_id_134">User highlights and media overlays</a>
172+
<a href="../Text/Section-008.xhtml#sigil_toc_id_134">OS’ a11y modes</a>
173173
</li>
174174
</ol>
175175
</li>

docs/ReadiumCSS_docs/OEBPS/content.opf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
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">2020-04-30T19:10:46Z</meta>
11+
<meta property="dcterms:modified">2020-06-03T19:52:07Z</meta>
1212
<meta content="0.9.5" name="Sigil version"/>
1313
<meta property="schema:accessibilityFeature">displayTransformability</meta>
1414
<meta property="schema:accessibilityFeature">readingOrder</meta>

0 commit comments

Comments
 (0)