[WIP] Added text to speech 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]>
organicmaps · Sep 16, 2023 · 6ee4708 · 6ee4708
1 parent 564b53c
commit 6ee4708
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 1 deletion.
diff --git a/content/_index.md b/content/_index.md
@@ -111,3 +111,7 @@ Organic Maps is an [open-source software][github] licensed under the Apache Lice
 [fork]: https://en.wikipedia.org/wiki/Fork_(software_development)
 
 {{ references() }}
+
+## FAQ
+
+{{ tts_instructions() }}
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/shortcodes/tts_instructions.html b/templates/shortcodes/tts_instructions.html
@@ -0,0 +1,65 @@
+<h2>Text-to-speech output on Android</h2>
+<p>No tracking, no ads, no data collection, no spyware</p>
+
+<p>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.</p>
+
+<p>You can use a third-party Text-to-speech engine which can be downloaded from Google Play or F-Droid.</p>
+
+<p><a href="https://rhvoice.org/">RHVoice</a> is a free and open source speech engine which can be downloaded from <a href="https://play.google.com/store/apps/details?id=com.github.olga_yakovleva.rhvoice.android">Google Play</a> and <a href="https://f-droid.org/en/packages/com.github.olga_yakovleva.rhvoice.android/">F-Droid</a>.</p>
+
+<h2>Instructions</h2>
+
+<ol>
+  <li>Open the Settings app on your Android device.</li>
+  <li>Select Additional Settings and then select Accessibility.</li>
+  <li>Choose your preferred engine, speech rate and pitch.</li>
+</ol>
+
+<p>If you cannot find the setting, open the settings app and search for Text-to-speech.</p>
+
+<p>The option may not appear if you don't have a TTS installed on your device. Please install Google Speech Services from the <a href="https://play.google.com/store/apps/details?id=com.google.android.tts">Play Store</a>, which is used by many devices or you can install a third party one such as <a href="https://play.google.com/store/apps/details?id=com.github.olga_yakovleva.rhvoice.android">RHVoice</a></p>
+
+<h2>Screenshots</h2>
+
+<table>
+    <tr>
+      <th></th>
+      <th></th>
+      <th></th>
+    </tr>
+    <tr>
+      <td><img src='/images/screenshots/tts_config_1.jpg' width='400' alt='Screenshot 1'></td>
+      <td><img src='/images/screenshots/tts_config_2.jpg' width='400' alt='Screenshot 2'></td>
+      <td><img src='/images/screenshots/tts_config_3.jpg' width='400' alt='Screenshot 3'></td>
+    </tr>
+</table>  
+
+<h2>Custom ROM Workaround</h2>
+
+<p>You may try this workound to make RHVoice TTS engine work on LineageOS (a degoogled custom rom)</p>
+
+<p>Often RHVoice doesn't get initialized properly and app itself might be crashing. Mostly in cases where you haven't used any TTS engine on your phone yet (new installations etc)</p>
+
+<p>If you use custom rom like Lineageos without Google Play services & Speech Services by Google and want to use RHVoice as your preferred TTS engine, please follow workaround instructions below:</p>
+
+<ol>
+  <li>Install <a href="https://f-droid.org/en/packages/com.reecedunn.espeak">eSpeak TTS engine</a> available on F-Droid</li>
+  <li>Set it as the preferred engine
+    <ol type="a">
+      <li>Go to Lineage os main Settings.</li>
+      <li>Scroll down to Accessibility.</li>
+      <li>Select text-to-speech output (below SCREEN READERS) and Preferred engine (left side) and make sure eSpeak is selected.</li>
+    </ol>
+  </li>
+  <li>Go back and press play to see if it's working</li>
+  <li>Install <a href="https://f-droid.org/en/packages/com.github.olga_yakovleva.rhvoice.android/">RHVoice</a> available on F-droid.
+    <ol type="a">
+      <li>Open it, select the language you want to use, tap on the cloud icon (far left) to download voices.</li>
+      <li>Press play button to verify if it's working</li>
+    </ol>
+  </li>
+  <li>Set RHVoice as preferred engine (see step 2)</li>
+  <li>Now, you should be able to use RHVoice without any problems</li>
+</ol>
+
+<p><em>In order to hear voice instructions you have to actually move around to receive any voice output, OrganicMaps will not give you any voice institutions while you're still.</em></p>