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
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
45de45e
Add proper FAQ page and TTS instructions
vachan-maker Apr 20, 2022
5425228
Moved TTS instructions to a separate FAQ section
strump Sep 27, 2023
71b4316
Changes in faq/general page
strump Sep 27, 2023
0dcfdc1
Added draft of faq/map
strump Sep 27, 2023
8c32527
Improvements to faq/map page
strump Sep 28, 2023
0e35d1e
faq/map progress
strump Oct 3, 2023
62c70c3
Added faq/routing draft
strump Oct 3, 2023
cab04e8
far/routing progress
strump Oct 3, 2023
016a307
far/routing progress
strump Oct 3, 2023
94daabd
far/routing progress
strump Oct 5, 2023
01a5f58
Page faq/android progress
strump Oct 5, 2023
5ddf50e
Small faq changes
strump Oct 5, 2023
e2b9d3f
Added faq/ios page
strump Oct 5, 2023
3f1c743
Small change to faq/tts
strump Oct 5, 2023
2ef0344
Added faq/bookmarks page
strump Oct 5, 2023
31f87ba
Page faq/bookmarks progress
strump Oct 5, 2023
065df1d
Page faq/bookmarks progress
strump Oct 5, 2023
5a89961
Added images for faq/bookmarks
strump Oct 5, 2023
6be7c6c
Small changes to faq pages
strump Oct 6, 2023
aaee830
Taxonomies migration progress
strump Oct 6, 2023
ef3f0dd
Changed templates to support taxonomy list and taxonomy term pages
strump Oct 6, 2023
1e21793
Splitted faq/bookmarks and faq/general into multiple md files
strump Oct 6, 2023
8306073
Simplified templates
strump Oct 6, 2023
ac9528b
Splitted iOS questions
strump Oct 6, 2023
cbe2c45
Updated readme.md with new Zola taxonomy feature
strump Oct 6, 2023
d48a388
Split faq/map
strump Oct 6, 2023
4933cbe
Split faq/routing
strump Oct 6, 2023
508a942
Added order to FAQ questions
strump Oct 9, 2023
cc99342
Using title instead of extra field
strump Oct 9, 2023
4feb0cd
Apply suggestions from code review
strump Oct 9, 2023
67adc10
Moved each question to subfolders
strump Oct 9, 2023
c0046cd
Moved FAQ files to each question folder
strump Oct 9, 2023
f3a3bf8
[FAQ] Updated Android version. Fixed OpenStreetMaps => OpenStreetMap
strump Oct 9, 2023
3fb2b26
Renamed "OrganicMaps" to "Organic Maps". Small typos
strump Oct 9, 2023
f40a2fa
Apply suggestions from code review
strump Nov 1, 2023
3f11f1d
Add FAQ TTS test screenshot (#195)
gpesquero Dec 5, 2023
5b0c03c
Modify TTS test screenshot
gpesquero Dec 6, 2023
7add7b9
Add screenshots to Android FAQs
gpesquero Dec 6, 2023
be328f2
Changed structure: one FAQ - one page
strump Dec 15, 2023
77ac153
Added explicit 'slug' to each FAQ page
strump Dec 18, 2023
9696427
Changed structure: FAQ page has all questions grouped by subject.
strump Jan 8, 2024
86ce005
On `/faq/` page category name is link now.
strump Jan 11, 2024
a997f3c
Add ru language to FAQ
biodranik Feb 22, 2024
27ae95f
Added some FAQ UI translations (en, ru).
strump Feb 23, 2024
ef68fc8
Extracted F.A.Q. breadcrumbs to a separate template.
strump Feb 26, 2024
771794b
Removed "question" from taxonomy section title. Now "Android" instead…
strump Feb 28, 2024
2c5076c
Explicitly use news templates
biodranik Mar 1, 2024
82f2189
Add another faq ru example
biodranik Mar 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
node_modules
public
translations.yaml
.idea/*
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,48 @@ Every merge into the _master_ branch deploys changes into the production at http
Run `npm run news` to automatically download news from our [Telegram channel](https://t.me/OrganicMapsApp),
then create a git commit and push it.

## Taxonomy and F.A.Q. architecture

Each MD page in `/faq/` has one or more taxonomy defined in header. E.g.:

```yaml
taxonomies:
faq: ["Android"]
```

Zola collects all such taxonomies:

| File | Taxonomy key | Taxonomy value |
| -------------------- | ------------ | -------------- |
| android-lags.md | `faq` | `Android` |
| android-logs.md | `faq` | `Android` |
| general-team.md | `faq` | `General` |
| general-bugreport.md | `faq` | `General` |
| ios-versions.md | `faq` | `iOS` |
| map-longtap.md | `faq` | `Map` |
| ... | ... | ... |

After that Zola gets all values for `faq` taxonomy: `[General, Android, iOS, Map, ...]`. And generates pages:

* For key `/faq/` with the list of values (see `templates/faq/list.html`)
* For each value `/faq/general`, `/faq/android`, etc. with the list of questions (see `templates/faq/single.html`)

If you want to add new question then create .md file with header:

```yaml
taxonomies:
faq: ["iOS"]
```

Zola will add your question to specific F.A.Q. sub-page.

**Limitation**: List of taxonomies at `/faq/` page is always alphabetical. So 'Android' is always the first, 'Bookmarks' is the second, 'General' is the third and so on.

**Limitation**: You can't sort questions at any F.A.Q. sub-page. So questions at `/faq/general` are always sorted by filename. We can create additional extra field like `extra.order` and sort questions by this field. But reordering would be hard.

**Limitation**: Each F.A.Q. sub-page has only a name. No description, no icon. Only name 'Android', or 'iOS', or 'Routing', etc.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be easy to add additional parameters to pages, if necessary, via extra or by overriding the base template.

Copy link
Sponsor Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extra could be used to add properties to each question. But groups of questions Android, Routing, Bookmarks have only name. No metadata.



## Contribution

Any good ideas and help with web site improvement are appreciated. And it's always better to discuss
Expand Down
12 changes: 12 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ build_search_index = false

ignored_content = [".DS_Store"]

taxonomies = [
{name = "faq", feed = false},
]

[markdown]
external_links_target_blank = true

Expand All @@ -30,13 +34,15 @@ stripe = "https://donate.organicmaps.app/"
address = "Address"
back = "Back to News"
contact = "Contact Us"
engines = "Supported TTS Engines"
install-appgallery = "Install Organic Maps from Huawei AppGallery"
install-appstore = "Install Organic Maps from the AppStore"
install-googleplay = "Install Organic Maps from Google Play"
install-fdroid="Install Organic Maps from F-Droid"
language = "English"
name = "Name"
token = "Token"
faq-menu-title = "F.A.Q"

# Please sort all other translation sections and values in alphabetical order.
[languages.de]
Expand Down Expand Up @@ -88,17 +94,23 @@ language = "Polski"
name = "Nazwa"
token = "Token"
[languages.ru]
taxonomies = [
{name = "faq", feed = false},
]
[languages.ru.translations]
address = "Адрес"
back = "Назад к новостям"
contact = "Связаться с нами"
engines = "Поддерживаемые TTS движки"
install-appgallery = "Установите Organic Maps из Huawei AppGallery"
install-appstore = "Установите Organic Maps из AppStore"
install-googleplay = "Установите Organic Maps из Google Play"
install-fdroid = "Установите Organic Maps из F-Droid"
language = "Русский"
name = "Название"
token = "Токен"
faq-menu-title = "Справка"

[languages.tr]
[languages.tr.translations]
address = "Adres"
Expand Down
2 changes: 1 addition & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ Organic Maps is an [open-source software][github] licensed under the Apache Lice

[fork]: https://en.wikipedia.org/wiki/Fork_(software_development)

{{ references() }}
{{ references() }}
9 changes: 9 additions & 0 deletions content/faq/android/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Android FAQ

taxonomies:
faq: ["Android"]

extra:
order: 30
---
9 changes: 9 additions & 0 deletions content/faq/android/_index.ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Android ЧАВО

taxonomies:
faq: ["Android"]

extra:
order: 30
---
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions content/faq/android/how-to-enable-logs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: How to enable logs?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Android"]

extra:
order: 40
---

If you want to report a bug then additional app logs could help locate a problem.
To get useful logs go to "Settings → Enable logging". After that, do the action that reproduces the problem.

<img src="/faq/android/how-to-enable-logs/settings-enable-logging.png" style="width:100%; max-width:400px"/>

Finally, tap on the button with Organic Maps icon on main screen and press "Report a bug" button.
Don't forget to disable logging after reporting.

<img src="/faq/android/how-to-enable-logs/about-report-a-bug.png" style="width:100%; max-width:400px"/>
20 changes: 20 additions & 0 deletions content/faq/android/how-to-enable-logs/index.ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Как включить логи?
description: "Часто задаваемые вопросы по Organic Maps"

taxonomies:
faq: ["Android"]

extra:
order: 40
---

Если вы хотите сообщить об ошибке, включение логов в приложении поможет быстрее найти проблему.
Чтобы включить запись лог файлов, перейдите в раздел "Настройки → Включить логи". После этого выполните действие, которое воспроизводит ошибку.

<img src="/faq/android/how-to-enable-logs/settings-enable-logging.png" style="width:100%; max-width:400px"/>

Наконец, нажмите на кнопку со значком Organic Maps на главном экране и нажмите кнопку "Сообщить об ошибке".
Не забудьте отключить ведение журнала после отправки сообщения.

<img src="/faq/android/how-to-enable-logs/about-report-a-bug.png" style="width:100%; max-width:400px"/>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: What Android version can run Organic Maps?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Android"]

extra:
order: 10
---

You need at least Android 5 to run the app. Devices with later Android versions can run Organic Maps.

Organic Maps can work on devices with Google Services installed and without Google support.

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Какие версии Android поддерживает Organic Maps?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Андроид"]

extra:
order: 10
---

Для работы Organic Maps достаточно устройства с Android 5 или выше. Если у вас самая свежая версия Android, значит Organic Maps точно заработает.

Карта может работать как при наличии Google сервисов, так и без них.
12 changes: 12 additions & 0 deletions content/faq/android/what-if-app-crashes-on-start/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: What if app crashes on start?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Android"]

extra:
order: 50
---

You need to enable Android WebView component.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: What's the difference between F-Droid and Google Play versions of the app?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Android"]

extra:
order: 20
---

[F-Droid](https://f-droid.org/) version comes without [Google Play Services](https://en.wikipedia.org/wiki/Google_Play_Services). These Services improve location accuracy using nearest cell towers and wifi hotspots if internet connection is available. F-Droid version uses only device GPS sensor.

With Organic Maps from Google Play you can disable Google Play Services for location search in app settings.
19 changes: 19 additions & 0 deletions content/faq/android/why-organic-maps-is-slow-on-my-device/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Why Organic Maps is slow on my device, UI is laggy, and it crashes randomly?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Android"]

extra:
order: 30
---

Most likely you configured to store maps data on SD card. Usually switchable SD cards in Android phones are slow and unreliable.

Change Organic Maps config to store maps data in internal storage. Open Settings → Save maps to → Internal private storage.

<img src="/faq/android/why-organic-maps-is-slow-on-my-device/settings-save-map-to.png" style="width:100%; max-width:400px"/>

Or you can replace SD card with faster one to improve map performance.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions content/faq/bookmarks/how-to-edit-or-move-bookmarks/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: How to edit or move bookmarks?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Bookmarks"]

extra:
order: 10
---

To edit a bookmark use longtap menu or hit "Edit bookmark" when bookmark is selected on map.

<img src="/faq/bookmarks/how-to-edit-or-move-bookmarks/android-selected-bookmark.jpg" width="400"/>

You can change bookmark name, description, color, and folder. Don't forget to tap "Save".

<img src="/faq/bookmarks/how-to-edit-or-move-bookmarks/android-edit-bookmark.jpg" width="400"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: How to find bookmarks and tracks files on phone?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Bookmarks"]

extra:
order: 70
---

Bookmarks and tracks are stored in private app folder and are not accessible from 3rd party apps.

On iOS, you can access these files on iPhone/iPad from desktop using iTunes app.

On Android device with Root enabled you can find bookmarks in `/data/data/app.organicmaps`.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions content/faq/bookmarks/how-to-import-gpx-track/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: How to import GPX track on Android and iOS?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Bookmarks"]

extra:
order: 40
---

If you received GPX file in email, messenger, or cloud drive you can import it directly to Organic Maps app.

On iOS tap on GPX file and press Share button: <img src="/faq/bookmarks/how-to-import-gpx-track/ios-share.png" width="50px"/>. Then select Organic Maps to open the file.

On Android tap on received GPX file to see Share menu. Select Organic Maps to import the file.

<img src="/faq/bookmarks/how-to-import-gpx-track/android-share-1.jpg" width="200px"/> <img src="/faq/bookmarks/how-to-import-gpx-track/android-share-2.jpg" width="200px"/>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: How to import multiple bookmarks on Android?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Bookmarks"]

extra:
order: 30
---

<img src="/faq/bookmarks/how-to-import-multiple-bookmarks-on-android/android-import-bookmarks.jpg" width="400px"/>

Push "Import Bookmarks and tracks" button. Choose folder on your phone with KML/KMZ/GPX files. Organic Maps will scan picked folder and import all bookmarks and tracks.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: How to move imported track to another folder?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Bookmarks"]

extra:
order: 50
---

On Android : ???

On iOS : ???
14 changes: 14 additions & 0 deletions content/faq/bookmarks/how-to-remove-bookmark-or-track/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: How to remove bookmark or track?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Bookmarks"]

extra:
order: 20
---

On Android you can remove bookmark from the bookmarks list using longtap menu.

On iOS: ???
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: What would happen with my bookmarks and tracks after uninstalling app?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["Bookmarks"]

extra:
order: 60
---

All you tracks and bookmarks are removed from device when Organic Maps is uninstalled. Please backup your bookmarks and tracks using export button.

Cloud bookmarks backup and sync is planned in future releases.
15 changes: 15 additions & 0 deletions content/faq/general/how-to-send-a-bugreport/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: How to send up a bugreport?
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["General"]

extra:
order: 60
---

Report bugs or issues to [the issue tracker][issues] or [email us][email]. You can submit feedback directly from app.
Just click icon with "?" on iOS or with green Organic Maps icon on Android. You'll find "Report a bug" button there.

{{ references() }}
12 changes: 12 additions & 0 deletions content/faq/general/project-history/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Project history
description: "Frequently asked questions for Organic Maps application"

taxonomies:
faq: ["General"]

extra:
order: 10
---

???
Loading