Skip to content

Commit

Permalink
Readme: Expand translations section
Browse files Browse the repository at this point in the history
Readme: Add section about how translations work

Closes #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 #245 (comment)
- Add a section about how to find a translation in Transifex
  • Loading branch information
tordans committed Nov 11, 2021
1 parent 0913fba commit 56a8175
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ([Exampple](https://github.com/openstreetmap/id-tagging-schema/blob/main/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 change translation, 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
Expand All @@ -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).

0 comments on commit 56a8175

Please sign in to comment.