Skip to content

Commit

Permalink
Merge pull request #46 from edrlab/contents-updates
Browse files Browse the repository at this point in the history
Contents updates
  • Loading branch information
gautierchomel authored Aug 10, 2023
2 parents c4f26b7 + 6480b67 commit 1ed9313
Show file tree
Hide file tree
Showing 19 changed files with 187 additions and 67 deletions.
4 changes: 2 additions & 2 deletions content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h2>Thorium Reader</h2>
{{< blocks/section color="dark" >}}
{{% blocks/feature icon="fa-download" title="Download" %}}

Version 2.3.0, released in July 2022.
Version 2.3.0, released in July 2023.

<ul>
<li class="listnone"> <a class="orange" href="https://bit.ly/thoriumreader-en">For Windows 11 on the Windows Store</a>.</li>
Expand All @@ -54,7 +54,7 @@ <h2>Thorium Reader</h2>
<li class="listnone">Touch screen finger swipe.</li>
<li class="listnone">Image zoom.</li>
<li class="listnone">MathML native rendering.</li>
<li class="listnone">Left/right/justify text alignement .</li>
<li class="listnone">Left/right/justify text alignment.</li>
<li class="listnone">OPDS display of accessibility metadata.</li>
<li class="listnone">Double-click for text selection.</li>
<li class="listnone">Translations: Bulgarian, Greek, Croatian, Korean, Portuguese (Portugal).</li>
Expand Down
20 changes: 20 additions & 0 deletions content/en/docs/210_reading/212_ImageZoom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Zooming on images"
description: ""
draft: false
weight: 213
toc: false
---
Since 2.3, Thorium has an image zoom feature (epub only).

To zoom on an image you can select the image (a magenta focus outline will appear around it) and activate zoom by clicking with the mouse or tapping it with the finger. Access to image zoom via keyboard is currently not possible.

If the image is also a link or if the book your read is in a fixed layout format, you will need to hit the <kbd>Shift</kbd> key in order to enter the image zoom feature.

To zoom in or out, tab to the `+` or `-` buttons and hit <kbd>enter</kbd>, use mouse wheel, scroll up and down or pinch and stretch trackpad or onscreen touch gestures.

Once the image is zoomed you can move vertically and horizontally with <kbd>&larr;</kbd>, <kbd>&rarr;</kbd>, <kbd>&uarr;</kbd> and <kbd>&darr;</kbd>, by moving mouse while maintaining clic, with usual trackpad gestures or with finger moves on tactile screens.

To close the image zoom view and to return to the reading view, press <kbd>ESC</kbd> key, or the X button.

Some restrictions due to ebook design may apply, for example when images are inserted as style (CSS), it is not possible to open the image view for zooming.
2 changes: 1 addition & 1 deletion content/en/docs/210_reading/213_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Search in a book"
description: ""
draft: false
weight: 213
weight: 214
toc: false
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/210_reading/214_bookmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Mark a page or a passage"
description: ""
draft: false
weight: 214
weight: 215
toc: false
---

Expand Down
6 changes: 4 additions & 2 deletions content/en/docs/210_reading/215_ReadingParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
title: "Reading settings"
description: ""
draft: false
weight: 214
weight: 216
toc: false
---

In the reading interface use the `Preferences` button (<img class="icons" src="/images/icons/font-size.svg" alt="" width="20px">): the following options are revealed.
In the reading interface use the `Preferences` button (<img class="icons" src="/images/icons/font-size.svg" alt="" width="20px">): the options are revealed.

{{< alert info >}}
Reading settings can be saved or reset by using buttons `Save` and `Reset` located in the menu `Settings`, submenu `Configuration` of the Reading window.
{{< /alert >}}

Major settings are available for EPUB Reflowable, Fixed Layout EPUBs and PDF formats just don't allow personalisation of appearance. Most Fixed Layout EPUBs will allow to open Image view for zooming on a page. PDFs can be enlarged using the Zoom sub-menu in the Preferences panel.
## Theme

The color of the background and foreground can be changed using one of the three
Expand Down
26 changes: 15 additions & 11 deletions content/en/docs/210_reading/221_maths.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ draft: false
weight: 221
toc: false
---
Thorium-Reader supports mathematical formulas in MathML
format thanks to the MathJax module. This last one requires memory resources
Since 2.3 Thorium Reader supports mathematical formulas in MathML natively thanks to Chromium.
MathJax module is incorporated and may be of use for interoperability and accessibility needs.

