inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-3087] Clarified section about adding/replacing keys in i18n guide (#3392)

Browse Source 
* [ADF-3087] Clarified section about adding/replacing keys

* [ADF-3087] Corrected information in i18n and translation service docs
This commit is contained in:
Andy Stark
2018-05-25 11:10:21 +01:00
committed by Denys Vuika
parent 1064521fe9
commit 3bbabb5dad
2 changed files with 44 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/core/translation.service.md
View File

@@ -70,7 +70,7 @@ general format of the path to this folder will be:
`<app>/src/assets/my-translations/i18n`
If you wanted English and French translations then you would copy the built-in
If you wanted English and French translations then you would add
`en.json` and `fr.json` files into the `i18n` folder and add your new keys:
// en.json
@@ -84,6 +84,22 @@ If you wanted English and French translations then you would copy the built-in
"WELCOME_MESSAGE": "Bienvenue !"
...
The files follow the same hierarchical key:value JSON format as the built-in translations.
You can add new keys to your local files or redefine existing keys but the built-in definitions
will be used for any keys you don't explicitly define in your files. For example, `en.json` might
look like the following:
```json
{
"title": "my app",
"LOGIN": {
"LABEL": {
"LOGIN": "Custom Sign In"
}
}
}
```
To enable the new translations in your app, you also need to register them in your
`app.module.ts` file. Import `TRANSLATION_PROVIDER` and add the path of your
translations folder to the `providers`:
@@ -128,10 +144,6 @@ ngOnInit() {
...
```
The new translation files completely replace the built-in ones.
If you want to continue using the built-in keys then you must add your new
keys to copies of the existing files.
Note: the `source` property points to the web application root. Ensure you have
webpack correctly set up to copy all the i18n files at compile time.