Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add F.A.Q. section #185

Closed
wants to merge 48 commits into from
Closed

Add F.A.Q. section #185

wants to merge 48 commits into from

Conversation

strump
Copy link
Sponsor Contributor

@strump strump commented Oct 6, 2023

Fixes #6

I picked PR #171 "[WIP] Added text to speech instructions" and added F.A.Q. questions from @biodranik coffers. Implemented using Zola taxonomies.

Almost all screenshots are made on Android.

Blank spaces are present.

What to do with *.po files? Should I add texts from new pages to PO file?

Update 2023-10-09

Create subfolder for each FAQ question.

Using title propety instead of custom extra.question.

Added ordering by extra.order field. weight is not available for taxonomy terms.

vachan-maker and others added 19 commits September 25, 2023 22:11
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]>

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]>

[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]>

Add table with all languages

Signed-off-by: meenbeese <[email protected]>

Update eSpeak link

Signed-off-by: meenbeese <[email protected]>

Update and clarify instructions page

Signed-off-by: meenbeese <[email protected]>
Signed-off-by: S. Kozyr <[email protected]>
Signed-off-by: S. Kozyr <[email protected]>
Signed-off-by: S. Kozyr <[email protected]>
Signed-off-by: S. Kozyr <[email protected]>
Signed-off-by: S. Kozyr <[email protected]>
Signed-off-by: S. Kozyr <[email protected]>
Signed-off-by: S. Kozyr <[email protected]>
Signed-off-by: S. Kozyr <[email protected]>
Signed-off-by: S. Kozyr <[email protected]>
@strump strump temporarily deployed to production October 6, 2023 08:41 — with GitHub Actions Inactive
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 6, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 82f2189
Status: ✅  Deploy successful!
Preview URL: https://2877c827.organicmaps.pages.dev
Branch Preview URL: https://faq-plus-tts.organicmaps.pages.dev

View logs

@strump strump temporarily deployed to production October 6, 2023 14:52 — with GitHub Actions Inactive
Signed-off-by: Alexander Borsuk <[email protected]>
@biodranik
Copy link
Member

@strump let's polish this branch and prepare it to merge. If there is not enough time to read all texts, let's select one simple FAQ page and translate it to all languages, according to this commit: a997f3c

Existing content can stay on this or another branch, and then we can continue improving it after rebasing to the master branch with the ready structure.

@rtsisyk
Copy link
Member

rtsisyk commented Feb 23, 2024

Please push a branch with 1-2 FAQ articles for the beginning, in English. I have been waiting for this new FAQ section for months.

Added RU translation for /faq/android/what-android-version-can-run-organic-maps page

Signed-off-by: S. Kozyr <[email protected]>
@strump
Copy link
Sponsor Contributor Author

strump commented Feb 23, 2024

@biodranik I fixed FAQ templates little bit:

  • Added translation for FAQ breadcrumbs
  • Added RU translation for a single Android related question

Problems I see so far: you can't change language from https://faq-plus-tts.organicmaps.pages.dev/faq/ and https://faq-plus-tts.organicmaps.pages.dev/faq/android/ pages. Language selector (top right link) doesn't work with taxonomies, because those taxonomies have no list of supported languages. Only FAQ questions have language selector (if translations are available).

I'm little bit lost with next steps. What structural changes do we need? What text related changes do we need?

@gpesquero
Copy link
Collaborator

I've fixed PR 204 so the FAQs also work now for Spanish language.

One issue that I've noticed in the resulting FAQ list in Spanish...

faq_list_es1

...is that the "Aplicación preguntas" text is incorrect, as it comes from the direct composition of the translation of the taxonomy name "App" and the string "questions". In Spanish (and in many other languages), the word order shall be the opposite ("Preguntas (de) Aplicación").

This taxonomy+question word order comes from the code <h3><a href="{{term.permalink}}">{{term.name}} {{ trans(key='faq-questions', lang=lang) }}</a></h3> in the file templates/faq/list.html. Could it be possible to have different versions of this file for every/some languages to arrange correctly the word order?

@biodranik
Copy link
Member

@gpesquero yes, you can add something like {% if lang == "es" %}{{ trans(key='faq-questions', lang=lang)}} de {{term.name}}{% else %}{{term.name}} {{ trans(key='faq-questions', lang=lang) }}{% endif %}

@biodranik
Copy link
Member

@strump did you try to set lang explicitly in taxonomy? Maybe dumping all available variables help to get list of translations?

выява

If languages issue is fixed, then we can cleanup the code and merge it to the master. Do you see any other issues?

@strump
Copy link
Sponsor Contributor Author

strump commented Feb 24, 2024

@biodranik I can get the current language for a taxonomy, but I couldn't find all available languages for a taxonomy.

For example, "Android" taxonomy is currently available in two languages, while "Map" taxonomy has only "en" translation. But I don't know how to get a list of all available translations to enable language switcher.

Taxonomy+Translation = pain 😔

@biodranik
Copy link
Member

@strump you can access all currently configured taxonomies and their translations from global var languages["ru"].taxonomies[], which may be similar to the already existing code that scans page translations.

But I don't think it's a blocker, let's focus on other issues and polishing the final version for merging, this fix can be done later.

@strump
Copy link
Sponsor Contributor Author

strump commented Feb 26, 2024

@gpesquero @biodranik maybe we should replace

faq-questions = "questions"

with somethink like

[languages.en]
faq-questions = "%1 questions"

[languages.es]
faq-questions = "Preguntas de %1"

What do you think?

… of "Android questions".

Russian taxonomy translation. And it works!

Signed-off-by: S. Kozyr <[email protected]>
@strump
Copy link
Sponsor Contributor Author

strump commented Feb 28, 2024

@gpesquero Let's try another option. I removed work "question"/"pregunta" completely. Let's use just taxonomy names as titles: "Android", "Map", "Routing".

And you can translate taxonomy terms: "Mapa" instead of "Map", "Ruta" instead or "Routing". Please try and tell how it looks now?

@gpesquero
Copy link
Collaborator

@gpesquero Let's try another option. I removed work "question"/"pregunta" completely. Let's use just taxonomy names as titles: "Android", "Map", "Routing".

This approach is simpler and will give us less "headaches", so it looks good to me...

PR 204 updated accordingly...

Captura desde 2024-02-28 21-28-07

Signed-off-by: Alexander Borsuk <[email protected]>
Signed-off-by: Alexander Borsuk <[email protected]>
@strump
Copy link
Sponsor Contributor Author

strump commented Mar 7, 2024

@biodranik should I close this PR after #212 is merged?

@biodranik
Copy link
Member

@strump I think yes, you did a lot of work, thank you very, very much!

It may make sense to leave content articles though for future updates/modifications.

@biodranik
Copy link
Member

The FAQ structure based on this PR has already been merged. Only the content is needed now.

@biodranik biodranik closed this Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add /faq/ section
8 participants