If you make use of the MathJax module you might be interested by [MathJax documentation](https://docs.mathjax.org/en/latest/).

Previous versions rely on the MathJax module. This last one requires memory resources
so it is not automatically activated when you open Thorium.
To activate it when reading a book, go to the
menu `Reading settings`, at the bottom of the `Display` tab you will find
Expand Down Expand Up @@ -42,15 +46,15 @@ Copy: Use the Copy mode to Copy MathML object source code.

Navigation mode commands:

* "Down Arrow": Zoom in on a smaller subpart of the math content.
* "Up Arrow": Zoom out to a larger sub-part of the math content.
* "Left Arrow": Move to the previous math content.
* "Right Arrow": Move to the next math content.
* "Home": Move back to the top of the Entire math content.
* "Ctrl + c": Copy object MathML source code
* "Numpad 1to 9": Reading the math content into serialized text using NVDA Review Text.
* "Escape": Exit the navigation mode.
* "Ctrl + Alt + m": Switch the provider between Access8Math and Math Player.
* <kbd>Down Arrow</kbd>: Zoom in on a smaller subpart of the math content.
* <kbd>Up Arrow</kbd>: Zoom out to a larger sub-part of the math content.
* <kbd>Left Arrow</kbd>: Move to the previous math content.
* <kbd>Right Arrow</kbd>: Move to the next math content.
* <kbd>Home</kbd>: Move back to the top of the Entire math content.
* <kbd>Ctrl</kbd> + <kbd>c</kbd>: Copy object MathML source code
* <kbd>Numpad 1 to 9</kbd>: Reading the math content into serialized text using NVDA Review Text.
* <kbd>Escape</kbd>: Exit the navigation mode.
* <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>m</kbd>: Switch the provider between Access8Math and Math Player.

{{< /details >}}

Expand Down
35 changes: 35 additions & 0 deletions content/en/docs/210_reading/230_TTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "Text to Speech (TTS)"
description: ""
draft: false
weight: 230
toc: false
---

{{< alert danger >}}

Thorium 2.3 TTS reads page numbers by default which might result in a too verbose earing experience. The `skipability` option in `readaloud` parameter does not affect TTS reading as expected. This is fixed in [2.4 alpha continuous test build](https://github.com/edrlab/thorium-reader/releases) and will be shipped in 2.4 release.

{{< /alert>}}

Text-to-speech is launched using the speaker button in the middle of the toolbar,
or by using the keyboard shortcut <kbd>Ctrl</kbd> + <kbd>2</kbd>.

* Play and pause can be controlled with the keyboard shortcut
<kbd>Ctrl</kbd> + <kbd>2</kbd>.

* The playback position can be moved with <kbd>Ctrl</kbd> + <kbd>1</kbd>
and <kbd>Ctrl</kbd> + <kbd>3</kbd> for previous and next respectively.

* A speed control is available when read aloud
is selected, with a range from x0.5 to x2.

* The current sentence is highlighted in light yellow, and each word spoken is
underlined in orange.

* An alternative (simplified) view of the publication is provided through
options available in the `Settings / Readaloud` menu.

{{< alert info >}}
Thorium uses the voices from the computer's operating system, in combination with the language information provided by the book. If you experience problems please check the related FAQ entry [I can't select the adequate voice for read aloud function (TTS)](/docs/400_ressources/430_faq#TTSvoices).
{{< /alert>}}
22 changes: 1 addition & 21 deletions content/en/docs/300_accessibility/310_natives.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,4 @@ or PDF files.

## Text-to-Speech (TTS)

Text-to-speech is launched using the speaker button in the middle of the toolbar,
or by using the keyboard shortcut <kbd>Ctrl</kbd> + <kbd>2</kbd>.

* Play and pause can be controlled with the keyboard shortcut
<kbd>Ctrl</kbd> + <kbd>2</kbd>.

* The playback position can be moved with <kbd>Ctrl</kbd> + <kbd>1</kbd>
and <kbd>Ctrl</kbd> + <kbd>3</kbd> for previous and next respectively.

* A speed control is available when read aloud
is selected, with a range from x0.5 to x2.

* The current sentence is highlighted in light yellow, and each word spoken is
underlined in orange.

* An alternative (simplified) view of the publication is provided through
options available in the `Settings / Readaloud` menu.

{{< alert info >}}
Thorium uses the voices from the computer's operating system, in combination with the language information provided by the book. If you experience problems please check the related FAQ entry [I can't select the adequate voice for read aloud function (TTS)](/docs/400_ressources/430_faq#TTSvoices).
{{< /alert>}}
See dedicated section about [Text to Speech (TTS)](/docs/210_reading/230_TTS/).
20 changes: 20 additions & 0 deletions content/en/docs/400_ressources/403_gesture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Tactile gestures"
description: ""
draft: true
images: [logo.png]
weight: 403
toc: false
---
Thorium Reader has limited onscreen touch gesture control. They are mainly implemented for Image zoom control and turning pages. Some native operating system gestures may also work.

The following table repertories the known working gestures so far.

|Gestures|Context|Action|
|---|---|---|
|Tap|All views|Activate button|
|Tap then select and move cursors|On text|Select text|
|Place one finger on the screen and slide horizontally or vertically|Reading in scrollable layout|Scroll|
|Place one finger on the screen and slide horizontally|Reading in paginated layout|Turn page|
|Place fingers on the screen and pinch in or stretch out|Image zoom view|Zoom in or out|
|Press and hold|All views|Show more commands (like right-clicking)|
2 changes: 1 addition & 1 deletion content/fr/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h2>Thorium Reader</h2>
{{< blocks/section color="dark" >}}
{{% blocks/feature icon="fa-download" title="Télécharger" %}}

Version 2.3.0, publiée en juillet 2022.
Version 2.3.0, publiée en juillet 2023.

<ul id="download">
<li class="listnone"> <a class="orange" href="https://bit.ly/thoriumreader-en">Windows 11 (Windows Store)</a></li>
Expand Down
20 changes: 20 additions & 0 deletions content/fr/docs/210_reading/212_ImageZoom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Zoomer sur les images"
description: ""
draft: false
weight: 213
toc: false
---
Depuis la version 2.3, Thorium dispose d'une fonction de zoom sur les images (dans les epub seulement).

Pour zoomer sur une image, vous pouvez sélectionner l'image (un contour magenta apparaît autour de l'image) et activer le zoom en cliquant avec la souris ou en tapant avec le doigt. L'accès au zoom sur l'image par le clavier n'est pas possible pour l'instant.

Si l'image est également un lien ou si le livre que vous lisez est dans un format de mise en page fixe, vous devrez cliquer en appuyant sur la touche <kbd>Shift</kbd> pour accéder à la fonction de zoom de l'image.

Pour effectuer un zoom avant ou arrière, cliquez sur les boutons `+` ou `-` et appuyez sur <kbd>enter</kbd>, utilisez la molette de la souris, le défilement haut et bas ou les gestes de pincement et d'étirement sur le pavé ou l'écran tactile.

Une fois l'image zoomée, vous pouvez vous déplacer verticalement et horizontalement avec <kbd>&larr;</kbd>, <kbd>&rarr;</kbd>, <kbd>&uarr;</kbd> et <kbd>&darr;</kbd>, en déplaçant la souris tout en maintenant le clic, ou faites glisser votre doigt sur le pavé ou l'écran tactile.

Pour fermer la vue "zoom image" et revenir à la vue de lecture, appuyez sur la touche <kbd>ESC</kbd> ou sur le bouton `X`.

Certaines restrictions liées à la conception des livres électroniques peuvent s'appliquer, par exemple lorsque les images sont insérées en tant que style (css).
2 changes: 1 addition & 1 deletion content/fr/docs/210_reading/213_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Faire une recherche dans un livre"
description: ""
draft: false
weight: 213
weight: 214
toc: false
---

Expand Down
2 changes: 1 addition & 1 deletion content/fr/docs/210_reading/214_bookmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Marquer une page ou un passage"
description: ""
draft: false
weight: 214
weight: 215
toc: false
---

Expand Down
6 changes: 4 additions & 2 deletions content/fr/docs/210_reading/215_ReadingParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@
title: "Paramètres de lecture"
description: ""
draft: false
weight: 214
weight: 216
toc: false
---
Dans l'interface de lecture utilisez le bouton `Préférences`
(<img class="icons" src="/images/icons/font-size.svg" alt="" width="20px">)
: en cliquant sur ce bouton, les options suivantes sont révélées.
: en cliquant sur ce bouton, les options sont révélées.

{{< alert info >}}

Les paramétres de lecture peuvent être sauvegardés et réinitialisés depuis la fenétre de lecture via les boutons `Sauvegarder` et `Réinitialiser` qui se situent dans le sous menu `Configuration` du menu `Préférences`.

{{< /alert >}}

Les principaux paramètres de personnalisation sont disponibles pour les EPUB adaptable (Reflowable), les EPUB à mise en page fixe et les formats PDF ne permettent tout simplement pas de personnaliser l'apparence. La plupart des EPUB à mise en page fixe permettent d'ouvrir une vue d'image pour zoomer sur une page. Les PDF peuvent être agrandis via le sous menu `Zoom` du menu `préférences`.
## Thème
La couleur de l'arrière-plan et du premier plan peut être modifiée en utilisant
l'un des trois thèmes disponibles - Neutre, Sépia et Nuit.
Expand Down
6 changes: 4 additions & 2 deletions content/fr/docs/210_reading/221_maths.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ draft: false
weight: 221
toc: false
---
Depuis la version 2.3, Thorium Reader supporte nativement les formules mathématiques en MathML grâce à Chromium.
Un module MathJax est incorporé et peut être utile pour les besoins d'interopérabilité et d'accessibilité.

Si vous utilisez le module MathJax, vous serez peut-être intéressé par la [documentation MathJax (en anglais)](https://docs.mathjax.org/en/latest/).

Thorium-Reader prend en charge les formules mathématiques au format MathML
grace au module MathJax. Ce dernier nécessitant des ressources mémoires
Les versions précédentes s'appuient sur le module MathJax. Ce dernier nécessitant des ressources mémoires
il n'est pas activé d'office lorsque vous ouvrez Thorium.
Pour l'activer lors de la lecture d'un livre allez dans le menu
`Paramétres de lecture`, en bas de l'onglet `Affichage` vous trouverez
Expand Down
35 changes: 35 additions & 0 deletions content/fr/docs/210_reading/230_TTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "Synthèse vocale (TTS)"
description: ""
draft: false
weight: 230
toc: false
---

{{< alert danger >}}

Thorium 2.3 TTS lit les numéros de page par défaut, ce qui peut entraîner une expérience d'écoute trop verbeuse. L'option `skipability` dans le paramètre `readaloud` n'affecte pas la lecture TTS comme prévu. Ce problème a été corrigé dans la [2.4 alpha continuous test build] (https://github.com/edrlab/thorium-reader/releases) et sera intégré à la version 2.4.

{{< /alert>}}

La synthèse vocale est lancée à l'aide du bouton haut-parleur au milieu de la
barre d'outils, ou à l'aide du raccourci clavier <kbd>Ctrl</kbd> + <kbd>2</kbd>.

* La lecture et la pause peuvent être contrôlées avec le raccourci clavier
<kbd>Ctrl</kbd> + <kbd>2</kbd>.

* La position de lecture peut être déplacée avec <kbd>Ctrl</kbd> + <kbd>1</kbd>
et <kbd>Ctrl</kbd> + <kbd>3</kbd> pour, respectivement, précédent et suivant.

* Un contrôle de la vitesse est disponible lorsque la lecture à haute voix
est sélectionnée, avec une plage allant de x0,5 à x2.

* La phrase en cours est surlignée en jaune pâle, et chaque mot prononcé est
souligné en orange.

* Une vue alternative (simplifiée) de la publication est fournie par le biais
des options disponible dans le menu `Paramètres / Readaloud`.

{{< alert info >}}
Thorium utilise les voix du système d'exploitation de l'ordinateur, en combinaison avec les informations linguistiques fournies par le livre. Si vous rencontrez des problèmes, veuillez consulter l'entrée correspondante de la section questions fréquentes [Je ne peux pas sélectionner la voix adéquate pour la fonction de lecture à haute voix (TTS)](/docs/400_ressources/430_faq#TTSvoicesFR)
{{< /alert>}}
22 changes: 1 addition & 21 deletions content/fr/docs/300_accessibility/310_natives.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,24 +40,4 @@ ou les fichiers PDF.

## Synthèse vocale (TTS)

La synthèse vocale est lancée à l'aide du bouton haut-parleur au milieu de la
barre d'outils, ou à l'aide du raccourci clavier <kbd>Ctrl</kbd> + <kbd>2</kbd>.

* La lecture et la pause peuvent être contrôlées avec le raccourci clavier
<kbd>Ctrl</kbd> + <kbd>2</kbd>.

* La position de lecture peut être déplacée avec <kbd>Ctrl</kbd> + <kbd>1</kbd>
et <kbd>Ctrl</kbd> + <kbd>3</kbd> pour, respectivement, précédent et suivant.

* Un contrôle de la vitesse est disponible lorsque la lecture à haute voix
est sélectionnée, avec une plage allant de x0,5 à x2.

* La phrase en cours est surlignée en jaune pâle, et chaque mot prononcé est
souligné en orange.

* Une vue alternative (simplifiée) de la publication est fournie par le biais
des options disponible dans le menu `Paramètres / Readaloud`.

{{< alert info >}}
Thorium utilise les voix du système d'exploitation de l'ordinateur, en combinaison avec les informations linguistiques fournies par le livre. Si vous rencontrez des problèmes, veuillez consulter l'entrée correspondante de la section questions fréquentes [Je ne peux pas sélectionner la voix adéquate pour la fonction de lecture à haute voix (TTS)](/docs/400_ressources/430_faq#TTSvoicesFR)
{{< /alert>}}
Voir la section dédiée [Synthèse vocale (TTS)](/docs/210_reading/230_TTS/).
19 changes: 19 additions & 0 deletions content/fr/docs/400_ressources/403_gesture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Gestes tactiles"
description: ""
draft: true
images: [logo.png]
weight: 403
toc: false
---
Thorium Reader dispose d'une prise en charge limitée des gestes tactiles à l'écran. Ils sont principalement implémentés pour le contrôle du zoom de l'image et pour tourner les pages. Certains gestes natifs du système d'exploitation peuvent également fonctionner.
Le tableau suivant répertorie les gestes connus qui fonctionnent jusqu'à présent.

|Gestes|Contexte|Action|
|---|---|---|
|Appuyer sur le bouton|Toutes les vues|Active le bouton|
|Appuyer puis sélectionnez et déplacez les curseurs|Sur le texte|Sélectionne le texte|
|Placer un doigt sur l'écran et faire glisser horizontalement ou verticalement|Disposition défilé|Défilement|
|Placer un doigt sur l'écran et faire glisser horizontalement|Disposition paginée|Tourner la page|
|Placer deux doigts sur l'écran et pincer ou étirer|Vue zoom de l'image|Zoomer ou dézoomer|
|Appuyer et maintenir|Toutes les vues|Afficher d'autres commandes (équivalent au clic droit)|
3 changes: 2 additions & 1 deletion layouts/partials/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
{{ end }}
</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2 text-white">
{{ with .Site.Params.copyright }}<small class="text-white">&copy; {{ now.Year}} {{ .}} {{ T "footer_all_rights_reserved" }}</small>{{ end }}
<!-- {{ with .Site.Params.copyright }}<small class="text-white">&copy; {{ now.Year}} {{ .}} {{ T "footer_all_rights_reserved" }}</small>{{ end }} -->
<small class="text-white">© 2023 <a href="https://edrlab.org">EDRLab </a><a href="http://www.apache.org/licenses/LICENSE-2.0"></a>Apache-2.0 license </small>
<br/>
{{ with .Site.Params.privacy_policy }}<small class="ml-1"><a class="orange"href="{{ . }}">{{ T "footer_privacy_policy" }}</a></small>{{ end }}
| {{ with .Site.Params.accessibility }} <small class="ml-1"><a class="orange"href="{{ . }}">{{ T "footer_accessibility" }}</a></small>{{ end }}
Expand Down

0 comments on commit 1ed9313

Please sign in to comment.