mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2025-12-30 08:50:49 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): improve l10n docs

Browse Source 
Signed-off-by: jkoberg <jkoberg@owncloud.com>
This commit is contained in:
jkoberg
2024-12-30 11:41:48 +01:00
parent 7947c99930
commit c314e71c05
1 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/services/general-info/add-translations.md
View File

@@ -29,7 +29,13 @@ Translations have a `context` and a `translatable string`. The context is shown
* Add the `OCIS_DEFAULT_LANGUAGE` envvar in `services/<service-name>/pkg/config/config.go`.\
For details see the userlog or notifications service code.
* Use `"github.com/owncloud/ocis/v2/ocis-pkg/l10n"` for the translation.
* Add the `<SERVICE_NAME>_TRANSLATION_PATH` envvar in `services/<service-name>/pkg/config/config.go`.\
For details see the userlog or notifications service code.
* Use `"github.com/owncloud/ocis/v2/ocis-pkg/l10n"` for the translation.\
Use `l10n.Template` to define the translation string.\
Use `l10n.NewTranslator` or `l10n.NewTranslatorFromCommonConfig` to get the translator.\
Use `t.Get` to translate the string. See package for more advanced usage.
* Create a config in `services/<service-name>/pkg/service/l10n/.tx/config` with the following content. Note that it is important to stick with `ocis-<service-name>` to easily identify all ocis translations on Transifex:
```
@@ -46,9 +52,11 @@ Translations have a `context` and a `translatable string`. The context is shown
```
Note: o: organization, p: project, r: resource
* Create a go file like `templates.go` in `ocis/services/<service-name>/pkg/service` that will define your translation sources like the following:
* Create an empty file `services/<service-name>/pkg/service/l10n/locale/en/LC_MESSAGES/<service-name>.po`. This is required for ocis to build. This file will be replaced nightly with the latest translations from Transifex.
* Create a go file like `templates.go` in e.g. `ocis/services/<service-name>/pkg/service` that will define your translation sources like the following:
```
// context string
// this comment will appear in transifex as context
var yourString = l10n.Template("Translation String")
```
@@ -85,7 +93,7 @@ Translations have a `context` and a `translatable string`. The context is shown
l10n-read: $(GO_XGETTEXT)
go-xgettext -o $(OUTPUT_DIR)/<service-name>.pot \
--keyword=l10n.Template --add-comments -s \
ocis/services/<service-name>/pkg/service/templates.go
pkg/service/templates.go
.PHONY: l10n-write
l10n-write: