r15769 by christoph - rewritten translation-howto.html
scribus-commit
scribus-commit at lists.scribus.net
Thu Nov 4 23:42:01 CET 2010
Author: christoph
Date: Thu Nov 4 22:42:00 2010
New Revision: 15769
URL: http://scribus.info/websvn/listing.php?repname=Scribus&sc=1&rev=15769
Log:
rewritten translation-howto.html
Modified:
branches/Version135/Scribus/scribus/doc/en/translation_howto.html
Modified: branches/Version135/Scribus/scribus/doc/en/translation_howto.html
URL: http://scribus.info/websvn/diff.php?repname=Scribus&rev=15769&path=/branches/Version135/Scribus/scribus/doc/en/translation_howto.html
==============================================================================
--- branches/Version135/Scribus/scribus/doc/en/translation_howto.html (original)
+++ branches/Version135/Scribus/scribus/doc/en/translation_howto.html Thu Nov 4 22:42:00 2010
@@ -6,23 +6,22 @@
<body>
<h2>How to create or update a translation of Scribus</h2>
-<p>Scribus is available in over 20 languages thanks to the many willing souls out there who have spent the time translating. This is no small task, but to be honest, not a very difficult one technically. This page outlines the requirements and procedures for creating or updating such a translation.</p>
+<p>Scribus is available in over 20 languages, thanks to the many willing souls out there who have spent the time translating. This is no small task, but at least technically not a very difficult one. This page outlines the requirements and procedures for creating or updating such a translation.</p>
-<p>Please note, there are many willing contributors to the Scribus project and there may already be a translation in progress for the language you wish to help for. It would be worthwhile asking on the mailing list to see if someone has started. This is also a courtesy matter. At this point we don't really have any "official" translators but perhaps you can work together, or take over an old translation if the previous translator no longer has the time to keep it up-to-date. So, here we go...</p>
+<p>Please note that there are many willing contributors to the Scribus project, and there may already be a translation in progress for the language you wish to help for. It would be worthwhile asking on the mailing list to see if someone has started. This is also a courtesy matter. At this point we don’t really have any “official” translators but perhaps you can work together, or take over an old translation if the previous translator no longer has the time to keep it up-to-date. So, here we go ...</p>
+<h3>Part One: Translating the TS files</h3>
-<h3>Requirements</h3>
+<h4>Requirements</h4>
<ul>
-<li>The Scribus source from SVN. Please see the <a href="install.html">Installation</a> section for details on how to checkout SVN if you aren't up with that yet. Its not too hard so don't be dismayed. By working with the SVN source, you know you will be working with the latest Scribus source and therefore will get the most up-to-date set of files to translate.</li>
-<li>KBabel or Qt Linguist. Both of these are available in their respective development packages. The choice of which one to use is more a user preference, the result is the same.</li>
-<li>You will need to make sure you have the <strong><code>lupdate</code></strong> and <strong><code>lrelease</code></strong> programs which are a part of Qt, or perhaps a part of a Qt development package, depending on your distribution.</li>
-<li>If you use create .mo for .po files you need the <strong><code>msg2qm</code></strong> program to convert them to .qm files.</li>
-<li>For Scribus 1.3.5+, you must use Qt4's translation tools only. Do NOT use Qt3 utilities!</li>
+<li>The Scribus source from SVN. Please see the <a href="install1.html">Installation</a> section for details on how to checkout SVN if you aren’t up with that yet. Its not too hard so don’t be dismayed. By working with the SVN source, you know you will be working with the latest Scribus source and therefore will get the most up-to-date set of files to translate.</li>
+<li><a href="http://i18n.kde.org/tools/">Lokalize</a> or Qt4 Linguist (do <b>not</b> use Qt3 linguist!). Both of these are available in their respective development packages. The choice of which one to use is more a user preference, the result will be the same. For those who are new to this kind of work, Qt4 Linguist may be the tool of choice, as it offers a very simple, yet efficient user interface. Moreover, it's availabe for all platforms that are supported by Scribus (Linux/UNIX, Mac OS X, Windows 2000+, OS/4 Warp4 and eComStation).</li>
+<li>You will need to make sure you have the <code>lupdate</code> program installed, which is a part of Qt4, or perhaps a part of the Qt4 development package, depending on your distribution.</li>
</ul>
-<h3>Procedure for creating or updating a translation file</h3>
+<h4>Procedure for creating or updating a translation file</h4>
<ol>
-<li>Check out SVN as per instructions on this page.</li>
-<li>Move into the <code>Scribus</code> directory.</li>
+<li>Check out <a href="install1.html">SVN</a>.</li>
+<li>Move into the <code>~/Scribus</code> directory.</li>
<li>Run <code>qmake -project</code>.</li>
<li>Edit the <code>Scribus.pro</code> file to have the language listed at the bottom that you wish to translate for. For example,
<blockquote><table width="100%" border="1" bgcolor="#eeeeee"><tr><td border="0">
@@ -30,16 +29,58 @@
</td></tr></table></blockquote>
Of course, replace the <code>en_GB</code> in this example with the language code you are working with.</li>
<li>Run <code>lupdate Scribus.pro</code>.</li>
-<li>Start KBabel or Qt Linguist and load the <code>resources/translations/po/scribus.en_GB.ts</code> file.</li>
+<li>Start your translation program and load the <code>resources/translations/po/scribus.en_GB.ts</code> file.</li>
<li>Perform the translations.</li>
-<li>Save the <code>.ts</code> file.</li>
-<li>Run <code>lrelease resources/translations/po/scribus.en_GB.ts -qm scribus/qm/scribus.en_GB.qm</code>. this can be simplified by just running <code>lrelease resources/translations/po/scribus.en_GB.ts</code> and the qm will be created for you in the <code>resources/translations/po</code> directory. The previous command allows a <code>make && make install</code> with the translations in their correct places.</li>
-<li>Copy the <code>.qm</code> file to the <code>/usr/local/lib/scribus</code> directory (or appropriate Scribus installation directory on your PC).</li>
-<li>Run Scribus with the language code from the command line like: <code>scribus -lang en_GB</code>.</li>
-<li>Once you are happy with this, please open your web browser to the <a href="http://bugs.scribus.net">Scribus Bugs Website</a> and submit a new bug with Title of "British English Translation Update" and Category of "Translation" and upload the new <code>.ts</code> AND <code>.qm</code> into the bug system. If you can, please make a <code>tar.bz2</code> file of the two to save some space on the bugs site.</li>
-<li>If you need to update translations for the render frames editor, you also need to update xml files located in <code>resources/editorconfig</code> and attach updated files to your translation update request.</li>
-<li>That's it! When the next SVN release is made, your new translation will be added by the team.</li>
+<li>Save the <code>.ts</code> file and copy it into the source directory that contains the translation files (e.g. <code>~/Scribus/resources/translations</code>).</li>
+<li>If you want to test your translation before submitting it to the Scribus developers, delete the file CMakeCache.txt in your build directory (provided you have built Scribus from source before), rerun cmake as you did before, but now add the parameter <code>-DWANT_GUI_LANG="xx_XX</code>, where xx_XX is the language code for your translation, e.g. en_GB (British English) or pt_BR (Brazilian Portuguese).</li>
+<li>If you only specified your translation as a parameter, this will the only UI language available. If you have built Scribus with more than one language, select your translation in <i>File > Preferences</i>.</li>
</ol>
-<p>So that's it really! Enjoy Scribus in your favourite language!</p>
+<h3>Part Two: Translating other parts of Scribus</h3>
+<p>Unfortunately or fortunately, depending on your point of view, not all parts of the Scribus user interface can be translated via ts files. In two cases you need to edit XML files to translate Scribus, namely for Templates and the Render Frame editor.</p>
+<h4>Translating Templates</h4>
+<p>To translate Template categories, names and decriptions, you need the file <code>template.xml</code> from the directory <code> ~/Scribus/resources/templates</code>. Save this file under a name that helps Scribus identify the language you are translating to, e.g. <code>template.it.xml</code> for Italian.</p>
+<p>The content of the XML file is (hopefully) self-explanatory. There is an entry for each template. A complete entry looks like this:
+<pre>
+<template category="<span style="color: red;">Newsletters</span>">
+ <name><span style="color: red;">TextBased</span></name>
+ <file>textbased/textbased.sla.gz</file>
+ <tnail>textbased/textbasedtn.png</tnail>
+ <img>textbased/textbased.png</img>
+ <psize>A4</psize>
+ <color><span style="color: red;">color</span></color>
+ <descr><span style="color: red;">A decent newsletter/magazine originaly created for one non-profit organization. Unrealized unfortunately.</span></descr>
+ <usage><span style="color: red;">Right click on text replace what's inside with your own. Or whatever you want to... ;)</span></usage>
+ <scribus_version>1.2RC1cvs</scribus_version>
+ <date>2004-07-10</date>
+ <author>Petr Van&#283;k</author>
+ <email>petr at yarpen.cz</email>
+</template>
+</pre>
+Fortunately, you need not (actually <b>must</b> not) translate everything in here. What needs a translation is only the strings that are in red in the example above.</p>
+<h4>Translating the Render Frame Editor</h4>
+<p>As described in <a href="renderframes.html">Working with Render Frames</a>, this kind of frame is freely configurable. Not only can you add configuration files for new programs, but you can also add translations to existing ones. In contrast to Templates, you don’t have to create new XML files for your translations. Instead, you need to edit the existing ones. The configuration files for Render Frames are located in <code>~Scribus/resources/editorconfig</code>. There is a file for each program, e.g. <code>100_latex.xml</code> for LaTeX, <code>300_lilypond.xml</code> for Lilypond etc.</p>
+<p>To make life easier for translators, the developer of the Render Frame plugin has placed an indicator for translatable text strings in the files, namely <code>i18n</code>, which is an acronym for “internationalization”:</p>
+<pre>
+<title><i18n>
+ <en>Ranges</en>
+ <cs>Rozsahy</cs>
+ <de>Bereiche</de>
+ <fr>Rangées</fr>
+ <pl>Zakresy</pl>
+ <ru>&#1044;&#1080;&#1072;&#1087;&#1072;&#1079;&#1086;&#1085;&#1099;</ru>
+ <hu>Tartomány</hu>
+</i18n></title>
+</pre>
+<p>If you want to add a, say, Dutch translation, simply add a string like this to the list above: <code><nl>Bereik</nl></code>. Of course you should only submit a translated configuration file that’s complete to the development team!</p>
+
+<h3>Submitting your translation</h3>
+<ul>
+<li>Once you are happy with the result of your hard work, please open your web browser, head to the <a href="http://bugs.scribus.net">Scribus Bugtracker</a> and submit a new bug with the title of your translation update under the “Translation” category.</p>
+<li><i><b>Please note that as of Scribus 1.3.9 it is no longer necessary to upload qm files, as these will be generated at build time. Also note that the translation of the Templates and Render Frame files is optional.</b></i></p></li>
+<li>If you want to be credited (and we prefer to give credit where credit is due!), please add your name and your email address to the bug report.</li>
+<li>That’s it! When the next SVN release is made, your new translation will be added by the team. Usually, new translations are being added SVN within one or two days.</li>
+</ul>
+<h3>Translating the Online Help</h3>
+<p>Before you start translating the Online Help, you should be aware of the fact that this a huge task, and this doesn’t just refer to the skills or the time required to successfully complete the work. The documentation will be updated on a regular basis, which is why you should contact the team before you are wasting your time on translating files that are in the process of being rewritten or replaced. Also note that some basic HTML knowledge will help a lot, since all help files are written in HTML. Again, you are advised to contact the development team to learn about the rather strict HTML coding conventions for Scribus help files.</p>
</body>
</html>
More information about the scribus-commit
mailing list