code:commercial:hse-translator:getting-started
Table of Contents
02 Getting Started
Installation
-
Install the latest package of the JKI Simple Localization Toolkit
-
Extract the .zip file which you have received from HSE
-
Copy the folder
hse-i18n_Source\Libraries\hse-i18n
into your project folder/APP-NAME_Source\Libraries
-
Add the
Translator.ini
to your existingConfig/Unit_XYZ
folder -
In your project explorer, include the new folder
APP-NAME_Source\Libraries\hse-i18n
Directory Structure
Test
-
Run the Test Translator API.vi of the Translator to test if it is working
-
Run the Test Translator-UI API.vi of the Translator-UI to test, if it is working
Configuration
-
Within the Translator-UI, create a new JSON Dictionary file on your hard disc
-
Update
Translator.ini
located in yourConfig/Unit_XYZ
folder so that the config keydictionary
points to the new JSON Dictionary file -
Once per application: Make sure to start the Translator module before any other modules by adding it to the front of the modules list in
config.ini
-
e.g.
list = “Libraries\hse-i18n\Translator;Modules\Dummy”
Usage
-
For each VI that should be translated:
-
Use the Translator-UI to define all identifiers and translation phrases which should be used for that VI.
-
Within that VI, call the Register VI-Request of the Translator and pass the VI reference.
If no language is set, the toolkit will use the current system locale.
Don't forget to set Caption Visible for the controls instead of Labels!
Setting for Non Unicode Programms
Additional Steps, if no HSE-Application Template is used
-
The Toolkit makes use of our Project Structure. At least create two folders where APP-Name can be a name of your choice.
-
Create a Config-Folder /APP-NAME_Config
-
Create a Source-Folder /APP-NAME_Source
-
Copy the the content of the folder hse-i18n_Config into your project folder /APP-NAME_Config
-
create a config.ini which points to your Config/Unit
Examples
The repository contains a small example DQMH Module called
Dummy
in the\Modules
subdirectory.Register a VI for Translation
Manually Translate a String
-
code/commercial/hse-translator/getting-started.txt · Last modified: 2024/02/09 15:25 by alexander.elbert
-