Add proper FAQ page and TTS instructions

Signed-off-by: meenbeese <[email protected]> Create text-to-speech.md Signed-off-by: meenbeese <[email protected]> Update text-to-speech.md Signed-off-by: meenbeese <[email protected]> Add files via upload Signed-off-by: meenbeese <[email protected]> added 3rd image Signed-off-by: vachan-maker [email protected] Signed-off-by: meenbeese <[email protected]> Update text-to-speech.md Signed-off-by: meenbeese <[email protected]> added rhvoice Signed-off-by: meenbeese <[email protected]> Update text-to-speech.md Signed-off-by: meenbeese <[email protected]> Update text-to-speech.md Signed-off-by: meenbeese <[email protected]> added lineageos instructions for tts Signed-off-by: meenbeese <[email protected]> made small changes Signed-off-by: meenbeese <[email protected]> Update text-to-speech.md Signed-off-by: meenbeese <[email protected]> Update text-to-speech.md Signed-off-by: meenbeese <[email protected]> [WIP] Added text to speech instructions Signed-off-by: meenbeese <[email protected]> Add faq to top bar and use md Signed-off-by: meenbeese <[email protected]> Minor rewording and grammar fixes Signed-off-by: meenbeese <[email protected]>
organicmaps · Sep 24, 2023 · 0d268f2 · 0d268f2
1 parent 564b53c
commit 0d268f2
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 3 deletions.
diff --git a/content/_index.md b/content/_index.md
@@ -110,4 +110,4 @@ Organic Maps is an [open-source software][github] licensed under the Apache Lice
 
 [fork]: https://en.wikipedia.org/wiki/Fork_(software_development)
 
-{{ references() }}
+{{ references() }}
diff --git a/content/faq/index.md b/content/faq/index.md
@@ -0,0 +1,61 @@
+---
+title: Text-to-Speech on Android
+description: Guide on how to make TTS work on Android
+weight: 100
+extra:
+ menu_title: FAQ
+---
+
+TLDR:
+
+Organic Maps uses the system text-to-speech (TTS) engine for voice instructions. The default engines vary by device. The choices can include Google Text-to Speech, device manufacturer's engine or a third-party one. 
+
+You can use a third-party Text-to-speech engine which can be downloaded from Google Play or F-Droid. 
+
+[RHVoice](https://rhvoice.org/) is a free and open source speech engine which can be downloaded from [Google Play](https://play.google.com/store/apps/details?id=com.github.olga_yakovleva.rhvoice.android) and [F-Droid](https://f-droid.org/en/packages/com.github.olga_yakovleva.rhvoice.android/).
+
+## Instructions
+
+- Open the Settings app on your Android device.
+- Select Additional Settings and then select Accessibility.
+- Choose your preferred engine, speech rate and pitch.
+
+If you cannot find the relevant setting, open the settings app and search for Text-to-speech.
+
+P.S: Do note that these steps may vary based on the phone brand you are using.
+
+The option may not appear if you don't have a TTS installed on your device. Please install Google Speech Services from the [Play Store](https://play.google.com/store/apps/details?id=com.google.android.tts), which is used by many devices or you can install a FOSS third party one such as [RHVoice](https://play.google.com/store/apps/details?id=com.github.olga_yakovleva.rhvoice.android) from F-Droid.
+
+## Screenshots
+
+| | | |
+| ----------- | ----------- | ----------- |
+| <img src='/images/screenshots/tts_config_1.jpg' width='400' alt='Screenshot 1'> | <img src='/images/screenshots/tts_config_2.jpg' width='400' alt='Screenshot 2'> | <img src='/images/screenshots/tts_config_3.jpg' width='400' alt='Screenshot 3'> |
+
+## Workarounds
+
+If you’re having trouble initializing the RHVoice TTS engine on LineageOS or other custom ROMs, try this workaround. RHVoice may not initialize properly and the app may crash, especially if you haven’t used any TTS engine on your phone before (e.g., new installation, factory reset, etc.). If you’re using a custom ROM like LineageOS <ins>without Google Play services and Speech Services by Google</ins>, and you want to use RHVoice as your preferred TTS engine, follow the instructions below as a workaround:
+
+- Install the [eSpeak TTS engine](https://f-droid.org/en/packages/com.reecedunn.espeak) available on F-Droid
+
+- Set it as the preferred system engine
+
+ - Go to LineageOS main **Settings**.
+
+ - Scroll down to **Accessibility**.
+
+ - Select **text-to-speech output** and **Preferred engine** (left side) and make sure **eSpeak** is selected.
+
+- Go back and press **play** to see if it is working
+
+- Install [RHVoice](https://f-droid.org/en/packages/com.github.olga_yakovleva.rhvoice.android/) available on F-droid.
+
+ - Open it, select the language you want to use, tap on the cloud icon (far left) to download voices.
+
+ - Press play button to verify if it is working
+
+- Set **RHVoice** as preferred engine (see step 2)
+
+- Now, you should be able to use RHVoice without any problems
+
+*In order to hear voice instructions you have to actually start a navigation to receive any voice output, Organic Maps will not give you any voice instructions while you're standing still.*
diff --git a/sass/main.scss b/sass/main.scss
@@ -114,7 +114,7 @@ footer {
  }
 }
 
-@media (width <= 768px) {
+@media (max-width: 768px) {
  #badges {
  flex-direction: column;
  }

diff --git a/static/images/screenshots/tts_config_1.jpg b/static/images/screenshots/tts_config_1.jpg
diff --git a/static/images/screenshots/tts_config_2.jpg b/static/images/screenshots/tts_config_2.jpg
diff --git a/static/images/screenshots/tts_config_3.jpg b/static/images/screenshots/tts_config_3.jpg
diff --git a/templates/top_menu.html b/templates/top_menu.html
@@ -8,7 +8,8 @@
  {% for page in [
  get_section(path="news/_index.md"),
  get_page(path="donate/index.md"),
- get_page(path="support-us/index.md")
+ get_page(path="support-us/index.md"),
+ get_page(path="faq/index.md")
  ] %}
  {% set translated = page.translations | filter(attribute='lang', value=lang) | first %}
  {% if translated %}