Difference between revisions of "Translations"

From BaseX Documentation
Jump to navigation Jump to search
Line 5: Line 5:
 
It is easy to translate BaseX into your native language! This is how you can proceed:
 
It is easy to translate BaseX into your native language! This is how you can proceed:
  
−
==Using the JAR file==
+
==Working with the sources==
−
JAR files are nothing else than ZIP archives.
 
−
All language files are placed in the <code>lang</code> directory inside the JAR file:
 
−
# Unzip the source file <code>English.lang</code> and rename it to your target language (e.g. <code>Zulu.lang</code>)
 
−
# Enter your name and potential contact information in the second line and translate all texts
 
−
# Update your JAR file by copying the translated file into the zipped <code>lang</code> directory. Your new language file will be automatically scanned.
 
−
# Start BaseX and choose your language in the GUI (''Options'' → ''Preferences...'')
 
−
# Restart BaseX to see the changes
 
  
−
==Using the sources==
+
If you have downloaded all BaseX sources via [[http://docs.basex.org/wiki/Integrate|Eclipse]] or [[http://docs.basex.org/wiki/Maven|Maven]], you may proceed as follows:
−
All language files are placed in the <code>src/main/resources/lang</code> directory of the main project:
 
−
# Create a copy of the source file <code>English.lang</code> and rename it to your target language (e.g. <code>Zulu.lang</code>)
 
−
# Enter your name and potential contact information in the second line and translate all texts
 
−
# Copy the translated file back to the <code>lang</code> directory. Your new language file will be automatically scanned.
 
−
# Recompile the project, start BaseX and choose your language in the GUI (''Options'' → ''Preferences...'')
 
−
# Restart BaseX to see the changes
 
  
−
You may as well change the language in the <code>.basex</code> configuration file,
+
All language files are placed in the <code>[https://github.com/BaseXdb/basex/tree/master/src/main/resources/lang src/main/resources/lang]</code> directory of the main project:
 +
# Create a copy of an existing translation file (e.g., <code>English.lang</code>) and rename it to your target language (e.g. <code>Hawaiian.lang</code>)
 +
# Enter your name and contact information in the second line
 +
# If you are using Eclipse, refresh the project (via ''Project'' → ''Refresh''); if you are using Maven, type in {{Code|mvn compile}}. Your new language file will be automatically detected.
 +
# Start the BaseX GUI, choose your language via ''Options'' → ''Preferences...'' and close the GUI
 +
# Translate the texts in your language file and restart BaseX in order to see the changes
 +
# Repeat the last step if you want to revise your translations
 +
 
 +
==Updating BaseX.jar==
 +
 
 +
You may directly add new languages to the JAR file. JAR files are nothing else than ZIP archives, and all language files are placed in the <code>lang</code> directory int the JAR file:
 +
 
 +
# Unzip an existing translation file (e.g., <code>English.lang</code>) and rename it to your target language (e.g. <code>Hawaiian.lang</code>)
 +
# Enter your name and contact information in the second line and translate the texts
 +
# Update your JAR file by copying the translated file into the zipped <code>lang</code> directory. Your new language file will be automatically detected.
 +
# Start BaseX.jar, choose your language via ''Options'' → ''Preferences...'' and restart BaseX to see the changes
 +
 
 +
You may also change the language in the <code>.basex</code> configuration file,
 
which is placed in your [[Configuration|home directory]].
 
which is placed in your [[Configuration|home directory]].
−
To see where the all text keys are used within BaseX, we recommend you to temporarily
+
In order to see where the all text keys are used within BaseX, you may temporarily
 
set the [[Options#LANGKEY|LANGKEY]] option to <code>true</code>.
 
set the [[Options#LANGKEY|LANGKEY]] option to <code>true</code>.

Revision as of 12:51, 11 December 2012

This page is part of the Developer Section. It describes how to translate BaseX into other (natural) languages.

BaseX is currently available in nine languages, namely Dutch, English, French, German, Italian, Indonesian, Japanese, Mongolian, and Romanian.
It is easy to translate BaseX into your native language! This is how you can proceed:

Working with the sources

If you have downloaded all BaseX sources via [[1]] or [[2]], you may proceed as follows:

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

  1. Create a copy of an existing translation file (e.g., English.lang) and rename it to your target language (e.g. Hawaiian.lang)
  2. Enter your name and contact information in the second line
  3. If you are using Eclipse, refresh the project (via Project → Refresh); if you are using Maven, type in mvn compile. Your new language file will be automatically detected.
  4. Start the BaseX GUI, choose your language via Options → Preferences... and close the GUI
  5. Translate the texts in your language file and restart BaseX in order to see the changes
  6. Repeat the last step if you want to revise your translations

Updating BaseX.jar

You may directly add new languages to the JAR file. JAR files are nothing else than ZIP archives, and all language files are placed in the lang directory int the JAR file:

  1. Unzip an existing translation file (e.g., English.lang) and rename it to your target language (e.g. Hawaiian.lang)
  2. Enter your name and contact information in the second line and translate the texts
  3. Update your JAR file by copying the translated file into the zipped lang directory. Your new language file will be automatically detected.
  4. Start BaseX.jar, choose your language via Options → Preferences... and restart BaseX to see the changes

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

Retrieved from "http://docs.basex.org/index.php?title=Translations&oldid=8450"