From f74d575d6a58ee27f84ebbc141340f8c87a010a0 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Thu, 18 Feb 2021 21:42:46 +0100 Subject: [PATCH] Update the i18n readme --- i18n/README.md | 44 +++++++++++++++++++++++++------------------- i18n/nw_pt.ts | 3 ++- 2 files changed, 27 insertions(+), 20 deletions(-) diff --git a/i18n/README.md b/i18n/README.md index e3b54c6e..2addc4b3 100644 --- a/i18n/README.md +++ b/i18n/README.md @@ -1,18 +1,21 @@ # novelWriter Internationalisation The `i18n` folder contains the internationalisation files for novelWriter. -There are two types of files. The `nw_XX.qm` files are for localisation of the -main GUI, and the `project_XX.json` files are JSON files with translation maps -for the novelWriter projects. +There are two types of files. The `nw_XX.ts` / `nw_XX.qm` files are for +localisation of the main GUI, and the `project_XX.json` files are JSON files +with translation maps for the novelWriter projects, used by the Build Novel +Project tool. ## GUI Localisation -The `.qm` files are not generated by default. They can be built with: +The `.qm` files are the actual files used by the application to translate the +GUI into another language other than the default British English. The files are +not generated by default. They can be built with: ```bash python3 setup.py qtlrelease ``` -To add a new translation file, please add a new entry in the `novelWriter.pro` +To add a new translation file, first add a new entry in the `novelWriter.pro` file under the `TRANSLATIONS` variable. Please use the underscore syntax for file names as the importer expects this format. @@ -22,11 +25,16 @@ python3 setup.py qtlupdate ``` This will build a new `nw_XX.ts` file for the language you just added. The file -can then be edited with the Qt 5 Linguist application. Please select "English" -and "United Kingdom" as the source langauge when prompted. +can then be edited with the Qt 5 Linguist application provided by Qt. This is +by far easier than manually editing the `.ts` file. Please select "English" and +"United Kingdom" as the source langauge when prompted by Qt 5 Linguist. When you're done editing, you can build the `nw_XX.qm` file and test it in -novelWriter. +novelWriter. The Preferences dialog should list the newly added language, and +you can select it and test it. + +Please do not submit thw `.qm` files to the repository. Only the `.ts` files +are needed. **Note:** This requires that you have the tools Qt 5 Linguist and `pylupdate5` installed on your system. @@ -37,16 +45,14 @@ Projects can have a different language setting than the GUI itself. The files with format `project_XX.json` are simple translation maps for text that goes into the exported documents. -The files are loaded based on the main GUI spell check language or the -project's spell check language. The project's spell check language takes -precedence over the GUI spell check language. - -Since these are used mainly as replacement lookups, they are maintained as -plain JSON files. The main usage is to generate chapter headers as number -words. +The files are loaded based on the language setting on the Build Novel Project +tool. At the present time, no other parts of the application use these files. +Since these are used as replacement lookups, they are maintained as plain JSON +files. The main usage is to generate chapter headers as number words. There is no trick to using these files. Just copy the `project_en.json` file, -rename it, and edit it. Please use the underscore as separator if a language -needs to be localised to a specific country under a language. The importer will -for instance look for `en_GB` or `en_US` first, then use `en` if either is not -found. If there are no matching files, the project falls back to using English. +rename it to the appropriate language coded filename, and edit it. Please use +the underscore as separator if a language needs to be localised to a specific +country under a language. The importer will for instance look for `en_US` +first, then use `en` if it is not found. If there are no matching files, the +project falls back to using English. diff --git a/i18n/nw_pt.ts b/i18n/nw_pt.ts index c0c183be..a7ce6797 100644 --- a/i18n/nw_pt.ts +++ b/i18n/nw_pt.ts @@ -1,5 +1,6 @@ - + + Common