T r a n s l a t o r   C e n t r a l
Submit Translation   |   How to Translate   |   Translation Guidelines



If your ability in English is sufficient to produce high-quality translations of English texts in a formal style, you can volunteer to translate the TrueCrypt user interface into your native language. You can also volunteer to translate the TrueCrypt User Guide.


All TrueCrypt translators are required to follow the Translation Guidelines.





Translation Guidelines


  1. Keep in mind that TrueCrypt is security software and inaccurate or misleading translation may cause very serious problems.


  2. Keep in mind that inaccurate translation can be worse than no translation at all.


  3. Learn as much as you can about TrueCrypt. There should be no TrueCrypt feature that you don't understand or are unable to use.


  4. A word or phrase may have different meanings in various contexts. Before translating a word or phrase, make sure you know in what context it is used (run TrueCrypt and locate the word or phrase that you intend to translate within the user interface).


  5. Each time you translate a word or phrase, exit and restart TrueCrypt and verify that the translated phrase is not too long and that it fits in the text field with your screen DPI set to 96 (default in Windows). If it does not, try to rephrase or choose shorter synonyms. If that does not solve the problem, use short forms or abbreviations (for example, instead of the word "including" you could use "incl.").


  6. Avoid informal expressions. Write in a formal style. Use a serious and polite tone.


  7. Do not translate proper names (for example, TrueCrypt Foundation, Serpent, AES, TrueCrypt).


  8. Do not put any nick names (for example, "HaCkEr") in the language pack credits section or in the documentation. If you do not want to reveal your real name, use a proper pseudonym (i.e., "FirstName LastName"). Do not put any URLs or e-mail addresses in the credits sections. Only names of translators (or their proper pseudonyms) may be included in the credits sections. If multiple translators have worked on a translation, their names must be preserved and separated with a comma and a space (for example, "John Smith, Paul Carpenter"). All names and pseudonyms in the credits section must be in the Latin alphabet.


  9. Do not insert any new texts in the language pack or in the documentation (apart from your name in the credits section). Likewise, do not remove any texts in the language pack or in the documentation. You are allowed solely to translate (and only thus replace) the existing texts.


  10. Do not rush your translation. Quality is very important to us. How long it takes you to translate TrueCrypt is not as important as how good your translation is. (However, you should still keep in mind that if a new version of TrueCrypt is released, your translation may need to be updated. If your translation appears to be abandoned for an unreasonably long time, another translator may take it over or replace it.)


  11. A font face may be changed only if it is not available in the corresponding localized version of Windows or if there is a more commonly used equivalent font face in the localized version of Windows (never only because you like another font face more, for example). A font size may be changed only if it causes serious legibility issues or if most of the translated texts do not fit in their text fields even though you used short forms or abbreviations (for example, instead of the word "including" you used "incl.").


  12. Some of the strings contain special control strings (predefined sequences of characters). All these control strings and the order in which they appear must be preserved.

    Types of control strings:
    1. "Escaped" characters. These begin with the character \

      \n     new line
      \t      tab
      \\     \  (backslash)

      Example: "Warning: Caps Lock is on.\nThis may cause you to enter your password incorrectly."


    2. Placeholders, which get replaced with other text. They begin with %

      %hs
      %hc
      %s
      %c
      %d
      %I64d
      %.2f

      etc.

      Example:  "Free space on drive %hs is %d GB."


    3. "Escaped" XML characters.

      & represents the character & (used to define shortcut keys)
      &lt; represents the character <
      &gt; represents the character >
      &quot; represents the character "

      Example:  "Select D&amp;evice"  (Windows will convert this string to "Select Device" and assign the key E as shortcut.)

      Note that in XML editors these characters are usually converted automatically.
                              



How to Translate


Please make sure you have read the Translation Guidelines and that you have the latest version of TrueCrypt.

