organicmaps/website
13
Fork 1
Code Issues 31 Pull requests 8 Projects Releases Wiki Activity Actions

[WIP] Added text to speech instructions #171

Closed
meenbeese wants to merge 1 commit from tts-instructions into master
pull from: tts-instructions
merge into: organicmaps:master
Conversation 7 Commits 1 Files changed 8 +172 -2
meenbeese commented 2023-09-16 22:37:03 +00:00 (Migrated from github.com)
Copy link

Revives the TTS PR by improving upon it. The current solution that I managed to implement is not final and should be iterated before merging. The FAQ living in the main page is not ideal because it should be in the header bar and in its own page instead so it can be linked easily from the main app.

I know that this is a PR that stalled for too long and is important for many issues to be resolved in Organic Maps. Can you take a look so we can discuss/make the necessary improvements and merge it as soon as possible @biodranik ?

Closes #6
Closes #32
Closes #115

Revives the TTS PR by improving upon it. The current solution that I managed to implement is not final and should be iterated before merging. The FAQ living in the main page is not ideal because it should be in the header bar and in its own page instead so it can be linked easily from the main app. I know that this is a PR that stalled for too long and is important for many issues to be resolved in Organic Maps. Can you take a look so we can discuss/make the necessary improvements and merge it as soon as possible @biodranik ? Closes #6 Closes #32 Closes #115
biodranik (Migrated from github.com) reviewed 2023-09-16 22:37:03 +00:00
biodranik commented 2023-09-16 23:56:55 +00:00 (Migrated from github.com)
Copy link

Html file in shortcodes doesn't look right. How it should be translated? Let's create a faq section first, and add it into the top menu.

Html file in shortcodes doesn't look right. How it should be translated? Let's create a faq section first, and add it into the top menu.
meenbeese commented 2023-09-17 02:17:14 +00:00 (Migrated from github.com)
Copy link

Html file in shortcodes doesn't look right.

I agree with you. The reason I went with html is because I kept getting weird errors with markdown that I couldn’t resolve and html was much easier to work with.

How it should be translated? Let's create a faq section first, and add it into the top menu.

This makes a lot of sense. In that case, should I incorporate the work from #115 into this PR too? There is no need to duplicate all that work that was already done.

> Html file in shortcodes doesn't look right. I agree with you. The reason I went with html is because I kept getting weird errors with markdown that I couldn’t resolve and html was much easier to work with. > How it should be translated? Let's create a faq section first, and add it into the top menu. This makes a lot of sense. In that case, should I incorporate the work from #115 into this PR too? There is no need to duplicate all that work that was already done.
biodranik commented 2023-09-17 05:38:49 +00:00 (Migrated from github.com)
Copy link

What kind of weird errors did you get with markdown?

Yes, you can incorporate changes from that pr. But we need a separate section, not a single FAQ page. See #6

What kind of weird errors did you get with markdown? Yes, you can incorporate changes from that pr. But we need a separate section, not a single FAQ page. See #6
meenbeese commented 2023-09-17 20:52:27 +00:00 (Migrated from github.com)
Copy link

What kind of weird errors did you get with markdown?

I get this error when trying to call the screenshots function from markdown:
Error: Failed to build the site Error: Failed to render content of \\?\C:\Users\meenbeese\OneDrive\Documents\GitHub\organicmaps.github.io\content\_index.md Error: Reason: Failed to render tts_testing shortcode Error: Reason: Failed to render 'shortcodes/tts_testing.md' Error: Reason: Function 'screenshot' not found

And when I remove the function call to integrate them directly into md, they don't render at all.
I don't have any of these problems with HTML so I think I will use that for the PR.

Yes, you can incorporate changes from that pr. But we need a separate section, not a single FAQ page. See #6

You mean like adding it to the top bar, right? If so, I will start working on that now.
Screenshot 2023-09-17 165100

Do you have an idea of where it would be best to add it? Before the news, or after Github for example?

