organicmaps.github.io icon indicating copy to clipboard operation
organicmaps.github.io copied to clipboard

[WIP] Added text to speech instructions

Open meenbeese opened this issue 1 year ago • 6 comments

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

meenbeese avatar Sep 16 '23 22:09 meenbeese

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.

biodranik avatar Sep 16 '23 23:09 biodranik

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.

meenbeese avatar Sep 17 '23 02:09 meenbeese

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

biodranik avatar Sep 17 '23 05:09 biodranik

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?

meenbeese avatar Sep 17 '23 20:09 meenbeese

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

meenbeese avatar Sep 18 '23 02:09 meenbeese

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 avatar Sep 24 '23 21:09 meenbeese