More localisation documentation

giellalt · Dec 19, 2023 · ccd3bda · ccd3bda
1 parent f474bd8
commit ccd3bda
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 1 deletion.
diff --git a/apps/AppLocalisation.md b/apps/AppLocalisation.md
@@ -78,7 +78,9 @@ TBW
 
 TBW
 
-# Páhkat package descriptions
+# Páhkat
+
+## Package descriptions
 
 Each package has a name and description, both of which can be localised. The entries look like
 the following:
@@ -112,6 +114,62 @@ The name and description will be updated in two steps:
 
 Both steps should be automatic and happen regularly, so on average, new package descriptions will be available pretty soon after they have been committed and pushed.
 
+## Categories and channel labels
+
+Category and channel labels are defined in `.toml` files in `main/strings/`. The following is the content of the `en.toml` (English) file:
+
+```toml
+[tags]
+"cat:keyboard-layouts" = "Keyboards"
+"cat:spellers" = "Spellers"
+"cat:speller-engines" = "Speller Engines"
+
+[channels]
+"default" = "Stable"
+"nightly" = "Nightly"
+"beta" = "Beta"
+```
+
+The category labels are used as category headings in Borealium.org:
+
+![Pahkatkategori_i_borealium.png](../images/Pahkatkategori_i_borealium.png)
+
+and the channel labels show up in the settings in Divvun Manager:
+
+![Pahkatkategori_i_borealium.png](../images/Pahkattekst_i_DM_settings.png)
+
+## Other strings
+
+There are a couple of other strings as well that could or should be translated.
+
+### Language listing heading
+
+This is defined in `main/index.toml`:
+
+```toml
+[name]
+en = "Divvun Languages"
+ru = "Языки Divvun"
+
+[description]
+en = "The repository of all languages supported by Divvun."
+```
+
+(The description is presently not being used anywhere, AFAIK.)
+
+This text is found several places:
+
+![Pahkattekst_i_DM_settings2.png](../images/Pahkattekst_i_DM_settings2.png)
+
+![Pahkattekst_i_DM_settings2.png](../images/Pahkattekst_i_DM_meny.png)
+
+### More strings
+
+The following files and directories contain localisable strings:
+
+- `tools/index.toml`
+- `tools/strings/*.toml`
+
 # satni.org
 
 TBW
diff --git a/images/Pahkatkategori_i_borealium.png b/images/Pahkatkategori_i_borealium.png
diff --git a/images/Pahkattekst_i_DM_meny.png b/images/Pahkattekst_i_DM_meny.png
diff --git a/images/Pahkattekst_i_DM_settings.png b/images/Pahkattekst_i_DM_settings.png
diff --git a/images/Pahkattekst_i_DM_settings2.png b/images/Pahkattekst_i_DM_settings2.png