~valhalla-routing/+junk/valhalla_2.1.9-0ubuntu1

« back to all changes in this revision

Viewing changes to libvalhalla/locales/README.md

  • Committer: valhalla
  • Date: 2017-04-24 20:20:53 UTC
  • Revision ID: valhalla@mapzen.com-20170424202053-7o69b9nwx9ee0tw3
PackagingĀ forĀ 2.1.9-0ubuntu1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# How to contribute a new narrative language file
 
2
 
 
3
1. Copy the [en-US.json](en-US.json) to `<NEW_LANGUAGE_TAG>.json`
 
4
Using [IETF BCP 47](https://tools.ietf.org/html/bcp47) as reference - the typical format for the `<NEW_LANGUAGE_TAG>` is:  
 
5
<[ISO 639 two-letter language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)>-<[ISO 3166 two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)>  
 
6
Czech/Czech Republic example:  
 
7
`cs-CZ`
 
8
 
 
9
2. Update the `posix_locale` value in your new file. The character encoding must be UTF-8. The typical format is:  
 
10
<[ISO 639 two-letter language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)>_<[ISO 3166 two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)>.UTF-8  
 
11
Czech/Czech Republic `posix_locale` example:  
 
12
`cs_CZ.UTF-8`
 
13
 
 
14
3. Update the `aliases` array in your new file. A typical alias entry is the [ISO 639 two-letter language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) without the    
 
15
[ISO 3166 two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). The alias entry must be unique across language files.  
 
16
Czech `aliases` entry example:  
 
17
`cs`
 
18
 
 
19
4. Do not translate the JSON keys or phrase tags. An example using the ramp instruction:  
 
20
![Alt text](img/do_not_translate.png)
 
21
 
 
22
5. Please translate the JSON values. As needed, reorder the phrase words and tags - the tags must remain in the phrase. An example using the ramp instruction:  
 
23
![Alt text](img/translate.png)
 
24
 
 
25
6. Run `make check` to verify the tests pass OR move on to step#7 and we can help verify.
 
26
 
 
27
7. Submit a pull request for review. Thank you!
 
28
 
 
29
#### Instruction descriptions
 
30
`TODO`
 
31
 
 
32
#### Tag descriptions
 
33
`TODO`
 
34