Merge pull request #5 from rmraya/Localization

Localization

.gitignore

@@ -7,13 +7,15 @@
 /node_modules/
 /man/
 /out/
-/docs/out/
+/docs/en/out/
+/docs/es/out/
 /release
 /XLIFF Manager-darwin-x64/
 /XLIFF Manager-darwin-arm64/
 /XLIFF Manager-win32-x64/
 /XLIFF Manager-linux-x64/
 /.settings/
 /.scannerwork/
+/.vscode/
 .DS_Store
 package-lock.json

LOCALIZATION.md

@@ -0,0 +1,33 @@
+# XLIFF Manager Localization
+
+Localizing XLIFF Manager requires processing 3 types of files:
+
+1. Java .properties files
+2. TypeScript strings in JSON format
+3. Documentation from DITA files
+
+## Localization of Java .properties
+
+[javaPM](https://www.maxprograms.com/products/javapm.html) is used to generate XLIFF from `/src` folder.
+
+Use a command like this to generate XLIFF:
+
+```bash
+/path-to-Javapm/createxliff.sh -src XLIFFManager/src -xliff yourXliffFile.xlf -srcLang en -tgtLang fr -enc UTF-8
+```
+
+XLIFF Manager .properties are encoded in UTF-8; translated versions must be generated using UTF-8 character set.
+
+## Localization of TypeScript strings
+
+XLIFF Manager can be used to generate to generate XLIFF from the JSON files stored in `/i18n` folder.
+
+- Use `/i189/filterConfig.json` when generating XLIFF to handle `'&'` signs used in menu names as regular characters instead of HTML entities.
+- Select *Paragraph Segmentation* to avoid splitting strings at inconvenient places.
+- Select *Export Approved Segments as TMX* when merging the translated XLIFF and then reuse those translations when processing the User Guide.
+
+## Localization of DITA manuals
+
+Although you can use XLIFF Manager to generate XLIFF from the DITA maps stored in `/docs` folder, it is stronly suggested to use [Fluenta](https://www.maxprograms.com/products/fluenta.html) for processing the manuals. Fluenta offers enhanced methods for reusing translations when the manual is updated.
+
+Use [Conversa DITA Publisher](https://www.maxprograms.com/products/conversa.html) to publish the translated DITA maps as PDF.

README.md

@@ -119,8 +119,8 @@ You can subscribe to [Maxprograms Support](https://groups.io/g/maxprograms/) at
 
 - JDK 17 or newer is required for compiling and building. Get it from [Adoptium](https://adoptium.net/).
 - Apache Ant 1.10.12 or newer. Get it from [https://ant.apache.org/](https://ant.apache.org/)
-- Node.js 16.13.0 LTS or newer. Get it from [https://nodejs.org/](https://nodejs.org/)
-- TypeScript 4.8.4.  Get it from [https://www.typescriptlang.org/](https://www.typescriptlang.org/)
+- Node.js 18.0.0 LTS or newer. Get it from [https://nodejs.org/](https://nodejs.org/)
+- TypeScript 5.0.0 or newer.  Get it from [https://www.typescriptlang.org/](https://www.typescriptlang.org/)
 
 ## Building