From 72ca71d956419026d29767353808f4abc0a17fb6 Mon Sep 17 00:00:00 2001
From: map-per <79519062+map-per@users.noreply.github.com>
Date: Wed, 20 Nov 2024 15:57:05 +0100
Subject: [PATCH] Update POI category section in TRANSLATIONS.md

Add more guidance for the POI category translation files (see: https://github.com/organicmaps/organicmaps/issues/8290#issuecomment-2459408903)

Signed-off-by: map-per <79519062+map-per@users.noreply.github.com>
---
 docs/TRANSLATIONS.md | 32 ++++++++++++++++++--------------
 1 file changed, 18 insertions(+), 14 deletions(-)

diff --git a/docs/TRANSLATIONS.md b/docs/TRANSLATIONS.md
index 193c3438ee..aa236ad34d 100644
--- a/docs/TRANSLATIONS.md
+++ b/docs/TRANSLATIONS.md
@@ -25,25 +25,29 @@ To run the `tools/unix/generate_localizations.sh` script, it is necessary to hav
 
 ## Translation files
 
-Main:
-- Application UI strings: [`data/strings/strings.txt`](../data/strings/strings.txt)
-- A few iOS specific strings: [`iphone/plist.txt`](../iphone/plist.txt)
-- Names of map features/types: [`data/strings/types_strings.txt`](../data/strings/types_strings.txt)
-- Search keywords/aliases/synonyms for map features: [`data/categories.txt`](../data/categories.txt)
+- Main:
+  - Application UI strings: [`data/strings/strings.txt`](../data/strings/strings.txt)
+  - A few iOS specific strings: [`iphone/plist.txt`](../iphone/plist.txt)
 
-Additional:
-- Text-to-speech strings for navigation: [`data/strings/sound.txt`](../data/strings/sound.txt)
+- POI Categories:
+  - Names of map features/types: [`data/strings/types_strings.txt`](../data/strings/types_strings.txt)
+  - Search keywords/aliases/synonyms for map features: [`data/categories.txt`](../data/categories.txt)
 
-- Android stores description: [`android/app/src/fdroid/play/`](../android/app/src/fdroid/play/)
-- Apple AppStore description: [`iphone/metadata/`](../iphone/metadata/)
+  The POI definitions in the [OpenStreetMap Wiki](https://wiki.openstreetmap.org/) help finding the most suitable translation. Both POI files should be kept in sync, so make sure that every category name is also contained in the coresponding search keyword list. Strings in _categories.txt_ should, however, not contain common tokens like e.g. Shop, Store or Center as separate words.
 
-- Popular brands of map features: [`data/strings/brands_strings.txt`](../data/strings/brands_strings.txt)
-- Search keywords for popular brands: [`data/categories_brands.txt`](../data/categories_brands.txt)
-- Search keywords for cuisine types: [`data/categories_cuisines.txt`](../data/categories_cuisines.txt)
+- Additional:
+  - Text-to-speech strings for navigation: [`data/strings/sound.txt`](../data/strings/sound.txt)
 
-- Country / map region names: [`data/countries_names.txt`](../data/countries_names.txt)
+  - Android stores description: [`android/app/src/fdroid/play/`](../android/app/src/fdroid/play/)
+  - Apple AppStore description: [`iphone/metadata/`](../iphone/metadata/)
 
-- [other strings](STRUCTURE.md#strings-and-translations) files
+  - Popular brands of map features: [`data/strings/brands_strings.txt`](../data/strings/brands_strings.txt)
+  - Search keywords for popular brands: [`data/categories_brands.txt`](../data/categories_brands.txt)
+  - Search keywords for cuisine types: [`data/categories_cuisines.txt`](../data/categories_cuisines.txt)
+
+  - Country / map region names: [`data/countries_names.txt`](../data/countries_names.txt)
+
+  - [other strings](STRUCTURE.md#strings-and-translations) files
 
 Language codes used are from [ISO 639-1 standard](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
 If a string is not translated into a particular language then it falls back to English or a "parent" language (e.g. `es-MX` falls back to `es`).