From ee7556c53d6a2fe6d558230c68e410b6da5aa9f4 Mon Sep 17 00:00:00 2001 From: Sjur N Moshagen Date: Fri, 25 Oct 2024 10:05:58 +0300 Subject: [PATCH] Lokalisering av ressursskildringar, og korleis ein legg til nye ressursar --- apps/AppLocalisation.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/apps/AppLocalisation.md b/apps/AppLocalisation.md index c0b268f..5cd771b 100644 --- a/apps/AppLocalisation.md +++ b/apps/AppLocalisation.md @@ -17,9 +17,26 @@ Localisation of each of them is described below. [borealium.org](https://github.com/borealium/borealium.org) is almost always localised using Pontoon. Log in using your GitHub account, it should be automatic. The exact setup of the localisation is as follows: -- [Borealium Core](https://divvun-pontoon-vm.norwayeast.cloudapp.azure.com/projects/borealium/): the main web site, general texts and descriptions. All UI languages should be translated 100 % for this Pontoon project -- Borealium Resources (except Pahkat resources): localised names and descriptions for the language resources listed on Borealium. This is a separate Pontoon project (to be created), and the only localisation requirement is that every resource is localised into its own language + English. Other languages may be added as desired or deemed useful, but it is not required. -- Páhkat resources: +- **[Borealium Core](https://divvun-pontoon-vm.norwayeast.cloudapp.azure.com/projects/borealium/):** the main web site, general texts and descriptions. All UI languages should be translated 100 % for this Pontoon project +- **Borealium Resources** (except Pahkat resources): localised names and descriptions for the language resources listed on Borealium. There is [a separate Pontoon project for each language's resources](https://divvun-pontoon-vm.norwayeast.cloudapp.azure.com/projects/), and the only localisation requirement is that every resource is localised into its own language + English, where English is the reference as well as the last-resort fallback language. Other languages may be added as desired or deemed useful, but that is not required. + - adding new resources: + - add basic info and links in `data/resources/` (copy one of the existing ones, then edit as needed) + - use string identifiers instead of actual strings + - add the string identifiers to the appriopriate localisation file in `resources/en/*-resources.ftl`, and provide suitable text in English (this becomes the reference text for localisation into other languages) + - localise the resources as needed; the set of languages to localise into is configured in the file `resources/*-l10n.toml`, which has a very simple structure (example file taken from Faroese): + + ```toml + [[paths]] + reference = "en/fao-resources.ftl" + l10n = "{locale}/fao-resources.ftl" + locales = [ + "fo", + "da", + ] + ``` + - Pontoon reads this config file, and in this case, Faroese resources should be localised into Faroese and Danish, using English as the reference. + - new strings for new resources are automatically synced to Pontoon each hour (on the hour) +- **Páhkat resources:** - Spellers: - native language and English: `configure.ac`, in the variables `SPELLER_NAME_NATIVE`, `SPELLER_NAME_ENG`, `SPELLER_DESC_NATIVE` and `SPELLER_DESC_ENG`. The text in these variables will be used to name and describe the spellers both in Borealium.org, and in other places. - Other languages: add them to `manifest.toml.in`, under the sections `[speller.name]` and `[speller.description]`, as many as is needed. @@ -38,14 +55,14 @@ Localisation of each of them is described below. description: Mobiltastatur for sørsamisk fra Divvun-gruppa. ``` - One can add as many `locales` as needed. - - The new/edited locales are pushed to the Páhkat server on the next successfull CI build, and from there it is automatically picked up by borealium.org on the next site build. [**NB!** This seems not to work ATM. A [bug report](https://github.com/borealium/borealium.org/issues/32) exists.] + - The new/edited locales are pushed to the Páhkat server on the next successfull CI build, and from there it is automatically picked up by borealium.org on the next site build. **All Pontoon localisations** are automatically synced from Pontoon to GitHub, but *only* after the localisations have been *accepted*. **All Pahkat resource** localisations are automatically picked up on each site rebuild. The site is rebuilt every hour (on the hour), and on every `git push` to the repository. -It is still possible to also do localisations directly in GitHub, and those changes will be synced with Pontoon automatically. For that reason, the documentation below is kept for reference. - Pontoon projects and user configuration is administered [here](https://divvun-pontoon-vm.norwayeast.cloudapp.azure.com/a/). +It is still possible to also do localisations directly in GitHub, and those changes will be synced with Pontoon automatically. For that reason, the documentation below is kept for reference. + --- All pathnames in this section are relative to the root of the [borealium.org](https://github.com/borealium/borealium.org) repository.