You can write a new translation or edit existing translations (for example, to correct mistakes in your or someone else's translation, or to complete incomplete translations).

Note that language packs are currently supported only by the Windows versions of TrueCrypt.


Although at first glance the following steps might seem too difficult or complicated, as regards technical aspects, translating TrueCrypt is actually quite easy and straightforward.


1) First of all, look at this page to find out whether a language pack for your native language is available. If it is and if you want to complete or correct it, download that language pack and continue from step 2.

If there is currently no language pack for your native language available or you want to replace an existing language pack with a new one starting from scratch, download the English language pack.


2) Unpack the archive that you have downloaded in step 1. Extract it to the folder to which you installed TrueCrypt (that is the folder in which TrueCrypt.exe resides).


3) If you are not going to create a new translation (i.e., if you just intend to complete or correct an existing translation), skip steps 4-6 and continue from step 7.


4) Among the unpacked files, locate the file Language.xml and rename it to Language.xx.xml where xx is your language code (for example, you could rename it to Language.de.xml). Please use a two-character language code. If the ISO 639 standard does not provide a two-character code for your language or dialect, you may use a five-character code in the format xx-xx, which might be listed here.


5) Open the file Language.xx.xml (where xx is the target language code you chose in step 4) in a plain text editor (such as notepad.exe) or in an XML editor. Note that the editor must support the UTF-8 (Unicode) encoding. If you decide to open the file in a plain text editor, you will have to cope with XML tags (but it shouldn't be a big problem). If you need information about XML, it may be found, for example, here.


6) In the file you opened in step 5, find the tag language and set its attributes as follows:

a) Set langid to the target language code you chose in step 4 (for example, de)
b) Set en-name to the English name of the target language (for example, German)
c) Set name to the native name of the target language (for example, Deutsch)
d) Append your name to the attribute string translators.

Note that in some editors, the UTF-8 signature at the beginning of the file (before the <?xml tag) is displayed as three characters, which may appear to be garbage. Do not delete these characters.

An example for those who will use a plain text editor:

       Note: For clarity in this example, the only parts you need to edit are in bold.

You will edit the following:
<language langid="en" name="English" en-name="English" version="0.0.0" translators="" />

After having been edited, it could look like this:
<language langid="de" name="Deutsch" en-name="German" version="0.0.0" translators="John Smith" />


7) If you skipped steps 4-6, open the language pack in a plain text editor (such as notepad.exe) or in an XML editor. Note that the editor must support the UTF-8 (Unicode) encoding. If you decide to open the file in a plain text editor, you will have to cope with XML tags (but it shouldn't be a big problem). If you need information about XML, it may be found, for example, here.

Note that in some editors, the UTF-8 signature at the beginning of the file (before the <?xml tag) is displayed as three characters, which may appear to be garbage. Do not delete these characters.


8) In the language pack, translate all strings that are in English into the target language. Make sure you are following the Translation Guidelines. For each translated item, set the lang attribute to the target language code (that you chose in step 4); otherwise the translated string will be ignored and the English original will be displayed instead.

An example for those who will use a plain text editor:

       Note: For clarity in this example, the only parts you need to edit are in bold.

For example, you decide to translate the following item, which is the caption of the Abort button:
<control lang="en" key="IDC_ABORT_BUTTON">Abort</control>

Then the same item after you translate it e.g. into German should look like this:
<control lang="de" key="IDC_ABORT_BUTTON">Abbrechen</control>


Important: Do not change the lang attribute if you have not translated the string (just leave it at "en" until you translate it). However, if an English word and its translation have identical spelling (internationalism), then do not leave the attribute at "en".

If you begin translating an item, please translate it entirely or leave it untranslated. It is unacceptable to have one half of a sentence in English and the other half of the same sentence in another language.


9) Submit/upload the language pack using the form on this page. Please do not send it via e-mail. The only way to send us your translation is to upload it using the form on this page. Translations sent any other way cannot and will not be accepted.


