diff --git a/README.md b/README.md index 83b01db0..b916ae08 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,19 @@ faq-menu-title = "{Translation of 'F.A.Q.' to a new language}" **Limitation**: Each F.A.Q. category has only a name. No description, no icon. Only name 'App', or 'Bookmarks and Tracks', or 'Map Editing', etc. +## Embedded FAQ + +A subset of FAQ questions is used to generate static single-page FAQ: [`/faq/embedded-faq/`](https://organicmaps.app/faq/embedded-faq/?lang=en). This page should be used as an embedded offline help page in Organic Maps app on Android and iOS. To see how it looks in different languages use following links: + +* https://organicmaps.app/faq/embedded-faq/?lang=en +* https://organicmaps.app/faq/embedded-faq/?lang=de +* https://organicmaps.app/faq/embedded-faq/?lang=ru +* etc. + +List of supported languages could be found in `templates/faq/embedded-faq.html`: `en`, `de`, `es`, `fr`, `pt`, `pt-BR`, `pl`, `ru`, `tr`, `uk`, `zh`. + +To update embedded FAQ replace [`data/faq.html`](https://github.com/organicmaps/organicmaps/blob/master/data/faq.html) file with the latest version generate by Zola. + ## Contribution Any good ideas and help with web site improvement are appreciated. And it's always better to discuss