From d96986ba792c5f76b5946e39bb4c4547e3c28470 Mon Sep 17 00:00:00 2001 From: Tobias Date: Mon, 13 Dec 2021 17:59:16 +0100 Subject: [PATCH] Readme: Add section about how translations work (#245) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Readme: Expand translations section Readme: Add section about how translations work Closes https://github.com/openstreetmap/id-tagging-schema/issues/55 Readme: Improve section about translations - Change the order of the bullets to clarify which goes where. - Update the primary Transifex link based on feedback in https://github.com/openstreetmap/id-tagging-schema/pull/245#discussion_r741621759 - Add a section about how to find a translation in Transifex * fix typo and bind to specific version Co-authored-by: Minh Nguyễn * tweak wording very slightly Co-authored-by: Martin Raifer Co-authored-by: Minh Nguyễn --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index aa07cec5a..b77395897 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,18 @@ This Tagging Schema fills that need, but with a number of caveats: - We support tags based on practicality, usage, and community approval - Sometimes there are reasons we can't support a tag even if it's used or approved +## Translations + +* English translations for the `terms`-key should be added to the JSON data ([Example](https://github.com/openstreetmap/id-tagging-schema/blob/v3.1.0/data/presets/natural/shrub.json#L16-L19)). + +* Apart from that, translations are managed [in the Transifex Project of the iD Editor](https://www.transifex.com/openstreetmap/id-editor/) inside the translation resource _'preset'_. + + To translate, you can [open the translation page](https://www.transifex.com/openstreetmap/id-editor/translate/), select a language, select _'preset'_ and search for `key:living_street` or `translation_text:'Living Street'` to find and change translations. + + To contribute to a language: [Select a language](https://www.transifex.com/openstreetmap/id-editor/languages/) and use 'Join team' to request access. The administrators will approve requests routinely, only rejecting requests for overly specific locales. + +* All translation changes will be released whenever [a new id-tagging-schema release is created](https://github.com/openstreetmap/id-tagging-schema/releases). They will be visible inside iD and other editors once those editors update their dependencies and release a new version as well. + ## Usage ### Java/Android @@ -39,7 +51,3 @@ iD's [code of conduct](https://github.com/openstreetmap/iD/blob/release/CODE_OF_ Documentation for the data formats is located with the [schema-builder](https://github.com/ideditor/schema-builder) package, which is the technical basis of this project. To make a change, update a file within the `data` folder and rebuild by running `npm run build` in your terminal. - -### Translating - -The translations for the iD presets are currently translated at the same place as the rest of iD. See [Contributing to iD/Translating](https://github.com/openstreetmap/iD/blob/develop/CONTRIBUTING.md#translating).