> What kind of weird errors did you get with markdown? I get this error when trying to call the screenshots function from markdown: `Error: Failed to build the site Error: Failed to render content of \\?\C:\Users\meenbeese\OneDrive\Documents\GitHub\organicmaps.github.io\content\_index.md Error: Reason: Failed to render tts_testing shortcode Error: Reason: Failed to render 'shortcodes/tts_testing.md' Error: Reason: Function 'screenshot' not found` And when I remove the function call to integrate them directly into md, they don't render at all. I don't have any of these problems with HTML so I think I will use that for the PR. > Yes, you can incorporate changes from that pr. But we need a separate section, not a single FAQ page. See #6 You mean like adding it to the top bar, right? If so, I will start working on that now. ![Screenshot 2023-09-17 165100](https://github.com/organicmaps/organicmaps.github.io/assets/114044633/f6b8ebdc-5a0b-44c9-b0c9-88ae0b9024d6) Do you have an idea of where it would be best to add it? Before the news, or after Github for example?
meenbeese commented 2023-09-18 02:20:49 +00:00 (Migrated from github.com)
Copy link

Never mind the previous errors as I figured out how to implement it using HTML. The only thing needed now is the taxonomy you mentioned previously in a linked issue so that every FAQ question has its own markdown file. Then, it will be easier to add several different FAQ titles, translate them and link them from the main app as necessary.

Screenshot 2023-09-17 223151

