Chapter 4. Customization

Table of Contents

4.1. Languages
4.1.1. Defining Language Files
4.2. Quote of the Day

This chapter shows how to customize the displayed language and the file for the Quote of the Day.

4.1. Languages

Klaros-Test­management comes with language files in German and English. Support for additional languages can be added by using additional language files if needed. The corresponding language file must be stored in the .klaros/resources/messages directory for this.

Language files are activated in the application under Configure / System / Languages. Detailed information can be found under Section, “Enabling and Disabling Languages”.

4.1.1. Defining Language Files

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).

[Tip] Language File Encoding

The language file must use ISO-8859-1 encoding with Unicode escapes ( \uXXXX).

If you prefer editing these files as UTF-8 please use a converter like native2ascii or iconv to translate them to a proper format.

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 (, and 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. 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.

4.2. Quote of the Day

Klaros-Test­management displays a new Quote of the day on the login screen every day. The default quotes can be extended by own entries or deactivated. The quote file can be uploaded and activated in Klaros-Test­management on the page General Settings directly into the folder .klaros/resources in the user's home directory.

This file is a .txt document in ISO-8859-1 encoding and uses one line per quote. Section Section 10.4, “System” describes how to install this file. The respective quotes change daily.