Difference between revisions of "Translations"

From BaseX Documentation
Jump to navigation Jump to search
(Created page with "BaseX is available in several languages (such as English, German, or Japanese). We are always thankful for contributions, and if you willing to contribute a new translation, plea...")
 
Line 5: Line 5:
 
==Using the JAR file==
 
==Using the JAR file==
 
JAR files are nothing else than ZIP archives.
 
JAR files are nothing else than ZIP archives.
All language files are placed in the <code>lang</code> directory inside the JAR file.
+
All language files are placed in the <code>lang</code> directory inside the JAR file:
# Unzip the source file <code>English.lang</code> and name it to your language (e.g. <code>Zulu.lang</code>)
+
# 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
 
# 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 in the JAR file
+
# Update your JAR file by copying the translated file back to the <code>lang</code> directory
 
# Start BaseX and choose your language in the GUI (''Options'' → ''Preferences...'')
 
# Start BaseX and choose your language in the GUI (''Options'' → ''Preferences...'')
# Restart BaseX, and you should see the changes
+
# Restart BaseX to see the changes
  
 
==Using the sources==
 
==Using the sources==
 
All language files are placed in the <code>src/main/resources/lang</code> directory of the main project:
 
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 name it to your language (e.g. <code>Zulu.lang</code>)
+
# 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
 
# Enter your name and potential contact information in the second line and translate all texts
# Translate all given texts
 
 
# Compile the project, start BaseX and choose your language in the GUI (''Options'' → ''Preferences...'')
 
# Compile the project, start BaseX and choose your language in the GUI (''Options'' → ''Preferences...'')
# Restart BaseX, and you should see the changes
+
# Restart BaseX to see the changes
  
To see where the texts are used within BaseX, it is recommended to set the LANGKEYS property in the <code>.basex</code> configuration file to true. You will find the file in your [[Configuration#Home_Directory home directory]].
+
You may as well change the language in the <code>.basex</code> configuration file,
 +
which is placed in your [[Configuration#Home_Directory|home directory]].
 +
To see where the texts are used within BaseX, we recommend you to also set the
 +
[[Options#General options|LANGKEY]] property to <code>true</code>.

Revision as of 13:32, 31 March 2011

BaseX is available in several languages (such as English, German, or Japanese). We are always thankful for contributions, and if you willing to contribute a new translation, please 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 back to the lang directory
  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. Compile the project, start BaseX and choose your language in the GUI (OptionsPreferences...)
  4. 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 texts are used within BaseX, we recommend you to also set the LANGKEY property to true.