-
Notifications
You must be signed in to change notification settings - Fork 115
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #238 from Schokobecher/i18n
German Translation Update / Cross-platform Language File Generation script / Updated Translation Docs
- Loading branch information
Showing
16 changed files
with
569 additions
and
248 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,92 @@ | ||
| # Transalation | ||
| # Translation | ||
|
|
||
| ## How to update exists translation | ||
| ## Firmware | ||
|
|
||
| 1. Edit fw/data/i18n.csv with your favorite text editor. For vscode, extension "Edit csv" is recommended. | ||
| 2. Run `fw/scripts/i18n_gen.py` to generate new language files. | ||
| 3. Optional: Run `fw/scripts/font_data_gen.sh` to generate new font data if you add new charaters in i18n.csv | ||
| 4. Run `make full` rebuild firmware | ||
| ## How to update existing translation | ||
|
|
||
| When editing CSV files with VSCode, the extension [Edit CSV](https://marketplace.visualstudio.com/items?itemName=janisdd.vscode-edit-csv) is recommended. | ||
|
|
||
| **Windows** requires you to have [Python](https://www.python.org/downloads/) and [Git](https://git-scm.com/download/windows) installed and within your `$PATH` | ||
| For **Linux**, most distributions come with `python` and `git` by default and **macOS** comes bundled with `python`, but to use `git` you either need to install the Command Line tools via `xcode-select –-install`, or download [Git](https://git-scm.com/download/mac) separately. | ||
|
|
||
| ### Windows | ||
|
|
||
| note: <br /> | ||
| The script `font_data_gen.sh` only can be run in Git Bash windows in Windows. | ||
| 1. Clone this repository | ||
| `git clone https://github.com/solosky/pixl.js.git; cd pixl.js` | ||
| 2. Edit `fw/data/i18n.csv` | ||
| 3. Run `py.exe fw/scripts/i18n_gen.py` to generate new language files. | ||
| 4. _Optional:_ Run `py.exe fw/scripts/font_data_gen.py` to generate new font data if you add new characters in `i18n.csv` | ||
| 5. [Build the Firmware](03-Build-Firmware.md) | ||
|
|
||
| ### Linux and macOS | ||
|
|
||
| 1. Clone this repository | ||
| `git clone https://github.com/solosky/pixl.js.git; cd pixl.js` | ||
| 2. Edit `fw/data/i18n.csv` | ||
| 3. Run `python3 fw/scripts/i18n_gen.py` to generate new language files. | ||
| 4. Optional: Run `python fw/scripts/font_data_gen.py` to generate new font data if you add new characters in `i18n.csv` | ||
| 5. [Build the Firmware](03-Build-Firmware.md) | ||
|
|
||
| ## How to add new language translation | ||
|
|
||
| 1. Add new column in fw/data/i18n.csv, for example "ja_JP" | ||
| The process is similar to updating an existing translation, and has the same requirements depending on your Operating System. | ||
|
|
||
| 1. Add new column in `fw/data/i18n.csv`, for example "ja_JP" | ||
| 2. Run `fw/scripts/i18n_gen.py` to generate new language files. | ||
| 3. Optional: Run `fw/scripts/font_data_gen.sh` to generate new font data if you add new charaters in i18n.csv | ||
| 3. Optional: Run `fw/scripts/font_data_gen.py` to generate new font data if you add new characters in `i18n.csv` | ||
| 4. Edit `fw/application/src/i18n/language.h` and `fw/application/src/i18n/language.c` to adopt new language | ||
| 5. Edit Makefile to include `$(PROJ_DIR)/i18n/ja_JP.c` as C source files | ||
| 6. Run `make full` rebuild firmware | ||
| 6. [Build the Firmware](03-Build-Firmware.md) | ||
|
|
||
| ## Font notes | ||
|
|
||
| For release builds (RELEASE=1), the firmware uses wenquanyi_9pt_u8g2.bdf to display unicode characters. | ||
| Please check if the new language character codepoint is included in wenquanyi_9pt_u8g2.bdf or not. | ||
| If not, it's not recommended supporting the new language due to the MCU internal flash restrictions. | ||
|
|
||
| ## Web App | ||
|
|
||
| ### How to update existing translation | ||
|
|
||
| The language file can be found under `web/src/i18n' | ||
|
|
||
| ## How to add new language translation | ||
|
|
||
| In this example, we will add a Japanese (ja_JP) translation: | ||
|
|
||
| 1. Copy the `en_US.js` file and name it `ja_JP.js` | ||
| 2. Translate the string within `ja_JP.js` including the `changeok` message. | ||
|
|
||
| Don't translate the other language names. | ||
|
|
||
| Add your language at the bottom of the `lang {` section: | ||
|
|
||
| `ja: '日本語',` | ||
|
|
||
| 3. Edit `index.js` while keeping its current structure, adding: | ||
|
|
||
| ```js | ||
| import elementJaLocale from 'element-ui/lib/locale/lang/ja' // element-ui | ||
| lang import jaLocale from './ja_JP' elementJpLocale | ||
| ``` | ||
|
|
||
| And extending `messages`: | ||
|
|
||
| ```js | ||
| ja_JP: { | ||
| ...jaLocale, | ||
| ...elementJaLocale, | ||
| }, | ||
| ``` | ||
|
|
||
| 4. Add your language to the other `.js` files (within the `lang: {` section): | ||
|
|
||
| `vueja: '日本語',` | ||
|
|
||
| ## Font notes | ||
| 5. Add your language to the `web/src/App.vue` file: | ||
|
|
||
| For release build (RELEASE=1), the firmware use wenquanyi_9pt_u8g2.bdf to display unicode characters. <br /> | ||
| Please check new language charater codepoint is included in wenquanyi_9pt_u8g2.bdf or not.<br /> | ||
| If not, I am not recommended to support the new language due to the MCU internal flash restrction. | ||
| ```js | ||
| <el-dropdown-item Enabled="language==='ja'" command="ja" divided> | ||
| {{ $t('lang.ja') }} | ||
| </el-dropdown-item> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.