Translating your WordWeaver

*This guide assumes you have followed the steps for installing WordWeaver. It also assumes some familiarity with JSON, basic directory structure of your WordWeaver, Command Line, and NPM

The basic interface for your WordWeaver is already translated into English and French. But, you may want to add translations for your own language. This is the guide to show you how to do that.

1. Determine your language's code

Use a unique 2 or 3 digit code, or look yours up in the ISO 639-3 standard. Make note of this, you will have to use it in the next steps.

2. Create your file

Add two files to your i18n assets as seen below:

.
+-- projects
|   +-- server
|   +-- word-weaver
|       +-- src
|           +-- app
|               +-- app
|               +-- core
|               +-- pages
|               +-- shared
|           +-- assets
|               +-- i18n
|                   +-- data
|                       +-- en.json
|                       +-- fr.json
|                       +-- <yourcode>.json
|                   +-- en.json
|                   +-- fr.json
|                   +-- <yourcode>.json
...

3. Update your WordWeaver Configuration

Update your configuration values for languages. If you want to change your default language, you can also update that.

4. Extract default translations

Use the npm script, npm run-script extract-translations to update your json files automatically.

TODO: this currently only updates projects/word-weaver/src/assets/i18n/<yourcode>.json but not projects/word-weaver/src/assets/i18n/data/<yourcode>.json

5. Update your translations

You now must change the values for each key in projects/word-weaver/src/assets/i18n/<yourcode>.json to your language. We recommend using either a desktop tool like, BabelEdit, or an online collaborative resource like POEditor

That's it - your website will now include your translations!

info

We make use of, and greatly appreciate, the excellent tools ngx-translate and ngx-translate-extract - yay for open source!! 🎉🎉