Never mind the previous errors as I figured out how to implement it using HTML. The only thing needed now is the taxonomy you mentioned previously in a linked issue so that every FAQ question has its own markdown file. Then, it will be easier to add several different FAQ titles, translate them and link them from the main app as necessary. ![Screenshot 2023-09-17 223151](https://github.com/organicmaps/organicmaps.github.io/assets/114044633/57c950ce-74bf-4637-b2ad-63aaf7f1394c)
biodranik (Migrated from github.com) reviewed 2023-09-19 20:50:15 +00:00
biodranik (Migrated from github.com) left a comment
Copy link

It would be great to preview it! Hint: provide a branch preview link instead of a commit link, it will be automatically updated after any changes.

It would be great to preview it! Hint: provide a branch preview link instead of a commit link, it will be automatically updated after any changes.
content/faq/index.md
biodranik (Migrated from github.com) commented 2023-09-19 20:45:55 +00:00
Copy link

Simple tables are supported in markdown syntax, check templates/shortcodes/crypto_table.md

Simple tables are supported in markdown syntax, check templates/shortcodes/crypto_table.md
biodranik (Migrated from github.com) commented 2023-09-19 20:46:33 +00:00
Copy link

ROM here and in other places.

ROM here and in other places.
biodranik (Migrated from github.com) commented 2023-09-19 20:47:59 +00:00
Copy link

It would be great to mention this list of other TTS engines. And even better, to port it here as a separate maintainable markdown table, like a crypto table.
https://docs.google.com/spreadsheets/d/1kZ6cKY_BcCkxmGtCioQi9Z0SvhcWBkf427DQCWSwIDs/edit#gid=0

It would be great to mention this list of other TTS engines. And even better, to port it here as a separate maintainable markdown table, like a crypto table. https://docs.google.com/spreadsheets/d/1kZ6cKY_BcCkxmGtCioQi9Z0SvhcWBkf427DQCWSwIDs/edit#gid=0
biodranik (Migrated from github.com) commented 2023-09-19 20:48:34 +00:00
Copy link

Can images be referenced with markdown syntax?

Can images be referenced with markdown syntax?
content/faq/index.md
@ -0,0 +54,4 @@
- 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
biodranik (Migrated from github.com) commented 2023-09-19 20:48:59 +00:00
Copy link

Are these empty lines necessary?

Are these empty lines necessary?
meenbeese (Migrated from github.com) reviewed 2023-09-24 02:19:12 +00:00
content/faq/index.md
@ -0,0 +54,4 @@
- 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
meenbeese (Migrated from github.com) commented 2023-09-24 02:19:11 +00:00
Copy link

No, not really. I have removed them.

No, not really. I have removed them.
meenbeese (Migrated from github.com) reviewed 2023-09-24 02:53:17 +00:00
content/faq/index.md
meenbeese (Migrated from github.com) commented 2023-09-24 02:53:17 +00:00
Copy link

I don't think so. Even though it can be done for primitive images, we need HTML to adjust the height and the width here.

I don't think so. Even though it can be done for primitive images, we need HTML to adjust the height and the width here.
biodranik (Migrated from github.com) reviewed 2023-09-24 18:16:57 +00:00
content/faq/index.md
biodranik (Migrated from github.com) commented 2023-09-24 18:16:57 +00:00
Copy link

Can't you adjust the height and width using CSS?

Can't you adjust the height and width using CSS?
meenbeese (Migrated from github.com) reviewed 2023-09-24 20:48:23 +00:00
content/faq/index.md
meenbeese (Migrated from github.com) commented 2023-09-24 20:48:23 +00:00
Copy link

Done! Will be pushing to the branch.

Done! Will be pushing to the branch.
meenbeese (Migrated from github.com) reviewed 2023-09-24 21:03:51 +00:00
content/faq/index.md
meenbeese (Migrated from github.com) commented 2023-09-24 21:03:51 +00:00
Copy link

I think this is a case where practicality beats purity. Using html makes more sense here.

Edit: Upon further research, I found that this is really difficult to do, if possible at all.

I think this is a case where practicality beats purity. Using html makes more sense here. Edit: Upon further research, I found that this is really difficult to do, if possible at all.
meenbeese commented 2023-09-24 21:20:20 +00:00 (Migrated from github.com)
Copy link

It would be great to preview it! Hint: provide a branch preview link instead of a commit link, it will be automatically updated after any changes.

I agree, a preview would be nice. How can I do this?

> It would be great to preview it! Hint: provide a branch preview link instead of a commit link, it will be automatically updated after any changes. I agree, a preview would be nice. How can I do this?
meenbeese (Migrated from github.com) reviewed 2023-09-24 21:28:02 +00:00
config.toml
@ -59,3 +38,2 @@
language = "English"
language-word = "Language"
more-info-om = "For more information please visit our web-site"
const_lang = "Language"
meenbeese (Migrated from github.com) commented 2023-09-24 21:28:02 +00:00
Copy link

Is there a better way to name this?

Is there a better way to name this?
simonschaufi (Migrated from github.com) reviewed 2023-10-01 10:29:15 +00:00
content/faq/index.md
@ -0,0 +28,4 @@
| | | |
| ----------- | ----------- | ----------- |
| <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'> |
simonschaufi (Migrated from github.com) commented 2023-10-01 10:29:15 +00:00
Copy link

These alt tags are not useful at all. Please a more descriptive text.

These alt tags are not useful at all. Please a more descriptive text.
meenbeese commented 2025-01-22 07:31:12 +00:00 (Migrated from github.com)
Copy link

Replaced with #212

Replaced with #212

Pull request closed

This pull request cannot be reopened because the branch was deleted.
Sign in to join this conversation.
Reviewers
No reviewers
biodranik
Labels
Clear labels   
about page

About Page of the website

  
bug

Something isn't working

  
community page

Community Page of the website

  
documentation

Improvements or additions to documentation

  
donate page

Donate Page of the website

  
duplicate

This issue or pull request already exists

  
enhancement

New feature or request

  
feature page

Feature Page of the website

  
good first issue

Good for newcomers

  
Google Season of Docs

Google Season of Docs

  
help wanted

Extra attention is needed

  
invalid

This doesn't seem right

  
landing page

Landing Page of website

  
news page

News Page of the website

  
question

Further information is requested

  
support page

Support Page of the website

  
wontfix

This will not be worked on

No labels
about page
bug
community page
documentation
donate page
duplicate
enhancement
feature page
good first issue
Google Season of Docs
help wanted
invalid
landing page
news page
question
support page
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: organicmaps/website#171
No description provided.
Delete branch "tts-instructions"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?