Translations

From BaseX Documentation
Jump to navigation Jump to search

BaseX is available in several languages (such as English, German, or Japanese). You can make us happy by contributing new translations! You may proceed as follows:

Using the JAR file

JAR files are nothing else than ZIP archives. All language files are placed in the lang directory inside the JAR file:

  1. Unzip the source file English.lang and rename it to your target language (e.g. Zulu.lang)
  2. Enter your name and potential contact information in the second line and translate all texts
  3. Update your JAR file by copying the translated file into the zipped lang directory. Your new language file will be automatically scanned.
  4. Start BaseX and choose your language in the GUI (OptionsPreferences...)
  5. Restart BaseX to see the changes

Using the sources

All language files are placed in the src/main/resources/lang directory of the main project:

  1. Create a copy of the source file English.lang and rename it to your target language (e.g. Zulu.lang)
  2. Enter your name and potential contact information in the second line and translate all texts
  3. Copy the translated file back to the lang directory. Your new language file will be automatically scanned.
  4. Recompile the project, start BaseX and choose your language in the GUI (OptionsPreferences...)
  5. Restart BaseX to see the changes

You may as well change the language in the .basex configuration file, which is placed in your home directory. To see where the all text keys are used within BaseX, we recommend you to temporarily set the LANGKEY option to true.