Chapter 4. Customization

Adding a valid language file to the .klaros/resources/messages directory causes the language to become available in Klaros-Test­management. A valid language file has a name of the form messages_${language}_${COUNTRY}_${variation}.properties where ${language} is the two-letter ISO 639-1 code for the language in lower-case, ${COUNTRY} is the two-letter ISO 3166 code for the country in upper-case and ${variation} is an optional, user-definable code for the variation of the language (e.g. dialect).

After Klaros-Test­management is run for the first time, the American English, German and fallback language files will be copied to the .klaros/resources/messages folder. In order to create a new language file, the text should be copied out of one of these files into an appropriately named file. The contents of the file consist of key value pairs in the form: key=This sentence is the value. None of the keys should be altered. The values (the text after the '=') should be translated into the target language.

When Klaros-Test­management is started, the default language files ( messages.properties, messages_en_US.properties and messages_de_DE.properties) are copied to the .klaros/resources/messages folder, overwriting any changes made to these files. Therefore, it is advised that any user changes to the American English and German interfaces be made in a file with the variation in the filename set, e.g. messages_en_US_companyName.properties in order to persist changes.

As well as copying over the default files, Klaros-Test­management also merges any changes with user-defined files. If key-value pairs are added to the default files during an update, these will also be added to the end of any user-defined language files, along with a comment stating when the entries were added. These entries should be translated by the creator of the custom language file.