Translating
There are two ways to translate phrases:
- Manually translate generated JSON file.
- Use the app editor Swiftyper Translations.
Command to generate missing translation hashes from collected source strings:
php ./vendor/bin/fbt generate-translations --src=./path/to/fbt/.source_strings.json --translation-input=./path/to/translation_input.json
# or
php ./vendor/bin/fbt generate-translations --src=./path/to/fbt/.source_strings.json --translations=./path/to/translations/*.json
Options:
| name | default | description |
|---|---|---|
| --src | ./.source_strings.json | Path to collected source strings file |
| --translation-input | ./translation_input.json | Path to translation input file |
--translations=[path] | none | The translation files containing translations. E.g. --translations=./path/to/translations/*.json |
Command to convert provided translations to jenkins:
php ./vendor/bin/fbt translate --path=./path/to/fbt/ --stdin < translation_input.json
# or
php ./vendor/bin/fbt translate --path=./path/to/fbt/ --translations=./path/to/translations/*.json
Options:
| name | default | description |
|---|---|---|
| --path | none | Path to export translation output (Cache storage path - must be same as in configuration) |
| --pretty | no | Pretty print the translation output |
--translations=[path] | none | The translation files containing translations. E.g. --translations=/path/to/translations/*.json |
| --stdin < translation_input.json | none | Instead of reading translation files and source file separately, read monolithic JSON file from STDIN |
JSON schema:
In addition to the below example, the translation_input.json
provided in our tests
is a good reference on the "schema" used for the translations.
{
"phrases": [
"hashToText": {
<text_hash>: <text>,
...
},
"jsfbt": string|{t:<table>, m:<metadata>}
],
...
"translationGroups": [{
"fb-locale": "xx_XX",
"translations": {
<translation_hash>: {
"tokens": [<token1>, ..., <tokenN>],
"types": [<variationType1>, ..., <variationTypeN>]
"translations": [{
"translation": <translation1>,
"variations": [variationValue1,...,variationValueN]
},
...,
]
}
}
}]
}
The <text_hash> and <translation_hash> correspond in the above example.
That is translations[<hash>] is the translation entry for
phrases.hashToText[<hash>].
Here tokens, types and variations are all associative arrays. That is, in
the above example, types[i] represents the variation type (or mask) of
tokens[i] and variations[i] is the variation value of token[i] for the
given translation entry.
Variation types
Variation types can be one of
IntlVariations::BITMASK_NUMBER: 28
IntlVariations::BITMASK_GENDER: 3
This signifies what the given token can variate on. Token types of type GENDER can be:
IntlVariations::GENDER_MALE: 1
IntlVariations::GENDER_FEMALE: 2
IntlVariations::GENDER_UNKNOWN: 3
while token types of NUMBER can be:
IntlVariations::NUMBER_ONE: 4
IntlVariations::NUMBER_TWO: 8
IntlVariations::NUMBER_MANY: 12
IntlVariations::NUMBER_ZERO: 16
IntlVariations::NUMBER_FEW: 20
IntlVariations::NUMBER_OTHER: 24