Muldersoft/LameXP
Muldersoft/LameXP
1
0
Fork 0
Code Releases 2 Activity

Slightly update the translators guide.

Browse Source
This commit is contained in:
LoRd_MuldeR 2011-01-06 01:45:05 +01:00
parent bb538580d6
commit af18311299
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/translate.html
View File

@ -13,9 +13,9 @@
<p>You can download <i>Qt Linguist</i> as a part of the Qt Framework, which is available as a free download from the <a href="http://qt.nokia.com/downloads/downloads" target="_blank">Qt download site</a>. You should pick the "LGPL" version and the "framework only" download.</p>
<br>
<h3>Editing the language file:</h3>
<p>LameXP v4.xx translations are created as TS (translation) files, which can be edited using the <i>Qt Linguist</i> application. For new translations an empty TS file ("Blank.ts") is provided in the LameXP Git repository. When you open the empty TS file for the first time, Linguist will ask for some basic settings. Here you must keep the "Source language" options at "English" and "Any Country". Change the "Target language" options to whatever language (region) you are going to translate too. Once you have edited all (or some) text strings, you can save your work to a TS file again. It is recommended to save your work to "LameXP_XX.ts", where <i>XX</i> should be replaced with the suitable upper-case <a href="http://www.loc.gov/standards/iso639-2/php/code_list.php" target="_blank">ISO 639-1</a> country code (for example the German translation is saved as "LameXP_DE.ts"). You can re-open your TS file at any time in order to continue with your work. In case you want to improve an existing LameXP translation, simply download the corresponding TS file from the LameXP Git repository and edit it using the Qt Linguist tool.</p>
<p>The latest translation (TS) files can always be found in the LameXP Git repository at:<br><a href="https://github.com/lordmulder/LameXP/tree/master/etc/Translation" target="_blank">https://github.com/lordmulder/LameXP/tree/master/etc/Translation</a><br>(After you have chosen a file from the directory tree, you can download the file by right-clicking on "raw" an choosing "Save Link Target As...")</p>
<p><font color="darkred"><b>Important:</b> Before you start translating, always make sure your download the <i>latest</i> "Blank.ts" file from the LameXP Git repository. If you want to edit an existing translation, including translations you have created yourself, make sure your download the <i>latest</i> TS file from the LameXP Git repository. Never ever do any translations based on an old working copy (TS file) from your local system! The translation files in the repository will be updated, as the development proceeds.</font></p>
<p>LameXP v4.xx translations are created as TS (translation) files, which can be edited using the <i>Qt Linguist</i> application. For new translations an empty TS file ("Blank.ts") is provided in the LameXP Git repository. When you open the empty TS file for the first time, Qt Linguist will ask for some basic settings. Here you must keep the "Source language" options at "English" and "Any Country". Change the "Target language" options to whatever language (region) you are going to translate to. Once you have edited all (or some) text strings, you can save your work to a TS file again. It is recommended to save your work to "LameXP_XX.ts", where <i>XX</i> should be replaced with the suitable upper-case <a href="http://www.loc.gov/standards/iso639-2/php/code_list.php" target="_blank">ISO 639-1</a> country code (for example the German translation is saved as "LameXP_DE.ts"). You can re-open your TS file at any time in order to continue with your work. In case you want to improve an existing LameXP translation, simply download the corresponding TS file from the LameXP Git repository and edit it using the Qt Linguist tool.</p>
<p>The latest translation (TS) files can always be found in the LameXP Git repository at:<br><a href="https://github.com/lordmulder/LameXP/tree/master/etc/Translation" target="_blank">https://github.com/lordmulder/LameXP/tree/master/etc/Translation</a><br><br style="line-height:4px">(After you have chosen a file from the directory tree, you can download the file by right-clicking on "raw" an choosing "Save Link Target As...")</p>
<p style="border-width:1px;border-style:solid;border-color:darkred"><font color="darkred"><b>Important:</b> Before you start translating, always make sure your download the <i>latest</i> "Blank.ts" file from the LameXP Git repository. If you want to edit an existing translation, including translations you have created yourself, make sure your download the <i>latest</i> TS file from the LameXP Git repository. Never ever do any translations based on an old working copy (TS file) from your local system! The translation files in the repository will be updated continuously, as the development proceeds.</font></p>
<br>
<h3>Language file editing rules:</h3>
Only language files that have been edited according to the following rules can be accepted:
@ -27,16 +27,17 @@ Only language files that have been edited according to the following rules can b
<li>All Qt-style placeholders, like <tt>%1</tt>, <tt>%2</tt> and so on, <i>must</i> remain in the translated strings, at the appropriate position.
</ul>
<br>
<h3>Personalization:</h3>
<p>Usually all translators will be mentioned in the "About..." dialogue. If you don't want your name and/or e-mail address to appear there, please tell us how you want to be credited!</p>
<br>
<h3>Testing your translation:</h3>
<p>Currently LameXP v4.xx needs to be re-built from the sources in order to integrate and test new translations. A more convenient method will be added soon.</p>
<p>LameXP v4.xx needs to be re-built from the sources in order to integrate a new translation or to update one of the "built-in" translations. However there is an easy method to test your translation file <i>without</i> re-building LameXP: Open your current translation (TS) file in the Qt Linguist application and goto "File" -> "Release As...", which allows you to save your translation as a "release" (QM) file. Once saved as a QM file, you can load your translation in LameXP. Just goto "View" -> "Language" -> "From File..." and choose the desired QM file. Your translation should be in effect immediately. If you notice that your translation needs further modifications, go back to the TS file for editing. Then, for your next test run, create a new QM file from the updated TS file.</p>
<br>
<h3>Submitting your translation:</h3>
<p>Once you are done with your translation, you can submit it, so it can be included in the next LameXP release. You can contact me by e-mail:<br><b><a href="mailto:mulder2%20[at]%20gmx%20[dot]%20de">mulder2<font color="dimgray">[at]</font>gmx<font color="dimgray">[dot]</font>de</a></b><br><br>It is sufficient to submit the translation file (*.ts). You don't need to compress the language file (ZIP, RAR, etc) and you don't need to attach a flag icon file.</p>
<p>Once you are done with your translation, you can submit it, so it can be integrated into the next LameXP release. You can contact me by e-mail:<br><b><a href="mailto:mulder2%20[at]%20gmx%20[dot]%20de">mulder2<font color="dimgray">[at]</font>gmx<font color="dimgray">[dot]</font>de</a></b></p>
<p>It is sufficient to submit the translation (TS) file. Please do <i>not</i> submit QM files. You don't need to compress the submitted file (ZIP, RAR, etc) and you don't need to attach a flag icon file.</p>
<p>(Note: Advanced translators can get write-access to the Git repository on request, so they can keep their translations up-to-date easily)</p>
<br>
<h3>Personalization:</h3>
<p>Usually all translators will be mentioned in the "About..." dialogue. If you don't want your name and/or e-mail address to appear there, please tell us how you want to be credited!</p>
<br>
<br>
Thanks in advance !!!
</body>