Important:
Note that when we produce a new version of TrueCrypt, new texts may be added to the user interface; some texts may be changed or deleted. When that happens, we will automatically merge your translation (of the older version of TrueCrypt) with the latest version of the English language pack. The result of the merging will be a language pack containing your translated texts and new texts in English (this merged language pack will be compatible with the latest version of TrueCrypt). We will publish this merged language pack and its status (displayed at this page) will be incomplete.
If you see that the status of your language pack changed to incomplete, download the language pack (whose status is incomplete) from our server and follow the steps 2, 7, 8, and 9 (i.e., translate all strings that are in English into the target language, and resubmit the whole xml file).

If we release a new version of TrueCrypt while you are translating an older language pack, you can still finish it and submit it. As described in the previous paragraph, we will merge it with the latest English language pack and publish it with the status of incomplete (see above).








How to Translate TrueCrypt User's Guide


If you also intend to translate the TrueCrypt User Guide, first please ask yourself whether you will be able to translate it entirely and to keep updating it each time a new version of TrueCrypt is released. We will be able to publish your translations only if answers to both of those questions are "yes". If they are, then look at this page to find out whether a language pack for your native language is available. If it is, download and unpack it to find out whether it contains a file called TrueCrypt User Guide.xx.pdf where xx is a language code. If it doesn't contain such a file or if there is no language pack for your native language available, download this file (it is in the OpenDocument format, which can be edited for example with the free OpenOffice Writer) and translate it entirely. Note that you are not allowed to insert any new texts in the documentation (only to translate the existing), with one exception: You may add the following phrase at the very end of the documentation: "Translated by [your name]" (instead of your real name you can use a proper pseudonym in accordance with the Translation Guidelines).

Should you need to change fonts, please use only Unicode fonts in wide-spread use. After you finish translating, add your target language code to the filename (for example, TrueCrypt User Guide.de.odt). Please use a two-character language code. If the ISO 639 standard does not provide a two-character code for your language or dialect, you may use a five-character code in the format xx-xx, which might be listed here. Make sure you have followed the Translation Guidelines. Finally, submit the translated file (in the .odt format) using the form on this page (please do not send it via e-mail).

Important: Please keep both the translated .odt file that you will submit and a copy of the original TrueCrypt User Guide.odt file in English (which you translated). When we release a new version of TrueCrypt, the documentation translated by you may be removed from the language pack (for being obsolete and potentially misleading). If that happens, you will need to update your translation. It will be easier if you know exactly which parts of the manual have changed since the last version. The best way to find that out is as follows: Download the latest version of the documentation in English, load it in OpenOffice Writer, select Edit -> Compare Document, and then select/load the previous version of the documentation in English (if you have it). For more information on comparing two documents in OpenOffice, please refer to its documentation. Do not forget to examine screenshots of the TrueCrypt user interface in the User Guide for possible changes (note that OpenOffice does not detect changes in images). After you translate new/changed portions, and after you delete parts in your translation that were removed in the English version, you may submit your updated translation using the form on this page (please do not send it via e-mail).






Submit Form

Important notes:

Please do not e-mail us your translations. The only way to send us your translation is to upload it using this form. Translations sent any other way cannot and will not be accepted.

We recommend that you provide a valid e-mail address. If there is any problem with your translation, we may need to contact you to ask you to fix it. If we cannot contact you, your translation may be removed or rejected. Note that we will keep your e-mail address secret.

Please do not pack the file you intend to upload. Note that you can submit only the following types of files: .xml, .odt. The maximum allowed file size is 1.9 MB.

Before you can upload a file, you must check the checkbox below the text field to indicate that you accept and agree to be bound by the terms of the TrueCrypt Translator Agreement that is displayed above the checkbox.



I agree and accept the terms of the TrueCrypt Translator Agreement (above).



Your e-mail address:

File to upload:




Last Updated July 2, 2012          Legal Notices  •  Sitemap  •  Search