diff options
Diffstat (limited to 'translate-toolkit-1.3.0/translate/doc/user')
117 files changed, 15994 insertions, 0 deletions
diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-accelerator_accelerator.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-accelerator_accelerator.html new file mode 100644 index 0000000..6defe11 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-accelerator_accelerator.html @@ -0,0 +1,36 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="accelerator_accelerator" id="accelerator_accelerator">--accelerator=ACCELERATOR</a></h1> +<div class="level1"> +<table class="inline"> + <tr class="row0"> + <th class="col0 leftalign"> Marker </th><th class="col1 leftalign"> Used by </th> + </tr> + <tr class="row1"> + <td class="col0 centeralign"> & </td><td class="col1 leftalign"> <a href="guide-kde_desktop.html" class="wikilink1" title="guide-kde_desktop.html">KDE desktop</a>, <a href="guide-mozilla.html" class="wikilink1" title="guide-mozilla.html">Mozilla</a> (when using <a href="toolkit-moz2po.html" class="wikilink1" title="toolkit-moz2po.html">moz2po</a>) </td> + </tr> + <tr class="row2"> + <td class="col0 centeralign"> _ </td><td class="col1 leftalign"> <a href="guide-gnome_desktop.html" class="wikilink1" title="guide-gnome_desktop.html">GNOME desktop</a> </td> + </tr> + <tr class="row3"> + <td class="col0 centeralign"> ~ </td><td class="col1 leftalign"> <a href="guide-openoffice.org.html" class="wikilink1" title="guide-openoffice.org.html">OpenOffice.org</a> </td> + </tr> +</table> + +</div> +</body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-base_classes.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-base_classes.html new file mode 100644 index 0000000..f962984 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-base_classes.html @@ -0,0 +1,235 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="base_classes" id="base_classes">Base classes</a></h1> +<div class="level1"> + +<p> +NOTE: This page is mostly useful for <a href="toolkit-developers.html" class="wikilink1" title="toolkit-developers.html">developers</a> as it describes some programming detail of the <a href="toolkit-index.html" class="wikilink1" title="toolkit-index.html">toolkit</a>. +</p> + +<p> +For the implementation of the different storage classes that the toolkit supports, we want to define a set of base classes to form a common <acronym title="Application Programming Interface">API</acronym> for all formats. This will simplify implementation of new storage formats, and enable easy integration into external tools, such as Pootle. It will also mean less duplication of code in similar storage formats. +</p> + +<p> +These ideas explained here should be seen as drafts only. +</p> + +</div> +<!-- SECTION "Base classes" [1-561] --> +<h2><a name="requirements" id="requirements">Requirements</a></h2> +<div class="level2"> + +<p> +The base classes should be rich enough in functionality to enable users of the base classes to have access to all or most of the features that are available in the formats. In particular, the following are considered requirements: +</p> +<ul> +<li class="level1"><div class="li"> Seamless and hidden handling of escaping, quoting and character sets</div> +</li> +<li class="level1"><div class="li"> Parsing a file when given a file name or file contents (whole file in a string)</div> +</li> +<li class="level1"><div class="li"> Writing a file to disk</div> +</li> +<li class="level1"><div class="li"> Support for source and target languages (as required in the <a href="toolkit-lisa.html" class="wikilink2" title="toolkit-lisa.html">LISA</a> standards)</div> +</li> +<li class="level1"><div class="li"> Support for “multifiles”, in other words a file that contain other entities that corresponds to files in other formats. Examples: ZIP, <acronym title="Cross Platform Installer">XPI</acronym> and <a href="toolkit-xliff.html" class="wikilink1" title="toolkit-xliff.html">XLIFF</a>.</div> +</li> +<li class="level1"><div class="li"> Support for variable number of languages in the format. Examples: .txt and .properties support one language, <acronym title="Gettext Portable Object">PO</acronym> supports two, <a href="toolkit-tmx.html" class="wikilink1" title="toolkit-tmx.html">TMX</a> supports many.</div> +</li> +<li class="level1"><div class="li"> Support for plurality that can vary between different languages (as the <acronym title="Gettext Portable Object">PO</acronym> format allows with msgid_plural, etc.)</div> +</li> +</ul> + +<p> + +All these do not mean that all formats must support al these features, but in the formats that do support these features, it must be accessible through the base class, and it must be possible to interrogate the storage format through the base class to know which features it supports. +</p> + +</div> +<!-- SECTION "Requirements" [562-1801] --> +<h2><a name="the_classes" id="the_classes">The classes</a></h2> +<div class="level2"> + +<p> +A file contains a number of translation units, and possibly a header. Each translation unit contains one or more strings corresponding to each of the languages represented in that unit. +</p> + +</div> +<!-- SECTION "The classes" [1802-2012] --> +<h3><a name="messagestring_multistring" id="messagestring_multistring">Message/string (multistring)</a></h3> +<div class="level3"> + +<p> +This class represents a single conceptual string in a single language. It must know its own requirements for escaping and implement it internally. Escaped versions are only used for internal representation and only exposed for file creation and testing (unit tests, for example). +</p> + +<p> +Note that when storing different plural forms of the same string, they should be stored in this class. The main object is the singular string, and all of the string forms can be accessed in a list at x.strings. Most of the time the object can be dealt with as a single string, only when it is necessary to deal with plural forms do the extra strings have to be taken into account +</p> + +<p> +Comments/notes could possibly be supported in this class. +</p> + +</div> +<!-- SECTION "Message/string (multistring)" [2013-2772] --> +<h3><a name="translation_unit" id="translation_unit">Translation unit</a></h3> +<div class="level3"> + +<p> +This class represents a unit of one or several related messages/strings. In most formats the contained strings will be translations of some original message/string. It must associate a language value with each message/string. It must know how to join all contained messages/strings to compile a valid representation. For formats that support at least two languages, the first two languages will serve as “source” and “target” languages for the common case of translating from one language into another language. +</p> + +<p> +As the number of of languages can be seen as one “dimension” of the translation unit, plurality can be seen as a second dimension. A format can thus be classified according to the dimensionality that it supports, as follows: +</p> +<ul> +<li class="level1"><div class="li"> .properties files supports one language and no concept of plurals. This include most document types, such as .txt, <acronym title="HyperText Markup Language">HTML</acronym> and OpenDocument formats.</div> +</li> +<li class="level1"><div class="li"> Old style <acronym title="Gettext Portable Object">PO</acronym> files supported two languages and no plurals.</div> +</li> +<li class="level1"><div class="li"> New style <acronym title="Gettext Portable Object">PO</acronym> files support two languages and any number of plurals as required by the target language. The plural forms are stored in the original or target strings, as extra forms of the string (See message/string class above).</div> +</li> +<li class="level1"><div class="li"> <acronym title="Translation Memory eXchange">TMX</acronym> files support any number of languages, but has no concept of plurality.</div> +</li> +</ul> + +<p> + +Comments/notes are supported in this class. Quality or status information (fuzzy, last-changed-by) should be stored. TODO: see if this should be on unit level or language level. +</p> + +</div> +<!-- SECTION "Translation unit" [2773-4243] --> +<h3><a name="file" id="file">File</a></h3> +<div class="level3"> + +<p> +This class represents a whole collection of translation units, usually stored in a single file. It supports the concept of a header, and possibly comments at file level. A file will not necessarily be contained alone in single file on disc. See “multifile” below. +</p> + +</div> +<!-- SECTION "File" [4244-4523] --> +<h3><a name="multifile" id="multifile">Multifile</a></h3> +<div class="level3"> + +<p> +This class represents a storage format that contains other files or file like objects. Examples include ZIP, <acronym title="Cross Platform Installer">XPI</acronym> and <acronym title="XML Localization Interchange File Format">XLIFF</acronym>, and OpenOffice SDF files. It must give access to the contained files, and possibly give access to the translation units contained in those files, as if they are contained natively. +</p> + +</div> +<!-- SECTION "Multifile" [4524-4849] --> +<h1><a name="additional_notes" id="additional_notes">Additional Notes</a></h1> +<div class="level1"> + +<p> + +Dwayne and I (Andreas) discussed cleaning up the storage base class. +A lot of what we discussed is related to the above. +A quick summary: +</p> +<ul> +<li class="level1"><div class="li"> Implement a new base class.</div> +<ul> +<li class="level2"><div class="li"> Flesh out the <acronym title="Application Programming Interface">API</acronym>, clean and clear definitions.</div> +</li> +<li class="level2"><div class="li"> Document the <acronym title="Application Programming Interface">API</acronym>.</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> We need to discuss the class hierarchy, eg:</div> +</li> +</ul> +<pre class="code"> +base + -- po + -- text + -- xml + -- xhtml + -- lisa + -- xliff + -- tmx + -- tbx +</pre> +<ul> +<li class="level1"><div class="li"> Clean up converters.</div> +<ul> +<li class="level2"><div class="li"> Parsing of file content needs to happen only in the storage implementation of each filetype/storage type. Currently parsing happens all over the place.</div> +</li> +<li class="level2"><div class="li"> Currently there are separate conversion programs for each type and direction to convert to, eg. po2xliff and xliff2po (24 commands with lots of duplicate code in them). Ideally conversion should be as simple as:</div> +</li> +</ul> +</li> +</ul> +<pre class="code"> +>>> po_store = POStore(filecontent) +>>> print str(po_store) +msgid "bleep" +msgstr "blorp" + +>>> xliff_store = XliffStore(po_store) +>>> print str(xliff_store) +<xliff> + <file> + <trans-unit> + <source>bleep</source> + <target>blorp</target> + </trans-unit> + </file> +</xliff> +</pre> + +<p> +Note that the xliffstore is being instantiated using the postore object. +This works because all the data in any translation store object is accessible via the same well-defined base <acronym title="Application Programming Interface">API</acronym>. +A concept class implementing the above code snippet has already been written. + +</p> +<ul> +<li class="level1"><div class="li"> Move certain options into their respective storage classes.</div> +<ul> +<li class="level2"><div class="li"> eg the --duplicates option can move into po.py</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> Store the meta data for a storage object.</div> +<ul> +<li class="level2"><div class="li"> Can be implemented as separate sqlite file that accompanies the real file.</div> +</li> +<li class="level2"><div class="li"> Features not directly supported by a file format can be stored in the metadata file.</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> A storage object should know all information pertaining to itself.</div> +<ul> +<li class="level2"><div class="li"> eg. “am I monolingual?”</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> We should discuss how to make an object aware that it is monolingual, bilingual or multilingual.</div> +<ul> +<li class="level2"><div class="li"> Maybe through mixin-classes?</div> +</li> +<li class="level2"><div class="li"> How will the behaviour of a monolingual store differ from a bilingual store?</div> +</li> +</ul> +</li> +</ul> + +</div> +<!-- SECTION "Additional Notes" [4850-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-building.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-building.html new file mode 100644 index 0000000..4a3ac4d --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-building.html @@ -0,0 +1,90 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="building" id="building">Building</a></h1> +<div class="level1"> + +</div> +<!-- SECTION "Building" [1-24] --> +<h2><a name="unix" id="unix">UNIX</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "UNIX" [25-42] --> +<h2><a name="windows" id="windows">Windows</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Windows" [43-64] --> +<h3><a name="requirements" id="requirements">Requirements</a></h3> +<div class="level3"> +<ul> +<li class="level1"><div class="li"> <a href="http://www.jrsoftware.org/isinfo.php" class="urlextern" title="http://www.jrsoftware.org/isinfo.php">Innosetup</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://www.py2exe.org/" class="urlextern" title="http://www.py2exe.org/">py2exe</a></div> +</li> +</ul> + +<p> + +Consult the README in the source distribution for the build dependencies. +</p> + +</div> + +<h4><a name="building_python_packages_with_c_extensions_under_windows" id="building_python_packages_with_c_extensions_under_windows">Building Python packages with C extensions under Windows</a></h4> +<div class="level4"> + +<p> + +In order to build modules which have C extensions, you will need either the Visual Studio C++ compiler or <a href="http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780" class="urlextern" title="http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780">MinGW</a>. +</p> + +<p> +Make sure that your Visual Studio C++ or MinGW program path is part of your system's program path, since the Python build system requires this. +</p> + +<p> +To build and install a package with MinGW, you need to execute: +</p> +<pre class="code">''python setup.py build -c mingw32 install''</pre> + +<p> +from the command line. +</p> + +<p> +To build a Windows installer when using MinGW, execute: +</p> +<pre class="code">''python setup.py build -c mingw32 bdist_wininst''</pre> + +</div> +<!-- SECTION "Requirements" [65-909] --> +<h3><a name="building1" id="building1">Building</a></h3> +<div class="level3"> + +<p> + +Simply execute <code>python setup.py innosetup</code>. +</p> + +<p> +The generated file can be found under <code>translate-toolkit-<version>\Output</code> (where <code><version></code> is the software version). +</p> + +</div> +<!-- SECTION "Building" [910-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-checking_for_inconsistencies.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-checking_for_inconsistencies.html new file mode 100644 index 0000000..3c65cb0 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-checking_for_inconsistencies.html @@ -0,0 +1,192 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="checking_for_inconsistencies_in_your_translations" id="checking_for_inconsistencies_in_your_translations">Checking for inconsistencies in your translations</a></h1> +<div class="level1"> + +<p> + +Over time language changes, hopefully not very quickly. However, if your language is new to computers the change might be rapid. So +now your older translations have different text to your new translations. In this use case we look at how you can bring alignment back to your translations. +</p> + +<p> +Other cases in which you can expect inconsistencies: + +</p> +<ul> +<li class="level1"><div class="li"> Multiple translators are involved</div> +</li> +<li class="level1"><div class="li"> Translations are very old</div> +</li> +<li class="level1"><div class="li"> You prepared this set of translations with translations from multiple sources</div> +</li> +<li class="level1"><div class="li"> You changed terminology at some stage in the translation</div> +</li> +<li class="level1"><div class="li"> You did not do a formal glossary development stage</div> +</li> +</ul> + +</div> +<!-- SECTION "Checking for inconsistencies in your translations" [1-679] --> +<h2><a name="what_we_won_t_be_able_to_achieve" id="what_we_won_t_be_able_to_achieve">What we won't be able to achieve</a></h2> +<div class="level2"> + +<p> + +We cannot find grammatical errors and we won't be able to find all cases of words, etc +</p> + +</div> +<!-- SECTION "What we won't be able to achieve" [680-813] --> +<h2><a name="scenario" id="scenario">Scenario</a></h2> +<div class="level2"> + +<p> + +You are translating Mozilla Firefox into Afrikaans. The files are stored in <em>af</em>. You have the following issues: + +</p> +<ol> +<li class="level1"><div class="li"> Your current translator is good but took over from a team of three</div> +</li> +<li class="level1"><div class="li"> Terminology is well defined but not well used by the old translators</div> +</li> +</ol> + +<p> + +We'll look at the translations first from the English, or source text, point of view. Then we will look at it from the Afrikaans point of view. The first will pick up where we have translated the same English word differently in Afrikaans ie an inconsistency. While the second will determine if we use the same English word for different English words, possibly this will confuse a user. +</p> + +</div> +<!-- SECTION "Scenario" [814-1490] --> +<h3><a name="step_1extracting_conflicting_target_text_translations" id="step_1extracting_conflicting_target_text_translations">Step 1: Extracting conflicting target text translations</a></h3> +<div class="level3"> +<pre class="code">poconflicts -I --accelerator="&" af af-conflicts</pre> + +<p> + +From our existing translation in <em>af</em> we extract conflicts and place them in <em>af-conflicts</em>. We are ignoring case with <em>-I</em> so that <code>Save as</code> is considered the same as <code>Save As</code>. The <em>--accelerator</em> options allows us to ignore accelerators so that <code>File</code> is the sane as <code>&File</code> which is also the same as <code>Fi&le</code> +</p> + +<p> +If we browse into <em>af-conflicts</em> we will see a flat structure of words with conflicts. + +</p> +<pre class="code">cd af-conflicts +ls +change.po disc.po functionality.po letter.po overwrite.po restored.po subtitle.po +changes.po document.po gb.po library.po page.po restore.po suffix.po +character.po dots.po graphic.po light.po pager.po retry.po superscript.po +chart.po double.po grayscale.po limit.po percent.po return.po supported.po +check.po down.po grid.po line.po pies.po right.po symbols.po +circle.po drawing.po group.po +etc...</pre> + +<p> + +These are normal <acronym title="Gettext Portable Object">PO</acronym> files which you can edit in any <acronym title="Gettext Portable Object">PO</acronym> editor or text editor. If we look at the first file <code>change.po</code> we can see that the source text <em>Change</em> was translated as <em>Verander</em> and <em>Wysig</em>. The translators job is noe to correct these <acronym title="Gettext Portable Object">PO</acronym> files, ignoring instances where the difference is in fact correct. +</p> + +<p> +Once all fixes have been made we can merge our changes back into the original files. +</p> + +</div> +<!-- SECTION "Step 1: Extracting conflicting target text translations" [1491-3121] --> +<h3><a name="step_2merging_our_corrections_back_into_the_original_files" id="step_2merging_our_corrections_back_into_the_original_files">Step 2: Merging our corrections back into the original files</a></h3> +<div class="level3"> + +<p> + +Our files in <em>af-conflicts</em> are in a flat structure. We need to structure them into the hierarchy of the existing <acronym title="Gettext Portable Object">PO</acronym> files. + +</p> +<pre class="code">porestructure af-conflicts af-restructured</pre> + +<p> + +The entries that where in the files in <em>af-conflicts</em> have been placed in <em>af-restrucured</em>, they now appear in the correct place in the directory structure and also appear in the correct file. We are now ready to merge + +</p> +<pre class="code">pomerge -t af -i af-restructure -o af</pre> + +<p> + +Using the existing files in <em>af</em> we merge the corrected and restructured file from <em>af-restructure</em> and place them back into <em>af</em>. Note: use a different output directory if you do not want to overwrite your existing files. All your conflict corrections are now in the correct <acronym title="Gettext Portable Object">PO</acronym> file in <em>af</em>. +</p> + +<p> +You might want to run <strong>Step 1</strong> again to make sure you didn't miss anything or introduce yet another problem. +</p> + +<p> +Next we look at the inverted conflict problem. +</p> + +</div> +<!-- SECTION "Step 2: Merging our corrections back into the original files" [3122-4096] --> +<h3><a name="step_3extracting_conflicts_of_meaning" id="step_3extracting_conflicts_of_meaning">Step 3: Extracting conflicts of meaning</a></h3> +<div class="level3"> + +<p> + +If you have used the same Afrikaans word for two different English words then you could have created a conflict of meaning. For instance in our Xhosa translations the word <code>Cima</code> was used for both <code>Delete</code> and <code>Cancel</code>. Clearly this is a serious issue. This step will allow us to find those errors and take action. + +</p> +<pre class="code">poconflicts -v -I --accelerator="&" af af-conflicts-invert</pre> + +<p> + +We use the same command line as in <strong>Step 1</strong> but add <em>-v</em> to allow us to invert the match. We are also now outputting to <em>af-conflicts-invert</em> to make things clear. +</p> + +<p> +This time the <acronym title="Gettext Portable Object">PO</acronym> files that are created have Afrikaans names + +</p> +<pre class="code">cd af-conflicts-invert +ls +dataveld.po grys.po lisensieooreenkoms.po paragraaf.po sny.po verslag.po +datumgekoop.po hallo.po lysinhoud.po pasmaak.po soek.po verstek.po +datum.po hiperboliese.po maateenheid.po persentasie.po sorteer.po verteenwoordig.po +deaktiveer.po hoekbeheer.po maatskappynaam.po posadres.po sorteervolgorde.po vertikaal.po +etc...</pre> + +<p> + +We edit these as usual. You need to remember that you will see a normal <acronym title="Gettext Portable Object">PO</acronym> file but that you are looking at how the translation might be confusing to a user. If you see the same Afrikaans translation for two different English terms but there is no conflict of meaning or no alternative then leave it as is. You will find a lot of these instances so the results are less dramatic then the results from a normal conflict analysis. +</p> + +<p> +Lastly follow <strong>Step 2</strong> to restructure and merge these conflicts back into your translations +</p> + +</div> +<!-- SECTION "Step 3: Extracting conflicts of meaning" [4097-5829] --> +<h2><a name="conclusion" id="conclusion">Conclusion</a></h2> +<div class="level2"> + +<p> + +You've now gone a long way to improving the quality of your translations. Congratulations! You might want to take some of what you've learnt here to start building a terminology list that can help prevent some of the issues you have seen. + +</p> + +</div> +<!-- SECTION "Conclusion" [5830-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-cleanup_translator_comments.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-cleanup_translator_comments.html new file mode 100644 index 0000000..e8f249a --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-cleanup_translator_comments.html @@ -0,0 +1,104 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="cleanup_translator_comments" id="cleanup_translator_comments">Cleanup translator comments</a></h1> +<div class="level1"> + +<p> + +Translate Toolkit 1.1 saw source comments being converted to developer comments instead of translator comments. +</p> + +<p> +This use case shows you how to get rid of the old translator comments. +</p> + +</div> +<!-- SECTION "Cleanup translator comments" [1-228] --> +<h2><a name="the_change" id="the_change">The Change</a></h2> +<div class="level2"> + +<p> + +We used to put all source comments into translator comments. + +</p> +<pre class="code"># Some Comment</pre> + +<p> + +But now place them in developer comments. + +</p> +<pre class="code">#. Some Comment</pre> + +<p> + +This ensures that these source comments are updated to the newest versions from the source files, which is a good thing. Translator comments survive these updates, just like you want, while developer comments are discarded. +</p> + +<p> +If you don't clean up your <acronym title="Gettext Portable Object">PO</acronym> files you will now end up with: + +</p> +<pre class="code"># Some Comment +#. Some Comment</pre> + +<p> + +Thus a duplicated comment. Fortunately you only need to clean your <acronym title="Gettext Portable Object">PO</acronym> files once. +</p> + +</div> +<!-- SECTION "The Change" [229-805] --> +<h2><a name="removing_old_translator_comments" id="removing_old_translator_comments">Removing old translator comments</a></h2> +<div class="level2"> + +<p> + +<p><div class="notewarning">This will remove all your translator comments. So if you have some that you actually want to keep then you will need to manual editing +</div></p> +</p> + +<p> +Removal is simple using <a href="toolkit-pocommentclean.html" class="wikilink1" title="toolkit-pocommentclean.html">pocommentclean</a>: + +</p> +<pre class="code">pocommentclean my-po-dir</pre> + +<p> + +Which will clean all your <acronym title="Gettext Portable Object">PO</acronym> files in <code>my-po-dir</code> +</p> + +<p> +<code>pocommentclean</code> is simply a nice wrapper for this sed command: + +</p> +<pre class="code">sed -i "/^#$/d;/^#[^\:\~,\.]/d" $(find po -name "*.po")</pre> + +<p> + +This will delete all lines starting with # that are not used by <acronym title="Gettext Portable Object">PO</acronym> for locations (#:), automatic/developer comments (#.), state (#,) and obsolete (#~). +</p> + +<p> +You can now safely commit your changes and begin your migrations using <a href="toolkit-pot2po.html" class="wikilink1" title="toolkit-pot2po.html">pot2po</a> of <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a> +</p> + +</div> +<!-- SECTION "Removing old translator comments" [806-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-conformance.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-conformance.html new file mode 100644 index 0000000..0cf48c8 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-conformance.html @@ -0,0 +1,59 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="standards_conformance" id="standards_conformance">Standards conformance</a></h1> +<div class="level1"> + +<p> +This page links to pages documenting standard conformance for different standards or file formats. +</p> + +</div> +<!-- SECTION "Standards conformance" [1-136] --> +<h2><a name="lisa_and_oasis_standards" id="lisa_and_oasis_standards">LISA and OASIS standards</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-tmx.html" class="wikilink1" title="toolkit-tmx.html">TMX</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-xliff.html" class="wikilink1" title="toolkit-xliff.html">XLIFF</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-tbx.html" class="wikilink1" title="toolkit-tbx.html">TBX</a></div> +</li> +</ul> + +</div> +<!-- SECTION "LISA and OASIS standards" [137-212] --> +<h2><a name="other_formats" id="other_formats">Other formats</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-csv.html" class="wikilink1" title="toolkit-csv.html">CSV</a></div> +</li> +<li class="level1"><div class="li"> Qt Linguist <a href="toolkit-ts.html" class="wikilink1" title="toolkit-ts.html">.ts</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Other formats" [213-275] --> +<h2><a name="searching_and_matching" id="searching_and_matching">Searching and matching</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-levenshtein_distance.html" class="wikilink1" title="toolkit-levenshtein_distance.html">Levenshtein distance</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Searching and matching" [276-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-contributing.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-contributing.html new file mode 100644 index 0000000..47fd708 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-contributing.html @@ -0,0 +1,402 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="contributing" id="contributing">Contributing</a></h1> +<div class="level1"> + +<p> + +We could use your help. If you are interesting in contributing then please join us on <acronym title="Internet Relay Chat">IRC</acronym> on <a href="irc://irc.freenode.net/#pootle" class="urlextern" title="irc://irc.freenode.net/#pootle">#pootle</a> +and on the <a href="mailto:translate-devel@lists.sourceforge.net" class="mail JSnocheck" title="translate-devel@lists.sourceforge.net">translate-devel</a> mailing list. +</p> + +<p> +Here are some idea of how you can contribute + +</p> +<ol> +<li class="level1"><div class="li"> <a href="toolkit-contributing.html#testing" class="wikilink1" title="toolkit-contributing.html">Test</a> - help us test new candidate releases before they are released</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-contributing.html#debugging" class="wikilink1" title="toolkit-contributing.html">Debug</a> - check bug reports, create tests to highlight problems</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-contributing.html#developing" class="wikilink1" title="toolkit-contributing.html">Develop</a> - add your Python developer skills to the mix</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-contributing.html#documenting" class="wikilink1" title="toolkit-contributing.html">Document</a> - help make our docs readable, useful and complete</div> +</li> +</ol> + +<p> + +Below we give you more detail on these: +</p> + +</div> +<!-- SECTION "Contributing" [1-709] --> +<h2><a name="testing" id="testing">Testing</a></h2> +<div class="level2"> + +<p> + +Before we release new versions of the Toolkit we need people to check that they still work correctly. If you are a frequent user +you might want to start using the release candidate on your current work and report any errors before we release them. +</p> + +<p> +Compile and install the software to see if we have any platform issues + +</p> +<pre class="code">./setup.py install</pre> + +<p> + +Check for any files that are missing, tools that were not installed, etc. +</p> + +<p> +Run unit tests to see if there are any issues. You'll need the <a href="http://codespeak.net/py/dist/test.html" class="urlextern" title="http://codespeak.net/py/dist/test.html">py.test</a> unit test software +which you can <a href="http://codespeak.net/py/dist/download.html" class="urlextern" title="http://codespeak.net/py/dist/download.html">download</a> and install or install this <a href="http://translate.sourceforge.net/releases/testing/fedora/pylib-0.9.1-1.fc9.noarch.rpm" class="urlextern" title="http://translate.sourceforge.net/releases/testing/fedora/pylib-0.9.1-1.fc9.noarch.rpm">Fedora RPM</a> +</p> + +<p> +To run the tests you do + +</p> +<pre class="code">py.test</pre> + +<p> + +from the translate src directory, or + +</p> +<pre class="code">py.test storage/test_dtd.py</pre> + +<p> + +to run a specific set of tests. +</p> + +<p> +Report any failures. +</p> + +<p> +Note: If your Pootle tests fail with an error along the lines of: +</p> +<pre class="code">URLError: <urlopen error (-2, 'Name or service not known')></pre> + +<p> + +Check your http_proxy environment variable. Usually it helps just to unset it: +</p> +<pre class="code">unset http_proxy</pre> + +<p> + +Finally, simply work with the software. Checking all your current usage patterns and report problems. +</p> + +</div> +<!-- SECTION "Testing" [710-1978] --> +<h2><a name="debugging" id="debugging">Debugging</a></h2> +<div class="level2"> +<ol> +<li class="level1"><div class="li"> Make sure your familiar with the <a href="developers-reporting_bugs.html" class="wikilink1" title="developers-reporting_bugs.html">bug reporting guidelines</a>.</div> +</li> +<li class="level1"><div class="li"> Create a login for yourself at <a href="http://bugs.locamotion.org" class="urlextern" title="http://bugs.locamotion.org">http://bugs.locamotion.org</a></div> +</li> +<li class="level1"><div class="li"> Then choose a bug</div> +</li> +</ol> + +<p> + +Now you need to try and validate the bug. Your aim is to confirm that the bug is +either fixed, is invalid or still exists. +</p> + +<p> +If its fixed please close the bug and give details of +how when it was fixed or what version you used to validate it as corrected. +</p> + +<p> +If you find that the bug reporter has made the incorrect assumptions or their suggestion +cannot work. Then mark the bug as invalid and give reasons why. +</p> + +<p> +The last case, an existing bug is the most interesting. Check through the bug and do the following: + +</p> +<ol> +<li class="level1"><div class="li"> Fix up the summary to make it clear what the bug is</div> +</li> +<li class="level1"><div class="li"> Create new bugs for separate issues</div> +</li> +<li class="level1"><div class="li"> Set severity level and classifications correctly</div> +</li> +<li class="level1"><div class="li"> Add examples to reproduce the bug, or make the supplied files simpler</div> +</li> +<li class="level1"><div class="li"> If you can identify the bug but not fix it then explain what needs fixing</div> +</li> +<li class="level1"><div class="li"> Move on to the next bug</div> +</li> +</ol> + +</div> +<!-- SECTION "Debugging" [1979-3027] --> +<h2><a name="developing" id="developing">Developing</a></h2> +<div class="level2"> + +<p> + +Don't ignore this area if you feel like your not a hotshot coder! +</p> + +<p> +You will need some Python skills, this is a great way to learn. +</p> + +<p> +Here are some ideas to get you going: +</p> +<ul> +<li class="level1"><div class="li"> Write a test to expose some bug</div> +</li> +<li class="level1"><div class="li"> Try to fix the actual code to fix your bug</div> +</li> +<li class="level1"><div class="li"> Add a small piece of functionality that helps you</div> +</li> +<li class="level1"><div class="li"> Document the methods in especially the base class and derived classes</div> +</li> +<li class="level1"><div class="li"> Add a format type and converters: e.g. <acronym title="Portable Document Format">PDF</acronym>, ODF, .doc</div> +</li> +<li class="level1"><div class="li"> Add more features to help our formats <a href="toolkit-conformance.html" class="wikilink1" title="toolkit-conformance.html">conform to the standards</a></div> +</li> +</ul> + +<p> + +You will definitely need to be on the <a href="http://lists.sourceforge.net/lists/listinfo/translate-devel" class="urlextern" title="http://lists.sourceforge.net/lists/listinfo/translate-devel">Development</a> and probably on the <a href="http://lists.sourceforge.net/lists/listinfo/translate-cvs" class="urlextern" title="http://lists.sourceforge.net/lists/listinfo/translate-cvs">Subversion checkin</a> lists. +</p> + +<p> +Now is the time to familiarise yourself with the <a href="toolkit-developers.html" class="wikilink1" title="toolkit-developers.html">developers guide</a>. +</p> + +</div> +<!-- SECTION "Developing" [3028-3880] --> +<h2><a name="documenting" id="documenting">Documenting</a></h2> +<div class="level2"> + +<p> + +This is the easy one. Login to the wiki and start! +</p> + +<p> +The key areas that need to be looked at are: + +</p> +<ol> +<li class="level1"><div class="li"> Do the guides to each tool cover all command line options</div> +</li> +<li class="level1"><div class="li"> Are the examples clear for the general cases</div> +</li> +<li class="level1"><div class="li"> Is the tools use clear</div> +</li> +<li class="level1"><div class="li"> In the Use cases, can we add more, do they need updating. Has upstream changed its approach</div> +</li> +</ol> + +<p> + +After that and always: + +</p> +<ul> +<li class="level1"><div class="li"> Grammar</div> +</li> +<li class="level1"><div class="li"> Spelling</div> +</li> +<li class="level1"><div class="li"> Layout</div> +</li> +</ul> + +</div> +<!-- SECTION "Documenting" [3881-4307] --> +<h2><a name="feature_requests" id="feature_requests">Feature Requests</a></h2> +<div class="level2"> + +<p> + +This section is for any kind of feature request or wish list items. If you have any idea for something (anything) to implement, you may list it here. +</p> + +</div> + +<h4><a name="abbreviation_finder" id="abbreviation_finder">Abbreviation finder</a></h4> +<div class="level4"> + +<p> + +I often get abbreviations in the text that I know might be written in full form elsewhere in the text, but I can't guess what it might be. So how about a tool that will search for possible full forms of abbreviations. Input VFS, and search for stuff like Virtual File Server, virtual file server, etc. Also add stopword list so that short words inside full forms can be ignored. + +</p> +<pre class="code">pogrep -I --accelerator="~" --search=source -e "\bv.+\bm.+\bl" source.po vml.po</pre> + +<p> + +This is a hack that will work for you now. It searches in the source (msgid or source tu), ignores case and searches for a structure of words that start with V them M then L. It wouldn't find <acronym title="Extensible Markup Language">XML</acronym> - eXtensible Markup Language. +</p> + +</div> + +<h4><a name="aligner_for_tmx" id="aligner_for_tmx">Aligner for TMX</a></h4> +<div class="level4"> + +<p> + +An aligner would be nice. At the moment, po2tmx can create a <acronym title="Translation Memory eXchange">TMX</acronym> file, but the TUs in the <acronym title="Translation Memory eXchange">TMX</acronym> often contain more than one sentence. A TM is more useful to translators if it contains sentences, not paragraphs. So, how about a tool that takes such a <acronym title="Translation Memory eXchange">TMX</acronym> and attempts to converts each one into sentences (source and target). The output can be <acronym title="Comma Seperated Value">CSV</acronym>, so that a translator can open it in a graphical <acronym title="Comma Seperated Value">CSV</acronym> editor and correct misalignments. The output can even be a plaintext tab delimited file so that one can open it as a table in OpenOffice and use shortcuts to correct the alignment. +</p> + +<p> +The idea would be to keep the first sentence of each TU aligned. This means that if a previous TU had dissimilar number of sentences in the source and target, there would be empty cells above the current TU (either in the source or in the target). +</p> + +</div> + +<h4><a name="pomerge_to_accept_.po.txt" id="pomerge_to_accept_.po.txt">pomerge to accept .po.txt</a></h4> +<div class="level4"> + +<p> + +As ek pomerge probeer doen met n lêer wat op .po.txt eindig, dan wil hy nie. kan dalk nuttig vir windows gebruikers wees, omdat baie windows programme outomaties .txt agteraan las en dan moet die arme gebruiker dit eers weer gaan uitvee voor pomerge tevrede is. +</p> + +</div> + +<h4><a name="po2table" id="po2table">po2table</a></h4> +<div class="level4"> + +<p> + +I wish the Toolkit could export to table in a wordprocessing document and reimport from a table in a wordprocessing document. This would make it possible for almost anyone to help translate in a Toolkit based project. The best table format is probably an OpenDocument table, so that <acronym title="Microsoft">MS</acronym> Word users can use it without screwing it up too much. The table can have three columns (or more, but additional columns are ignored -- possibly to be used by the proofreader for notes to the translator, etc). +</p> + +<p> +If ODT is too difficult, how about exporting to a three column in <acronym title="HyperText Markup Language">HTML</acronym>? An <acronym title="HyperText Markup Language">HTML</acronym> file can be opened in WYSIWIG in <acronym title="Microsoft">MS</acronym> Word and OpenOffice.org, and although the saved <acronym title="HyperText Markup Language">HTML</acronym> file will have horrible machine generated code to give anyone in alt.html.critique a heart attack, it will still be a valid table which can simply be converted back to <acronym title="Gettext Portable Object">PO</acronym>. +</p> + +<p> +po2csv isn't really feasible because different programs have different <acronym title="Comma Seperated Value">CSV</acronym> definitions. Excel and Calc interpret a <acronym title="Comma Seperated Value">CSV</acronym> file in two different ways. So exporting the <acronym title="Gettext Portable Object">PO</acronym> to <acronym title="Comma Seperated Value">CSV</acronym> only works for tools that can correctly interpret the Toolkit's chosen dialect of <acronym title="Comma Seperated Value">CSV</acronym>. + +</p> +<blockquote><div class="no"> + The underlying toolkit <acronym title="Comma Seperated Value">CSV</acronym> module supports various flavours of <acronym title="Comma Seperated Value">CSV</acronym>. It currently uses the Excel flavour. So it is possible to output for different spreadsheets if needed. It might be better to understand what exactly fails, I know we had to hack things to prevent the loss of leading single quotes which in most word processors are interpreted as meaning 'treat this as text' --- <em><a href="mailto:dwayne@translate.org.za" class="mail JSnocheck" title="dwayne@translate.org.za">Dwayne Bailey</a> 2007/10/18 03:13</em></div></blockquote> +<blockquote><div class="no"> +<blockquote><div class="no"> + Well, Excel doesn't convert cleanly to a word processing format and back. Excel wasn't designed as a text editing tool anyway. The “normal” program to edit text in, surely, is a word processor. -- Samuel</div></blockquote> +</div></blockquote> + +</div> + +<h4><a name="blacklist_in_pofilter" id="blacklist_in_pofilter">Blacklist in pofilter</a></h4> +<div class="level4"> + +<p> + +It would be nice if one could do a pofilter check that takes a list of words from an input file and checks to see if they occur in the target text. This list of words would be a blacklist of terms that should not be used in the translation, no matter what. Useful for when a client decides to change his prescribed terminology and you want to do a bulk pogrep on your files while keeping the blacklist of words all in one place. +</p> + +<p> +The blacklist should respect word boundaries. So if “klik” is on the blacklist, then “toeganklik” should not trigger it. +</p> + +</div> + +<h4><a name="glossary_check_in_pofilter" id="glossary_check_in_pofilter">Glossary check in pofilter</a></h4> +<div class="level4"> + +<p> + +What I mean is that a pofilter check should take a bilingual list of words as input file, and check to see if a term in the source text was translated using using the right word in the target text. In other words, if the bilingual list contains: +</p> + +<p> +computer = rekenaar +</p> + +<p> +then pofilter will check which source texts contain 'computer' and the check if all of their corresponding target texts contain 'rekenaar'. Those that don't, fail the check. +</p> + +<p> +The bilingual list check should not respect word boundaries (or: should do a fuzzy check), so that “rekenaar” would also match “rekenaars” and “berekenaar”. +</p> + +</div> + +<h4><a name="one-pager_search_pogrep_in_pootle" id="one-pager_search_pogrep_in_pootle">One-pager search pogrep in Pootle</a></h4> +<div class="level4"> + +<p> + +Okay, this is a Pootle wish list item… perhaps it belongs elsewhere. Currently, you can do a search for a word in Pootle, and Pootle jumps to the next instance of that word. The advantage of this, is context. The disadvantage is not seeing all the instances in one page. I suggest the following: +</p> + +<p> +Let there be a tickbox option next to the search box in Pootle whereby a search result opens in a new browser window. The result can be a normal plaintext <acronym title="Gettext Portable Object">PO</acronym> file that would be the normal result of a pogrep action (but a single page, not multiple pages), or… it can be a simple <acronym title="HyperText Markup Language">HTML</acronym> file in which the search term is highlighted in each string. +</p> + +<p> +The current search system assumes that the user might want to edit the strings that form the search result. The purpose of the proposed system would be to do quick searches on term usage, but not enable users to edit the strings there and then. +</p> + +<p> +(Actually… well… it's a pity that the files in Pootle are nested in a directory tree, otherwise this search method could open multiple pages that advanced users can download, edit, and upload if they wanted.) +</p> + +</div> + +<h4><a name="compare_expression_with_another_languages" id="compare_expression_with_another_languages">Compare expression with another languages</a></h4> +<div class="level4"> + +<p> + +When translating some expression on pootle, for many times I use to check how an expression have been translated on other languages (by accessing the same link on other languages, just changing the suffix of the lang - i.e.: 'es', 'fr', 'pt_BR'). +</p> + +<p> +On this idea, i can imagine that a user would be allowed to define “alternate languages” in it's preferences. On translation interface, small links would appear, just like: +</p> + +<p> +<a href="toolkit.html" class="wikilink2" title="toolkit.html">pt_BR</a>, <a href="toolkit.html" class="wikilink2" title="toolkit.html">es</a>, <a href="toolkit.html" class="wikilink2" title="toolkit.html">fr</a> +</p> + +<p> +… pointing to a link of the translation of that string on the language. This could raise an popup, a simple link or something else that I'm not sure about the better layout. +</p> + +<p> +I think that anything that helps the translation, as this feature, would be nice for increasing the quality and speed of the work. + +</p> + +</div> +<!-- SECTION "Feature Requests" [4308-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-copyright.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-copyright.html new file mode 100644 index 0000000..156661a --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-copyright.html @@ -0,0 +1,27 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="copyright" id="copyright">Copyright</a></h1> +<div class="level1"> + +<p> + +The Translate Toolkit documentation (everything which is included with the Translate Toolkit or is under the toolkit/ namespace on the wiki) is released under the <a href="http://www.gnu.org/licenses/gpl.html" class="urlextern" title="http://www.gnu.org/licenses/gpl.html">GNU General Public License (GPL)</a>. +</p> + +</div> +</body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-creating_a_terminology_list_from_your_existing_translations.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-creating_a_terminology_list_from_your_existing_translations.html new file mode 100644 index 0000000..25f1870 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-creating_a_terminology_list_from_your_existing_translations.html @@ -0,0 +1,263 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="creating_a_terminology_list_from_your_existing_translations" id="creating_a_terminology_list_from_your_existing_translations">Creating a terminology list from your existing translations</a></h1> +<div class="level1"> + +<p> + +If you did not create a terminology list when you started your translation project or if you have inherited some old translations you probably now want to create a terminology list. +</p> + +<p> +A terminology list or glossary is a list of words and phrases with their expected translation. They are useful for ensuring that your translations are consistent across your project. +</p> + +<p> +With existing translations you have embedded a list of valid translation. This example will help you to extract the terms. It is only the first step you will need to review the terms and must not regard this as a complete list. And of course you would want to take your corrections and feed them back into the original translations. +</p> + +</div> +<!-- SECTION "Creating a terminology list from your existing translations" [1-780] --> +<h2><a name="quick_overview" id="quick_overview">Quick Overview</a></h2> +<div class="level2"> + +<p> + +This describes a multi-stage process for extracting terminology from translation files. It is provided for historical interest and completeness, but you will probably find that using <a href="toolkit-poterminology.html" class="wikilink1" title="toolkit-poterminology.html">poterminology</a> is easier and will give better results than following this process. + +</p> +<ol> +<li class="level1"><div class="li"> Filter our phrases of more than N words</div> +</li> +<li class="level1"><div class="li"> Remove obviously erroneous phrases such as numbers and punctuation</div> +</li> +<li class="level1"><div class="li"> Create a single <acronym title="Gettext Portable Object">PO</acronym> compendium</div> +</li> +<li class="level1"><div class="li"> Extract and review items that are fuzzy and drop untranslated items</div> +</li> +<li class="level1"><div class="li"> Create a new <acronym title="Gettext Portable Object">PO</acronym> files and process into <acronym title="Comma Seperated Value">CSV</acronym> and <acronym title="Translation Memory eXchange">TMX</acronym> format</div> +</li> +</ol> + +</div> +<!-- SECTION "Quick Overview" [781-1363] --> +<h2><a name="get_short_phrases_from_the_current_translations" id="get_short_phrases_from_the_current_translations">Get short phrases from the current translations</a></h2> +<div class="level2"> + +<p> + +We will not be able to identify terminology within bodies of text, we are only going to extract short bit of text ie ones that are between 1 and 3 words long. + +</p> +<pre class="code">pogrep --header --search=msgid -e '^\w+(\s+\w+){0,2}$' zulu zulu-short</pre> + +<p> + +We use --header to ensure that the <acronym title="Gettext Portable Object">PO</acronym> files have a header entry (which is important for encoding). We are searching only in the msgid and the regular expression we use is looking for a string with between 1 and 3 words in it. We are searching through the folder <em>zulu</em> and outputting the result in <em>zulu-short</em> +</p> + +</div> +<!-- SECTION "Get short phrases from the current translations" [1364-1976] --> +<h2><a name="remove_any_translations_with_issues" id="remove_any_translations_with_issues">Remove any translations with issues</a></h2> +<div class="level2"> + +<p> + +You can for instance remove all entries with only a single letter. Useful for eliminating all those spurious accelerator keys. + +</p> +<pre class="code">pogrep --header --search=msgid -v -e "^.$" zulu-short zulu-short-clean</pre> + +<p> + +We use the -v option to invert the search. Our <em>cleaner</em> potential glossary words are now in <em>zulu-short-clean</em>. What you can eliminate is only limited by your ability to build regular expressions but yu could eliminate: + +</p> +<ul> +<li class="level1"><div class="li"> Entries with only numbers</div> +</li> +<li class="level1"><div class="li"> Entries that only contain punctuation</div> +</li> +</ul> + +</div> +<!-- SECTION "Remove any translations with issues" [1977-2529] --> +<h2><a name="create_a_compendium" id="create_a_compendium">Create a compendium</a></h2> +<div class="level2"> + +<p> + +Now that we have our words we want to create a sinlge files of all terminology. Thus we create a <acronym title="Gettext Portable Object">PO</acronym> compendium + +</p> +<pre class="code">~/path/to/pocompendium -i -su zulu-gnome-glossary.po -d zulu-short-clean</pre> + +<p> + +You can use various methods but our bash script is quite good. Here we ignore case, -i, and ignore the underscore (_) accelerator key, -su, outputting the results in. +</p> + +<p> +We now have a single file containing all glossary terms and the clean up and review can begin. +</p> + +</div> +<!-- SECTION "Create a compendium" [2530-3016] --> +<h2><a name="split_the_file" id="split_the_file">Split the file</a></h2> +<div class="level2"> + +<p> + +We want to split the file into translated, untranslated and fuzzy entries + +</p> +<pre class="code">~/path/to/posplit ./zulu-gnome-glossary.po</pre> + +<p> + +This will create three files: + +</p> +<ul> +<li class="level1"><div class="li"> zulu-gnome-glossary-translated.po - all fully translated entries</div> +</li> +<li class="level1"><div class="li"> zulu-gnome-glossary-untranslated.po - messages with no translation</div> +</li> +<li class="level1"><div class="li"> zulu-gnome-glossary-fuzzy.po - words that need investigation</div> +</li> +</ul> +<pre class="code">rm zulu-gnome-glossary-untranslated.po</pre> + +<p> + +We discard <code>zulu-gnome-glossary-untranslated.po</code> since they are of no use to us. +</p> + +</div> +<!-- SECTION "Split the file" [3017-3528] --> +<h2><a name="dealing_with_the_fuzzies" id="dealing_with_the_fuzzies">Dealing with the fuzzies</a></h2> +<div class="level2"> + +<p> + +The fuzzies come in two kinds. Those that are simply wrong or needed updating and those where there was more then one translation for a given term. So if someone had translated 'File' differently across the translations we'd have an entry that was marked fuzzy with the two options displayed. + +</p> +<pre class="code">pofilter -t compendiumconflicts zulu-gnome-glossary-fuzzy.po zulu-gnome-glossary-conflicts.po</pre> + +<p> + +These compedium conflicts are what we are interested in so we use pofilter to filter them from the other fuzzies. + +</p> +<pre class="code">rm zulu-gnome-glossary-fuzzy.po</pre> + +<p> + +We discard the other fuzzies as they where probably wrong in the first place. You could review these but it is not recommended. +</p> + +<p> +Now edit <code>zulu-gnome-glossary-conflicts.po</code> to resolve the conflicts. You can edit them however you like but we usually follow the format: + +</p> +<pre class="code">option1, option2, option3</pre> + +<p> + +You can get them into that layout by doing the following: + +</p> +<pre class="code">sed '/#, fuzzy/d; /\"#-#-#-#-# /d; /# (pofilter) compendiumconflicts:/d; s/\\n"$/, "/' zulu-gnome-glossary-conflicts.po > tmp.po +msgcat tmp.po > zulu-gnome-glossary-conflicts.po</pre> + +<p> + +Of course if a word is clearly wrong, misspelled etc. then you can eliminate it. Often you will find the “problem” relates to the part of speech of the source word and that indeed there are two options depending on the context. +</p> + +<p> +You now have a cleaned fuzzy file and we are ready to proceed. +</p> + +</div> +<!-- SECTION "Dealing with the fuzzies" [3529-4947] --> +<h2><a name="put_it_back_together_again" id="put_it_back_together_again">Put it back together again</a></h2> +<div class="level2"> +<pre class="code">msgcat zulu-gnome-glossary-translated.po zulu-gnome-glossary-conflicts.po > zulu-gnome-glossary.po</pre> + +<p> + +We now have a single file <code>zulu-gnome-glossary.po</code> which contains our glossary texts. +</p> + +</div> +<!-- SECTION "Put it back together again" [4948-5178] --> +<h2><a name="create_other_formats" id="create_other_formats">Create other formats</a></h2> +<div class="level2"> + +<p> + +It is probably good to make your terminology available in other formats. You can create <acronym title="Comma Seperated Value">CSV</acronym> and <acronym title="Translation Memory eXchange">TMX</acronym> files from your <acronym title="Gettext Portable Object">PO</acronym>. + +</p> +<pre class="code">po2csv zulu-gnome-glossary.po zulu-gnome-glossary.csv +po2tmx -l zu zulu-gnome-glossary.po zulu-gnome-glossary.tmx</pre> + +<p> + +For the terminology to be usable by Trados or Wordfast translators they need to be in the following formats: + +</p> +<ul> +<li class="level1"><div class="li"> Trados - comma delimited file <code>source,target</code></div> +</li> +<li class="level1"><div class="li"> Wordfast - tab delimited file <code>source[tab]target</code></div> +</li> +</ul> + +<p> + +In that format they are now available to almost all localisers in the world. +</p> + +<p> +<img src="images/smileys/fixme.gif" align="middle" alt="FIXME" /> need scripts to generate these formats. +</p> + +</div> +<!-- SECTION "Create other formats" [5179-5797] --> +<h1><a name="the_work_has_only_just_begun" id="the_work_has_only_just_begun">The work has only just begun</a></h1> +<div class="level1"> + +<p> + +The lists you have just created are useful in their own right. But you most likely want to keep growing them, cleaning and improving them. +</p> + +<p> +You should as a first step review what you have created and fix spelling and other errors or disambiguate terms as needed. +</p> + +<p> +But congratulations a Terminology list or Glossary is one of your most important assets for creating good and consistent translations and it acts as a valuable resource for both new and experienced translators when they need prompting as to how to translate a term. + +</p> + +</div> +<!-- SECTION "The work has only just begun" [5798-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-creating_mozilla_pot_files.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-creating_mozilla_pot_files.html new file mode 100644 index 0000000..79f07f4 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-creating_mozilla_pot_files.html @@ -0,0 +1,116 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="creating_mozilla_pot_files" id="creating_mozilla_pot_files">Creating Mozilla POT files</a></h1> +<div class="level1"> + +<p> + +You can do this two ways: +</p> +<ol> +<li class="level1"><div class="li"> Using Mozilla source (from <acronym title="Concurrent Versions System">CVS</acronym> or Mercurial)</div> +</li> +<li class="level1"><div class="li"> Using an en-US <acronym title="Cross Platform Installer">XPI</acronym> file</div> +</li> +</ol> + +</div> +<!-- SECTION "Creating Mozilla POT files" [1-147] --> +<h2><a name="using_mercurial" id="using_mercurial">Using Mercurial</a></h2> +<div class="level2"> + +<p> + +Since Firefox 3.1 and Thunderbird 3.0, Mozilla has switched to using Mercurial for version control. See the Mozilla's <a href="https://developer.mozilla.org/En/L10n_on_Mercurial" class="urlextern" title="https://developer.mozilla.org/En/L10n_on_Mercurial">L10n on Mercurial</a> page for instructions on how to checkout and update your Mozilla sources and l10n files. +</p> + +<p> +You can use <a href="toolkit-mozilla_l10n_scripts.html#get_moz_enus.py" class="wikilink1" title="toolkit-mozilla_l10n_scripts.html">get_moz_enUS.py</a> to extract an en-US directory from the source tree: + +</p> +<pre class="code">get_moz_enUS.py -s mozilla-central/ -d l10n/ -p browser</pre> + +<p> + +This will move the correct en-US files to <code>l10n/en-US</code>. You can now create <acronym title="Gettext Portable Object Template">POT</acronym> files as follows: + +</p> +<pre class="code">moz2po -P l10n/en-US l10n/pot</pre> + +<p> + +This will create the <acronym title="Gettext Portable Object Template">POT</acronym> files in <code>l10n/pot</code> using the American English files from <code>en-US</code>. You now have a set of <acronym title="Gettext Portable Object Template">POT</acronym> files +that you can use for translation or updating your existing <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +</div> +<!-- SECTION "Using Mercurial" [148-973] --> +<h2><a name="using_cvs" id="using_cvs">Using CVS</a></h2> +<div class="level2"> + +<p> + +Firefox versions before 3.1 and Thunderbird versions before 3.0 still has its source in <acronym title="Concurrent Versions System">CVS</acronym>. Check out files from the Mozilla repository. If you don't want to checkout all files do: + +</p> +<pre class="code">make -f client.mk l10n-checkout</pre> + +<p> + +The English files are in the <code>mozilla/</code> module, while the translated files all reside in the <code>l10n/</code> module. They have different structure but not enough to kill you. +</p> + +<p> +Once you have checked out <code>mozilla/</code> you will need to get the correct files for en-US. To do this we will create en-US as a pseudo language. + +</p> +<pre class="code">make -f tools/l10n/l10n.mk create-en-US</pre> + +<p> + +This will move the correct en-US files to <code>l10n/en-US</code>. You can now create <acronym title="Gettext Portable Object Template">POT</acronym> files as follows: + +</p> +<pre class="code">moz2po -P l10n/en-US l10n/pot</pre> + +<p> + +This will create the <acronym title="Gettext Portable Object Template">POT</acronym> files in <code>l10n/pot</code> using the American English files from <code>en-US</code>. You now have a set of <acronym title="Gettext Portable Object Template">POT</acronym> files +that you can use for translation or updating your existing <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +</div> +<!-- SECTION "Using CVS" [974-1910] --> +<h2><a name="using_an_en-us_xpi_file" id="using_an_en-us_xpi_file">Using an en-US XPI file</a></h2> +<div class="level2"> + +<p> + +Download an <acronym title="Cross Platform Installer">XPI</acronym> file and run the following: + +</p> +<pre class="code">moz2po -P en-US.xpi pot</pre> + +<p> + +You now have a set of <acronym title="Gettext Portable Object Template">POT</acronym> files in <code>pot</code>. + +</p> + +</div> +<!-- SECTION "Using an en-US XPI file" [1911-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-csv.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-csv.html new file mode 100644 index 0000000..a6c2956 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-csv.html @@ -0,0 +1,56 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="csv" id="csv">CSV</a></h1> +<div class="level1"> + +<p> +<acronym title="Comma Seperated Value">CSV</acronym> (Comma Separated Values) is a simple file format for general data interchange. It can be used in the toolkit for simple data interchange, and can be edited with most spreadsheet programs. There is no formal specification for the <acronym title="Comma Seperated Value">CSV</acronym> file format, but more information can be acquired from <a href="http://en.wikipedia.org/wiki/Comma-separated%20values" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Comma-separated%20values">Comma-separated values</a> +</p> + +<p> +For information on more file formats, see <a href="toolkit-conformance.html" class="wikilink1" title="toolkit-conformance.html">conformance</a>. +</p> + +</div> +<!-- SECTION "CSV" [1-401] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> + +<p> +<acronym title="Comma Seperated Value">CSV</acronym> files were initially used to convert from and to <a href="toolkit-po.html" class="wikilink1" title="toolkit-po.html">PO</a> files, and therefore contained three columns as follows: +</p> +<ul> +<li class="level1"><div class="li"> A column with the location of the original msgid (in other words, a line in a programming source file, as indicated in the #: comments of <acronym title="Gettext Portable Object">PO</acronym> files).</div> +</li> +<li class="level1"><div class="li"> The source text (or msgid)</div> +</li> +<li class="level1"><div class="li"> The target text (or msgstr)</div> +</li> +</ul> + +<p> + +Tabs and newlines are maintained, although it is not clear how easy it is to edit these things in a spreadsheet. +</p> + +<p> +Quoting is a problem, because the different spreadsheet programs handle these things differently. Notably, Microsoft's excel handles single quotes slightly differently. In future, it might be worthwhile to handle excel <acronym title="Comma Seperated Value">CSV</acronym> as a different format from other <acronym title="Comma Seperated Value">CSV</acronym> files. An entry like 'mono' is ambiguous as it is not sure whether this refers simply to the word <em>mono</em> or to the entry <em>'mono'</em> quoted with single quotes. (Example from Audacity pot file) +</p> + +</div> +<!-- SECTION "Conformance" [402-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-csv2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-csv2po.html new file mode 100644 index 0000000..64c274f --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-csv2po.html @@ -0,0 +1,203 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="csv2po_and_po2csv" id="csv2po_and_po2csv">csv2po and po2csv</a></h1> +<div class="level1"> + +<p> + +Convert between <acronym title="Comma Seperated Value">CSV</acronym> (Comma Separated Value) files and the <acronym title="Gettext Portable Object">PO</acronym> format. This is useful for those translators who can only use a Spreadsheet, a modern spreadsheet can open <acronym title="Comma Seperated Value">CSV</acronym> files for editing. It is also useful if you have other data such as translation memory in <acronym title="Comma Seperated Value">CSV</acronym> format and you wish to use it with your <acronym title="Gettext Portable Object">PO</acronym> translations. +</p> + +</div> +<!-- SECTION "csv2po and po2csv" [1-359] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">csv2po [options] <csv> <po> +po2csv [options] <po> <csv></pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <csv> </td><td class="col1 leftalign"> is a file or directory containing <acronym title="Comma Seperated Value">CSV</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a file or directory containing <acronym title="Gettext Portable Object">PO</acronym> files </td> + </tr> +</table> + +<p> + +Options (csv2po): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in csv format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in pot, po, pot formats </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --charset=CHARSET </td><td class="col1 leftalign"> set charset to decode from csv files </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --columnorder=COLUMNORDER </td><td class="col1 leftalign"> specify the order and position of columns (source,source,target) </td> + </tr> +</table> + +<p> + +Options (po2csv): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in csv format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --columnorder=COLUMNORDER </td><td class="col1 leftalign"> specify the order and position of columns (comment,source,target) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [360-2433] --> +<h2><a name="csv_file_layout" id="csv_file_layout">CSV file layout</a></h2> +<div class="level2"> + +<p> + +The resultant <acronym title="Comma Seperated Value">CSV</acronym> file has the following layout + +</p> +<table class="inline"> + <tr class="row0"> + <th class="col0 leftalign"> Column </th><th class="col1 leftalign"> Data </th><th class="col2 leftalign"> Description </th> + </tr> + <tr class="row1"> + <td class="col0 centeralign"> A </td><td class="col1 leftalign"> Location </td><td class="col2 leftalign"> All the <acronym title="Gettext Portable Object">PO</acronym> #: location comments. These are needed to reconstruct or merge the <acronym title="Comma Seperated Value">CSV</acronym> back into the <acronym title="Gettext Portable Object">PO</acronym> file </td> + </tr> + <tr class="row2"> + <td class="col0 centeralign"> B </td><td class="col1"> Source Language (English) </td><td class="col2 leftalign"> The msgid or source string </td> + </tr> + <tr class="row3"> + <td class="col0 centeralign"> C </td><td class="col1 leftalign"> Target Language </td><td class="col2 leftalign"> The msgstr or target language </td> + </tr> +</table> + +</div> +<!-- SECTION "CSV file layout" [2434-2814] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +These examples demonstrate the use of csv2po: + +</p> +<pre class="code">po2csv -P pot csv</pre> + +<p> + +We use the <em>-P</em> option to recognise <acronym title="Gettext Portable Object Template">POT</acronym> files found in <em>pot</em> and convert them to <acronym title="Comma Seperated Value">CSV</acronym> files placed in <em>csv</em> + +</p> +<pre class="code">csv2po csv po</pre> + +<p> + +Convert <acronym title="Comma Seperated Value">CSV</acronym> files in <em>csv</em> to <acronym title="Gettext Portable Object">PO</acronym> files placed in <em>po</em> + +</p> +<pre class="code">csv2po --charset=windows-1250 -t pot csv po</pre> + +<p> + +User working on Windows will often return files encoded in everything but Unicode. In this case we convert +<acronym title="Comma Seperated Value">CSV</acronym> files found in <em>csv</em> from <em>windows-1250</em> to UTF-8 and place the correctly encoded files in <em>po</em>. We use +the templates found in <em>pot</em> to ensure that we preserve formatting and other data. Note that +UTF-8 is the only available destination encoding. +</p> + +</div> +<!-- SECTION "Examples" [2815-3512] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Translation comments #[space] and KDE comments _: are not available in <acronym title="Comma Seperated Value">CSV</acronym> mode which effects the translators effectiveness</div> +</li> +<li class="level1"><div class="li"> Locations #: that are not conformant to <acronym title="Gettext Portable Object">PO</acronym> (i.e. have spaces) will get messed up by <acronym title="Gettext Portable Object">PO</acronym> tools.</div> +</li> +</ul> + +</div> +<!-- SECTION "Bugs" [3513-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-csv2tbx.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-csv2tbx.html new file mode 100644 index 0000000..dffb3fa --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-csv2tbx.html @@ -0,0 +1,177 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="csv2tbx" id="csv2tbx">csv2tbx</a></h1> +<div class="level1"> + +<p> + +Convert between <acronym title="Comma Seperated Value">CSV</acronym> (Comma Separated Value) files and the <a href="toolkit-tbx.html" class="wikilink1" title="toolkit-tbx.html">TBX</a> format for terminology exchange. +</p> + +</div> +<!-- SECTION "csv2tbx" [1-123] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">csv2tbx [--charset=CHARSET] [--columnorder=COLUMNORDER] <csv> <tbx></pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <csv> </td><td class="col1 leftalign"> is a <acronym title="Comma Seperated Value">CSV</acronym> file </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <tbx> </td><td class="col1"> is the target <acronym title="TermBase eXchange">TBX</acronym> file </td> + </tr> +</table> + +<p> + +Options (csv2tbx): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in csv format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in tbx format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> --charset=CHARSET </td><td class="col1 leftalign"> set charset to decode from csv files </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --columnorder=COLUMNORDER </td><td class="col1 leftalign"> specify the order and position of columns (comment,source,target) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [124-1172] --> +<h2><a name="csv_file_layout" id="csv_file_layout">CSV file layout</a></h2> +<div class="level2"> + +<p> + +The <acronym title="Comma Seperated Value">CSV</acronym> file is expected in to have three columns, of which the default layout is + +</p> +<table class="inline"> + <tr class="row0"> + <th class="col0 leftalign"> Column </th><th class="col1 leftalign"> Data </th><th class="col2 leftalign"> Description </th> + </tr> + <tr class="row1"> + <td class="col0 centeralign"> A </td><td class="col1 leftalign"> comment </td><td class="col2 leftalign"> All the <acronym title="Gettext Portable Object">PO</acronym> #: location comments. These are not used in the <acronym title="TermBase eXchange">TBX</acronym> files, and can be left empty, but could be generated by <a href="toolkit-po2csv.html" class="wikilink1" title="toolkit-po2csv.html">po2csv</a> </td> + </tr> + <tr class="row2"> + <td class="col0 centeralign"> B </td><td class="col1"> Source Language (English) </td><td class="col2 leftalign"> The msgid or source string </td> + </tr> + <tr class="row3"> + <td class="col0 centeralign"> C </td><td class="col1 leftalign"> Target Language </td><td class="col2 leftalign"> The msgstr or target language </td> + </tr> +</table> + +</div> +<!-- SECTION "CSV file layout" [1173-1612] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +These examples demonstrate the use of csv2tbx: + +</p> +<pre class="code">csv2tbx terms.csv terms.tbx</pre> + +<p> + +to simply convert <em>terms.csv</em> to <em>terms.tbx</em>. +</p> + +<p> +To convert a directory recursively to another directory with the same structure of files: + +</p> +<pre class="code">csv2tbx csv-dir tbx-target-dir</pre> + +<p> + +This will convert <acronym title="Comma Seperated Value">CSV</acronym> files in <em>csv-dir</em> to <acronym title="TermBase eXchange">TBX</acronym> files placed in <em>tbx-target-dir</em>. + +</p> +<pre class="code">csv2tbx --charset=windows-1250 csv tbx</pre> + +<p> + +Users working on Windows will often return files in encoding other the Unicode based encodings. In this case we convert +<acronym title="Comma Seperated Value">CSV</acronym> files found in <em>csv</em> from <em>windows-1250</em> to UTF-8 and place the correctly encoded files in <em>tbx</em>. Note that +UTF-8 is the only available destination encoding. +</p> + +</div> +<!-- SECTION "Examples" [1613-2309] --> +<h2><a name="two_column_csv" id="two_column_csv">Two column CSV</a></h2> +<div class="level2"> +<pre class="code">csv2tbx --columnorder=(source,target) foo.csv foo.tbx</pre> + +</div> +<!-- SECTION "Two column CSV" [2310-2394] --> +<h2><a name="notes" id="notes">Notes</a></h2> +<div class="level2"> + +<p> + +For conformance to the standards and to see which features are implemented, see <a href="toolkit-csv.html" class="wikilink1" title="toolkit-csv.html">csv</a> and <a href="toolkit-tbx.html" class="wikilink1" title="toolkit-tbx.html">tbx</a>. +</p> + +</div> +<!-- SECTION "Notes" [2395-2515] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None. + +</p> + +</div> +<!-- SECTION "Bugs" [2516-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-developers.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-developers.html new file mode 100644 index 0000000..5ac75a0 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-developers.html @@ -0,0 +1,350 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="translate_toolkit_developers_guide" id="translate_toolkit_developers_guide">Translate Toolkit Developers Guide</a></h1> +<div class="level1"> + +<p> + +The goal of the translate toolkit is to simplify and unify the process of translation. +</p> + +</div> +<!-- SECTION "Translate Toolkit Developers Guide" [1-138] --> +<h2><a name="history" id="history">History</a></h2> +<div class="level2"> + +<p> + +The initial toolkit was designed to convert Mozilla .dtd and .properties files into Gettext <acronym title="Gettext Portable Object">PO</acronym> format. The logic was not that <acronym title="Gettext Portable Object">PO</acronym> was in any way superior but that by simplifying the translations process i.e. allowing a translator to use one format and one tool that we could get more people involved and more translators. +</p> + +<p> +The tools have now evolved to include other formats such as OpenOffice.org and the goal is still to migrate various formats to a common format, <acronym title="Gettext Portable Object">PO</acronym> and in the future <acronym title="XML Localization Interchange File Format">XLIFF</acronym> as more tools become available for that format. +</p> + +<p> +These tools we group as converters. Along the way we developed other tools that allowed us to manipulate <acronym title="Gettext Portable Object">PO</acronym> files and check them for consistency. As we evolved the converter tools we have also improved and abstracted the classes that read the various file types. In the future we hope to define these better so that we have a more or less stable <acronym title="Application Programming Interface">API</acronym> for converters. +</p> + +</div> +<!-- SECTION "History" [139-1072] --> +<h2><a name="resources" id="resources">Resources</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Resources" [1073-1095] --> +<h3><a name="subversion_access" id="subversion_access">Subversion access</a></h3> +<div class="level3"> + +<p> +We moved to the SourceForge Subversion repository in August 2006. + +</p> +<pre class="code">svn co https://translate.svn.sourceforge.net/svnroot/translate/src/trunk translate</pre> + +</div> +<!-- SECTION "Subversion access" [1096-1276] --> +<h3><a name="bugzilla" id="bugzilla">Bugzilla</a></h3> +<div class="level3"> +<ul> +<li class="level1"><div class="li"> <a href="http://bugs.locamotion.org/" class="urlextern" title="http://bugs.locamotion.org/">http://bugs.locamotion.org/</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Bugzilla" [1277-1330] --> +<h3><a name="communication" id="communication">Communication</a></h3> +<div class="level3"> +<ul> +<li class="level1"><div class="li"> <acronym title="Internet Relay Chat">IRC</acronym> channel - <a href="irc://irc.freenode.net/#pootle" class="urlextern" title="irc://irc.freenode.net/#pootle">irc://irc.freenode.net/#pootle</a></div> +</li> +<li class="level1"><div class="li"> Developers mailing list - <a href="https://lists.sourceforge.net/lists/listinfo/translate-devel" class="urlextern" title="https://lists.sourceforge.net/lists/listinfo/translate-devel">https://lists.sourceforge.net/lists/listinfo/translate-devel</a></div> +</li> +<li class="level1"><div class="li"> Commits to version control - <a href="https://lists.sourceforge.net/lists/listinfo/translate-cvs" class="urlextern" title="https://lists.sourceforge.net/lists/listinfo/translate-cvs">https://lists.sourceforge.net/lists/listinfo/translate-cvs</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Communication" [1331-1591] --> +<h2><a name="source_code_map" id="source_code_map">Source code map</a></h2> +<div class="level2"> + +<p> + +The tools are stored in SVN <a href="https://translate.svn.sourceforge.net/viewvc/translate/src/trunk/" class="urlextern" title="https://translate.svn.sourceforge.net/viewvc/translate/src/trunk/">https://translate.svn.sourceforge.net/viewvc/translate/src/trunk/</a> (previously in <a href="http://translate.cvs.sourceforge.net/translate/src/" class="urlextern" title="http://translate.cvs.sourceforge.net/translate/src/">CVS</a>). This rough map will allow you to navigate SVN: + +</p> +<ul> +<li class="level1"><div class="li"> convert -- convert between different formats and <acronym title="Gettext Portable Object">PO</acronym> format</div> +</li> +<li class="level1"><div class="li"> filters -- <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> and its helper functions (badly named, it is really a checking tool)</div> +</li> +<li class="level1"><div class="li"> storage -- all base file formats: <acronym title="XML Localization Interchange File Format">XLIFF</acronym>, .properties, OpenOffice.org, <acronym title="Translation Memory eXchange">TMX</acronym>, etc.</div> +</li> +<li class="level1"><div class="li"> misc -- various helper functions</div> +</li> +<li class="level1"><div class="li"> tools -- all <acronym title="Gettext Portable Object">PO</acronym> manipulation programs: <a href="toolkit-pocount.html" class="wikilink1" title="toolkit-pocount.html">pocount</a>, <a href="toolkit-pogrep.html" class="wikilink1" title="toolkit-pogrep.html">pogrep</a>, etc</div> +</li> +<li class="level1"><div class="li"> lang -- modules with data / tweaks for various languages</div> +</li> +<li class="level1"><div class="li"> search -- translation memory, terminology matching, and indexing / searching</div> +</li> +<li class="level1"><div class="li"> share -- data files</div> +</li> +</ul> + +</div> +<!-- SECTION "Source code map" [1592-2364] --> +<h2><a name="current_source_state" id="current_source_state">Current source state</a></h2> +<div class="level2"> + +<p> + +Note that this documentation is almost always for trunk. + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> Development </td><td class="col1 leftalign"> trunk </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> Current stable branch </td><td class="col1 leftalign"> Pootle-toolkit-1.2 </td> + </tr> +</table> + +</div> +<!-- SECTION "Current source state" [2365-2571] --> +<h2><a name="setup" id="setup">Setup</a></h2> +<div class="level2"> + +<p> + +The toolkit is installed by running: + +</p> +<pre class="code">./setup.py install</pre> + +<p> + +As root +</p> + +<p> +The various setup options are yours to explore +</p> + +<p> +To run / test things without installing, see the <a href="pootle-no_install.html" class="wikilink1" title="pootle-no_install.html">instructions for Pootle</a>. Those instructions sets your environment for both Pootle and the toolkit +</p> + +</div> +<!-- SECTION "Setup" [2572-2877] --> +<h2><a name="general_overview_of_the_programs" id="general_overview_of_the_programs">General overview of the programs</a></h2> +<div class="level2"> + +<p> + +Each tool in the toolkit has both a core program and a command line wrapper. For example the oo2po converter: + +</p> +<ul> +<li class="level1"><div class="li"> oo2po -- the command line tool</div> +</li> +<li class="level1"><div class="li"> oo2po.py -- the core program</div> +</li> +</ul> + +<p> + +This is done so that the tools can be used from within the Pootle server thus reusing the toolkit easily. +</p> + +</div> +<!-- SECTION "General overview of the programs" [2878-3211] --> +<h3><a name="command_line_options" id="command_line_options">Command line options</a></h3> +<div class="level3"> + +<p> + +Getting lost with the command line options? Well you might want to volunteer to move some of them into configuration files. But in terms of programming you might be confused as to where they are located. Many of the command line options are implemented in each tool. Things such as --progress and --errorlevel are used in each program. Thus these are abstracted in <strong>misc/optrecurse.py</strong>. While each tools unique command line options are implemented in <strong>xxx.py</strong>. +</p> + +</div> +<!-- SECTION "Command line options" [3212-3715] --> +<h2><a name="converters" id="converters">Converters</a></h2> +<div class="level2"> + +<p> + +The converters each have a class that handles the conversion from one format to another. This class has one important method <strong>convertfile</strong> which handles the actual conversion. +</p> + +<p> +A function <strong>convertXXX</strong> manages the conversion for the command line equivalent and essentially has at least 3 parameters: inputfile, outputfile and templatefile. It itself will call the conversion class to handle conversion of individual files. Recursing through multiple files is handled by the optrecurse.py logic. +</p> + +<p> +The converters <strong>main</strong> function handles any unique command line options. +</p> + +<p> +Where we are headed is to get to a level where the storage formats themselves are more aware of themselves and their abilities. Thus the converter could end up as one program that accepts storage format plugins to convert from anything to almost anything else. Although our target localisation formats are <acronym title="Gettext Portable Object">PO</acronym> and <acronym title="XML Localization Interchange File Format">XLIFF</acronym> only. +</p> + +<p> +If you want to create a new converter it is best to look at a simple instance such as <a href="toolkit-csv2tbx.html" class="wikilink1" title="toolkit-csv2tbx.html">csv2tbx</a> or <a href="toolkit-txt2po.html" class="wikilink1" title="toolkit-txt2po.html">txt2po</a> and their associated storage classes. The <a href="http://translate.sourceforge.net/doc/api/public/translate.storage.base-module.html" class="urlextern" title="http://translate.sourceforge.net/doc/api/public/translate.storage.base-module.html">storage base class documentation</a> will give you the information you need for the storage class implementation. +</p> + +</div> +<!-- SECTION "Converters" [3716-4997] --> +<h2><a name="tools" id="tools">Tools</a></h2> +<div class="level2"> + +<p> + +The tools in some way copy the logic of the converters. We have a class so that we can reuse a lot of the functionality in Pootle. We have a core function that take: input, output and templates. And we have a <strong>main</strong> function to handle the command line version. +</p> + +<p> +<a href="toolkit-pocount.html" class="wikilink1" title="toolkit-pocount.html">pocount</a> should be converted to this but does not follow this conventions. In fact pocount should move the counting to the storage formats to allow any format to return its own word count. +</p> + +</div> +<!-- SECTION "Tools" [4998-5477] --> +<h2><a name="checks" id="checks">Checks</a></h2> +<div class="level2"> + +<p> + +There's really only one, <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a>. But there are lots of helper functions for pofilter. pofilters main task is to check for errors in <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files. Here are the helper file and their descriptions. + +</p> +<ul> +<li class="level1"><div class="li"> autocorrect.py -- when using --autocorrect it will attempt some basic corrections found in this file</div> +</li> +<li class="level1"><div class="li"> checks.py -- the heart. This contains: the actual checks and their error reports, and defined variables and accelerators for eg --mozilla</div> +</li> +<li class="level1"><div class="li"> decorations.py -- various helper functions to identify accelerators, variables and markers</div> +</li> +<li class="level1"><div class="li"> helpers.py -- functions used by the tests</div> +</li> +<li class="level1"><div class="li"> prefilters.py -- functions to eg remove variables and accelerators before applying tests to the <acronym title="Gettext Portable Object">PO</acronym> message</div> +</li> +</ul> + +<p> + +pofilter is now relatively mature. The best areas for contributions are: + +</p> +<ul> +<li class="level1"><div class="li"> more tests</div> +</li> +<li class="level1"><div class="li"> language specific configuration files</div> +</li> +<li class="level1"><div class="li"> tests for the tests -- so we don't break our good tests</div> +</li> +<li class="level1"><div class="li"> defining a config files scheme to do cool stuff off of the command line. Globally enable or disable tests based on language, etc</div> +</li> +<li class="level1"><div class="li"> some approach to retesting that would remove '# (pofilter)' failure markings if the test now passes.</div> +</li> +<li class="level1"><div class="li"> ability to mark false positives</div> +</li> +</ul> + +<p> + +The <a href="http://translate.sourceforge.net/doc/api/translate.filters-module.html" class="urlextern" title="http://translate.sourceforge.net/doc/api/translate.filters-module.html">API documentation</a> is a good start if you want to add a new tests. To add a new language have a look at a language you understand amongst those already implemented. +</p> + +</div> +<!-- SECTION "Checks" [5478-6920] --> +<h2><a name="storage" id="storage">Storage</a></h2> +<div class="level2"> + +<p> + +These are the heart of the converters. Each destination storage format is implemented in its own file. Up until toolkit version 0.8, there was no formally defined <acronym title="Application Programming Interface">API</acronym> (the tools have been evolving and only recently stabilised), but they generally followed this structure. These classes are defined: + +</p> +<ul> +<li class="level1"><div class="li"> XXelement -- handles the low level individual elements of the file format. e.g. <acronym title="Gettext Portable Object">PO</acronym> message, <acronym title="Comma Seperated Value">CSV</acronym> records, <acronym title="Document Type Definition">DTD</acronym> elements</div> +</li> +<li class="level1"><div class="li"> XXfile -- handles the document or file level of the format. Eg a <acronym title="Gettext Portable Object">PO</acronym> file, a <acronym title="Comma Seperated Value">CSV</acronym> file a <acronym title="Document Type Definition">DTD</acronym> file</div> +<ul> +<li class="level2"><div class="li"> fromlines -- read in a file and initialise the various elements</div> +</li> +<li class="level2"><div class="li"> tolines -- convert the elements stored in XXelements and portions in XXfile to a raw file in that format</div> +</li> +</ul> +</li> +</ul> + +<p> + +In the <acronym title="Extensible Markup Language">XML</acronym> based formats e.g. <acronym title="Translation Memory eXchange">TMX</acronym>, <acronym title="XML Localization Interchange File Format">XLIFF</acronym> and <acronym title="HyperText Markup Language">HTML</acronym> there is usually just an extended parser to manage the file creation. +</p> + +<p> +Within each storage format there are many helper functions for escaping and managing the unique features of the actual format. +</p> + +<p> +You can help by: + +</p> +<ul> +<li class="level1"><div class="li"> abstracting more of the functions and documenting that so that we can get a better <acronym title="Application Programming Interface">API</acronym></div> +</li> +<li class="level1"><div class="li"> adding other formats and converters eg .DOC, .ODF and others</div> +</li> +<li class="level1"><div class="li"> helping us move to a position where any format should convert to the base format: <acronym title="Gettext Portable Object">PO</acronym> and in the future <acronym title="XML Localization Interchange File Format">XLIFF</acronym> without having to create a specific converter wrapper.</div> +</li> +<li class="level1"><div class="li"> Ensuring that our formats <a href="toolkit-conformance.html" class="wikilink1" title="toolkit-conformance.html">conform to the standards</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Storage" [6921-8314] --> +<h3><a name="base_classes" id="base_classes">Base Classes</a></h3> +<div class="level3"> + +<p> + +From toolkit 0.9 onwards, we are moving towards basing all storage formats on a set of <a href="toolkit-base_classes.html" class="wikilink1" title="toolkit-base_classes.html">base classes</a>, in the move to a universal <acronym title="Application Programming Interface">API</acronym>. We're also fixing things so that escaping is much more sane and handled within the class itself not by the converters. +</p> + +<p> +In base classes we have different terminology + +</p> +<ul> +<li class="level1"><div class="li"> XXXunit = XXXelement</div> +</li> +<li class="level1"><div class="li"> XXXstore = XXXfile</div> +</li> +</ul> + +<p> + +We have also tried to unify terminology but this has been filtered into the old classes as far as possible. + +</p> + +</div> +<!-- SECTION "Base Classes" [8315-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-dtd.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-dtd.html new file mode 100644 index 0000000..4b9538c --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-dtd.html @@ -0,0 +1,58 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="mozilla_dtd_format" id="mozilla_dtd_format">Mozilla DTD format</a></h1> +<div class="level1"> + +<p> + +Mozilla makes use of a .dtd file to store many of its translatable elements, the <a href="toolkit-moz2po.html" class="wikilink1" title="toolkit-moz2po.html">moz2po</a> converter can handle these. +</p> + +</div> +<!-- SECTION "Mozilla DTD format" [1-155] --> +<h2><a name="references" id="references">References</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="http://www.w3.org/TR/REC-xml/" class="urlextern" title="http://www.w3.org/TR/REC-xml/">XML specification</a></div> +</li> +</ul> + +</div> +<!-- SECTION "References" [156-236] --> +<h2><a name="features" id="features">Features</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Comments - these are handled correctly and integrated with the unit</div> +</li> +<li class="level1"><div class="li"> Accelerators - if a unit has an associated access key entry then these are combined into a single unit</div> +</li> +<li class="level1"><div class="li"> Translator directive - all LOCALIZATION NOTE items such as DONT_TRANSLATE are handled and such items are discarded</div> +</li> +</ul> + +</div> +<!-- SECTION "Features" [237-557] --> +<h2><a name="issues" id="issues">Issues</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> We don't escape character entities like &lt;, &#38; - this doesn't break anything but it would be nicer to see © rather then &copy;</div> +</li> +</ul> + +</div> +<!-- SECTION "Issues" [558-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-duplicates_duplicatestyle.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-duplicates_duplicatestyle.html new file mode 100644 index 0000000..d5f0ad4 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-duplicates_duplicatestyle.html @@ -0,0 +1,126 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="duplicates_duplicatestyle" id="duplicates_duplicatestyle">--duplicates=DUPLICATESTYLE</a></h1> +<div class="level1"> + +<p> + +Gettext <acronym title="Gettext Portable Object">PO</acronym> files only allow one message with a common msgid (source string). Many other formats allow duplicate entries. To create a valid <acronym title="Gettext Portable Object">PO</acronym> file you need to merge these duplicate entries into one <acronym title="Gettext Portable Object">PO</acronym> message. However, this often negatively affects the roundrip or is not what is expected by the user. Thus we have a number of methods of handling duplicates which we call <em>duplicate styles</em>. +</p> + +<p> +Also affected are conversions in which the source format is empty (allowing possible translation). As the header in a <acronym title="Gettext Portable Object">PO</acronym> file is identified by an empty source string, your message will appear to be a duplicate of the header. In this case duplicate removal is critical. +</p> + +<p> +Previously the tools used msgid_comment (KDE style comments) to disambiguate text. However, with the release of Gettext 0.15, the new msgctxt disambiguation is now recommended, especially if you wish to use your files with other Gettext the tools. Many other pieces of software now also support this feature, and will probably become the best choice for almost all circumstances. +</p> + +</div> +<!-- SECTION "--duplicates=DUPLICATESTYLE" [1-1095] --> +<h2><a name="merge" id="merge">merge</a></h2> +<div class="level2"> + +<p> + +This is the traditional Gettext approach. All messages with the same source string or English string are merged into one <acronym title="Gettext Portable Object">PO</acronym> message. +</p> +<pre class="code po"><pre class="code po">#: file1.dtd:instruction_manual +#: file1.dtd:manual_process +msgid "Manual" +msgstr ""</pre></pre> +<p> +If however the source text is blank (these are often configuration options in Mozilla) then the <em>merge</em> style will use KDE comments as used in the <em>msgid_comment</em> style in order to create unambiquous entries that can still be used for configuration. +</p> +<pre class="code po"><pre class="code po">#: file1.dtd:translators_name +msgid "_: file1.dtd:translators_name\n" +msgstr "" + +#: file1.dtd:translators_email +msgid "_: file1.dtd:translators_email\n" +msgstr ""</pre></pre> +</div> +<!-- SECTION "merge" [1096-1790] --> +<h2><a name="keep" id="keep">keep</a></h2> +<div class="level2"> + +<p> + +Duplictes are not merged and each appear in their own message. This type of <acronym title="Gettext Portable Object">PO</acronym> file will not work with the Gettext tools. +</p> +<pre class="code po"><pre class="code po">#: file1.dtd:instruction_manual +msgid "Manual" +msgstr "" + +#: file1.dtd:manual_process +msgid "Manual" +msgstr ""</pre></pre> +</div> +<!-- SECTION "keep" [1791-2062] --> +<h2><a name="msgid_comment" id="msgid_comment">msgid_comment</a></h2> +<div class="level2"> + +<p> + +If a duplicates is discovered then we make use of the KDE style comments to make them unique. +</p> +<pre class="code po"><pre class="code po">#: file1.dtd:instruction_manual +msgid "_: instruction_manual\n" +"Manual" +msgstr "" + +#: file1.dtd:manual_process +msgid "_: manual_process\n" +"Manual" +msgstr ""</pre></pre> +<p> +You can see that both the entries <em>instruction_manual</em> and <em>manual_process</em> have source strings of <em>“Manual”</em>. By adding +the KDE style comment we make the messages unique. This is helful for many people but isn't quite perfect in that in many cases +your language will use the same word and you don't want it split - you now simply have more work. +</p> + +</div> +<!-- SECTION "msgid_comment" [2063-2720] --> +<h2><a name="msgid_comment_all" id="msgid_comment_all">msgid_comment_all</a></h2> +<div class="level2"> + +<p> + +This operates the same as <em>msgid_comment</em> except now <strong>every</strong> message has a KDE style comment added regardless if it is a duplicate or not. +</p> + +</div> +<!-- SECTION "msgid_comment_all" [2721-2895] --> +<h2><a name="msgctxt" id="msgctxt">msgctxt</a></h2> +<div class="level2"> + +<p> + +This uses the new feature of gettext that was introduced with gettext 0.15. Several tools might not support it 100%. This option for duplicatestyle was added in version 1.0 of the translate toolkit. +</p> +<pre class="code po"><pre class="code po">#: file1.dtd:instruction_manual +msgctxt "instruction_manual" +msgid "Manual" +msgstr "" + +#: file1.dtd:manual_process +msgctxt "manual_process" +msgid "Manual" +msgstr ""</pre></pre> +</div> +<!-- SECTION "msgctxt" [2896-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-errorlevel_errorlevel.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-errorlevel_errorlevel.html new file mode 100644 index 0000000..054c362 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-errorlevel_errorlevel.html @@ -0,0 +1,90 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="errorlevel_errorlevel" id="errorlevel_errorlevel">--errorlevel=ERRORLEVEL</a></h1> +<div class="level1"> + +<p> + +This is a parameter that can be passed to most of the programs in the translate toolkit in order to choose the level of feedback that you need when errors occur. It is mostly useful for debugging. Please report your errors to the developers with --errorlevel=traceback. +</p> + +</div> +<!-- SECTION "--errorlevel=ERRORLEVEL" [1-311] --> +<h2><a name="none" id="none">none</a></h2> +<div class="level2"> + +<p> + +Display no error messages +</p> + +</div> +<!-- SECTION "none" [312-356] --> +<h2><a name="message" id="message">message</a></h2> +<div class="level2"> + +<p> + +Display on the error message +</p> +<pre class="code"> +An error occurred processing PO file +</pre> + +</div> +<!-- SECTION "message" [357-460] --> +<h2><a name="exception" id="exception">exception</a></h2> +<div class="level2"> + +<p> + +Give the error message and name and Python exception +</p> +<pre class="code"> +ValueError: An error occurred processing PO file +</pre> + +</div> +<!-- SECTION "exception" [461-602] --> +<h2><a name="traceback" id="traceback">traceback</a></h2> +<div class="level2"> + +<p> + +Provide a full traceback for debugging purposes +</p> +<pre class="code"> +csv2po: warning: Error processing: nso/readlicense_oo/docs/readme.csv: Traceback (most recent call last): + + File "/usr/lib/python2.4/site-packages/translate/misc/optrecurse.py", line 415, in recursiveprocess + success = self.processfile(fileprocessor, options, fullinputpath, fulloutputpath, fulltemplatepath) + + File "/usr/lib/python2.4/site-packages/translate/misc/optrecurse.py", line 468, in processfile + if fileprocessor(inputfile, outputfile, templatefile, **passthroughoptions): + + File "/usr/lib/python2.4/site-packages/translate/convert/csv2po.py", line 183, in convertcsv + outputpo = convertor.convertfile(inputcsv) + + File "/usr/lib/python2.4/site-packages/translate/convert/csv2po.py", line 159, in convertfile + raise ValueError("An error occured processing PO file") + +ValueError: An error occurred processing PO file +</pre> + +</div> +<!-- SECTION "traceback" [603-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-features.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-features.html new file mode 100644 index 0000000..357bca1 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-features.html @@ -0,0 +1,60 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="features" id="features">Features</a></h1> +<div class="level1"> +<ul> +<li class="level1"><div class="li"> Work with <strong>ONE localisation format</strong>. You'll no longer be editing <acronym title="Document Type Definition">DTD</acronym> files in one tools, .properties in another, OpenOffice GSI in a third. Simply do all your localisation in a <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> editor</div> +</li> +<li class="level1"><div class="li"> Converters for a <strong>number of <a href="toolkit-formats.html" class="wikilink1" title="toolkit-formats.html">formats</a></strong></div> +<ul> +<li class="level2"><div class="li"> OpenOffice.org SDF/GSI</div> +</li> +<li class="level2"><div class="li"> Mozilla: .properties, <acronym title="Document Type Definition">DTD</acronym>, <acronym title="Extensible HyperText Markup Language">XHTML</acronym>, .inc, .ini, etc</div> +</li> +<li class="level2"><div class="li"> Others: Comma Separated Value, <acronym title="Translation Memory eXchange">TMX</acronym>, <acronym title="XML Localization Interchange File Format">XLIFF</acronym>, <acronym title="TermBase eXchange">TBX</acronym>, php, WordFast TXT, Qt .ts, txt, .ini, Windows .rc, ical</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> File access through the powerful <acronym title="Application Programming Interface">API</acronym> in all the above formats, as well as .qph, .qm, .mo</div> +</li> +<li class="level1"><div class="li"> Output <strong>VALID target file</strong> types. We make sure that your output files (eg .properties) contain all comments from the original file and preserves the layout of the original as far as possible. If your <acronym title="Gettext Portable Object">PO</acronym> entry is marked as fuzzy we use the English text, not your half complete translation. The converters for OpenOffice.org and Mozilla formats will also perform simple checks and corrections to make sure you have none of those hard to find localisation bugs.</div> +</li> +<li class="level1"><div class="li"> Our checker has over <a href="toolkit-pofilter_tests.html" class="wikilink1" title="toolkit-pofilter_tests.html">42 checks</a> to find errors such as: missing or translated variables, missing accelerator keys, bad escaping, start capitalisation, missing sentences, bad <acronym title="Extensible Markup Language">XML</acronym> and much more.</div> +</li> +<li class="level1"><div class="li"> Language awareness, taking language conventions for capitalisation, quotes and other punctuation into account</div> +</li> +<li class="level1"><div class="li"> <strong>Find conflicting translations</strong> easily, cases where you have translated a source word differently or used a target word for 2 very different English concepts</div> +</li> +<li class="level1"><div class="li"> <strong>Extract messages</strong> using simple text or a regular expression allowing you to quickly find and extract words that you need to fix due to glossary changes.</div> +</li> +<li class="level1"><div class="li"> <strong>Merge snippets</strong> of <acronym title="Gettext Portable Object">PO</acronym> files into your existing translations.</div> +</li> +<li class="level1"><div class="li"> Create word, string and file <strong>counts</strong> of your <acronym title="Gettext Portable Object">PO</acronym> files. Making it much easier to budget time as string counts do not give you a good indication of expected work.</div> +</li> +<li class="level1"><div class="li"> Create a set of <acronym title="Gettext Portable Object">PO</acronym> files with <strong>debugging</strong> entries to allow you to easily locate the source of translations. Very useful in OpenOffice.org which provides scant clues as to where the running application has sourced the message.</div> +</li> +</ul> + +<p> + +The Translate Toolkit is also a <strong>powerful <acronym title="Application Programming Interface">API</acronym></strong> for writing translation and localisation tools, already used by our own and several other projects. See the <a href="developers-index.html" class="wikilink1" title="developers-index.html">developers</a> section for more information. + +</p> + +</div> +</body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-filteraction_action.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-filteraction_action.html new file mode 100644 index 0000000..869721b --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-filteraction_action.html @@ -0,0 +1,63 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="filteraction_action" id="filteraction_action">--filteraction=ACTION</a></h1> +<div class="level1"> + +</div> +<!-- SECTION "--filteraction=ACTION" [1-37] --> +<h2><a name="none_default" id="none_default">none (default)</a></h2> +<div class="level2"> + +<p> + +Take no action. Messages from failing test will appear in the output file +</p> + +</div> +<!-- SECTION "none (default)" [38-141] --> +<h2><a name="warn" id="warn">warn</a></h2> +<div class="level2"> + +<p> + +Print a warning but otherwise include the message in the output file. +</p> + +</div> +<!-- SECTION "warn" [142-230] --> +<h2><a name="exclude-serious" id="exclude-serious">exclude-serious</a></h2> +<div class="level2"> + +<p> + +Only exclude errors that are listed as serious by the convertor. All other are included. +</p> + +</div> +<!-- SECTION "exclude-serious" [231-350] --> +<h2><a name="exclude-all" id="exclude-all">exclude-all</a></h2> +<div class="level2"> + +<p> + +Exclude any message that fails a test. + +</p> + +</div> +<!-- SECTION "exclude-all" [351-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-formats.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-formats.html new file mode 100644 index 0000000..c3be24a --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-formats.html @@ -0,0 +1,226 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="translation_related_file_formats" id="translation_related_file_formats">Translation Related File Formats</a></h1> +<div class="level1"> + +<p> + +These are the different storage formats for translations and files associated with translations that are supported by the toolkit. See also <a href="toolkit-conformance.html" class="wikilink1" title="toolkit-conformance.html">conformance</a> for standards conformance. +</p> + +<p> +Common concerns in handling these files using our <a href="toolkit-base_classes.html" class="wikilink1" title="toolkit-base_classes.html">base classes</a> for a uniform <acronym title="Application Programming Interface">API</acronym> are <a href="toolkit-quoting_and_escaping.html" class="wikilink1" title="toolkit-quoting_and_escaping.html">quoting and escaping</a>. +</p> + +</div> +<!-- SECTION "Translation Related File Formats" [1-348] --> +<h2><a name="primary_translation_formats" id="primary_translation_formats">Primary translation formats</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-xliff.html" class="wikilink1" title="toolkit-xliff.html">XLIFF</a></div> +</li> +<li class="level1"><div class="li"> Gettext <a href="toolkit-po.html" class="wikilink1" title="toolkit-po.html">PO</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Primary translation formats" [349-422] --> +<h2><a name="other_translation_formats" id="other_translation_formats">Other translation formats</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-csv.html" class="wikilink1" title="toolkit-csv.html">CSV</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-ini.html" class="wikilink1" title="toolkit-ini.html">.ini</a> (including Inno Setup .isl dialect (from > v1.2.1)</div> +</li> +<li class="level1"><div class="li"> Java <a href="toolkit-properties.html" class="wikilink1" title="toolkit-properties.html">properties</a> (also Mozilla derived properties files)</div> +</li> +<li class="level1"><div class="li"> Mozilla <a href="toolkit-dtd.html" class="wikilink1" title="toolkit-dtd.html">DTD</a></div> +</li> +<li class="level1"><div class="li"> OpenOffice.org <a href="toolkit-gsi.html" class="wikilink1" title="toolkit-gsi.html">GSI</a> (Also called SDF)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-php.html" class="wikilink1" title="toolkit-php.html">PHP</a> translation arrays</div> +</li> +<li class="level1"><div class="li"> Qt Linguist <a href="toolkit-ts.html" class="wikilink1" title="toolkit-ts.html">.ts</a> (both 1.0 and 1.1 supported, 1.0 has a converter)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-symbian.html" class="wikilink2" title="toolkit-symbian.html">Symbian</a> localization file (from > v1.2.1)</div> +</li> +<li class="level1"><div class="li"> Windows <a href="toolkit-rc.html" class="wikilink1" title="toolkit-rc.html">RC</a> files (from v1.2)</div> +</li> +</ul> + +</div> +<!-- SECTION "Other translation formats" [423-858] --> +<h2><a name="translation_memory_formats" id="translation_memory_formats">Translation Memory formats</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-tmx.html" class="wikilink1" title="toolkit-tmx.html">TMX</a> </div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-wordfast.html" class="wikilink1" title="toolkit-wordfast.html">Wordfast</a>: TM</div> +</li> +</ul> + +</div> +<!-- SECTION "Translation Memory formats" [859-933] --> +<h2><a name="glossary_formats" id="glossary_formats">Glossary formats</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-qt_phrase_book.html" class="wikilink1" title="toolkit-qt_phrase_book.html">Qt Phrase Book</a> (from v1.2)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-tbx.html" class="wikilink1" title="toolkit-tbx.html">TBX</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Glossary formats" [934-1011] --> +<h2><a name="formats_of_translatable_documents" id="formats_of_translatable_documents">Formats of translatable documents</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-html.html" class="wikilink1" title="toolkit-html.html">HTML</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-ical.html" class="wikilink1" title="toolkit-ical.html">iCal</a> (from v1.2)</div> +</li> +<li class="level1"><div class="li"> <a href="http://en.wikipedia.org/wiki/OpenDocument" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/OpenDocument">OpenDocument</a> - all ODF file types (from v1.2.1)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-text.html" class="wikilink1" title="toolkit-text.html">Text</a> - plain text with blocks separated by whitespace</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-wiki.html" class="wikilink1" title="toolkit-wiki.html">Wiki</a> - <a href="http://en.wikipedia.org/wiki/dokuwiki" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/dokuwiki">dokuwiki</a> and <a href="http://en.wikipedia.org/wiki/MediaWiki" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/MediaWiki">MediaWiki</a> supported</div> +</li> +</ul> + +</div> +<!-- SECTION "Formats of translatable documents" [1012-1279] --> +<h2><a name="machine_readable_formats" id="machine_readable_formats">Machine readable formats</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Gettext <a href="toolkit-mo.html" class="wikilink1" title="toolkit-mo.html">.mo</a></div> +</li> +<li class="level1"><div class="li"> Qt <a href="toolkit-qm.html" class="wikilink1" title="toolkit-qm.html">.qm</a> (read-only)</div> +</li> +</ul> + +</div> +<!-- SECTION "Machine readable formats" [1280-1364] --> +<h2><a name="in_development" id="in_development">In development</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-wml.html" class="wikilink1" title="toolkit-wml.html">WML</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://bugs.locamotion.org/show_bug.cgi?id=703" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=703">Subtitles</a></div> +</li> +</ul> + +</div> +<!-- SECTION "In development" [1365-1431] --> +<h2><a name="unsupported_formats" id="unsupported_formats">Unsupported formats</a></h2> +<div class="level2"> + +<p> + +Things that we would like to support but don't currently: + +</p> +<ul> +<li class="level1"><div class="li"> Wordfast: glossary</div> +</li> +<li class="level1"><div class="li"> Apple:</div> +<ul> +<li class="level2"><div class="li"> <a href="ftp://ftp.apple.com/developer/Tool_Chest/Localization_Tools/AppleGlot/AppleGlot_3.2_UsersGuide.pdf" class="urlextern" title="ftp://ftp.apple.com/developer/Tool_Chest/Localization_Tools/AppleGlot/AppleGlot_3.2_UsersGuide.pdf">AppleGlot</a> </div> +</li> +<li class="level2"><div class="li"> MacOS .strings file localization - Bug <a href="http://bugs.locamotion.org/show_bug.cgi?id=371" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=371">371</a> relates to this.</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> Adobe:</div> +<ul> +<li class="level2"><div class="li"> FrameMaker's Maker Interchange Format - <a href="http://help.adobe.com/en_US/FrameMaker/8.0/mif_reference.pdf" class="urlextern" title="http://help.adobe.com/en_US/FrameMaker/8.0/mif_reference.pdf">MIF</a> (See also <a href="http://lino.sourceforge.net/src/100.html" class="urlextern" title="http://lino.sourceforge.net/src/100.html">python-gendoc</a>, and <a href="http://search.cpan.org/~rst/FrameMaker-MifTree-0.075/lib/FrameMaker/MifTree.pm" class="urlextern" title="http://search.cpan.org/~rst/FrameMaker-MifTree-0.075/lib/FrameMaker/MifTree.pm">Perl MIF module</a>)</div> +</li> +<li class="level2"><div class="li"> FrameMaker's <a href="http://www.adobe.com/support/downloads/detail.jsp?ftpID=137" class="urlextern" title="http://www.adobe.com/support/downloads/detail.jsp?ftpID=137">Maker Markup Language</a> (<acronym title="Mathematical Markup Language">MML</acronym>)</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> Microsoft</div> +<ul> +<li class="level2"><div class="li"> Word, Excel, etc (probably through usage of OpenOffice.org)</div> +</li> +<li class="level2"><div class="li"> <a href="http://en.wikipedia.org/wiki/Office%20Open%20XML" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Office%20Open%20XML">OOXML</a> (at least at the text level we don't have to deal with much of the mess inside OOXML). See also: <a href="http://go.microsoft.com/fwlink/?LinkId=120908" class="urlextern" title="http://go.microsoft.com/fwlink/?LinkId=120908">Open XML SDK v1</a></div> +</li> +<li class="level2"><div class="li"> <a href="http://en.wikipedia.org/wiki/Rich%20Text%20Format" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Rich%20Text%20Format">Rich Text Format</a></div> +</li> +<li class="level2"><div class="li"> <a href="http://en.wikipedia.org/wiki/XML%20Paper%20Specification" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/XML%20Paper%20Specification">XML Paper Specification</a></div> +</li> +<li class="level2"><div class="li"> .NET Resource files (.resx) - Bug <a href="http://bugs.locamotion.org/show_bug.cgi?id=396" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=396">396</a></div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> <acronym title="Extensible Markup Language">XML</acronym> related</div> +<ul> +<li class="level2"><div class="li"> Generic <acronym title="Extensible Markup Language">XML</acronym></div> +</li> +<li class="level2"><div class="li"> <a href="http://en.wikipedia.org/wiki/DocBook" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/DocBook">DocBook</a> (can be handled by KDE's <a href="http://man.cx/xml2pot" class="interwiki iw_man" title="http://man.cx/xml2pot">xml2pot</a>)</div> +</li> +<li class="level2"><div class="li"> <a href="http://www.w3.org/TR/SVG/" class="urlextern" title="http://www.w3.org/TR/SVG/">SVG</a></div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> <a href="http://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture">DITA</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://en.wikipedia.org/wiki/PDF" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/PDF">PDF</a> (<a href="http://www.adobe.com/devnet/pdf/pdf_reference.html" class="urlextern" title="http://www.adobe.com/devnet/pdf/pdf_reference.html">spec</a>)</div> +</li> +<li class="level1"><div class="li"> <a href="http://en.wikipedia.org/wiki/LaTeX" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/LaTeX">LaTeX</a> - see <a href="http://plastex.sourceforge.net/plastex/index.html" class="urlextern" title="http://plastex.sourceforge.net/plastex/index.html">plasTeX</a>, a Python framework for processing LaTeX documents</div> +</li> +<li class="level1"><div class="li"> <a href="http://dag.wieers.com/home-made/unoconv/" class="urlextern" title="http://dag.wieers.com/home-made/unoconv/">unoconv</a> - Python bindings to OpenOffice.org UNO which could allow manipulation of all formats understood by OpenOffice.org.</div> +</li> +<li class="level1"><div class="li"> Trados TTX (<a href="http://www.tracom.de/04/EN/techdoccenter/download/TRADOS_TTX-DTD.zip" class="urlextern" title="http://www.tracom.de/04/EN/techdoccenter/download/TRADOS_TTX-DTD.zip">Reverse Engineered DTD</a>, <a href="http://blogs.sun.com/timf/entry/beds_mattresses_and_open_standards" class="urlextern" title="http://blogs.sun.com/timf/entry/beds_mattresses_and_open_standards">other discussion</a>)</div> +</li> +<li class="level1"><div class="li"> <a href="http://en.wikipedia.org/wiki/Android%20%28mobile%20device%20platform%29" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Android%20%28mobile%20device%20platform%29">Android</a> <a href="http://code.google.com/android/devel/resources-i18n.html" class="urlextern" title="http://code.google.com/android/devel/resources-i18n.html">resource files</a> specifically <a href="http://code.google.com/android/reference/available-resources.html#stringresources" class="urlextern" title="http://code.google.com/android/reference/available-resources.html#stringresources">string resources</a></div> +</li> +<li class="level1"><div class="li"> Subtitling</div> +<ul> +<li class="level2"><div class="li"> Both .sub and .srt are the main formats <a href="http://help.youtube.com/support/youtube/bin/answer.py?answer=100077" class="urlextern" title="http://help.youtube.com/support/youtube/bin/answer.py?answer=100077">supported by YouTube</a></div> +</li> +<li class="level2"><div class="li"> <a href="http://en.wikipedia.org/wiki/SubViewer" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/SubViewer">SubViewer</a> .sub - the format is outline on the youtube wupport page above.</div> +</li> +<li class="level2"><div class="li"> <a href="http://en.wikipedia.org/wiki/SubRip" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/SubRip">SubRip</a> .srt</div> +</li> +<li class="level2"><div class="li"> <a href="http://home.gna.org/gaupol/" class="urlextern" title="http://home.gna.org/gaupol/">Gaupol</a> an PyGTK based subtitling tool looks like a good option to get format readers.</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> Tcl: .msg files. <a href="http://www.google.com/codesearch?hl=en&q=show:XvsRBDCljVk:M2kzUbm70Ts:D5EHICz0aaQ&sa=N&ct=rd&cs_p=http://www.scilab.org/download/4.0/scilab-4.0-src.tar.gz&cs_f=scilab-4.0/tcl/scipadsources/msg_files/AddingTranslations.txt" class="urlextern" title="http://www.google.com/codesearch?hl=en&q=show:XvsRBDCljVk:M2kzUbm70Ts:D5EHICz0aaQ&sa=N&ct=rd&cs_p=http://www.scilab.org/download/4.0/scilab-4.0-src.tar.gz&cs_f=scilab-4.0/tcl/scipadsources/msg_files/AddingTranslations.txt">Good documentation</a></div> +</li> +<li class="level1"><div class="li"> NSIS installer: <a href="http://trac.vidalia-project.net/browser/vidalia/trunk/src/tools" class="urlextern" title="http://trac.vidalia-project.net/browser/vidalia/trunk/src/tools">Existing C++ implementation</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Unsupported formats" [1432-4358] --> +<h2><a name="unlikely_to_be_supported" id="unlikely_to_be_supported">Unlikely to be supported</a></h2> +<div class="level2"> + +<p> + +These formats are either: too difficult to implement, undocumented, can be processed using some intermediate format or used by too few people to justify the effort. Or some combination or these issues. + +</p> +<ul> +<li class="level1"><div class="li"> Trados: .tmw, Trados .txt (We are unable to find good documentation for these formats, you can interchange using <acronym title="Translation Memory eXchange">TMX</acronym>)</div> +</li> +</ul> + +</div> +<!-- SECTION "Unlikely to be supported" [4359-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-general_usage.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-general_usage.html new file mode 100644 index 0000000..0229dcc --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-general_usage.html @@ -0,0 +1,119 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="general_usage" id="general_usage">General Usage</a></h1> +<div class="level1"> + +<p> + +The tools follow a general usage convention which is helpful to understand. +</p> + +</div> +<!-- SECTION "General Usage" [1-106] --> +<h2><a name="input_output" id="input_output">Input & Output</a></h2> +<div class="level2"> + +<p> + +The last two arguments of your command are the input and output directories: + +</p> +<pre class="code">moz2po <input> <output></pre> + +<p> + +You can of course still us the -i and -o options which allows you to reorder commands + +</p> +<pre class="code">moz2po -o <output> -i <input></pre> + +</div> +<!-- SECTION "Input & Output" [107-359] --> +<h2><a name="error_reporting" id="error_reporting">Error Reporting</a></h2> +<div class="level2"> + +<p> + +All tools accept the option --errorlevel. If you find a bug add this option and send the traceback to the developers. +</p> +<pre class="code">moz2po <other-options> --errorlevel=traceback</pre> + +</div> +<!-- SECTION "Error Reporting" [360-558] --> +<h2><a name="templates" id="templates">Templates</a></h2> +<div class="level2"> + +<p> + +If you are working with any file format and you wish to preserve comments and layout then use your source file +as a template. + +</p> +<pre class="code">po2dtd -t <source-file> <input> <output></pre> + +<p> + +This will use the files in <source-file> as a template merge the <acronym title="Gettext Portable Object">PO</acronym> files in <input> and create new <acronym title="Document Type Definition">DTD</acronym> files in <output> +</p> + +<p> +If you ran this without the templates you would get valid <acronym title="Document Type Definition">DTD</acronym> files but they would not preserve the layout or all the comments from the source <acronym title="Document Type Definition">DTD</acronym> file +</p> + +<p> +The same concept of templates is also used when you merge files. + +</p> +<pre class="code">pomerge -t <old> <fixes> <new></pre> + +<p> + +This would take the <old> files merge in the <fix>'s and output new <acronym title="Gettext Portable Object">PO</acronym> files, preserving formatting, into <new>. You can use the same directory for <old> and <new> if you want the merges to overwrite files in <old> +</p> + +</div> +<!-- SECTION "Templates" [559-1345] --> +<h2><a name="source2target" id="source2target">source2target</a></h2> +<div class="level2"> + +<p> + +The converters all follow this convention: + +</p> +<ul> +<li class="level1"><div class="li"> source = the format from which you are converting e.g. in oo2po we are converting from OpenOffice.org SDF/GSI</div> +</li> +<li class="level1"><div class="li"> target = the format into which you are converting e.g. in oo2po we are converting to Gettext <acronym title="Gettext Portable Object">PO</acronym></div> +</li> +</ul> + +</div> +<!-- SECTION "source2target" [1346-1631] --> +<h2><a name="getting_help" id="getting_help">Getting Help</a></h2> +<div class="level2"> + +<p> + +The --help option will always list the available commands for the tool. + +</p> +<pre class="code">moz2po --help</pre> + +</div> +<!-- SECTION "Getting Help" [1632-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-gsi.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-gsi.html new file mode 100644 index 0000000..ffd4894 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-gsi.html @@ -0,0 +1,38 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="openoffice.org_gsisdf_format" id="openoffice.org_gsisdf_format">OpenOffice.org GSI/SDF format</a></h1> +<div class="level1"> + +<p> + +OpenOffice.org uses an internal format called SDF to manage localisation text. The toolkit can successfully manage all features of this format covnerting it to <acronym title="XML Localization Interchange File Format">XLIFF</acronym> or <acronym title="Gettext Portable Object">PO</acronym> format with the <a href="toolkit-oo2po.html" class="wikilink1" title="toolkit-oo2po.html">oo2po</a> and <a href="toolkit-oo2xliff.html" class="wikilink1" title="toolkit-oo2xliff.html">oo2xliff</a> tools. +</p> + +</div> +<!-- SECTION "OpenOffice.org GSI/SDF format" [1-269] --> +<h2><a name="features" id="features">Features</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Handles all translatable text from the SDF</div> +</li> +<li class="level1"><div class="li"> Can also use 'x-comments' 'language' found in the SDF to provide translator comments</div> +</li> +</ul> + +</div> +<!-- SECTION "Features" [270-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-history.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-history.html new file mode 100644 index 0000000..3ef695b --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-history.html @@ -0,0 +1,128 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="history_of_the_translate_toolkit" id="history_of_the_translate_toolkit">History of the Translate Toolkit</a></h1> +<div class="level1"> + +<p> + +This is a short history of the Translate Toolkit. In many ways written so that people who see problems in the toolkit can understand how it evolved and where it is going. +</p> + +</div> +<!-- SECTION "History of the Translate Toolkit" [1-221] --> +<h2><a name="conception" id="conception">Conception</a></h2> +<div class="level2"> + +<p> + +The toolkit was developed by David Fraser while working for <a href="http://translate.org.za" class="urlextern" title="http://translate.org.za">Translate.org.za</a>. Initially Translate.org.za had focussed on translating KDE into South Africa languages, this work was <acronym title="Gettext Portable Object">PO</acronym> based. The next project was to translate Mozilla which used a combination of <acronym title="Document Type Definition">DTD</acronym> and .properties files. The Mozilla project used a tool called Mozilla Translator, which mostly worked although it was not as feature rich as KBabel that was being used to manage <acronym title="Gettext Portable Object">PO</acronym> translations. A decision was made to create a set of tools that could convert the <acronym title="Document Type Definition">DTD</acronym> and .properties files into <acronym title="Gettext Portable Object">PO</acronym> files. The advantage being that translators would not need to learn new tools, that existing translations could be leveraged and that the resultant files, being bilingual, would make it easier to upgrade and manage translations. +</p> + +<p> +Thus was born what initially was called the mozpotools. +</p> + +</div> +<!-- SECTION "Conception" [222-1126] --> +<h2><a name="growth" id="growth">Growth</a></h2> +<div class="level2"> + +<p> + +The first problem with the tools was that it was possible to break Mozilla translations. This was a combination of the fact that translators would often translate variables such as &browserName; and that the toolkit had developed a method of folding labels and accelerators into one <acronym title="Gettext Portable Object">PO</acronym> field. These breakages where presented as broken <acronym title="Extensible Markup Language">XML</acronym>. Thus was born pofilter which allowed us to check the translations for problems in variables and accelerators. pomerge its sister allowed us to merge the corrections back into the main. We also developed pocount which allowed us to for the first time get a real feel of the volume of work required in translating a <acronym title="Gettext Portable Object">PO</acronym> file. +</p> + +</div> +<!-- SECTION "Growth" [1127-1815] --> +<h2><a name="expansion" id="expansion">Expansion</a></h2> +<div class="level2"> + +<p> + +Of course once you can convert the convoluted Mozilla translations then you realise you can do anything. A key addition was the converter for OpenOffice.org but also added where <acronym title="Translation Memory eXchange">TMX</acronym>, Qt .ts, txt and OpenOffice.org SXW files. +</p> + +<p> +The key being that files are converted to <acronym title="Gettext Portable Object">PO</acronym> to allow translations and use of the Gettext tools and existing <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +</div> +<!-- SECTION "Expansion" [1816-2185] --> +<h2><a name="pootle" id="pootle">Pootle</a></h2> +<div class="level2"> + +<p> + +Initially started as a separate project to allow online translation it was soon realised that the toolkit being file based gave all the infrastructure to allow Pootle to be a wrapper around the toolkit. So a file based, web translation tool was created. +</p> + +</div> +<!-- SECTION "Pootle" [2186-2462] --> +<h2><a name="wordforge_project" id="wordforge_project">WordForge project</a></h2> +<div class="level2"> + +<p> + +In 2006 with funding from the <a href="http://www.soros.org/" class="urlextern" title="http://www.soros.org/">Open Society Institute</a> (OSI) and <a href="http://www.idrc.ca/" class="urlextern" title="http://www.idrc.ca/">IDRC</a> the toolkit was adapted to allow many core changes. The first being to introduce the concept of a base class from which <acronym title="Gettext Portable Object">PO</acronym> and <acronym title="XML Localization Interchange File Format">XLIFF</acronym> storage formats are derived. This allowed tools to be adapted to allow output to <acronym title="XML Localization Interchange File Format">XLIFF</acronym> or <acronym title="Gettext Portable Object">PO</acronym> files. The tools themselves where adapted to allow them to work with the core formats <acronym title="XML Localization Interchange File Format">XLIFF</acronym> and <acronym title="Gettext Portable Object">PO</acronym> as well as all base class derived formats. Thus we can count, <acronym title="XML Localization Interchange File Format">XLIFF</acronym>, <acronym title="Gettext Portable Object">PO</acronym>, <acronym title="Gettext Machine Object">MO</acronym> and other formats. +</p> + +<p> +Additional contributions during this phase where the adaptation of Pootle to use <acronym title="XML Localization Interchange File Format">XLIFF</acronym> as well as <acronym title="Gettext Portable Object">PO</acronym>. The creation of tools to manage translation memory files and glossary files. +</p> + +<p> +The toolkit was also adapted to make dealing with encodings, plural forms, and escaping easier and more consistent throughout the code. Many but not all of the formats where converted to the base class. +</p> + +<p> +As part of the WordForge project Pootling was created which in the same way that Pootle is a web-based wrapper around the toolkit so Pootling is a <acronym title="Graphical User Interface">GUI</acronym> wrapper around the toolkit. +</p> + +</div> +<!-- SECTION "WordForge project" [2463-3603] --> +<h2><a name="the_future" id="the_future">The Future</a></h2> +<div class="level2"> + +<p> + +The toolkit continues to evolve with clean-up focused in various areas: +</p> +<ul> +<li class="level1"><div class="li"> Pulling features out of Pootle that should be in the Toolkit</div> +</li> +<li class="level1"><div class="li"> Cleaning up storage classes and converters to be <acronym title="XML Localization Interchange File Format">XLIFF</acronym>/<acronym title="Gettext Portable Object">PO</acronym> interchangeable</div> +</li> +<li class="level1"><div class="li"> Cleaning up the converters to use only base class features and migrating code from the converters to the storage class</div> +</li> +<li class="level1"><div class="li"> Adding storage classes as needed</div> +</li> +<li class="level1"><div class="li"> Optimisation where needed</div> +</li> +</ul> + +<p> + +The toolkit continues to serve as the core for the command line tools and for Pootle. Key new features: +</p> +<ul> +<li class="level1"><div class="li"> Process Management</div> +</li> +</ul> + +</div> +<!-- SECTION "The Future" [3604-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-html.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-html.html new file mode 100644 index 0000000..49206a3 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-html.html @@ -0,0 +1,53 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="html" id="html">HTML</a></h1> +<div class="level1"> + +<p> + +The Translate Toolkit is able to process <acronym title="HyperText Markup Language">HTML</acronym> files using the <a href="toolkit-html2po.html" class="wikilink1" title="toolkit-html2po.html">html2po</a> converter. +</p> + +<p> +The <acronym title="HyperText Markup Language">HTML</acronym> support is basic so please be aware of that +</p> + +</div> +<!-- SECTION "HTML" [1-160] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Can identify almost all tags and attributes that are localisable.</div> +</li> +<li class="level1"><div class="li"> Does not convert <acronym title="HyperText Markup Language">HTML</acronym> entities (e.g. &copy;) to normal strings</div> +</li> +<li class="level1"><div class="li"> It does not handle inline elements well and will drop them, so complicated <acronym title="HyperText Markup Language">HTML</acronym> might not make it through the filter</div> +</li> +</ul> + +</div> +<!-- SECTION "Conformance" [161-444] --> +<h2><a name="references" id="references">References</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Using character entities: <a href="http://www.w3.org/International/questions/qa-escapes" class="urlextern" title="http://www.w3.org/International/questions/qa-escapes">http://www.w3.org/International/questions/qa-escapes</a></div> +</li> +</ul> + +</div> +<!-- SECTION "References" [445-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-html2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-html2po.html new file mode 100644 index 0000000..606980f --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-html2po.html @@ -0,0 +1,182 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="html2po_and_po2html" id="html2po_and_po2html">html2po and po2html</a></h1> +<div class="level1"> + +<p> + +Convert translatable items in <acronym title="HyperText Markup Language">HTML</acronym> to the <acronym title="Gettext Portable Object">PO</acronym> format. +</p> + +</div> +<!-- SECTION "html2po and po2html" [1-89] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">html2po [options] <html> <po> +po2html [options] <po> <html></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <html> </td><td class="col1 leftalign"> is an <acronym title="HyperText Markup Language">HTML</acronym> file or a directory of <acronym title="HyperText Markup Language">HTML</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a <acronym title="Gettext Portable Object">PO</acronym> file or directory of <acronym title="Gettext Portable Object">PO</acronym> files </td> + </tr> +</table> + +<p> + +Options (html2po): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in htm, html, xhtml formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -u, --untagged </td><td class="col1 leftalign"> include untagged sections </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --duplicates=DUPLICATESTYLE </td><td class="col1 leftalign"> what to do with duplicate strings (identical source text): merge (default), msgid_comment, keep, msgid_comment_all </td> + </tr> +</table> + +<p> + +Options (po2html): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in htm, html formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in htm, html formats </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -wWRAP, --wrap=WRAP </td><td class="col1 leftalign"> set number of columns to wrap html at </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --notidy </td><td class="col1"> don't use tidy to clean up <acronym title="HyperText Markup Language">HTML</acronym>, even if installed (new in version 1.2.1) </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [90-2410] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">html2po -P site pot</pre> + +<p> + +This will find all <acronym title="HyperText Markup Language">HTML</acronym> files (.htm, .html, .xhtml) in <em>site</em> convert them to <acronym title="Gettext Portable Object Template">POT</acronym> files and place them in <em>pot</em> + +</p> +<pre class="code">po2html -t site xh site-xh</pre> + +<p> + +All the <acronym title="Gettext Portable Object">PO</acronym> translations in <em>xh</em> will be converted to html using html files in <em>site</em> as templates and outputting new translated <acronym title="HyperText Markup Language">HTML</acronym> files in <em>site-xh</em> +</p> + +</div> +<!-- SECTION "Examples" [2411-2762] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +We don't hide enough of some of the tags, e.g. <a> tags have too much exposed, we should expose only what needs to be translated and +allow the changing on position of the tag within the translation block. Similarly there is some markup that could be excluded eg <b> tags that +appear at the start and end of a msgid, i.e. they don't need placement from the translator. +</p> + +<p> +If the <acronym title="HyperText Markup Language">HTML</acronym> is indented you get very odd msgid's +</p> + +<p> +Some items end up in the msgid's that should not be translated +</p> + +<p> +It might be worth investigating <a href="http://opensource.bureau-cornavin.com/html2pot-po2html/index.html" class="urlextern" title="http://opensource.bureau-cornavin.com/html2pot-po2html/index.html">http://opensource.bureau-cornavin.com/html2pot-po2html/index.html</a> which uses <acronym title="Extensible Stylesheet Language Transformations">XSLT</acronym> to transform <acronym title="Extensible HyperText Markup Language">XHTML</acronym> to Gettext <acronym title="Gettext Portable Object">PO</acronym> + +</p> + +</div> +<!-- SECTION "Bugs" [2763-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-ical.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ical.html new file mode 100644 index 0000000..f6828af --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ical.html @@ -0,0 +1,126 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="icalendar" id="icalendar">iCalendar</a></h1> +<div class="level1"> + +<p> + +Support for <a href="http://en.wikipedia.org/wiki/iCalendar" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/iCalendar">iCalendar</a> (*.ics) files. This allows calendars to be localised. +</p> + +<p> +The format extracts certain properties from VEVENT objects. The properties are limited to textual entries that would need to be localised, it does not include entries such as dates and durations that would indeed change for various locales. +</p> + +</div> +<!-- SECTION "iCalendar" [1-353] --> +<h2><a name="resources" id="resources">Resources</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="http://tools.ietf.org/html/rfc2445" class="urlextern" title="http://tools.ietf.org/html/rfc2445">rfc2445</a> - Internet Calendaring and Scheduling Core Object Specification (iCalendar)</div> +</li> +<li class="level1"><div class="li"> iCal <a href="http://www.kanzaki.com/docs/ical/" class="urlextern" title="http://www.kanzaki.com/docs/ical/">spec</a> in a simple adaptation of the rfc that makes it easy to refer to all sections, items and attributes.</div> +</li> +<li class="level1"><div class="li"> <a href="http://vobject.skyhouseconsulting.com/" class="urlextern" title="http://vobject.skyhouseconsulting.com/">VObject</a> - the python library used to read the iCal file.</div> +</li> +<li class="level1"><div class="li"> <a href="http://severinghaus.org/projects/icv/" class="urlextern" title="http://severinghaus.org/projects/icv/">iCalender validator</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://en.wikipedia.org/wiki/iCalendar" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/iCalendar">iCalendar</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://upload.wikimedia.org/wikipedia/en/c/c0/ICalendarSpecification.png" class="urlextern" title="http://upload.wikimedia.org/wikipedia/en/c/c0/ICalendarSpecification.png">Components and their properties</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Resources" [354-961] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> + +<p> + +We are not creating iCal files, simply extracting localisable information and rebuilding the file. We rely on VObject to ensure correctness. +</p> + +<p> +The following data is extracted: + +</p> +<ul> +<li class="level1"><div class="li"> VEVENT:</div> +<ul> +<li class="level2"><div class="li"> SUMMARY</div> +</li> +<li class="level2"><div class="li"> DESCRIPTION</div> +</li> +<li class="level2"><div class="li"> LOCATION</div> +</li> +<li class="level2"><div class="li"> COMMENTS</div> +</li> +</ul> +</li> +</ul> + +<p> + +No other sections are extracted. +</p> + +</div> +<!-- SECTION "Conformance" [962-1272] --> +<h2><a name="notes" id="notes">Notes</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Notes" [1273-1291] --> +<h3><a name="languagenot_a_multilingual_solution" id="languagenot_a_multilingual_solution">LANGUAGE: not a multilingual solution</a></h3> +<div class="level3"> + +<p> + +It is possible to set the language attribute on an entry e.g. + +</p> +<pre class="code">SUMMARY:LANGUAGE=af;New Year's Day</pre> + +<p> + +However since only one SUMMARY entry is allowed this does not allow you to specify multiple entries which would allow a single multilingual file. With that in mind it is not clear why the LANGUAGE attribute is allowed, the examples they give are for LOCATION entries but that is still not clearly useful. +</p> + +</div> +<!-- SECTION "LANGUAGE: not a multilingual solution" [1292-1748] --> +<h3><a name="broken_lotus_notes" id="broken_lotus_notes">Broken Lotus Notes</a></h3> +<div class="level3"> + +<p> + +Lotus notes creates broken iCalendar files. They include _ (underscore) is some of the property names, [A-Z0-9\-] are the only valid chars. Therefore, we require vobject >= v0.6.5 (but there is unfortunately no way to check for the version of vobject). See vobject bug <a href="https://bugzilla.osafoundation.org/show_bug.cgi?id=12008" class="urlextern" title="https://bugzilla.osafoundation.org/show_bug.cgi?id=12008">#12008</a> for further details. +</p> + +</div> +<!-- SECTION "Broken Lotus Notes" [1749-2140] --> +<h2><a name="development_notes" id="development_notes">Development Notes</a></h2> +<div class="level2"> + +<p> + +If we use LANGUAGE at all it will be to ensure that we specify that an entry is in a given language. +</p> + +</div> +<!-- SECTION "Development Notes" [2141-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-ical2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ical2po.html new file mode 100644 index 0000000..af1e4c6 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ical2po.html @@ -0,0 +1,214 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="ical2po" id="ical2po">ical2po</a></h1> +<div class="level1"> + +<p> + +Converts iCalendar (*.ics) files to Gettext <acronym title="Gettext Portable Object">PO</acronym> format. +</p> + +<p> +<p><div class="noteclassic">New in v1.2 +</div></p> +</p> + +</div> +<!-- SECTION "ical2po" [1-105] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">ical2po [options] <ical> <po> +po2ical [options] -t <ical> <po> <ical></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <ical> </td><td class="col1 leftalign"> is a valid .ics file or directory of those files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a directory of <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="Gettext Portable Object Template">POT</acronym> files </td> + </tr> +</table> + +<p> + +Options (ical2po): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in php format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in php format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> <a href="toolkit-duplicates_duplicatestyle.html" class="wikilink1" title="toolkit-duplicates_duplicatestyle.html">--duplicates=DUPLICATESTYLE</a> </td><td class="col1 leftalign"> what to do with duplicate strings (identical source text): merge, msgid_comment, msgctxt, keep, msgid_comment_all (default: 'msgctxt') </td> + </tr> +</table> + +<p> + +Options (po2ical): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in php format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in php format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [106-2297] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +This example looks at roundtrip of iCalendar translations. While you can do recovery of translations, its unlikely that you will ever need to do that. +</p> + +<p> +First we need to create a set of <acronym title="Gettext Portable Object Template">POT</acronym> files. + +</p> +<pre class="code">ical2po -P ical.ics ical.pot</pre> + +<p> + +The ical.ics file is converted to Gettext <acronym title="Gettext Portable Object Template">POT</acronym> files called ical.pot. Directories of iCalendar files can also be processed. +</p> + +<p> +Begin translating the ical.pot file by first copying it to make a <acronym title="Gettext Portable Object">PO</acronym> file. + +</p> +<pre class="code">cp ical.pot ical-af.po</pre> + +<p> + +You are now in a position to translate the file ical-af.po in your favourite translation tool. +</p> + +<p> +Once translated you can convert back as follows: + +</p> +<pre class="code">po2ical -t ical.ics ical-af.po ical-af.ics</pre> + +<p> + +Your translations found in the Afrikaans <acronym title="Gettext Portable Object">PO</acronym> file, <code>ical-ad.po</code>, will be converted to .ics using the file <code>ical.ics</code> as a template and creating your newly translated .ics file <code>ical-af.ics</code>. +</p> + +<p> +To update your translations simply redo the <acronym title="Gettext Portable Object Template">POT</acronym> creation step and make use of <a href="toolkit-pot2po.html" class="wikilink1" title="toolkit-pot2po.html">pot2po</a> to bring your translation up-to-date. +</p> + +</div> +<!-- SECTION "Examples" [2298-3293] --> +<h2><a name="notes" id="notes">Notes</a></h2> +<div class="level2"> + +<p> + +The converter will only process events in the calender file, the file itself can contain many other things that could be localisable. Please raise a bug if you want to extract additional items. +</p> + +<p> +The converter does not make use of the LANGUAGE attribute which is permitted in the format. The LANGUAGE attribute does not aid multilingualism in this context so is ignored. +</p> + +<p> +The converter could conceivably also process <a href="http://en.wikipedia.org/wiki/vCard" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/vCard">vCard</a> files, but this has not been implemented for lack of a clear need. Please raise a bug with an example if you have such a file that could benefit from localisation. +</p> + +</div> +<!-- SECTION "Notes" [3294-3909] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known + +</p> + +</div> +<!-- SECTION "Bugs" [3910-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-important_changes.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-important_changes.html new file mode 100644 index 0000000..70410e9 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-important_changes.html @@ -0,0 +1,609 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="important_changes" id="important_changes">Important Changes</a></h1> +<div class="level1"> + +<p> + +The Translate Toolkit might have changed how it functions in certain cases. This page lists what has changed, how it +might affect you and how to work around the change either to bring your files in line or to use the old behaviour if required. +</p> + +</div> +<!-- SECTION "Important Changes" [1-286] --> +<h2><a name="trunk" id="trunk">trunk</a></h2> +<div class="level2"> + +<p> +This section describes the changes in the (unreleased) development files. It should reflect upcoming changes in the next version of the toolkit and latest <a href="http://translate.sourceforge.net/snapshots/" class="urlextern" title="http://translate.sourceforge.net/snapshots/">beta or rc release</a>. +</p> + +<p> +(none yet) +</p> + +</div> +<!-- SECTION "trunk" [287-540] --> +<h2><a name="section" id="section">1.2</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "1.2" [541-557] --> +<h3><a name="new_formats" id="new_formats">New formats</a></h3> +<div class="level3"> + +<p> + +The toolkit now supports: + +</p> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-qt_phrase_book.html" class="wikilink1" title="toolkit-qt_phrase_book.html">Qt Phrase Book</a></div> +</li> +<li class="level1"><div class="li"> Qt <a href="toolkit-ts.html" class="wikilink1" title="toolkit-ts.html">.ts</a> v1.1</div> +</li> +</ul> + +<p> + +This allows reading, counting and working on these formats. The <a href="toolkit-ts2po.html" class="wikilink1" title="toolkit-ts2po.html">ts2po</a> converter has not been changed so you will not be able to benefit from the new .ts support. However, you can use the format for translation memory, etc as its is now fully base class compliant. +</p> + +</div> +<!-- SECTION "New formats" [558-921] --> +<h3><a name="stats_database_change" id="stats_database_change">Stats database change</a></h3> +<div class="level3"> + +<p> +There were some changes in the database used by pocount for storing statistics. The location of the database might also have changed, depending on what the last version is that you used. Remove the file stats.db from any of ~/.translate_toolkit, ~/.wordforge (or the corresponding directories on your Windows installation. +</p> + +</div> +<!-- SECTION "Stats database change" [922-1277] --> +<h3><a name="valid_accelerators" id="valid_accelerators">Valid accelerators</a></h3> +<div class="level3"> + +<p> + +The <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> accelerator test is now able to make use of a list of valid accelerators. This allows translators to control the behaviour of the test for their language and add or remove characters that can be used as accelerators. Please define <a href="l10n-valid_accelerators.html" class="wikilink1" title="l10n-valid_accelerators.html">valid accelerators</a> for your language and these will then be included in future releases of the toolkit. By default the old process if followed so if you take no action then this check will continue to work as expected. +</p> + +</div> +<!-- SECTION "Valid accelerators" [1278-1788] --> +<h2><a name="branches" id="branches">branches</a></h2> +<div class="level2"> + +<p> + +These are branches that contain quite invasive changes that will most likely be merged into the main development and be released sometime in the future. +</p> + +</div> +<!-- SECTION "branches" [1789-1965] --> +<h3><a name="toolkit-c-po" id="toolkit-c-po">toolkit-C-po</a></h3> +<div class="level3"> + +<p> + +Converting the current Python based <acronym title="Gettext Portable Object">PO</acronym> parser to the Gettext C based parser for <acronym title="Gettext Portable Object">PO</acronym>. This offers quite a dramatic speed improvement and conformance to the output found in Gettext itself. For most users there will be a number of changes in layout of the files as they will now conform fully to Gettext layout. The 'keep' option in --duplicatestyle will no longer be supported as this is not valid Gettext output. +</p> + +</div> +<!-- SECTION "toolkit-C-po" [1966-2404] --> +<h2><a name="section1" id="section1">1.1.1</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "1.1.1" [2405-2423] --> +<h3><a name="premature_termination_of_dtd_entities" id="premature_termination_of_dtd_entities">Premature termination of DTD entities</a></h3> +<div class="level3"> + +<p> + +Although this does not occur frequently a case emerged where some <acronym title="Document Type Definition">DTD</acronym> entities where not fully extracted from the <acronym title="Document Type Definition">DTD</acronym> source. This was fixed in bug <a href="http://bugs.locamotion.org/show_bug.cgi?id=331" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=331">331</a>. +</p> + +<p> +We expect this change to create a few new fuzzy entries. There is no action required from the user as the next update of your <acronym title="Gettext Portable Object">PO</acronym> files will bring the correct text into your translations, if you are using a translation memory your translation might be recovered from obsolete translations. +</p> + +</div> +<!-- SECTION "Premature termination of DTD entities" [2424-2929] --> +<h2><a name="section2" id="section2">1.1</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "1.1" [2930-2947] --> +<h3><a name="oo2po_help_helpcontent2_escaping_fixed" id="oo2po_help_helpcontent2_escaping_fixed">oo2po Help (helpcontent2) escaping fixed</a></h3> +<div class="level3"> + +<p> + +OpenOffice.org Help (helpcontent2) has notoriously contained some unreadable esacping, e.g. \\\\<tag attr=\\”value\\”\\\\>. The escaping has been fixed and oo2po now understands helpcontent2 escaping while leaving the current <acronym title="Graphical User Interface">GUI</acronym> escape handling unaltered. +</p> + +<p> +If you have not translated helpcontent2 then you are unaffected by this change. If you have translated this content then you will need to follow these instructions when upgrading. +</p> + +<p> +If you follow normal procedures of creating <acronym title="Gettext Portable Object Template">POT</acronym> files and upgrading your <acronym title="Gettext Portable Object">PO</acronym> files using pot2po then your strings will not match and you will obtain files with many fuzzies. To avoid this do the following: + +</p> +<ol> +<li class="level1"><div class="li"> Make sure your <acronym title="Gettext Portable Object">PO</acronym> files contain no fuzzy entries</div> +</li> +<li class="level1"><div class="li"> Use po2oo from the previous release to create and SDF file</div> +</li> +<li class="level1"><div class="li"> Upgrade to the latest Translate Toolkit with new po2oo</div> +</li> +<li class="level1"><div class="li"> Use <code>po2oo -l xx-YY your.sdf po</code> to create a new set of <acronym title="Gettext Portable Object">PO</acronym> files with correct escaping</div> +</li> +</ol> + +<p> + +You can choose to do this with only your helpcontent2 <acronym title="Gettext Portable Object">PO</acronym> files if needed, this will allow you to leave your <acronym title="Graphical User Interface">GUI</acronym> work in its current state. Simply do the above procedure and discard all <acronym title="Gettext Portable Object">PO</acronym> files except helpcontent2, then move these new helpcontent2 files into your current work. +</p> + +</div> +<!-- SECTION "oo2po Help (helpcontent2) escaping fixed" [2948-4197] --> +<h3><a name="prop2po_uses_developer_comments" id="prop2po_uses_developer_comments">prop2po uses developer comments</a></h3> +<div class="level3"> + +<p> + +prop2po used to place comments found in the source .properties file in traditional translator comments, they should of course go into developer comments. The reason for this change is twofold, it allows these comments to be correctly managed and it is part of the process of cleaning up these formats so that they are closer to the base class and can thus work with <acronym title="XML Localization Interchange File Format">XLIFF</acronym>. +</p> + +<p> +For the user there will be fairly large changes as one comment format moves to the next. It is best to <a href="toolkit-cleanup_translator_comments.html" class="wikilink1" title="toolkit-cleanup_translator_comments.html">cleanup translator comments</a> and get your translations into a fit state, i.e. no fuzzies, and then proceed with any migrations. +</p> + +</div> +<!-- SECTION "prop2po uses developer comments" [4198-4855] --> +<h3><a name="moz2po_no_longer_uses_kde_comments" id="moz2po_no_longer_uses_kde_comments">moz2po no longer uses KDE comments</a></h3> +<div class="level3"> + +<p> + +moz2po has traditionally used KDE style comments for storing comments aimed at translators. Many translators confuse these and try to translate them. Thus these have been moved into automatic or developer comments. The result for many people migrating Mozilla <acronym title="Gettext Portable Object">PO</acronym> files will be that many strings will become fuzzy, you can avoid much of this by using pot2po which should intelligently be able to match without considering the KDE comments. +</p> + +<p> +The best strategy is to get your translations into a relatively good shape before migration. You can then migrate them first to a new set of <acronym title="Gettext Portable Object Template">POT</acronym> files generated from the same source files that the translation is based on. Eliminate all fuzzies as these should only relate to the changes in layout. Then proceed to migrate to a new set of <acronym title="Gettext Portable Object Template">POT</acronym> files. If you cannot work against the original source files then the best would be to also first eliminate fuzzy matches before proceeding to translation. Your fuzzies will include changes in layout and changes in content so proceed carefully. +</p> + +<p> +At the end of this you should have <acronym title="Gettext Portable Object">PO</acronym> files that conform to the Gettext standard without KDE comments. +</p> + +</div> +<!-- SECTION "moz2po no longer uses KDE comments" [4856-6041] --> +<h3><a name="read_and_write_mo_files" id="read_and_write_mo_files">Read and Write MO files</a></h3> +<div class="level3"> + +<p> + +You can read and write Gettext <acronym title="Gettext Machine Object">MO</acronym> files (compiled <acronym title="Gettext Portable Object">PO</acronym> files). Thus pocount can now count files on your filesystem and you can also compile <acronym title="Gettext Machine Object">MO</acronym> files using pocompile. <acronym title="Gettext Machine Object">MO</acronym> files can be compiled from either <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> sources. +</p> + +<p> +<acronym title="Gettext Machine Object">MO</acronym> will now also produce correct output for msgctxt and plural forms found in <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +</div> +<!-- SECTION "Read and Write MO files" [6042-6390] --> +<h3><a name="read_qt_.qm_files" id="read_qt_.qm_files">Read Qt .qm files</a></h3> +<div class="level3"> + +<p> + +We can now read Qt .qm files, thus pocount can count the contents of compiled files. We cannot however write .qm files at this time. +</p> + +</div> +<!-- SECTION "Read Qt .qm files" [6391-6555] --> +<h2><a name="section3" id="section3">1.0.1</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "1.0.1" [6556-6574] --> +<h3><a name="pot2po_will_create_new_empty_po_files_if_needed" id="pot2po_will_create_new_empty_po_files_if_needed">pot2po will create new empty PO files if needed</a></h3> +<div class="level3"> + +<p> + +From version 1.0.1, pot2po will create empty <acronym title="Gettext Portable Object">PO</acronym> files corresponding to new <acronym title="Gettext Portable Object Template">POT</acronym> files that might have been introduced. If some new <acronym title="Gettext Portable Object Template">POT</acronym> files are present in the input to pot2po, you will see a new <acronym title="Gettext Portable Object">PO</acronym> file appear in your output directory that was not in your old <acronym title="Gettext Portable Object">PO</acronym> files. You will not lose any data but in the worst case you will see new files on projects that you thought were fully translated. +</p> + +</div> +<!-- SECTION "pot2po will create new empty PO files if needed" [6575-7029] --> +<h2><a name="section4" id="section4">1.0</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "1.0" [7030-7046] --> +<h3><a name="improved_xliff_support" id="improved_xliff_support">Improved XLIFF support</a></h3> +<div class="level3"> + +<p> +Many toolkit tools that only worked with <acronym title="Gettext Portable Object">PO</acronym> files before, can now also work with <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files. pogrep, pocount, pomerge, and pofilter all work with <acronym title="XML Localization Interchange File Format">XLIFF</acronym>, for example. +</p> + +</div> +<!-- SECTION "Improved XLIFF support" [7047-7247] --> +<h3><a name="pretty_xml_output" id="pretty_xml_output">Pretty XML output</a></h3> +<div class="level3"> + +<p> +All <acronym title="Extensible Markup Language">XML</acronym> formats should now be more human readable, and the converters to Qt .ts files should work correctly again. +</p> + +</div> +<!-- SECTION "Pretty XML output" [7248-7391] --> +<h3><a name="fuzzy_matching_in_pot2po_is_optional" id="fuzzy_matching_in_pot2po_is_optional">Fuzzy matching in pot2po is optional</a></h3> +<div class="level3"> + +<p> +Fuzzy matching can now be entirely disabled in <a href="toolkit-pot2po.html" class="wikilink1" title="toolkit-pot2po.html">pot2po</a> with the --nofuzzymatching parameter. This should make it much faster, although pot2po is <strong>substantially</strong> faster than earlier versions, especially if <a href="toolkit-levenshtein_distance.html" class="wikilink1" title="toolkit-levenshtein_distance.html">python-Levenshtein</a> is installed. +</p> + +</div> +<!-- SECTION "Fuzzy matching in pot2po is optional" [7392-7708] --> +<h3><a name="old_matchlevenshtein.py_can_cause_name_clash" id="old_matchlevenshtein.py_can_cause_name_clash">Old match/Levenshtein.py* can cause name clash</a></h3> +<div class="level3"> + +<p> +The file previously called match/Levenshtein.py was renamed to lshtein.py in order to use the python-Levenshtein package mentioned above. If you follow the basic installation instructions, the old file will not be overwritten, and can cause problems. Ensure that you remove all files starting with Levenshtein.py in the installation path of the translate toolkit, usually something like /usr/lib/python2.4/site-packages/translate/search/. It could be up to three files. +</p> + +</div> +<!-- SECTION "Old match/Levenshtein.py* can cause name clash" [7709-8236] --> +<h3><a name="po_file_layout_now_follows_gettext_more_closely" id="po_file_layout_now_follows_gettext_more_closely">PO file layout now follows Gettext more closely</a></h3> +<div class="level3"> + +<p> + +The toolkits output <acronym title="Gettext Portable Object">PO</acronym> format should now resemble Gettext <acronym title="Gettext Portable Object">PO</acronym> files more closely. Long lines are wrapped correctly, messages with long initial lines will start with a 'msgid ””' entry. The reason for this change is to ensure that differences in files relate to content change not format change, no matter what tool you use. +</p> + +<p> +To understand the problem more clearly. If a user creates <acronym title="Gettext Portable Object Template">POT</acronym> files with e.g. <a href="toolkit-oo2po.html" class="wikilink1" title="toolkit-oo2po.html">oo2po</a>. She then edits them in a <acronym title="Gettext Portable Object">PO</acronym> editor or manipulate them with the Gettext tools. The layout of the file after manipulation was often different from the original produced by the Toolkit. Thus making it hard to tell what where content changes as opposed to layout changes. +</p> + +<p> +The changes will affect you as follows: + +</p> +<ol> +<li class="level1"><div class="li"> They will only impact you when using the Toolkit tools.</div> +</li> +<li class="level1"><div class="li"> You manipulate your files with a tool that follows Gettext <acronym title="Gettext Portable Object">PO</acronym> layout </div> +<ul> +<li class="level2"><div class="li"> your experience should now improve as the new <acronym title="Gettext Portable Object">PO</acronym> files will align with your existing files</div> +</li> +<li class="level2"><div class="li"> updates should now only include real content changes not layout changes</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> You manipulate your files using Toolkit related tools or manual editing</div> +<ul> +<li class="level2"><div class="li"> your files will go through a re-layout the first time you use any of the tools</div> +</li> +<li class="level2"><div class="li"> subsequent usage should continue as normal</div> +</li> +<li class="level2"><div class="li"> any manipulation using Gettext tools will leave your files correctly layed out.</div> +</li> +</ul> +</li> +</ol> + +<p> + +Our suggestion is that if you are about to suffer a major reflow that your initial merge contain only reflow and update changes. Do content changes in subsequent steps. Once you have gone through the reflow you should see no layout changes and only content changes. +</p> + +</div> +<!-- SECTION "PO file layout now follows Gettext more closely" [8237-9899] --> +<h3><a name="language_awareness" id="language_awareness">Language awareness</a></h3> +<div class="level3"> + +<p> +The toolkit is gradually becoming more aware of the differences between languages. Currently this mostly affects pofilter checks (and therefore also Pootle) where tests involving punctuation and capitalisation will be more aware of the differences between English and some other languages. Provisional customisation for the following languages are in place and we will welcome more work on the language module: Amharic, Arabic, Greek, Persian, French, Armenian, Japanese, Khmer, Vietnamese, all types of Chinese. +</p> + +</div> +<!-- SECTION "Language awareness" [9900-10443] --> +<h3><a name="new_pofilter_testsnewlines_and_tabs" id="new_pofilter_testsnewlines_and_tabs">New pofilter tests: newlines and tabs</a></h3> +<div class="level3"> + +<p> + +The escapes test has been refined with two new tests, <code>newlines</code> and <code>tabs</code>. This makes identifying the errors easier and makes it easier to control the results of the tests. You shouldn't have to change your testing behaviour in any way. +</p> + +</div> +<!-- SECTION "New pofilter tests: newlines and tabs" [10444-10738] --> +<h3><a name="merging_can_change_fuzzy_status" id="merging_can_change_fuzzy_status">Merging can change fuzzy status</a></h3> +<div class="level3"> + +<p> + +pomerge now handles fuzzy states: + +</p> +<pre class="code">pomerge -t old -i merge -o new</pre> + +<p> + +Messages that are fuzzy in <em>merge</em> will now also be fuzzy in <em>new</em>. Similarly if a fuzzy state is present in <em>old</em> but removed in <em>merge</em> then the message in <em>new</em> will not be fuzzy. +</p> + +<p> +Previously no fuzzy states were changed during a merge. +</p> + +</div> +<!-- SECTION "Merging can change fuzzy status" [10739-11102] --> +<h3><a name="pofilter_will_make_mozilla_accelerators_a_serious_failure" id="pofilter_will_make_mozilla_accelerators_a_serious_failure">pofilter will make Mozilla accelerators a serious failure</a></h3> +<div class="level3"> + +<p> + +If you use <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> with the <code>--mozilla</code> option then accelerator failures will produce a serious filter error, i.e. the message will be marked as <code>fuzzy</code>. This has been done because accelerator problems in your translations have the potential to break Mozilla applications. +</p> + +</div> +<!-- SECTION "pofilter will make Mozilla accelerators a serious failure" [11103-11455] --> +<h3><a name="po2prop_can_output_mozilla_or_java_style_properties" id="po2prop_can_output_mozilla_or_java_style_properties">po2prop can output Mozilla or Java style properties</a></h3> +<div class="level3"> + +<p> + +We have added the --personality option to allow a user to select output in either <code>java</code>, or <code>mozilla</code> style (Java property files use escaped Unicode, while Mozilla uses actual Unicode characters). This functionality was always available but was not exposed to the user and we always defaulted to the Mozilla style. +</p> + +<p> +When using <a href="toolkit-moz2po.html" class="wikilink1" title="toolkit-moz2po.html">po2moz</a> the behaviour is not changed for the user as the programs will ensure that the properties convertor uses Mozilla style. +</p> + +<p> +However, when using <a href="toolkit-prop2po.html" class="wikilink1" title="toolkit-prop2po.html">po2prop</a> the default style is now <code>java</code>, thus if you are converting a single <code>.properties</code> file as part of a Mozilla conversion you will need to add <code>--personality=mozilla</code> to your conversion. Thus + +</p> +<pre class="code">po2prop -t moz.properties moz.properties.po my-moz.properties</pre> + +<p> + +Would become + +</p> +<pre class="code">po2prop --personality=mozilla -t moz.properties moz.properties.po my-moz.properties</pre> + +<p> + +Note: output in java style escaped Unicode will still be usable by Mozilla but will be harder to read. +</p> + +</div> +<!-- SECTION "po2prop can output Mozilla or Java style properties" [11456-12500] --> +<h3><a name="support_for_compressed_files" id="support_for_compressed_files">Support for compressed files</a></h3> +<div class="level3"> + +<p> +There is some initial support for reading from and writing to compressed files. Single files compressed with gzip or bzip2 compression is supported, but not tarballs. Most tools don't support it, but pocount and the --tm parameter to pot2po will work with it, for example. Naturally it is slower than working with uncompressed files. Hopefully more tools can support it in future. +</p> + +</div> +<!-- SECTION "Support for compressed files" [12501-12922] --> +<h2><a name="section5" id="section5">0.11</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "0.11" [12923-12940] --> +<h3><a name="po2oo_defaults_to_not_check_for_errors" id="po2oo_defaults_to_not_check_for_errors">po2oo defaults to not check for errors</a></h3> +<div class="level3"> + +<p> + +In po2oo we made the default <code>--filteraction=none</code> i.e. do nothing and don't warn. Until we have a way of clearly marking false positives we'll have to disable this functionality as there is no way to quiet the output or mark non errors. Also renamed exclude to exclude-all so that it is clearer what it does i.e. it excludes 'all' vs excludes 'serious'. +</p> + +</div> +<!-- SECTION "po2oo defaults to not check for errors" [12941-13350] --> +<h3><a name="pofilter_xmltags_produces_less_false_positives" id="pofilter_xmltags_produces_less_false_positives">pofilter xmltags produces less false positives</a></h3> +<div class="level3"> + +<p> + +In the xmltags check we handle the case where we had some false positives. E.g. ”<Error>” which looks like <acronym title="Extensible Markup Language">XML</acronym>/<acronym title="HyperText Markup Language">HTML</acronym> but should actually be translated. These are handled by +</p> +<ol> +<li class="level1"><div class="li"> identifying them as being the same length as the source text,</div> +</li> +<li class="level1"><div class="li"> not containing any '=' sign. Thus the following would not be detected by this hack. “An <Error> occurred” → ”<Error name=“bob”>”, but these ones need human eyes anyway.</div> +</li> +</ol> + +</div> +<!-- SECTION "pofilter xmltags produces less false positives" [13351-13823] --> +<h2><a name="section6" id="section6">0.10</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "0.10" [13824-13841] --> +<h3><a name="po_to_xliff_conversion" id="po_to_xliff_conversion">PO to XLIFF conversion</a></h3> +<div class="level3"> + +<p> + +Conversion from <acronym title="Gettext Portable Object">PO</acronym> to <acronym title="XML Localization Interchange File Format">XLIFF</acronym> is greatly improved in 0.10 and this was done according to the specification at <a href="http://xliff-tools.freedesktop.org/wiki/Projects/XliffPoGuide" class="urlextern" title="http://xliff-tools.freedesktop.org/wiki/Projects/XliffPoGuide">http://xliff-tools.freedesktop.org/wiki/Projects/XliffPoGuide</a> - please let us know if there are features lacking. +</p> + +</div> +<!-- SECTION "PO to XLIFF conversion" [13842-14098] --> +<h3><a name="pot2po_can_replace_msgmerge" id="pot2po_can_replace_msgmerge">pot2po can replace msgmerge</a></h3> +<div class="level3"> + +<p> + +<a href="toolkit-pot2po.html" class="wikilink1" title="toolkit-pot2po.html">pot2po</a> has undergone major changes which means that it now respects your header entries, can resurrect obsolete messages, +does fuzzy matching using <a href="toolkit-levenshtein_distance.html" class="wikilink1" title="toolkit-levenshtein_distance.html">Levenshtein distance</a> algorithm, will correctly match messages with KDE style comments and can use an external Translation Memory. You can now use pot2po instead of Gettext's msgmerge and it can also replace <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a>. You may still want to use pomigrate2 if there +where file movements between versions as pot2po can still not do intelligent matching of <acronym title="Gettext Portable Object">PO</acronym> and <acronym title="Gettext Portable Object Template">POT</acronym> files, pomigrate2 has also been adapted so that it can use pot2po as it background merging tool. + +</p> +<pre class="code">pomigrate2 --use-compendium --pot2po <old> <pot> <new></pre> + +<p> + +This will migrate file with a compendium built from <acronym title="Gettext Portable Object">PO</acronym> files in <em><old></em> and will use pot2po as its conversion engine. +</p> + +</div> +<!-- SECTION "pot2po can replace msgmerge" [14099-14941] --> +<h3><a name="properties_pretty_formatting" id="properties_pretty_formatting">.properties pretty formatting</a></h3> +<div class="level3"> + +<p> + +When using templates for generating translated .properties files we will now preserve the formatting around the equal sign. + +</p> +<pre class="code"># Previously if the template had +property = value</pre> +<pre class="code"># We output +property=translation</pre> +<pre class="code"># We will now output +property = translation</pre> + +<p> + +This change ensures that there is less noise when checking differences against the template file. However, there will be quite a bit of noise when you make your first .properties commits with the new pretty layout. Our suggestion is that you make a single commit of .properties files without changes of translations to gt the formatting correct. +</p> + +</div> +<!-- SECTION ".properties pretty formatting" [14942-15616] --> +<h2><a name="section7" id="section7">0.9</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "0.9" [15617-15634] --> +<h3><a name="escaping_-_dtd_files_are_no_longer_escaped" id="escaping_-_dtd_files_are_no_longer_escaped">Escaping - DTD files are no longer escaped</a></h3> +<div class="level3"> + +<p> + +Previously each converter handled escaping, which made it a nightmare every time +we identified an escaping related error or added a new format. Escaping has now +been moved into the format classes as much as possible, the result being that +formats exchange Python strings and manage their own escaping. +</p> + +<p> +I doing this migration we revisited some of the format migration. We found that we +were escaping elements in our output <acronym title="Document Type Definition">DTD</acronym> files. <acronym title="Document Type Definition">DTD</acronym>'s should have no escaping ie \n is +a literal '\' followed by an 'n' not a newline. +</p> + +<p> +A result of this change is that older <acronym title="Gettext Portable Object">PO</acronym> files will have different escaping to what +po2moz will now expect. Probably resulting in bad output .dtd files. +</p> + +<p> +We did not make this backward compatible as the fix is relatively simple and is one +you would have done for any migration of your <acronym title="Gettext Portable Object">PO</acronym> files. +</p> +<pre class="code bash"><pre class="code bash"><span class="re3"># <span class="nu0">1</span>. Create a new <span class="kw3">set</span> of POT files</span> +moz2po -P mozilla pot +<span class="re3"># <span class="nu0">2</span>. Migrate your old PO files</span> +pomigrate2 old new pot +<span class="re3"># 3a. Fix all the fuzzy translations by editing your PO files</span> +<span class="re3"># 3b. Use pofilter to check <span class="kw1">for</span> escaping problems and fix them</span> +pofilter -t escapes new new-check +<span class="re3"># Edit file <span class="kw1">in</span> new-check <span class="kw1">in</span> your PO editor</span> +pomerge -t new -i new-check -o new-check</pre></pre> +</div> +<!-- SECTION "Escaping - DTD files are no longer escaped" [15635-16889] --> +<h3><a name="migration_to_base_class" id="migration_to_base_class">Migration to base class</a></h3> +<div class="level3"> + +<p> + +All filters are/have been migrate to a base class. This move is so that it is easier to add new format, interchange formats +and to create converters. Thus xx2po and xx2xlf become easier to create. Also adding a new format should be as simple as +working towards the <acronym title="Application Programming Interface">API</acronym> exposed in the base class. An unexpected side effect will be the Pootle should be able to work directly +with any base class file (although that will not be the normal Pootle operation) +</p> + +<p> +We have checks in place to ensure the the current operation remains correct. +However, nothing is perfect and unfortunately the only way to +really expose all bugs is to release this software. +</p> + +<p> +If you discover a bug please report it on Bugzilla or on the Pootle mailing list. If you +have the skills please check on HEAD to see if it is not already fixed and if you regard +it as critical discuss on the mailing list backporting the fix (note some fixes will not +be backported because they may be too invasive for the stable branch). If you are a developer +please write a test to expose the bug and a fix if possible. +</p> + +</div> +<!-- SECTION "Migration to base class" [16890-18004] --> +<h3><a name="duplicate_merging_in_po_files_-_merge_now_the_default" id="duplicate_merging_in_po_files_-_merge_now_the_default">Duplicate Merging in PO files - merge now the default</a></h3> +<div class="level3"> + +<p> + +We added the --duplicatestyle option to allow duplicate messages to be merged, commented or simply appear in the <acronym title="Gettext Portable Object">PO</acronym> unmerged. +Initially we used the msgid_comments options as the default. This adds a KDE style comment to all affected messages which created a good +balance allowing users to see duplicates in the <acronym title="Gettext Portable Object">PO</acronym> file but still create a valid <acronym title="Gettext Portable Object">PO</acronym> file. +</p> + +<p> +'msgid_comments' was the default for 0.8 (<img src="images/smileys/fixme.gif" align="middle" alt="FIXME" /> check), however it seemed to create more confusion then it solved. Thus +we have reverted to using 'merge' as the default (this then completely mimics Gettext behaviour). +</p> + +<p> +As Gettext will soon introduce the msgctxt attribute we may revert to using that to manage disambiguation messages instead of KDE comments. +This we feel will put us back at a good balance of usefulness and usability. We will only release this when msgctxt version of the Gettext tools are released. +</p> + +</div> +<!-- SECTION "Duplicate Merging in PO files - merge now the default" [18005-18949] --> +<h3><a name="properties_files_no_longer_use_escaped_unicode" id="properties_files_no_longer_use_escaped_unicode">.properties files no longer use escaped Unicode</a></h3> +<div class="level3"> + +<p> + +The main use of the .properties converter class is to translate Mozilla files, although .properties files are actually a Java standard. The old +Mozilla way, and still the Java way, of working with .properties files is to escape any Unicode characters using the \uNNNN convention. Mozilla +now allows you to use Unicode in UTF-8 encoding for these files. Thus in 0.9 of the Toolkit we now output UTF-8 encoded properties files. Bug <a href="http://bugs.locamotion.org/show_bug.cgi?id=114" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=114">114</a> tracks the status of this and we hope to add a feature to prop2po to restore the correct Java convention as an option. +</p> + +</div> +<!-- SECTION ".properties files no longer use escaped Unicode" [18950-19573] --> +<h2><a name="section8" id="section8">0.8</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "0.8" [19574-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-index.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-index.html new file mode 100644 index 0000000..2393be2 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-index.html @@ -0,0 +1,239 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="the_translate_toolkit" id="the_translate_toolkit">The Translate Toolkit</a></h1> +<div class="level1"> + +<p> + +The Translate Toolkit is a collection of useful tools for localisation, and a powerful <acronym title="Application Programming Interface">API</acronym> for programmers of localisation tools. It is designed by localisers for localisers. Its aim is to make your localisation easier and of higher quality. +</p> + +<p> +The Toolkit can convert between various different <a href="toolkit-formats.html" class="wikilink1" title="toolkit-formats.html">translation formats</a> (such as Gettext <acronym title="Gettext Portable Object">PO</acronym> formats, <acronym title="XML Localization Interchange File Format">XLIFF</acronym>, OpenOffice.org, and Mozilla formats). This makes it possible to stay in one format across all your localisation, thus allowing you +to master one translation editor instead of one per project. Of course an added benefit is that now you cannot create broken OpenOffice.org or Mozilla translation files. +</p> + +<p> +To help improve the quality of your localisation, the Toolkit includes tools to help check, validate, merge and extract messages from your localizations. And of course there are many other <a href="toolkit-features.html" class="wikilink1" title="toolkit-features.html">benefits</a>. +</p> + +<p> +The Toolkit has a long <a href="toolkit-history.html" class="wikilink1" title="toolkit-history.html">history</a> and is part of our project to build standards based localisation tools for Free and Open Source Software. At this stage the Translate Toolkit <acronym title="Application Programming Interface">API</acronym> already forms the technological basis of the translation tools built by ourselves and several other projects. If you want to use the Toolkit to build translation tools, you might be interested in the <a href="http://translate.sourceforge.net/doc/api" class="urlextern" title="http://translate.sourceforge.net/doc/api">API documentation for the Translate Toolkit</a>. +</p> + +<p> +This documentation is maintained in the wiki at <a href="http://translate.sourceforge.net/wiki/toolkit/index" class="urlextern" title="http://translate.sourceforge.net/wiki/toolkit/index">http://translate.sourceforge.net/wiki/toolkit/index</a> . +If you want the latest version or want to make changes, please consult the wiki. +</p> + +</div> +<!-- SECTION "The Translate Toolkit" [1-1572] --> +<h1><a name="quick_start" id="quick_start">Quick Start</a></h1> +<div class="level1"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-installation.html" class="wikilink1" title="toolkit-installation.html">Installation</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-features.html" class="wikilink1" title="toolkit-features.html">Features</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-important_changes.html" class="wikilink1" title="toolkit-important_changes.html">Important changes</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-general_usage.html" class="wikilink1" title="toolkit-general_usage.html">General usage</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-history.html" class="wikilink1" title="toolkit-history.html">History</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-contributing.html" class="wikilink1" title="toolkit-contributing.html">Contributing</a></div> +</li> +<li class="level1"><div class="li"> <a href="developers-reporting_bugs.html" class="wikilink1" title="developers-reporting_bugs.html">Reporting bugs</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-copyright.html" class="wikilink1" title="toolkit-copyright.html">Copyright</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Quick Start" [1573-1776] --> +<h1><a name="use_cases" id="use_cases">Use Cases</a></h1> +<div class="level1"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-migrating_translations.html" class="wikilink1" title="toolkit-migrating_translations.html">Migrating an older version of your translations to the latest templates</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-using_pofilter.html" class="wikilink1" title="toolkit-using_pofilter.html">Checking for technical errors in your translations</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-using_csv2po.html" class="wikilink1" title="toolkit-using_csv2po.html">Translating using only a spreadsheet</a> (a look at the whole roundtrip from <acronym title="Gettext Portable Object">PO</acronym> to <acronym title="Comma Seperated Value">CSV</acronym> and back)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-using_oo2po.html" class="wikilink1" title="toolkit-using_oo2po.html">Creating OpenOffice.org POT files</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-creating_mozilla_pot_files.html" class="wikilink1" title="toolkit-creating_mozilla_pot_files.html">Creating Mozilla POT files</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-migrating_to_firefox.html" class="wikilink1" title="toolkit-migrating_to_firefox.html">Migrating Mozilla translations to Firefox</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-checking_for_inconsistencies.html" class="wikilink1" title="toolkit-checking_for_inconsistencies.html">Checking for inconsistencies in your translations</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-creating_a_terminology_list_from_your_existing_translations.html" class="wikilink1" title="toolkit-creating_a_terminology_list_from_your_existing_translations.html">Creating a terminology list from your existing translations</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-running_the_tools_on_microsoft_windows.html" class="wikilink1" title="toolkit-running_the_tools_on_microsoft_windows.html">Running the tools on Microsoft Windows</a></div> +</li> +<li class="level1"><div class="li"> Using <code>phase</code> for the complete translation roundtrip</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-cleanup_translator_comments.html" class="wikilink1" title="toolkit-cleanup_translator_comments.html">Cleanup translator comments</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Use Cases" [1777-2617] --> +<h1><a name="converters" id="converters">Converters</a></h1> +<div class="level1"> + +<p> + +Converters change many different formats to <acronym title="Gettext Portable Object">PO</acronym> and back again. (Sometimes only one direction is supported, or conversion is done without <acronym title="Gettext Portable Object">PO</acronym> files.) + +</p> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-moz2po.html" class="wikilink1" title="toolkit-moz2po.html">moz2po</a> - Mozilla .properties and .dtd converter. Works with Firefox and Thunderbird</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-oo2po.html" class="wikilink1" title="toolkit-oo2po.html">oo2po</a> - OpenOffice.org SDF converter (See also <a href="toolkit-oo2xliff.html" class="wikilink1" title="toolkit-oo2xliff.html">oo2xliff</a>).</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-csv2po.html" class="wikilink1" title="toolkit-csv2po.html">csv2po</a> - Comma Separated Value (<acronym title="Comma Seperated Value">CSV</acronym>) converter. Useful for doing translations using a spreadsheet.</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-csv2tbx.html" class="wikilink1" title="toolkit-csv2tbx.html">csv2tbx</a> - Create <acronym title="TermBase eXchange">TBX</acronym> (TermBase eXchange) files from Comma Separated Value (<acronym title="Comma Seperated Value">CSV</acronym>) files</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-html2po.html" class="wikilink1" title="toolkit-html2po.html">html2po</a> - <acronym title="HyperText Markup Language">HTML</acronym> converter</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-ical2po.html" class="wikilink1" title="toolkit-ical2po.html">ical2po</a> - iCalendar file converter (v1.2)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-ini2po.html" class="wikilink1" title="toolkit-ini2po.html">ini2po</a> - Windows INI file converter (v1.1.1)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-odf2xliff.html" class="wikilink1" title="toolkit-odf2xliff.html">odf2xliff</a> - Convert OpenDocument (ODF) documents to <acronym title="XML Localization Interchange File Format">XLIFF</acronym> and vice-versa.</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-php2po.html" class="wikilink1" title="toolkit-php2po.html">php2po</a> - <acronym title="Hypertext Preprocessor">PHP</acronym> localisable string arrays converter.</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-po2wordfast.html" class="wikilink1" title="toolkit-po2wordfast.html">po2wordfast</a> - Wordfast Translation Memory converter</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-po2tmx.html" class="wikilink1" title="toolkit-po2tmx.html">po2tmx</a> - <acronym title="Translation Memory eXchange">TMX</acronym> (Translation Memory Exchange) converter</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pot2po.html" class="wikilink1" title="toolkit-pot2po.html">pot2po</a> - initialise <acronym title="Gettext Portable Object">PO</acronym> Template files for translation</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-prop2po.html" class="wikilink1" title="toolkit-prop2po.html">prop2po</a> - Java property file (.properties) converter</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-rc2po.html" class="wikilink1" title="toolkit-rc2po.html">rc2po</a> - Windows Resource .rc (C++ Resource Compiler) converter (v1.2)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-tiki2po.html" class="wikilink1" title="toolkit-tiki2po.html">tiki2po</a> - <a href="http://tikiwiki.org/" class="urlextern" title="http://tikiwiki.org/">TikiWiki</a> language.php converter</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-ts2po.html" class="wikilink1" title="toolkit-ts2po.html">ts2po</a> - Qt Linguist .ts converter</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-txt2po.html" class="wikilink1" title="toolkit-txt2po.html">txt2po</a> - Plain text to <acronym title="Gettext Portable Object">PO</acronym> converter</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-xliff2po.html" class="wikilink1" title="toolkit-xliff2po.html">xliff2po</a> - <acronym title="XML Localization Interchange File Format">XLIFF</acronym> (<acronym title="Extensible Markup Language">XML</acronym> Localisation Interchange File Format) converter</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-symb2po.html" class="wikilink1" title="toolkit-symb2po.html">symb2po</a> - Symbian-style translation to <acronym title="Gettext Portable Object">PO</acronym> converter (not in an official release yet)</div> +</li> +</ul> + +</div> +<!-- SECTION "Converters" [2618-4087] --> +<h1><a name="tools" id="tools">Tools</a></h1> +<div class="level1"> + +<p> + +The <acronym title="Gettext Portable Object">PO</acronym> tools allow you to manipulate and work with <acronym title="Gettext Portable Object">PO</acronym> files +</p> + +</div> +<!-- SECTION "Tools" [4088-4170] --> +<h3><a name="quality_assurance" id="quality_assurance">Quality Assurance</a></h3> +<div class="level3"> + +<p> +These tools are especially useful for measuring and improving translation quality. + +</p> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-poconflicts.html" class="wikilink1" title="toolkit-poconflicts.html">poconflicts</a> - extract messages that have conflicting translation</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> - filter <acronym title="Gettext Portable Object">PO</acronym> files to find common errors using a <a href="toolkit-pofilter_tests.html" class="wikilink1" title="toolkit-pofilter_tests.html">number of tests</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pogrep.html" class="wikilink1" title="toolkit-pogrep.html">pogrep</a> - find strings in your <acronym title="Gettext Portable Object">PO</acronym> files</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a> - merge file extracted using pofilter back into the original files</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-porestructure.html" class="wikilink1" title="toolkit-porestructure.html">porestructure</a> - restructures po files according to poconflict directives</div> +</li> +</ul> + +</div> +<!-- SECTION "Quality Assurance" [4171-4672] --> +<h3><a name="other_tools" id="other_tools">Other tools</a></h3> +<div class="level3"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-lookupserver.html" class="wikilink1" title="toolkit-lookupserver.html">lookupserver</a> - a server that can be queried with <acronym title="Extensible Markup Language">XML</acronym>-<acronym title="Remote Procedure Call">RPC</acronym> to lookup strings in a storage format</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-poclean.html" class="wikilink1" title="toolkit-poclean.html">poclean</a> - produces a clean file from an unclean file (Trados/Wordfast) by stripping out the tw4win indicators</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pocompile.html" class="wikilink1" title="toolkit-pocompile.html">pocompile</a> - create an <acronym title="Gettext Machine Object">MO</acronym> (Machine Object) file from a <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> file</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pocount.html" class="wikilink1" title="toolkit-pocount.html">pocount</a> - Count words and strings in <acronym title="Gettext Portable Object">PO</acronym>, <acronym title="XML Localization Interchange File Format">XLIFF</acronym> and other types of translatable files</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-podebug.html" class="wikilink1" title="toolkit-podebug.html">podebug</a> - Add debug strings to messages</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-posegment.html" class="wikilink1" title="toolkit-posegment.html">posegment</a> - Break a <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files into sentence segments, useful for creating a segmented translation memory.</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-poswap.html" class="wikilink1" title="toolkit-poswap.html">poswap</a> - uses a translation of another language that you would rather use than English as source language</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-poterminology.html" class="wikilink1" title="toolkit-poterminology.html">poterminology</a> - extracts potential terminology from your translation files.</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-tmserver.html" class="wikilink1" title="toolkit-tmserver.html">tmserver</a> - a Translation Memory server, can be queried over <acronym title="Hyper Text Transfer Protocol">HTTP</acronym> using JSON</div> +</li> +</ul> + +</div> +<!-- SECTION "Other tools" [4673-5592] --> +<h1><a name="scripts" id="scripts">Scripts</a></h1> +<div class="level1"> + +<p> + +The scripts are for working with and manipulating <acronym title="Gettext Portable Object">PO</acronym> files. Unlike the <code>tools</code> which are written in Python, the +scripts are written in <code>bash</code>. Some of them are packaged since version 1.0 of the toolkit, but you might need to download them from version control and do a manual installation . + +</p> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-moz-l10n-builder.html" class="wikilink1" title="toolkit-moz-l10n-builder.html">moz-l10n-builder</a> - Create Mozilla XPIs and rebuild Windows installers from existing translations</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-phase.html" class="wikilink1" title="toolkit-phase.html">phase</a> - Helps manage a project divided into phases of work, including sending, checking, etc</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pocompendium.html" class="wikilink1" title="toolkit-pocompendium.html">pocompendium</a> - Creates various types of <acronym title="Gettext Portable Object">PO</acronym> compendium (i.e. combines many <acronym title="Gettext Portable Object">PO</acronym> files into a single <acronym title="Gettext Portable Object">PO</acronym> file)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pocommentclean.html" class="wikilink1" title="toolkit-pocommentclean.html">pocommentclean</a> - Remove all translator comments from a <acronym title="Gettext Portable Object">PO</acronym> file</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-poen.html" class="wikilink1" title="toolkit-poen.html">poen</a> - Initialises <acronym title="Gettext Portable Object Template">POT</acronym> files to English translations</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-poglossary.html" class="wikilink1" title="toolkit-poglossary.html">poglossary</a> - (obsolete; use <a href="toolkit-poterminology.html" class="wikilink1" title="toolkit-poterminology.html">poterminology</a> instead) Create a glossary of terms from existing po translations</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a> - Migrate older <acronym title="Gettext Portable Object">PO</acronym> files to new <acronym title="Gettext Portable Object Template">POT</acronym> files</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-popuretext.html" class="wikilink1" title="toolkit-popuretext.html">popuretext</a> - Extracts all the source text from a directory of <acronym title="Gettext Portable Object Template">POT</acronym> files</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-poreencode.html" class="wikilink1" title="toolkit-poreencode.html">poreencode</a> - Converts <acronym title="Gettext Portable Object">PO</acronym> files to a new character encoding</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-posplit.html" class="wikilink1" title="toolkit-posplit.html">posplit</a> - Split a <acronym title="Gettext Portable Object">PO</acronym> file into translate, untranslated and fuzzy files</div> +</li> +</ul> + +</div> +<!-- SECTION "Scripts" [5593-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-ini.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ini.html new file mode 100644 index 0000000..93790da --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ini.html @@ -0,0 +1,71 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="ini_files" id="ini_files">INI Files</a></h1> +<div class="level1"> + +<p> + +Also know as initialisation files. These are in some cases used to store translations. +</p> + +</div> +<!-- SECTION "INI Files" [1-115] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> + +<p> + +The toolkit uses <a href="http://code.google.com/p/iniparse/" class="urlextern" title="http://code.google.com/p/iniparse/">iniparse</a>, an INI file parser that preserves layout and follows the .ini format as supported by the Python language. +</p> + +</div> +<!-- SECTION "Conformance" [116-313] --> +<h3><a name="dialects" id="dialects">Dialects</a></h3> +<div class="level3"> + +<p> + +The format supports two dialects: + +</p> +<ul> +<li class="level1"><div class="li"> default: standard iniparse handling of INI files</div> +</li> +<li class="level1"><div class="li"> inno: follows <a href="http://www.innosetup.com/files/istrans/" class="urlextern" title="http://www.innosetup.com/files/istrans/">Inno</a> escaping conventions</div> +</li> +</ul> + +</div> +<!-- SECTION "Dialects" [314-510] --> +<h2><a name="references" id="references">References</a></h2> +<div class="level2"> + +<p> + +Further information is available on .ini files: + +</p> +<ul> +<li class="level1"><div class="li"> Wikipedia <a href="http://en.wikipedia.org/wiki/INI%20file" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/INI%20file">INI file</a> article</div> +</li> +<li class="level1"><div class="li"> <a href="http://www.cloanto.com/specs/ini.html" class="urlextern" title="http://www.cloanto.com/specs/ini.html">Unofficial specification</a></div> +</li> +</ul> + +</div> +<!-- SECTION "References" [511-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-ini2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ini2po.html new file mode 100644 index 0000000..caafa82 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ini2po.html @@ -0,0 +1,210 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="ini2po" id="ini2po">ini2po</a></h1> +<div class="level1"> + +<p> + +Converts .ini files to Gettext <acronym title="Gettext Portable Object">PO</acronym> format. +</p> + +<p> +<p><div class="noteclassic">New in v1.1.1 +</div></p> +</p> + +</div> +<!-- SECTION "ini2po" [1-93] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">ini2po [options] <ini> <po> +po2ini [options] -t <ini> <po> <ini></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <ini> </td><td class="col1 leftalign"> is a valid .ini file or directory of those files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a directory of <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="Gettext Portable Object Template">POT</acronym> files </td> + </tr> +</table> + +<p> + +Options (ini2po): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in php format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in php format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> <a href="toolkit-duplicates_duplicatestyle.html" class="wikilink1" title="toolkit-duplicates_duplicatestyle.html">--duplicates=DUPLICATESTYLE</a> </td><td class="col1 leftalign"> what to do with duplicate strings (identical source text): merge, msgid_comment, msgctxt, keep, msgid_comment_all (default: 'msgctxt') </td> + </tr> +</table> + +<p> + +Options (po2ini): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in php format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in php format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [94-2277] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +This example looks at roundtrip of .ini translations as well as recovery of existing translations. +</p> + +<p> +First we need to create a set of <acronym title="Gettext Portable Object Template">POT</acronym> files. + +</p> +<pre class="code">ini2po -P ini/ pot/</pre> + +<p> + +All .ini files found in the <code>ini/</code> directory are converted to Gettext <acronym title="Gettext Portable Object Template">POT</acronym> files and placed in the <code>pot/</code> directory. +</p> + +<p> +If you are translating for the first time then you can skip the next step. If you need to recovery your existing translations then we do the following: + +</p> +<pre class="code">ini2po -t lang/ zu/ po-zu/</pre> + +<p> + +Using the English .ini files found in <code>lang/</code> and your existing Zulu translation in <code>zu/</code> we create a set of <acronym title="Gettext Portable Object">PO</acronym> files in <code>po-zu/</code>. These will now have your translations. Please be aware that in order for the to work 100% you need to have both English and Zulu at the same revision, if they are not you will have to review all translations. +</p> + +<p> +You are now in a position to translate your recovered translations or your new <acronym title="Gettext Portable Object Template">POT</acronym> files. +</p> + +<p> +Once translated you can convert back as follows: + +</p> +<pre class="code">po2ini -t lang/ po-zu/ zu/</pre> + +<p> + +Your translations found in the Zulu <acronym title="Gettext Portable Object">PO</acronym> directory, <code>po-zu/</code>, will be converted to .ini using the files in <code>lang/</code> as templates and placing your newly translated .ini files in <code>zu/</code>. +</p> + +<p> +To update your translations simply redo the <acronym title="Gettext Portable Object Template">POT</acronym> creation step and make use of <a href="toolkit-pot2po.html" class="wikilink1" title="toolkit-pot2po.html">pot2po</a> to bring your translation up-to-date. +</p> + +</div> +<!-- SECTION "Examples" [2278-3609] --> +<h2><a name="issues" id="issues">Issues</a></h2> +<div class="level2"> + +<p> + +We do not extract comments from .ini files. These are sometimes needed as developers provide guidance to translators in these comments. +</p> + +</div> +<!-- SECTION "Issues" [3610-3767] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known + +</p> + +</div> +<!-- SECTION "Bugs" [3768-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-installation.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-installation.html new file mode 100644 index 0000000..9f1e6ad --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-installation.html @@ -0,0 +1,173 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="installation" id="installation">Installation</a></h1> +<div class="level1"> + +<p> + +This is a guide to installing the Translate Toolkit on your system. If the Translate Toolkit is already packaged for your system, this is probably the easiest way to install it. For Windows users, we provide installers. For several Linux distributions, the package might be available through your package manager. +</p> + +<p> +These packages might not be the absolute newest, or you might want to install from our packaged releases for some other reason. +</p> + +<p> +If your system already has the toolkit prepackaged, then please let us know what steps are required to install it. +</p> + +</div> +<!-- SECTION "Installation" [1-589] --> +<h2><a name="building" id="building">Building</a></h2> +<div class="level2"> + +<p> + +For build instructions, see the <a href="toolkit-building.html" class="wikilink1" title="toolkit-building.html">building</a> page. +</p> + +</div> +<!-- SECTION "Building" [590-663] --> +<h2><a name="download" id="download">Download</a></h2> +<div class="level2"> + +<p> + +Download a stable <a href="https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=97082" class="urlextern" title="https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=97082">released version</a>. For those who need problems fixed, or who want to work on the bleeding edge, get the latest source from <a href="toolkit-installation.html#installing_from_subversion" class="wikilink1" title="toolkit-installation.html">Subversion</a>. +</p> + +<p> +For most Windows users, the file named “translate-toolkit-…-setup.exe” is the best choice and contains everything you need. +</p> + +<p> +If you install the complete “setup” version in Windows, or if you install through your distribution's package manager, you should automatically have all the dependencies you need. If you are installing from the Version Control System, or from a source release, you should check the README file for information on the dependencies that are needed. Some of the dependencies are optional. The README file documents this. +</p> + +</div> +<!-- SECTION "Download" [664-1511] --> +<h2><a name="installing_packaged_versions" id="installing_packaged_versions">Installing packaged versions</a></h2> +<div class="level2"> + +<p> + +Get the package for your system: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"> -setup.exe </td><td class="col1"> A complete Windows installer containing all dependencies, including Python </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> .exe </td><td class="col1"> An installer for a Windows with Python and other dependencies already installed </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> RPM </td><td class="col1 leftalign"> If you want to install easily on an RPM based system </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> .tar.gz </td><td class="col1 leftalign"> for source based installing on Linux </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> .deb </td><td class="col1"> for Debian GNU/Linux (etch version) </td> + </tr> +</table> + +<p> + +The RPM package can be installed by using the following command: + +</p> +<pre class="code">rpm -Uvh translate-toolkit-1.0.1.rpm</pre> + +<p> + +To install a tar.bz2 + +</p> +<pre class="code">tar xvjf translate-toolkit-1.1.0.tar.bz2 +cd translate-toolkit-1.1.0 +su +./setup.py install</pre> + +<p> + +On Windows simply click on the .exe file and follow the instructions. +</p> + +<p> +On Debian (if you are on etch), just type the following command : + +</p> +<pre class="code">aptitude install translate-toolkit</pre> + +<p> + +If you are using an old Debian stable system, you might want to install the .tar.bz2 version. Be sure to install python and python development first with +</p> +<pre class="code">apt-get install python python-dev</pre> + +<p> +Alternatively newer packages might be in testing. +</p> + +</div> +<!-- SECTION "Installing packaged versions" [1512-2584] --> +<h2><a name="installing_from_subversion" id="installing_from_subversion">Installing from Subversion</a></h2> +<div class="level2"> + +<p> + +If you want to try the bleeding edge, or just want to have the latest fixes from a stabilising branch then you +need to use Subversion to get your sources. + +</p> +<pre class="code">svn co https://translate.svn.sourceforge.net/svnroot/translate/src/trunk translate</pre> + +<p> + +This will retrieve the <code>trunk</code> version of the toolkit. Further Subversion <a href="https://sourceforge.net/svn/?group_id=91920" class="urlextern" title="https://sourceforge.net/svn/?group_id=91920">instructions</a> are also available. +</p> + +<p> +Once you have the sources you have two options, a full install + +</p> +<pre class="code">su +./setup.py install</pre> + +<p> + +or, running the tools from the source directory +</p> +<pre class="code bash">.<span class="sy0">/</span>setuppath <span class="co0"># Only needed the first time</span> +. setpath <span class="co0"># Do this once for a session</span></pre> +</div> +<!-- SECTION "Installing from Subversion" [2585-3267] --> +<h2><a name="verify_installed_version" id="verify_installed_version">Verify installed version</a></h2> +<div class="level2"> + +<p> + +To verify which version of the toolkit you have installed run: + +</p> +<pre class="code">[l10n@server]# moz2po --version +moz2po 1.1.0</pre> + +</div> +<!-- SECTION "Verify installed version" [3268-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-levenshtein_distance.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-levenshtein_distance.html new file mode 100644 index 0000000..01a8195 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-levenshtein_distance.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="levenshtein_distance" id="levenshtein_distance">Levenshtein distance</a></h1> +<div class="level1"> + +<p> +The <a href="http://en.wikipedia.org/wiki/Levenshtein%20distance" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Levenshtein%20distance">Levenshtein distance</a> is used for measuring the “distance” or similarity of two character strings. Other similarity algorithms can be supplied to the code that does the matching. +</p> + +<p> +This code is used in pot2po and in the <a href="toolkit-lookupserver.html" class="wikilink1" title="toolkit-lookupserver.html">lookupserver</a>. It is implemented in the toolkit, but can optionally use the fast C implementation provided by <a href="https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=260161" class="urlextern" title="https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=260161">python-Levenshtein</a> if it is installed. +</p> + +<p> +To exercise the code, the <a href="toolkit-lookupserver.html" class="wikilink1" title="toolkit-lookupserver.html">lookupserver</a> can be used with the method “matches(message, max_candidates=15, min_similarity=50)”, or the classfile “Levenshtein.py” can be executed directly with +</p> +<pre class="code">python Levenshtein.py "The first string." "The second string"</pre> + +<p> +(remember to quote the two parameters) +</p> + +<p> +The following things should be noted: + +</p> +<ul> +<li class="level1"><div class="li"> Only the first MAX_LEN characters are considered. Long strings differing at the end will therefore seem to match better than they should. A penalty is awarded if strings are shortened.</div> +</li> +<li class="level1"><div class="li"> The calculation can stop prematurely as soon as it realise that the supplied minimum required similarity can not be reached. Strings with widely different lengths give the opportunity for this shortcut. This is by definition of the Levenshtein distance: the distance will be at least as much as the difference in string length. Similarities lower than your supplied minimum (or the default) should therefore not be considered authoritive.</div> +</li> +</ul> + +</div> +<!-- SECTION "Levenshtein distance" [1-1472] --> +<h3><a name="shortcommings" id="shortcommings">Shortcommings</a></h3> +<div class="level3"> + +<p> + +The following shortcommings have been identified: +</p> +<ul> +<li class="level1"><div class="li"> Cases sensitivity: 'E' and 'e' are considered different characters and according differ as much as 'z' and 'e'. This is not ideal, as case differences should be considered less of a difference.</div> +</li> +<li class="level1"><div class="li"> Diacritics: 'ê' and 'e' are considered different characters and according differ as much as 'z' and 'e'. This is not ideal, as missing diacritics could be due to small input errors, or even input data that simply do not have the correct diacritics.</div> +</li> +<li class="level1"><div class="li"> Words that have similar characters, but are different, could increase the similarity beyond what is wanted. The sentences “It is though.” and “It is dough.” differ markedly semantically, but score similarity of almost 85%. A possible solution is to do an additional calculation based on words, instead of characters.</div> +</li> +<li class="level1"><div class="li"> Whitespace: Differences in tabs, newlines, and space usage should perhaps be considered as a special case.</div> +</li> +</ul> + +</div> +<!-- SECTION "Shortcommings" [1473-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-lookupserver.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-lookupserver.html new file mode 100644 index 0000000..40cc7d9 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-lookupserver.html @@ -0,0 +1,64 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="lookupserver" id="lookupserver">lookupserver</a></h1> +<div class="level1"> + +<p> +The lookupserver is a service that can be accessed via http and queried via <acronym title="Extensible Markup Language">XML</acronym>-<acronym title="Remote Procedure Call">RPC</acronym>. It can perform lookup of strings in certain storage formats. +</p> + +</div> +<!-- SECTION "lookupserver" [1-174] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">lookupserver [--port=portnumber] [--address=hostname] [--language=languagename] storagefile</pre> + +where storagefile is the file from which queries must be answered. +<p> +Options: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --port </td><td class="col1"> set the port number on which to listen </td> + </tr> + <tr class="row1"> + <td class="col0"> --address </td><td class="col1"> the hostname to bind to </td> + </tr> + <tr class="row2"> + <td class="col0"> --language </td><td class="col1"> the target language for the lookup operation</td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [175-521] --> +<h2><a name="testing" id="testing">Testing</a></h2> +<div class="level2"> + +<p> +The server can be queried using any <acronym title="Extensible Markup Language">XML</acronym>-<acronym title="Remote Procedure Call">RPC</acronym> client. Example code is provided in the file lookupclient.py. Running +</p> +<pre class="code"> python lookupclient.py</pre> + +<p> + +with no parameters will connect to a lookupserver on the localhost as long as default settings were used by the server. Words can then be typed in and the reply from the server will be displayed in the client in the native format of the file store used by the server. +</p> + +</div> +<!-- SECTION "Testing" [522-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-migrating_to_firefox.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-migrating_to_firefox.html new file mode 100644 index 0000000..9690920 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-migrating_to_firefox.html @@ -0,0 +1,246 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="migrating_mozilla_translations_to_firefox" id="migrating_mozilla_translations_to_firefox">Migrating Mozilla Translations to Firefox</a></h1> +<div class="level1"> + +<p> + +This quickstart shows you how to migrate your existing translations +of the <a href="guide-mozilla.html" class="wikilink1" title="guide-mozilla.html">Mozilla</a> suite to the <a href="guide-firefox.html" class="wikilink1" title="guide-firefox.html">Firefox</a> web-browser. The same +instructions can be used to migrate <a href="guide-thunderbird.html" class="wikilink1" title="guide-thunderbird.html">Thunderbird</a>. +</p> + +<p> +Note: This guide assumes that you are or will be using <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +<p> +<img src="images/smileys/fixme.gif" align="middle" alt="FIXME" /> this page needs to be rewriten now that Mozilla is using <acronym title="Comma Seperated Value">CSV</acronym>. The steps are more or less the same. Look at <a href="toolkit-creating_mozilla_pot_files.html" class="wikilink1" title="toolkit-creating_mozilla_pot_files.html">creating mozilla POT files</a> which talks about creating <acronym title="Gettext Portable Object Template">POT</acronym> file from <acronym title="Concurrent Versions System">CVS</acronym>. Then the process is mostly the same except swap any reference to <acronym title="Cross Platform Installer">XPI</acronym> to be the translations in Mozilla <acronym title="Concurrent Versions System">CVS</acronym>. +</p> + +</div> +<!-- SECTION "Migrating Mozilla Translations to Firefox" [1-631] --> +<h2><a name="quick_start" id="quick_start">Quick Start</a></h2> +<div class="level2"> +<ol> +<li class="level1"><div class="li"> <a href="toolkit-moz2po.html" class="wikilink1" title="toolkit-moz2po.html">moz2po</a> -t mozilla-1.7.3-langenus.xpi langXXYY.xpi xxYY-1.7.3</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-moz2po.html" class="wikilink1" title="toolkit-moz2po.html">moz2po</a> -P firefox-1.0-en-US.xpi templates-ff-1.0 </div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a> xxYY-1.7.3 xxYY-ff-1.0 templates-ff-1.0</div> +</li> +</ol> + +</div> +<!-- SECTION "Quick Start" [632-867] --> +<h2><a name="detailed_description" id="detailed_description">Detailed Description</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Detailed Description" [868-901] --> +<h3><a name="make_sure_your_mozilla_is_in_po_format" id="make_sure_your_mozilla_is_in_po_format">Make sure your Mozilla is in PO format</a></h3> +<div class="level3"> + +<p> + +If you are not currently using <acronym title="Gettext Portable Object">PO</acronym> files to do your translations then you can +migrate an existing <acronym title="Cross Platform Installer">XPI</acronym> to <acronym title="Gettext Portable Object">PO</acronym> format. +</p> + +</div> + +<h4><a name="get_the_correct_en-us_xpi" id="get_the_correct_en-us_xpi">Get the correct en-US xpi</a></h4> +<div class="level4"> + +<p> + +Firstly make sure you have an <acronym title="Cross Platform Installer">XPI</acronym> for your language then download a Mozilla English (US) <acronym title="Cross Platform Installer">XPI</acronym> +for the same release: + +</p> +<ul> +<li class="level1"><div class="li"> <a href="ftp://ftp.mozilla.org/pub/mozilla.org/mozilla/releases/mozilla1.7.3/linux-xpi/langenus.xpi" class="urlextern" title="ftp://ftp.mozilla.org/pub/mozilla.org/mozilla/releases/mozilla1.7.3/linux-xpi/langenus.xpi">ftp://ftp.mozilla.org/pub/mozilla.org/mozilla/releases/mozilla1.7.3/linux-xpi/langenus.xpi</a></div> +</li> +</ul> + +<p> + +Change 1.7.3 to the release that you need. Note: Linux and Windows +langenus.xpi are the same so no need to worry about that. +</p> + +</div> + +<h4><a name="create_mozilla_po_files_for_your_language" id="create_mozilla_po_files_for_your_language">Create Mozilla PO files for your language</a></h4> +<div class="level4"> + +<p> + +Now create the Mozilla <acronym title="Gettext Portable Object">PO</acronym> files for your language using your existing <acronym title="Cross Platform Installer">XPI</acronym> and +the en-US <acronym title="Cross Platform Installer">XPI</acronym>. +</p> +<pre class="code bash"><pre class="code bash">moz2po -t mozilla<span class="nu0">-1.7</span><span class="nu0">.3</span>-langenus.xpi langXXYY.xpi xxYY<span class="nu0">-1.7</span><span class="nu0">.3</span></pre></pre> +<p> +Where: +</p> +<ul> +<li class="level1"><div class="li"> mozilla-1.7.3-langenus.xpi is the langenus.xpi downloaded above</div> +</li> +<li class="level1"><div class="li"> langXXYY.xpi is your existing translated <acronym title="Cross Platform Installer">XPI</acronym> with the same version and the en-US one downloaded.</div> +</li> +<li class="level1"><div class="li"> xxYY-1.7.3 is an output directory for the <acronym title="Gettext Portable Object">PO</acronym> files</div> +</li> +</ul> + +</div> +<!-- SECTION "Make sure your Mozilla is in PO format" [902-1901] --> +<h3><a name="create_firefox_pot_files" id="create_firefox_pot_files">Create Firefox POT files</a></h3> +<div class="level3"> + +<p> + +You need to create a set of Firefox <acronym title="Gettext Portable Object">PO</acronym> Template files that you will use as templates +when you migrate your Mozilla translations. Template files are simply blank <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +</div> + +<h4><a name="getting_the_en-us.xpi" id="getting_the_en-us.xpi">Getting the en-US.xpi</a></h4> +<div class="level4"> + +<p> + +Rumour has it that the en-US <acronym title="Cross Platform Installer">XPI</acronym> files for Firefox are different for Windows and Linux. + +</p> +<ul> +<li class="level1"><div class="li"> Linux -- Firefox 1.0: <a href="ftp://ftp.mozilla.org/pub/mozilla.org/firefox/releases/1.0/linux-i686/xpi/en-US.xpi" class="urlextern" title="ftp://ftp.mozilla.org/pub/mozilla.org/firefox/releases/1.0/linux-i686/xpi/en-US.xpi">ftp://ftp.mozilla.org/pub/mozilla.org/firefox/releases/1.0/linux-i686/xpi/en-US.xpi</a></div> +</li> +<li class="level1"><div class="li"> Windows -- Firefox 1.0: <a href="ftp://ftp.mozilla.org/pub/mozilla.org/firefox/releases/1.0/win32/xpi/en-US.xpi" class="urlextern" title="ftp://ftp.mozilla.org/pub/mozilla.org/firefox/releases/1.0/win32/xpi/en-US.xpi">ftp://ftp.mozilla.org/pub/mozilla.org/firefox/releases/1.0/win32/xpi/en-US.xpi</a></div> +</li> +</ul> + +</div> + +<h4><a name="create_the_pot_files" id="create_the_pot_files">Create the POT files</a></h4> +<div class="level4"> +<pre class="code bash"><pre class="code bash">moz2po -P firefox<span class="nu0">-1.0</span>-en-US.xpi templates-ff<span class="nu0">-1.0</span></pre></pre> +<p> +Where: +</p> +<ul> +<li class="level1"><div class="li"> <em>-P</em> specifies that you want to create <acronym title="Gettext Portable Object Template">POT</acronym> files instead of <acronym title="Gettext Portable Object">PO</acronym> files</div> +</li> +<li class="level1"><div class="li"> <em>firefox-1.0-en-US.xpi</em> is an en-US.xpi for Firefox downloaded earlier</div> +</li> +<li class="level1"><div class="li"> <em>templates-ff-1.0</em> is the new directory that will contain the <acronym title="Gettext Portable Object Template">POT</acronym> files</div> +</li> +</ul> + +</div> +<!-- SECTION "Create Firefox POT files" [1902-2786] --> +<h3><a name="migrate_the_mozilla_po_files_to_firefox" id="migrate_the_mozilla_po_files_to_firefox">Migrate the Mozilla PO files to Firefox</a></h3> +<div class="level3"> + +<p> + +We will now take the existing Mozilla <acronym title="Gettext Portable Object">PO</acronym> files and migrate them to Firefox. +Note that this tool only works on Linux (or an operating environment with bash +and the gettext tools). If you need help ask at <a href="mailto:translate-devel@lists.sourceforge.net" class="mail JSnocheck" title="translate-devel@lists.sourceforge.net">translate-devel@lists.sourceforge.net</a>. + +</p> +<pre class="code">pomigrate2 xxYY-1.7.3 xxYY-ff-1.0 templates-ff-1.0</pre> + +<p> + +Where: +</p> +<ul> +<li class="level1"><div class="li"> <em>xxYY-1.7.3</em> contains your Mozilla <acronym title="Gettext Portable Object">PO</acronym> files</div> +</li> +<li class="level1"><div class="li"> <em>xxYY-ff-1.0</em> will contain your new Firefox files</div> +</li> +<li class="level1"><div class="li"> <em>templates-ff-1.0</em> contains the Firefox template files</div> +</li> +</ul> + +</div> + +<h4><a name="how_does_it_do_the_migration" id="how_does_it_do_the_migration">How does it do the migration?</a></h4> +<div class="level4"> + +<p> + +Things that are fully automated scare most people and justifiably so! The +migration will do the following: + +</p> +<ol> +<li class="level1"><div class="li"> For each Firefox <acronym title="Gettext Portable Object">PO</acronym> Template file</div> +<ul> +<li class="level2"><div class="li"> If there is one in your Mozilla folder</div> +<ul> +<li class="level3"><div class="li"> If there is only one file with that name</div> +<ul> +<li class="level4"><div class="li"> copy it to the correct Firefox <acronym title="Gettext Portable Object">PO</acronym> location</div> +</li> +</ul> +</li> +<li class="level3"><div class="li"> Else </div> +<ul> +<li class="level4"><div class="li"> combine all the copies you find and then copy them to the Firefox <acronym title="Gettext Portable Object">PO</acronym> location</div> +</li> +</ul> +</li> +</ul> +</li> +<li class="level2"><div class="li"> Else</div> +<ul> +<li class="level3"><div class="li"> Initialise a blank <acronym title="Gettext Portable Object">PO</acronym> file</div> +</li> +</ul> +</li> +</ul> +</li> +<li class="level1"><div class="li"> Create a compendium file of all Mozilla <acronym title="Gettext Portable Object">PO</acronym> files</div> +</li> +<li class="level1"><div class="li"> Update all Firefox <acronym title="Gettext Portable Object">PO</acronym> files optionally using the compendium</div> +</li> +</ol> + +<p> + +The result is that all Firefox files are at least initialised. Many of them +are populated with conflicting entries clearly highlighted and ready for you to +fix. +</p> + +</div> +<!-- SECTION "Migrate the Mozilla PO files to Firefox" [2787-4076] --> +<h3><a name="begin_translating" id="begin_translating">Begin translating</a></h3> +<div class="level3"> + +<p> + +Your <acronym title="Gettext Portable Object">PO</acronym> files are ready. Begin translating with any of your usual <acronym title="Gettext Portable Object">PO</acronym> editing +tools. + +</p> + +</div> +<!-- SECTION "Begin translating" [4077-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-migrating_translations.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-migrating_translations.html new file mode 100644 index 0000000..7c3effd --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-migrating_translations.html @@ -0,0 +1,212 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="migrating_your_translations" id="migrating_your_translations">Migrating your translations</a></h1> +<div class="level1"> + +<p> + +You very often need to migrate older translations to newer template or <acronym title="Gettext Portable Object Template">POT</acronym> files. There are a number of Gettext tools +that can manage this but they do not handle the situation where files have been renamed and moved. The <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a> +script allows us to migrate between versions where there has been considerable change. +</p> + +<p> +This migration HOWTO takes you through the steps in a generic fashion so that you can apply it to any of your projects. We use +OpenOffice.org as an example for clarity. Our task in the examples is to migrate old translation for OpenOffice.org 1.1.3 to +OpenOffice.org 2.0. +</p> + +</div> +<!-- SECTION "Migrating your translations" [1-646] --> +<h2><a name="requirements" id="requirements">Requirements</a></h2> +<div class="level2"> + +<p> + +You will need: + +</p> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pocompendium.html" class="wikilink1" title="toolkit-pocompendium.html">pocompendium</a></div> +</li> +<li class="level1"><div class="li"> A text editor</div> +</li> +<li class="level1"><div class="li"> A <acronym title="Gettext Portable Object">PO</acronym> editing tool</div> +</li> +</ul> + +</div> +<!-- SECTION "Requirements" [647-769] --> +<h2><a name="preparing_the_new_pot_files" id="preparing_the_new_pot_files">Preparing the new POT files</a></h2> +<div class="level2"> + +<p> + +We need the new pot files. Either download these from the project or generate them using <a href="toolkit-moz2po.html" class="wikilink1" title="toolkit-moz2po.html">moz2po</a>, <a href="toolkit-oo2po.html" class="wikilink1" title="toolkit-oo2po.html">oo2po</a> or the other tools of the Translate Toolkit. The <acronym title="Gettext Portable Object Template">POT</acronym> files are templates for the destination files that we will be creating. + +</p> +<pre class="code">oo2po -P en-US.sdf ooo-20-pot</pre> + +<p> + +This will create new <acronym title="Gettext Portable Object Template">POT</acronym> files in <em>ooo-20-pot</em>. +</p> + +</div> +<!-- SECTION "Preparing the new POT files" [770-1133] --> +<h2><a name="checking_your_old_po_files_for_errors" id="checking_your_old_po_files_for_errors">Checking your old PO files for errors</a></h2> +<div class="level2"> + +<p> + +We will be migrating your old <acronym title="Gettext Portable Object">PO</acronym> files into the new <acronym title="Gettext Portable Object Template">POT</acronym> files. This is a good opportunity to check for encoding errors and inconsistencies. +</p> + +<p> +We use <a href="toolkit-pocompendium.html" class="wikilink1" title="toolkit-pocompendium.html">pocompendium</a> to check for encoding errors: + +</p> +<pre class="code">pocompendium check.po -d ooo-113-old</pre> + +<p> + +This will create a compendium <acronym title="Gettext Portable Object">PO</acronym> files, <em>check.po</em>, from all the <acronym title="Gettext Portable Object">PO</acronym> files in the directory <em>ooo-113-old</em>. Where <em>ooo-113-old</em> contains +all your old translations. pocompendium is a wrapper around various Gettext tools, encoding errors will appear as errors from those tools. +</p> + +<p> +Use your text editor to find and correct these errors. If you do not correct these now they will migrate to your new version. Once encoding errors are fixed they're usually gone for good, so it is time well spent. +</p> + +</div> +<!-- SECTION "Checking your old PO files for errors" [1134-1922] --> +<h2><a name="optionalchecking_your_old_po_files_for_consistency" id="optionalchecking_your_old_po_files_for_consistency">Optional: Checking your old PO files for consistency</a></h2> +<div class="level2"> + +<p> + +Note this step is optional, a more detailed explanation is given in <a href="toolkit-checking_for_inconsistencies.html" class="wikilink1" title="toolkit-checking_for_inconsistencies.html">checking for inconsistencies</a>. We now look at consistency within the translations. The first check extracts situations were the same English string was translated in two different ways: + +</p> +<pre class="code">pocompendium --ignore-case --accel-amp --errors check.po -d ooo-113-old</pre> + +<p> + +In <em>check.po</em> you will find all situations where the same English text was translated differently. We use <em>--accel-amp</em> to remove accelerator markers (you'll change this depending on the one used by the project - we can do & _ or ~). Now view <em>check.po</em> in a <acronym title="Gettext Portable Object">PO</acronym> editor or text editor. You will need to correct each inconsistency in the source <acronym title="Gettext Portable Object">PO</acronym> files, using <em>check.po</em> as the guide. Many of the errors are usually spelling mistakes. You can regenerate <em>check.po</em> from time to time until all inconsistencies are justified or removed. +</p> + +<p> +Then we check for words in your language that are used for more than one English concept. You don't for instance want the same word for <em>Cancel</em> and <em>Delete</em>. For this we invert the compendium. + +</p> +<pre class="code">pocompendium --invert --ignore-case --accel-amp --errors check.po -d ooo-113-old</pre> + +<p> + +We now have a file similar to the previous one except your language appears in the msgid and the English appears in the msgstr. Look for inconsistencies that would cause problems for the user and correct them in the source files. +</p> + +</div> +<!-- SECTION "Optional: Checking your old PO files for consistency" [1923-3391] --> +<h2><a name="migrate" id="migrate">Migrate</a></h2> +<div class="level2"> + +<p> + +You are now ready to migrate using <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a>. You have created your destination <acronym title="Gettext Portable Object Template">POT</acronym> files and all your <acronym title="Gettext Portable Object">PO</acronym> files are clean and ready to migrate. + +</p> +<pre class="code">pomigrate2 ooo-113-old ooo-20-new ooo-20-pot</pre> + +<p> + +This will take all translations from <em>ooo-113-old</em> and migrate them to <em>ooo-20-new</em> using <em>ooo-20-pot</em> as templates. By default pomigrate2 migrates without any fancy text matching, there are options to allow for fuzzy matching and the use of a compendium. Read the <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a> help page to find out more about these options. +</p> + +</div> +<!-- SECTION "Migrate" [3392-3948] --> +<h3><a name="techiewhat_does_pomigrate2_do_to_your_file" id="techiewhat_does_pomigrate2_do_to_your_file">Techie: what does pomigrate2 do to your file?</a></h3> +<div class="level3"> + +<p> + +This section is for those insanely curious about what pomigrate will do to their files. You don't need to understand this section <img src="images/smileys/icon_smile.gif" align="middle" alt=":-)" /> + +</p> +<ul> +<li class="level1"><div class="li"> Init stage</div> +<ul> +<li class="level2"><div class="li"> If a file has not changed location between old and new then it is simply copied across</div> +</li> +<li class="level2"><div class="li"> If it has moved then we try to find a file by the same name and move ours there. If there are multiple files by the same name, then we join them together and copy them</div> +</li> +<li class="level2"><div class="li"> If a file does not exist then we initialise it</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> Update stage</div> +<ul> +<li class="level2"><div class="li"> We now update our translations using msgmerge or pot2po</div> +</li> +<li class="level2"><div class="li"> If you asked for a compendium, we will build one from the existing files and update using it and optionally other external compendiums</div> +</li> +</ul> +</li> +</ul> + +<p> + +That's it. At the end you should have every file that needs translation updated to the latest template files. Files that moved should still be preserved and not lost. Files that where renamed will still be translated if you used a compendium otherwise they will be untranslated. +</p> + +</div> +<!-- SECTION "Techie: what does pomigrate2 do to your file?" [3949-4979] --> +<h2><a name="how_well_did_you_do" id="how_well_did_you_do">How well did you do</a></h2> +<div class="level2"> + +<p> + +Congratulations! Your files are now migrated. +</p> + +<p> +You might want to see how much of your old work was reusable in the new version: + +</p> +<pre class="code">pocount ooo-20-new</pre> + +<p> + +This will use <a href="toolkit-pocount.html" class="wikilink1" title="toolkit-pocount.html">pocount</a> to count the words in your new files and you can compare the number of translate and untranslated messages from your old version. +</p> + +</div> +<!-- SECTION "How well did you do" [4980-5322] --> +<h2><a name="conclusion" id="conclusion">Conclusion</a></h2> +<div class="level2"> + +<p> + +Your files have now been migrated and are ready for updating. If files moved they have been moved, if they changed names and you used a compendium then most likely you have most of that work translated. + +</p> + +</div> +<!-- SECTION "Conclusion" [5323-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-mo.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-mo.html new file mode 100644 index 0000000..a1738f7 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-mo.html @@ -0,0 +1,42 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="gettext_.mo" id="gettext_.mo">Gettext .mo</a></h1> +<div class="level1"> + +<p> + +The Gettext .mo (Machine Object) file is a compiled Gettext <a href="toolkit-po.html" class="wikilink1" title="toolkit-po.html">PO</a> file. In execution Gettext enabled programs retrieve translations from the .mo file. The file contains arrays for the English and the translations, an optional hash can speed up the access to the translations. +</p> + +</div> +<!-- SECTION "Gettext .mo" [1-308] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> + +<p> + +The toolkit can create .mo files from <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files, handling plurals and msgctxt. It can also read .mo files, allowing counting, etc and also allowing the .mo files to act as a translation memory. +</p> + +<p> +Since version 1.2 of the Translate Toolkit, the hash table is also generated (the Gettext .mo file works fine without it). Due to slight differences in the construction of the hashing, the generated files are not identical to those generated by msgfmt, but they should be functionally equivalent and 100% usable. Bug <a href="http://bugs.locamotion.org/show_bug.cgi?id=326" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=326">326</a> tracked the implementation of the hashing. The hash is platform dependent. + +</p> + +</div> +<!-- SECTION "Conformance" [309-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-moz-l10n-builder.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-moz-l10n-builder.html new file mode 100644 index 0000000..3e8f54d --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-moz-l10n-builder.html @@ -0,0 +1,163 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="moz-l10n-builder" id="moz-l10n-builder">moz-l10n-builder</a></h1> +<div class="level1"> + +<p> + +Take a set of Mozilla (Firefox, Thunderbird, SeaMonkey, etc.) localisation and migrate them to the latest Mozilla source, building XPIs and repackaging hte Windows .exe file as needed. +</p> + +<p> +Please also check the page on <a href="http://developer.mozilla.org/en/docs/Creating_a_Language_Pack" class="urlextern" title="http://developer.mozilla.org/en/docs/Creating_a_Language_Pack">creating a language pack</a> on the Mozilla wiki, to stay abreast of the latest Mozilla way of doing things. +</p> + +<p> +<p><div class="noteclassic">This page is only applicable to Mozilla products with its source hosted in <acronym title="Concurrent Versions System">CVS</acronym>. This includes Firefox versions before 3.1 and Thunderbird versions before 3.0. +</p> + +<p> +For information about working with the new source trees in Mercurial, see the <a href="toolkit-mozilla_l10n_scripts.html" class="wikilink1" title="toolkit-mozilla_l10n_scripts.html">Mozilla l10n scripts</a> page. +</div></p> +</p> + +</div> +<!-- SECTION "moz-l10n-builder" [1-703] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Translation update component and building XPIs</div> +<ul> +<li class="level2"><div class="li"> <a href="toolkit-installation.html" class="wikilink1" title="toolkit-installation.html">Translate Toolkit</a></div> +</li> +<li class="level2"><div class="li"> Existing Mozilla translations in <acronym title="Gettext Portable Object">PO</acronym> format</div> +</li> +<li class="level2"><div class="li"> A checkout of <a href="http://developer.mozilla.org/en/docs/Mozilla_Source_Code_Via_CVS" class="urlextern" title="http://developer.mozilla.org/en/docs/Mozilla_Source_Code_Via_CVS">Mozilla sources</a> updated to the correct <a href="http://developer.mozilla.org/en/docs/CVS_Tags" class="urlextern" title="http://developer.mozilla.org/en/docs/CVS_Tags">BRANCH or RELEASE</a></div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> Building Windows executables</div> +<ul> +<li class="level2"><div class="li"> Firefox or Thunderbird <a href="http://releases.mozilla.org/pub/mozilla.org/firefox/releases/" class="urlextern" title="http://releases.mozilla.org/pub/mozilla.org/firefox/releases/">en-US .exe</a> file eg. <a href="http://releases.mozilla.org/pub/mozilla.org/firefox/releases/2.0/win32/en-US/Firefox%20Setup%202.0.exe" class="urlextern" title="http://releases.mozilla.org/pub/mozilla.org/firefox/releases/2.0/win32/en-US/Firefox%20Setup%202.0.exe">Firefox 2.0 en-US</a></div> +</li> +<li class="level2"><div class="li"> <a href="http://upx.sourceforge.net/" class="urlextern" title="http://upx.sourceforge.net/">upx</a> for executable compression</div> +</li> +<li class="level2"><div class="li"> <a href="http://nsis.sourceforge.net/Main_Page" class="urlextern" title="http://nsis.sourceforge.net/Main_Page">Nullsoft installer</a> to package the installer.</div> +</li> +<li class="level2"><div class="li"> <a href="http://www.7-zip.org/" class="urlextern" title="http://www.7-zip.org/">7zip</a> for various compression</div> +</li> +<li class="level2"><div class="li"> Linux: <a href="http://winehq.com/" class="urlextern" title="http://winehq.com/">WINE</a> to run the Nullsoft installer</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> Directory structure under the directory you want to run moz-l10n-builder in:</div> +</li> +</ul> +<table class="inline"> + <tr class="row0"> + <td class="col0"> l10n/ </td><td class="col1"> Contains Mozilla l10n files for available/needed language(s) </td> + </tr> + <tr class="row1"> + <td class="col0"> mozilla/ </td><td class="col1"> The Mozilla source tree </td> + </tr> + <tr class="row2"> + <td class="col0"> po/ </td><td class="col1"> Contains your <acronym title="Gettext Portable Object">PO</acronym> files (output from moz2po) </td> + </tr> + <tr class="row3"> + <td class="col0"> potpacks/ </td><td class="col1"> Where <acronym title="Gettext Portable Object Template">POT</acronym>-archives go </td> + </tr> +</table> + +<p> + +Note these instructions are for building on Linux, they may work on Windows. All software should be available through your distribution. You will need to use Wine to install the Nullsoft installer and may need to sort out some path issues to get it to run correctly. +</p> + +</div> +<!-- SECTION "Prerequisites" [704-2191] --> +<h2><a name="latest_version" id="latest_version">Latest Version</a></h2> +<div class="level2"> + +<p> + +moz-l10n-builer is not currently distributed as part of the toolkit. You can get the <a href="https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/tools/mozilla/moz-l10n-builder" class="urlextern" title="https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/tools/mozilla/moz-l10n-builder">latest version from Subversion</a> + and you will also need this <a href="http://translate.svn.sourceforge.net/viewvc/*checkout*/translate/src/trunk/tools/mozilla/mozilla-l10n.patch" class="urlextern" title="http://translate.svn.sourceforge.net/viewvc/*checkout*/translate/src/trunk/tools/mozilla/mozilla-l10n.patch">minor patch</a> to the mozilla source code. +</p> + +</div> +<!-- SECTION "Latest Version" [2192-2619] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">moz-l10n-builder [language-code|ALL]</pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> language-code </td><td class="col1 leftalign"> build only the supplied languages, or build ALL if specified or if no option is supplied </td> + </tr> +</table> + +<p> + +Your translations will not be modified. +</p> + +</div> +<!-- SECTION "Usage" [2620-2839] --> +<h2><a name="operation" id="operation">Operation</a></h2> +<div class="level2"> + +<p> + +moz-l10n-builder does the following: + +</p> +<ul> +<li class="level1"><div class="li"> Updates the mozilla/ directory</div> +</li> +<li class="level1"><div class="li"> Creates <acronym title="Gettext Portable Object Template">POT</acronym> files</div> +</li> +<li class="level1"><div class="li"> Migrates your translations to this new <acronym title="Gettext Portable Object Template">POT</acronym> file</div> +</li> +<li class="level1"><div class="li"> Converts the migrated <acronym title="Gettext Portable Object Template">POT</acronym> files to .dtd and .properties files</div> +</li> +<li class="level1"><div class="li"> Builds <acronym title="Cross Platform Installer">XPI</acronym> and .exe files</div> +</li> +<li class="level1"><div class="li"> Performs various hacks to cater for the anomalies of file formats</div> +</li> +<li class="level1"><div class="li"> Outputs a diff of you migrated <acronym title="Gettext Portable Object">PO</acronym> files and your newly generated Mozilla l10n/ files</div> +</li> +</ul> + +</div> +<!-- SECTION "Operation" [2840-3265] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +Currently it is too Translate.org.za specific and not easily configurable without editing. It is also not intelligent enough to work our that you want Firefox vs Thunderbird generation. A lot of this functionality should be in the Mozilla source code itself. We hope over time that this might happen. + +</p> + +</div> +<!-- SECTION "Bugs" [3266-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-moz2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-moz2po.html new file mode 100644 index 0000000..f2a62b2 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-moz2po.html @@ -0,0 +1,270 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="moz2po_and_po2moz" id="moz2po_and_po2moz">moz2po and po2moz</a></h1> +<div class="level1"> + +<p> + +moz2po converts Mozilla files to <acronym title="Gettext Portable Object">PO</acronym> files. It wraps converters that handle .properties, .dtd, .xhtml and some strange Mozilla files. +The tool can extract from an <acronym title="Cross Platform Installer">XPI</acronym> file and build your complete <acronym title="Cross Platform Installer">XPI</acronym> file from your <acronym title="Gettext Portable Object">PO</acronym> files or work with files from Mozilla <acronym title="Concurrent Versions System">CVS</acronym>. Thus providing +a complete roundtrip for Mozilla localisation using <acronym title="Gettext Portable Object">PO</acronym> files and <acronym title="Gettext Portable Object">PO</acronym> editors. +</p> + +<p> +<p><div class="noteclassic">This page should only be used as a reference to the command-line options for moz2po and po2moz. For more about using the Translate Toolkit and <acronym title="Gettext Portable Object">PO</acronym> files for translating Mozilla products, please see the page on <a href="toolkit-mozilla_l10n_scripts.html" class="wikilink1" title="toolkit-mozilla_l10n_scripts.html">Mozilla l10n scripts</a>. +</div></p> +</p> + +<p> +<strong>Caution</strong>: The conversion to and from <acronym title="Cross Platform Installer">XPI</acronym> files is no longer actively supported, please work directly against Mozilla <acronym title="Concurrent Versions System">CVS</acronym> files. +</p> + +</div> +<!-- SECTION "moz2po and po2moz" [1-770] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">moz2po [options] <xpi|dir> <po> +po2moz [options] <po> <xpi|dir></pre> + +<p> + +Options (moz2po): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> --<a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> --<a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in inc, it, *, dtd, properties formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in it.po, it.pot, manifest, xhtml.po, xhtml.pot, ini.po, ini.pot, rdf, js, *, html.po, html.pot, inc.po, inc.pot, dtd.po, dtd.pot, properties.po, properties.pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in it, *, properties, dtd, inc formats </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> --<a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --<a href="toolkit-duplicates_duplicatestyle.html" class="wikilink1" title="toolkit-duplicates_duplicatestyle.html">duplicates=DUPLICATESTYLE</a> </td><td class="col1 leftalign"> what to do with duplicate strings (identical source text): merge (default), msgid_comment, keep, msgid_comment_all </td> + </tr> +</table> + +<p> + +Options (po2moz): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> --<a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> --<a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in dtd.po, dtd.pot, ini.po, ini.pot, inc.po, inc.pot, manifest, it.po, it.pot, *, html.po, html.pot, js, rdf, properties.po, properties.pot, xhtml.po, xhtml.pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in dtd, *, inc, it, properties formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in dtd, *, inc, it, properties formats </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> --<a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -lLOCALE, --locale=LOCALE </td><td class="col1 leftalign"> set output locale (required as this sets the directory names) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --clonexpi=CLONEXPI </td><td class="col1 leftalign"> clone xpi structure from the given xpi file </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [771-3419] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Examples" [3420-3441] --> +<h3><a name="creating_pot_files" id="creating_pot_files">Creating POT files</a></h3> +<div class="level3"> + +<p> + +See <a href="toolkit-creating_mozilla_pot_files.html" class="wikilink1" title="toolkit-creating_mozilla_pot_files.html">this page</a> for more information on creating Mozilla <acronym title="Gettext Portable Object Template">POT</acronym> files. +</p> + +<p> +After extracting the en-US l10n files, you can run the following command: + +</p> +<pre class="code">moz2po -P l10n/en-US pot</pre> + +<p> + +This creates a set of <acronym title="Gettext Portable Object Template">POT</acronym> (<code>-P</code>) files in the <code>pot</code> directory from the Mozilla files in <code>l10n/en-US</code>. + +</p> +<pre class="code">moz2po -P en-US.xpi pot</pre> + +<p> + +Creating set of <acronym title="Gettext Portable Object Template">POT</acronym> (<code>-P</code>) files from the American English <acronym title="Cross Platform Installer">XPI</acronym> (<code>en-US.xpi</code>) and placing them in <code>pot</code> for use as <acronym title="Gettext Portable Object">PO</acronym> Templates. +</p> + +<p> +If you want to create a set of <acronym title="Gettext Portable Object Template">POT</acronym> files with another base language try the following: + +</p> +<pre class="code">moz2po -P fr-FR.xpi fr-pot</pre> + +<p> + +This will create a set of <acronym title="Gettext Portable Object Template">POT</acronym> files in <code>fr-pot</code> that have French as your source language. +</p> + +</div> +<!-- SECTION "Creating POT files" [3442-4156] --> +<h3><a name="creating_po_files_from_existing_non-po_translations" id="creating_po_files_from_existing_non-po_translations">Creating PO files from existing non-PO translations</a></h3> +<div class="level3"> + +<p> + +If you have existing translations (Mozilla related or other Babelzilla files) and you wish to convert them to <acronym title="Gettext Portable Object">PO</acronym> for future translation then the following generic instructions will work: + +</p> +<pre class="code">moz2po -t en-US af-ZA af-ZA_pofiles</pre> + +<p> + +This will combine the untranslated template en-US files from <code>en-US</code> combine them with your existing translations in <code>af-ZA</code> and output <acronym title="Gettext Portable Object">PO</acronym> files to <code>af-ZA_pofiles</code>. + +</p> +<pre class="code">moz2po -t l10n/fr l10n/xh po/xh</pre> + +<p> + +For those who are not English fluent you can do the same with another languages. In this case <code>msgid</code> will contain the French text from <code>l10n/fr</code>. This is useful for translating where the translators other languages is not English but French, Spanish or Portuguese. Please make sure that the source languages i.e. the <code>msgid</code> language is fully translated as against en-US. +</p> + +</div> +<!-- SECTION "Creating PO files from existing non-PO translations" [4157-5036] --> +<h3><a name="creating_an_xpi_or_cvs_ready_translations" id="creating_an_xpi_or_cvs_ready_translations">Creating an XPI or CVS ready translations</a></h3> +<div class="level3"> +<pre class="code">po2moz -lzu-ZA -t en-US.xpi zu zu-ZA.xpi</pre> + +<p> + +Create a Zulu language (<code>-lzu-ZA</code>) <acronym title="Cross Platform Installer">XPI</acronym> called <code>zu-ZA.xpi</code> from translations found in <code>zu</code> using <code>en-US.xpi</code> as a template. We use a template to ensure that our <acronym title="Document Type Definition">DTD</acronym> and .properties files appear exactly as those in en-US + +</p> +<pre class="code">po2moz -t l10n/en-US po/xh l10n/xh</pre> + +<p> + +Create Mozilla files using the templates files in <code>l10n/en-US</code> (see above for how to create them) with <acronym title="Gettext Portable Object">PO</acronym> translations in <code>po/xh</code> and ouput them to <code>l10n/xh</code>. The files now in <code>l10n/xh</code> are ready for submission to Mozilla and can be used to build a language pack or translated version of Mozilla. +</p> + +</div> +<!-- SECTION "Creating an XPI or CVS ready translations" [5037-5709] --> +<h2><a name="issues" id="issues">Issues</a></h2> +<div class="level2"> + +<p> + +You can perform the bulk of your work (99%) with moz2po. +</p> + +<p> +Localisation of <acronym title="Extensible HyperText Markup Language">XHTML</acronym> is not yet perfect, you might want to work with the files directly. +</p> + +<p> +Bug <a href="http://bugs.locamotion.org/show_bug.cgi?id=129" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=129">129</a> tracks the outstanding features which would allow complete localisation of Mozilla including; all help, start pages, rdf files, etc. It also tracks some bugs. +</p> + +<p> +Accesskeys don't yet work in .properties files and in several cases where the Mozilla .dtd files don't follow the normal conventions, for example in <code>security/manager/chrome/pippki/pref-ssl.dtd.po</code>. You might also want to check the files mentioned in this bug <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=329444" class="interwiki iw_mozbug" title="https://bugzilla.mozilla.org/show_bug.cgi?id=329444">329444</a> where mistakes in the <acronym title="Document Type Definition">DTD</acronym>-definitions cause problems in the matching of accelerators with the text. +</p> + +<p> +You might want to give special attention to the following files since it contains customisations that are not really translations. +</p> +<ul> +<li class="level1"><div class="li"> mail/chrome/messenger/downloadheaders.dtd.po</div> +</li> +<li class="level1"><div class="li"> toolkit/chrome/global/intl.properties.po</div> +</li> +</ul> + +<p> + +Also, all width, height and size specifications need to be edited with feedback from testing the translated interfaces. +</p> + +<p> +There are some constructed strings in the Mozilla code which we can't do much about. Take good care to read the localisation notes. For an example, see <code>mail/chrome/messenger/downloadheaders.dtd.po</code>. In that specific file, the localisation note from the <acronym title="Document Type Definition">DTD</acronym> file is lost, so take good care of those. +</p> + +<p> +The file extension of the original Mozilla file is required to tell the Toolkit how to do the conversion. Therefore, a file like foo.dtd must be named foo.dtd.po in order to <code>po2moz</code> to recognise it as a <acronym title="Document Type Definition">DTD</acronym> file. +</p> + +</div> +<!-- SECTION "Issues" [5710-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-mozilla_l10n_scripts.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-mozilla_l10n_scripts.html new file mode 100644 index 0000000..f59d305 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-mozilla_l10n_scripts.html @@ -0,0 +1,274 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="mozilla_l10n_scripts" id="mozilla_l10n_scripts">Mozilla L10n Scripts</a></h1> +<div class="level1"> + +</div> +<!-- SECTION "Mozilla L10n Scripts" [1-35] --> +<h2><a name="introduction" id="introduction">Introduction</a></h2> +<div class="level2"> + +<p> +This page describes the purpose and usage of scripts available in the Translate Toolkit specifically for making the translation of Mozilla products easier. +</p> + +<p> +Mozilla's move from <acronym title="Concurrent Versions System">CVS</acronym> to Mercurial made a lot of these scripts necessary. For more information about Mozilla l10n from <acronym title="Concurrent Versions System">CVS</acronym>, see the <a href="toolkit-moz-l10n-builder.html" class="wikilink1" title="toolkit-moz-l10n-builder.html">moz-l10n-builder</a> page. +</p> + +<p> +All of these scripts are available on Subversion from <a href="https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/tools/mozilla/" class="urlextern" title="https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/tools/mozilla/">here</a>. +</p> + +</div> +<!-- SECTION "Introduction" [36-526] --> +<h2><a name="requirements" id="requirements">Requirements</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> The <a href="toolkit-index.html" class="wikilink1" title="toolkit-index.html">Translate Toolkit</a></div> +</li> +<li class="level1"><div class="li"> All scripts in the <code>tools/mozilla</code> directory (from the project sources) should be executable and in your <code>PATH</code>.</div> +</li> +</ul> + +</div> +<!-- SECTION "Requirements" [527-718] --> +<h2><a name="build_ff3.1_langs.sh" id="build_ff3.1_langs.sh">build_ff3.1_langs.sh</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "build_ff3.1_langs.sh" [719-751] --> +<h3><a name="description" id="description">Description</a></h3> +<div class="level3"> + +<p> +This is a simple bash script that embodies most of the Mozilla l10n process and does the following: +</p> +<ol> +<li class="level1"><div class="li"> Update Mozilla sources</div> +</li> +<li class="level1"><div class="li"> Update language files from <a href="http://hg.mozilla.org/l10n-central" class="urlextern" title="http://hg.mozilla.org/l10n-central">Mozilla's L10n</a> Mercurial repository.</div> +</li> +<li class="level1"><div class="li"> Replace old l10n en-US files with a fresh copy from the updated source tree.</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-creating_mozilla_pot_files.html" class="wikilink1" title="toolkit-creating_mozilla_pot_files.html">Create new POT files</a> from the <a href="#get_moz_enus.py" title=":toolkit:mozilla_l10n_scripts.txt ↵" class="wikilink1">en-US</a> l10n files.</div> +</li> +<li class="level1"><div class="li"> Create archives of the <acronym title="Gettext Portable Object Template">POT</acronym> files.</div> +</li> +<li class="level1"><div class="li"> For each language:</div> +<ol> +<li class="level2"><div class="li"> Update existing <acronym title="Gettext Portable Object">PO</acronym> files if the checked out from a <acronym title="Concurrent Versions System">CVS</acronym>, Subversion or Mercurial repository.</div> +</li> +<li class="level2"><div class="li"> <a href="toolkit-migrating_translations.html" class="wikilink1" title="toolkit-migrating_translations.html">Migrate</a> <acronym title="Gettext Portable Object">PO</acronym> files to new <acronym title="Gettext Portable Object Template">POT</acronym> files.</div> +</li> +<li class="level2"><div class="li"> <a href="toolkit-po2moz.html" class="wikilink1" title="toolkit-po2moz.html">Create Mozilla l10n files</a> for the language based on the migrated <acronym title="Gettext Portable Object">PO</acronym> files.</div> +</li> +<li class="level2"><div class="li"> Create archives of the <acronym title="Gettext Portable Object">PO</acronym> files.</div> +</li> +<li class="level2"><div class="li"> <a href="#buildxpi.py" title=":toolkit:mozilla_l10n_scripts.txt ↵" class="wikilink1">Build langpack</a> for the language.</div> +</li> +</ol> +</li> +</ol> + +<p> + +This script is used on the l10n.mozilla.org server to create most (if not all) of the files available from <a href="http://l10n.mozilla.org/pootle/" class="urlextern" title="http://l10n.mozilla.org/pootle/">http://l10n.mozilla.org/pootle/</a>. It was originally written as a stable way to provide these files and as such making it as general as possible was not the biggest requirement. This is evident in the script's very narrow focus. +</p> + +</div> +<!-- SECTION "Description" [752-1942] --> +<h3><a name="usage" id="usage">Usage</a></h3> +<div class="level3"> + +<p> +This script takes no command-line parameters and is only configurable via the variables at the top and, failing that, custom hacking of the script. +</p> + +<p> +The variables are used in the following ways: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"><code>BUILD_DIR</code></td><td class="col1"> The base build directory from where building is done. </td> + </tr> + <tr class="row1"> + <td class="col0"><code>MOZCENTRAL_DIR</code></td><td class="col1"> The directory containing a checkout of the Mozilla source tree (from <a href="http://hg.mozilla.org/mozilla-central/" class="urlextern" title="http://hg.mozilla.org/mozilla-central/">http://hg.mozilla.org/mozilla-central/</a>). </td> + </tr> + <tr class="row2"> + <td class="col0"><code>HG_LANGS</code></td><td class="col1"> A space-seperated list of language codes to build for. </td> + </tr> + <tr class="row3"> + <td class="col0"><code>L10N_DIR</code></td><td class="col1"> The directory where Mozilla l10n files should be collected. </td> + </tr> + <tr class="row4"> + <td class="col0"><code><acronym title="Gettext Portable Object">PO</acronym>_DIR</code></td><td class="col1"> The directory containing the externally-hosted or previously available source <acronym title="Gettext Portable Object">PO</acronym> files (ex. <acronym title="Gettext Portable Object">PO</acronym> files managed in another VCS repository). It contains a sub-directory for each language. </td> + </tr> + <tr class="row5"> + <td class="col0"><code>POPACK_DIR</code></td><td class="col1"> The output directory for <acronym title="Gettext Portable Object">PO</acronym> archives. </td> + </tr> + <tr class="row6"> + <td class="col0"><code>PORECOVER_DIR</code></td><td class="col1"> The directory to put recovered <acronym title="Gettext Portable Object">PO</acronym> files in. It contains a sub-directory for each language. </td> + </tr> + <tr class="row7"> + <td class="col0"><code><acronym title="Gettext Portable Object Template">POT</acronym>_INCLUDES</code></td><td class="col1"> A space-seperated list of files to be included in <acronym title="Gettext Portable Object Template">POT</acronym> archives. </td> + </tr> + <tr class="row8"> + <td class="col0"><code>POTPACK_DIR</code></td><td class="col1"> The output directory for <acronym title="Gettext Portable Object Template">POT</acronym> archives. </td> + </tr> + <tr class="row9"> + <td class="col0"><code>POUPDATED_DIR</code></td><td class="col1"> The directory to use for updated <acronym title="Gettext Portable Object">PO</acronym> files. It contains a sub-directory for each language. </td> + </tr> + <tr class="row10"> + <td class="col0"><code>LANGPACK_DIR</code></td><td class="col1"> The directory to put langpacks (XPIs) in. </td> + </tr> + <tr class="row11"> + <td class="col0"><code>FF_VERSION</code></td><td class="col1"> The version of Firefox that is being built for. This is used in the file names of archives. </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [1943-3308] --> +<h2><a name="build_tb3_langs.sh" id="build_tb3_langs.sh">build_tb3_langs.sh</a></h2> +<div class="level2"> + +<p> +This is the script that the <code>build_ff3.1_langs.sh</code> script above was actually adapted from. It is 90% similar with the obvious exception that it is aimed at building Thunderbird 3.0 packages in stead of Firefox 3.1. +</p> + +</div> +<!-- SECTION "build_tb3_langs.sh" [3309-3558] --> +<h2><a name="buildxpi.py" id="buildxpi.py">buildxpi.py</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "buildxpi.py" [3559-3582] --> +<h3><a name="description1" id="description1">Description</a></h3> +<div class="level3"> + +<p> +Creats a <acronym title="Cross Platform Installer">XPI</acronym> language pack from Mozilla sources and translated l10n files. This script has only been tested with Firefox 3.1 beta sources. +</p> + +<p> +It is basically the scripted version of the process described on Mozilla's <a href="https://developer.mozilla.org/en/Creating_a_Language_Pack" class="urlextern" title="https://developer.mozilla.org/en/Creating_a_Language_Pack">"Creating a language pack"</a> page. +</p> + +<p> +This script is used by <code>build_ff3.1_langs.sh</code> to build language packs in its final step. +</p> + +<p> +<strong>Note:</strong> This script uses the <code>.mozconfig</code> file in your home directory. Any existing <code>.mozconfig</code> is renamed to <code>.mozconfig.bak</code> during operation and copied back afterwards. +</p> + +</div> +<!-- SECTION "Description" [3583-4189] --> +<h3><a name="usage1" id="usage1">Usage</a></h3> +<div class="level3"> +<pre class="code">buildxpi.py -L /path/to/l10n -s /path/to/mozilla-central -o /path/to/xpi_output af</pre> + +Options:<table class="inline"> + <tr class="row0"> + <td class="col0"><code>/path/to/l10n</code></td><td class="col1"> The path to the parent directory of the “af” directory containing the Afrikaans translated l10n files. </td> + </tr> + <tr class="row1"> + <td class="col0"><code>/path/to/mozilla-central</code></td><td class="col1"> The path to the Firefox sources check out from <a href="http://hg.mozilla.org/mozilla-central" class="urlextern" title="http://hg.mozilla.org/mozilla-central">Mercurial</a>. Note that <code>--mozproduct</code> is not specified, because the default is <code>browser</code>. For Thunderbird (>=3.0) it should be <code>/path/to/<a href="http://hg.mozilla.org/comm-central" class="urlextern" title="http://hg.mozilla.org/comm-central">comm-central</a></code> and <code>--mozproduct mail</code> should be specified. </td> + </tr> + <tr class="row2"> + <td class="col0"><code>/path/to/xpi_output</code></td><td class="col1"> The path to the output directory. </td> + </tr> + <tr class="row3"> + <td class="col0"><code>af</code></td><td class="col1"> The language (Afrikaans in this case) to build a language pack for. </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [4190-4931] --> +<h2><a name="get_moz_enus.py" id="get_moz_enus.py">get_moz_enUS.py</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "get_moz_enUS.py" [4932-4959] --> +<h3><a name="description2" id="description2">Description</a></h3> +<div class="level3"> + +<p> +A simple script to collect the en-US l10n files from a Mozilla source tree (<code>'comm-central</code>' or <code>'mozilla-central</code>') by traversing the product's <code>l10n.ini</code> file. +</p> + +</div> +<!-- SECTION "Description" [4960-5150] --> +<h3><a name="usage2" id="usage2">Usage</a></h3> +<div class="level3"> +<pre class="code">get_moz_enUS.py [options]</pre> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"><code>-h</code>, <code>--help</code></td><td class="col1"> Show this help message and exit. </td> + </tr> + <tr class="row1"> + <td class="col0"><code>-s SRCDIR</code>, <code>--src=SRCDIR</code></td><td class="col1"> The directory containing the Mozilla l10n sources. (default: <code>mozilla</code>) </td> + </tr> + <tr class="row2"> + <td class="col0"><code>-d DESTDIR</code>, <code>--dest=DESTDIR</code></td><td class="col1"> The destination directory to copy the en-US locale files to. (default: <code>l10n</code>) </td> + </tr> + <tr class="row3"> + <td class="col0"><code>-pMOZPRODUCT</code>, <code>--mozproduct=MOZPRODUCT</code></td><td class="col1"> The Mozilla product name. (default: <code>browser</code>) </td> + </tr> + <tr class="row4"> + <td class="col0"><code>--delete-dest</code></td><td class="col1"> Delete the destination directory (if it exists). </td> + </tr> + <tr class="row5"> + <td class="col0"><code>-v, --verbose</code></td><td class="col1"> Be more noisy. </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [5151-5700] --> +<h2><a name="moz-l10n-builder" id="moz-l10n-builder">moz-l10n-builder</a></h2> +<div class="level2"> + +<p> +This is the pre-Mercurial build script originally written by Dwayne Bailey. This is the script that all the others on this page replaces for post-<acronym title="Concurrent Versions System">CVS</acronym> Mozilla l10n. +</p> + +<p> +<strong>Note</strong>: This script is <strong>not</strong> applicable to the l10n process of any Mozilla products after the move to Mercurial. +</p> + +<p> +For more information about this script see its dedicated <a href="toolkit-moz-l10n-builder.html" class="wikilink1" title="toolkit-moz-l10n-builder.html">wiki page</a>. +</p> + +</div> +<!-- SECTION "moz-l10n-builder" [5701-6111] --> +<h2><a name="moz_l10n_builder.py" id="moz_l10n_builder.py">moz_l10n_builder.py</a></h2> +<div class="level2"> + +<p> +This script was intended to be a simple and direct port of the <code>moz-l10n-builder</code> script from above. It has pro's and cons in comparison to the original, but is very similar for the most part. So for more information about this script, see the original script's <a href="toolkit-moz-l10n-builder.html" class="wikilink1" title="toolkit-moz-l10n-builder.html">wiki page</a>. + +</p> + +</div> +<!-- SECTION "moz_l10n_builder.py" [6112-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-multifile_multifilestyle.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-multifile_multifilestyle.html new file mode 100644 index 0000000..2683ae7 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-multifile_multifilestyle.html @@ -0,0 +1,60 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="multifile_multifilestyle" id="multifile_multifilestyle">--multifile=MULTIFILESTYLE</a></h1> +<div class="level1"> + +<p> + +This options determines how the <acronym title="Gettext Portable Object Template">POT</acronym>/<acronym title="Gettext Portable Object">PO</acronym> files are spli from the source files. In many cases +you have source files that generate either too many small files or one large files which you would rather see +split up into smaller files. +</p> + +</div> +<!-- SECTION "--multifile=MULTIFILESTYLE" [1-275] --> +<h2><a name="single" id="single">single</a></h2> +<div class="level2"> + +<p> + +Output individual files. +</p> + +</div> +<!-- SECTION "single" [276-321] --> +<h2><a name="toplevel" id="toplevel">toplevel</a></h2> +<div class="level2"> + +<p> + +Split the source files at the top level. Ie you see a number of top level files. +</p> + +</div> +<!-- SECTION "toplevel" [322-426] --> +<h2><a name="onefiles" id="onefiles">onefiles</a></h2> +<div class="level2"> + +<p> + +One large file instead of many smaller files. + +</p> + +</div> +<!-- SECTION "onefiles" [427-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-odf2xliff.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-odf2xliff.html new file mode 100644 index 0000000..07cbb19 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-odf2xliff.html @@ -0,0 +1,157 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="odf2xliff_and_xliff2odf" id="odf2xliff_and_xliff2odf">odf2xliff and xliff2odf</a></h1> +<div class="level1"> + +<p> + +Convert OpenDocument (ODF) files to <acronym title="XML Localization Interchange File Format">XLIFF</acronym> localization files. Create translated ODF files by combining the original ODF files with <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files containing translations of strings in the original document. +</p> + +<p> +<acronym title="XML Localization Interchange File Format">XLIFF</acronym> is the <acronym title="Extensible Markup Language">XML</acronym> Localization Interchange File Format +developed by <a href="http://lisa.org/" class="urlextern" title="http://lisa.org/">LISA</a> (The Localization Industry Standards Authority) to allow translation +work to be standardised no matter what the source format and to allow the work to be freely moved from tool to +tool. +</p> + +<p> +If you are more used to software translation or l10n, you might want to read a bit about <a href="guide-document_translation.html" class="wikilink1" title="guide-document_translation.html">document translation</a>. This should help you to get the most out of translating ODF with <acronym title="XML Localization Interchange File Format">XLIFF</acronym>. +</p> + +</div> +<!-- SECTION "odf2xliff and xliff2odf" [1-719] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">odf2xliff [options] <original_odf> <xliff> +xliff2odf [options] -t <original_odf> <xliff> <translated_odf></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"> <original_odf> </td><td class="col1 leftalign"> is an ODF document whose strings have to be translated </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <xliff> </td><td class="col1"> is an <acronym title="XML Localization Interchange File Format">XLIFF</acronym> file </td> + </tr> + <tr class="row2"> + <td class="col0"> <translated_odf> </td><td class="col1"> is an ODF file to generate by replacing the strings in <original_odf> with the translated strings in <xliff> </td> + </tr> +</table> + +<p> + +Options (odf2xliff): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in ODF format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in <acronym title="XML Localization Interchange File Format">XLIFF</acronym> format </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> +</table> + +<p> + +Options (xliff2odf): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in <acronym title="XML Localization Interchange File Format">XLIFF</acronym> formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in ODF format </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in ODF format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [720-2453] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">odf2xliff english.odt english_français.xlf</pre> + +<p> + +Create an <acronym title="XML Localization Interchange File Format">XLIFF</acronym> file from an ODT file (the source ODF file could also be any of the other ODF files, including ODS, ODG, etc.). + +</p> +<pre class="code">xliff2odf -t english.odt english_français.xlf français.odt</pre> + +<p> + +Using english.odt as the template document, and english_français.xlf as the file of translations, create a translated file français.odt. +</p> + +</div> +<!-- SECTION "Examples" [2454-2856] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +This filter is not yet extensively used - we appreciate your feedback. See <a href="toolkit-xliff.html" class="wikilink1" title="toolkit-xliff.html">xliff</a> to see how well our implementation conforms to the <acronym title="XML Localization Interchange File Format">XLIFF</acronym> standard. Possible issues were listed during <a href="odf-testing.html" class="wikilink1" title="odf-testing.html">testing</a>. + +</p> + +</div> +<!-- SECTION "Bugs" [2857-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-oo2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-oo2po.html new file mode 100644 index 0000000..13b9f36 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-oo2po.html @@ -0,0 +1,268 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="oo2po_and_po2oo" id="oo2po_and_po2oo">oo2po and po2oo</a></h1> +<div class="level1"> + +<p> + +Convert between OpenOffice.org GSI/SDF files and the <acronym title="Gettext Portable Object">PO</acronym> format. This tool provides a +complete roundtrip; it preserves the structure of the GSI file and creates +completely valid <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +<p> +oo2xliff will convert the SDF files to <acronym title="XML Localization Interchange File Format">XLIFF</acronym> format. +</p> + +</div> +<!-- SECTION "oo2po and po2oo" [1-276] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">oo2po [options] <sdf> <output> +po2oo [options] [-t <en-US.sdf>] -l <targetlang> <input> <sdf|output></pre> + +<p> +or for <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files +</p> +<pre class="code">oo2xliff [options] -l <targetlang> <sdf> <output> +xliff2oo [options] [-t <en-US.sdf>] -l <targetlang> <input> <sdf|output></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <sdf> </td><td class="col1 leftalign"> is a valid OpenOffice.org GSI or SDF files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <output> </td><td class="col1 leftalign"> is a directory for the resultant <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="Gettext Portable Object Template">POT</acronym>/<acronym title="XML Localization Interchange File Format">XLIFF</acronym> files </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> <input> </td><td class="col1 leftalign"> is a directory of translated <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="XML Localization Interchange File Format">XLIFF</acronym> files </td> + </tr> + <tr class="row3"> + <td class="col0"> <targetlang> </td><td class="col1"> is the <a href="http://en.wikipedia.org/wiki/ISO%20639" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/ISO%20639">ISO 639</a> language code used in the sdf file, eg. af </td> + </tr> +</table> + +<p> + +Options (oo2po and oo2xliff): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> --<a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> --<a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in oo format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) (only available in oo2po </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -lLANG, --language=LANG </td><td class="col1 leftalign"> set target language to extract from oo file (e.g. af-ZA) (required for oo2xliff) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --source-language=LANG </td><td class="col1 leftalign"> set source language code (default en-US) </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> --nonrecursiveinput </td><td class="col1 leftalign"> don't treat the input oo as a recursive store </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> --<a href="toolkit-duplicates_duplicatestyle.html" class="wikilink1" title="toolkit-duplicates_duplicatestyle.html">duplicates=DUPLICATESTYLE</a> </td><td class="col1 leftalign"> what to do with duplicate strings (identical original text) </td> + </tr> + <tr class="row14"> + <td class="col0 leftalign"> --<a href="toolkit-multifile_multifilestyle.html" class="wikilink1" title="toolkit-multifile_multifilestyle.html">multifile=MULTIFILESTYLE</a> </td><td class="col1 leftalign"> how to split po/pot files (single, toplevel or onefile) </td> + </tr> +</table> + +<p> +Options (po2oo and xliff2oo): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> --<a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> --<a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in oo format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in oo format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -lLANG, --language=LANG </td><td class="col1 leftalign"> set target language code (e.g. af-ZA) [required] </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --source-language=LANG </td><td class="col1 leftalign"> set source language code (default en-US) </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> -T, --keeptimestamp </td><td class="col1 leftalign"> don't change the timestamps of the strings </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> --nonrecursiveoutput </td><td class="col1 leftalign"> don't treat the output oo as a recursive store </td> + </tr> + <tr class="row14"> + <td class="col0 leftalign"> --nonrecursivetemplate </td><td class="col1 leftalign"> don't treat the template oo as a recursive store </td> + </tr> + <tr class="row15"> + <td class="col0 leftalign"> <a href="toolkit-filteraction_action.html" class="wikilink1" title="toolkit-filteraction_action.html">--filteraction=ACTION</a> </td><td class="col1 leftalign"> action on pofilter failure: none (default), warn, exclude-serious, exclude-all </td> + </tr> + <tr class="row16"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row17"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> + <tr class="row18"> + <td class="col0 leftalign"> --<a href="toolkit-multifile_multifilestyle.html" class="wikilink1" title="toolkit-multifile_multifilestyle.html">multifile=MULTIFILESTYLE</a> </td><td class="col1 leftalign"> how to split po/pot files (single, toplevel or onefile) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [277-3639] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +These examples demonstrate most of the useful invocations of oo2po: +</p> + +</div> +<!-- SECTION "Examples" [3640-3730] --> +<h3><a name="creating_pot_files" id="creating_pot_files">Creating POT files</a></h3> +<div class="level3"> +<pre class="code">oo2po -P en-US.sdf pot</pre> + +<p> + +Extract messages from <em>en-US.sdf</em> and place them in a directory called <em>pot</em>. The -P option ensures that we create <acronym title="Gettext Portable Object Template">POT</acronym> files instead of <acronym title="Gettext Portable Object">PO</acronym> files. +</p> +<pre class="code">oo2po -P --source-language=fr fr-FR.sdf french-pot</pre> + +<p> + +Instead of creating English <acronym title="Gettext Portable Object Template">POT</acronym> files we are now creating <acronym title="Gettext Portable Object Template">POT</acronym> files that contain French in the msgid. This is useful for translators who are +not English literate. You will need to have a fully translated sdf in the source language. +</p> + +</div> +<!-- SECTION "Creating POT files" [3731-4228] --> +<h3><a name="creating_po_files_from_existing_work" id="creating_po_files_from_existing_work">Creating PO files from existing work</a></h3> +<div class="level3"> +<pre class="code">oo2po --duplicates=merge -l zu zu-ZA.sdf zulu</pre> + +<p> + +Extract all existing Zulu (<em>zu</em>) messages from <em>zu-ZA.sdf</em> and place them in a directory called <em>zulu</em>. If you find duplicate messages in a file then merge them into a single message (This is the default behaviour for traditional <acronym title="Gettext Portable Object">PO</acronym> files). You might want to use <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a> to ensure that your <acronym title="Gettext Portable Object">PO</acronym> files match the latest <acronym title="Gettext Portable Object Template">POT</acronym> files. + +</p> +<pre class="code">cat GSI_af.sdf GSI_xh.sdf > GSI_af-xh.sdf +oo2po --source-language=af -l xh GSI_af-xh.sdf af-xh-po</pre> + +<p> + +Here we are creating <acronym title="Gettext Portable Object">PO</acronym> files with your existing translations but a different source language. Firstly we combine the two SDF files. Then oo2po creates a set of <acronym title="Gettext Portable Object">PO</acronym> files in <em>af-xh-po</em> using Afrikaans (<em>af</em>) as the source language and Xhosa (<em>xh</em>) as the target language from the combined SDF file <em>GSI_af-xh.sdf</em> +</p> + +</div> +<!-- SECTION "Creating PO files from existing work" [4229-5104] --> +<h3><a name="creating_a_new_gsisdf_file" id="creating_a_new_gsisdf_file">Creating a new GSI/SDF file</a></h3> +<div class="level3"> +<pre class="code">po2oo -l zu zulu zu_ZA.sdf</pre> + +<p> + +Using <acronym title="Gettext Portable Object">PO</acronym> files found in <em>zulu</em> create an SDF files called <em>zu_ZA.sdf</em> for language <em>zu</em> + +</p> +<pre class="code">po2oo -l af -t en-US.sdf --nofuzzy --keeptimestamp --filteraction=exclude-serious afrikaans af_ZA.sdf</pre> + +<p> + +Create an Afrikaans (<em>af</em>) SDF file called <em>af_ZA.sdf</em> using <em>en-US.sdf</em> as a template and preserving the timestamps within the SDF file +while also eliminating any serious errors in translation. Using templates ensures that the resultant SDF file has exactly the same format as +the template SDF file. In an SDF file each translated string can have a timestamp attached. This creates a large amount of unuseful traffic when comparing version of the SDF file, by preserving the timestamp we ensure that this does not change and can therefore see the translation changes clearly. We have included the <em>nofuzzy</em> option (on by default) that prevent fuzzy <acronym title="Gettext Portable Object">PO</acronym> messages from getting into the SDF file. Lastly the <em>filteraction</em> option is set to exclude serious errors: variables failures and translated <acronym title="Extensible Markup Language">XML</acronym> will be excluded from the final SDF. +</p> + +</div> +<!-- SECTION "Creating a new GSI/SDF file" [5105-6233] --> +<h2><a name="helpcontent2" id="helpcontent2">helpcontent2</a></h2> +<div class="level2"> + +<p> + +The escaping of <code>helpcontent2</code> from SDF files was very confusing, bug <a href="http://bugs.locamotion.org/show_bug.cgi?id=295" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=295">295</a> implemented a fix that appeared in version 1.1.0 (All known issues were fixed in 1.1.1). Translators are now able to translate helpcontent2 with clean escaping. +</p> + +</div> +<!-- SECTION "helpcontent2" [6234-6506] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known + +</p> + +</div> +<!-- SECTION "Bugs" [6507-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-oo2xliff.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-oo2xliff.html new file mode 100644 index 0000000..c9d4d93 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-oo2xliff.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/oo2po" class="wikilink1" title="toolkit:oo2po">oo2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-personality_type.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-personality_type.html new file mode 100644 index 0000000..c8d1c61 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-personality_type.html @@ -0,0 +1,56 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="personality_type" id="personality_type">--personality=TYPE</a></h1> +<div class="level1"> + +</div> +<!-- SECTION "--personality=TYPE" [1-34] --> +<h2><a name="java_default" id="java_default">java (default)</a></h2> +<div class="level2"> + +<p> + +Create output strictly according to the specification for .properties files. This will use escaped Unicode for any non-assci characters. Thus the following string found in a <acronym title="Gettext Portable Object">PO</acronym> file: + +</p> +<pre class="code">ṽḁḽṻḝ</pre> + +<p> + +Will appear as follows in the output .properties file: + +</p> +<pre class="code">\u1E7D\u1E01\u1E3D\u1E7B\u1E1D</pre> + +</div> +<!-- SECTION "java (default)" [35-357] --> +<h2><a name="mozilla" id="mozilla">mozilla</a></h2> +<div class="level2"> + +<p> + +Mozilla has made slight adjustments to the Java .properties <acronym title="specification">spec</acronym>. Mozilla will accept UTF-8 encoded strings in the property file and thus does not need escaped Unicode. Thus the string above string - ṽḁḽṻḝ - will not be escaped. Mozilla property files are thus more useful for non-Latin languages in that they are actually readable. +</p> + +<p> +Of course this style of file is only used by Mozilla and should not be used for other projects that follow the Java <acronym title="specification">spec</acronym> more strictly. + +</p> + +</div> +<!-- SECTION "mozilla" [358-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-phase.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-phase.html new file mode 100644 index 0000000..37d446e --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-phase.html @@ -0,0 +1,156 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="phase" id="phase">phase</a></h1> +<div class="level1"> + +<p> + +phase is a script that allows you to perform a number of tasks on a set of <acronym title="Gettext Portable Object">PO</acronym> files that have been broken into phases. +You can create a ZIP file for a phase, run checks against a phase, review a phase, edit files in a phase, etc. All +the tasks that would be involved in sending work to various translators, receiving work, checking it and committing to +<acronym title="Concurrent Versions System">CVS</acronym>. +</p> + +</div> +<!-- SECTION "phase" [1-382] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> An environment that will run <a href="http://man.cx/bash" class="interwiki iw_man" title="http://man.cx/bash">bash</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://man.cx/diff" class="interwiki iw_man" title="http://man.cx/diff">diff</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://man.cx/cvs" class="interwiki iw_man" title="http://man.cx/cvs">cvs</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Prerequisites" [383-491] --> +<h2><a name="latest_version" id="latest_version">Latest Version</a></h2> +<div class="level2"> + +<p> + +phase is not currently distributed as part of the toolkit. You can get the <a href="http://translate.svn.sourceforge.net/viewvc/*checkout*/translate/src//trunk/tools/phase" class="interwiki iw_svn" title="http://translate.svn.sourceforge.net/viewvc/*checkout*/translate/src//trunk/tools/phase">latest version from Subversion</a> +</p> + +</div> +<!-- SECTION "Latest Version" [492-654] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">phase <command> [options]</pre> + +<p> + +Mostly the usage follows the format of: +</p> +<pre class="code">phase <command> <language-dir> <phaselist> <phase-name> +phase <command> <language-dir> <phase-name></pre> + +<p> + +A full list of commands and options can be seen by running +</p> +<pre class="code">phase --help</pre> + +</div> +<!-- SECTION "Usage" [655-922] --> +<h2><a name="commands" id="commands">Commands</a></h2> +<div class="level2"> + +<p> + +These are the commands that you can use: + +</p> +<ul> +<li class="level1"><div class="li"> makephaselist <new-phase-list-name> -- creates a phase list</div> +</li> +<li class="level1"><div class="li"> listphases <phase-list> -- lists the different phases that appear in the phase-list file</div> +</li> +<li class="level1"><div class="li"> listfiles <phase-list> <phase-name> -- list all files for the given phase in the phase-list file</div> +</li> +<li class="level1"><div class="li"> checkphaselist <language-dir> <phase-list> -- checks to see which files are not included in the phaselist</div> +</li> +<li class="level1"><div class="li"> countpo <language-dir> <phase-list> <phase-name> -- counts <acronym title="Gettext Portable Object">PO</acronym> file in the given phase</div> +</li> +<li class="level1"><div class="li"> countpot <template-dir> <phase-list> <phase-name> -- counts <acronym title="Gettext Portable Object Template">POT</acronym> file in the given phase</div> +</li> +<li class="level1"><div class="li"> missingpo <language-dir> <phase-list> <phase-name> -- lists files that have not been returned for a phase</div> +</li> +<li class="level1"><div class="li"> packpot <template-dir> <phase-list> <phase-name> -- packs all <acronym title="Gettext Portable Object Template">POT</acronym> files for a given phase into a ZIP file</div> +</li> +<li class="level1"><div class="li"> packpo <language-dir> <phase-list> <phase-name> -- packs all <acronym title="Gettext Portable Object">PO</acronym> files for a given phase into a ZIP file</div> +</li> +<li class="level1"><div class="li"> packall <template-dir> <phase-list> -- packs all phases found in the phase list</div> +</li> +<li class="level1"><div class="li"> packallpo <language-dir> <phase-list> -- packs all phases found in the phase list for the given language</div> +</li> +<li class="level1"><div class="li"> countmismatch <language-dir> <template-dir> <phase-list> <phase-name> -- compares the source word count between <acronym title="Gettext Portable Object">PO</acronym> and <acronym title="Gettext Portable Object Template">POT</acronym> to determine if there are any file errors.</div> +</li> +<li class="level1"><div class="li"> editpo <language-dir> <phase-list> <phase-name> -- edit the <acronym title="Gettext Portable Object">PO</acronym> files in a phase</div> +</li> +<li class="level1"><div class="li"> editpochecks <language> <phase-name> -- edit the <acronym title="Gettext Portable Object">PO</acronym> checks output by checkpo</div> +</li> +<li class="level1"><div class="li"> editconflicts <language-dir> <phase-list> <phase-name> -- edit the extracted conflict items</div> +</li> +<li class="level1"><div class="li"> checkpo <language-dir> <phase-list> <phase-name> [pofilter options] -- run pofilter checks against the given phase</div> +</li> +<li class="level1"><div class="li"> mergepo <language> <phase-name> -- merge the checks back into the main language directory</div> +</li> +<li class="level1"><div class="li"> conflictpo <language-dir> <phase-list> <phase-name> [poconflict options] -- run poconflict checks against the given phase</div> +</li> +<li class="level1"><div class="li"> diffpo <language-dir> <phase-list> <phase-name> -- perform a cvs diff for the phase</div> +</li> +<li class="level1"><div class="li"> cvslog <language-dir> <phase-list> <phase-name> -- perform a cvs log against files in the phase</div> +</li> +<li class="level1"><div class="li"> lastlog <language-dir> <phase-list> <phase-name> -- retrieves the last cvs log entry for each file in a phase</div> +</li> +<li class="level1"><div class="li"> cvsadd <languages-dir> <phase-list> <phase-name> -- <acronym title="Concurrent Versions System">CVS</acronym> adds files and directories that are not already in <acronym title="Concurrent Versions System">CVS</acronym></div> +</li> +<li class="level1"><div class="li"> diffpo <language-dir> <phase-list> <phase-name> -- perform a cvs diff for the phase</div> +</li> +<li class="level1"><div class="li"> reviewpo <language-dir> <phase-list> <phase-name> [pofilter options] -- extract items marked for review for the given phase</div> +</li> +<li class="level1"><div class="li"> editreviews <language-dir> <phase-list> <phase-name> -- edit the extracted review items</div> +</li> +<li class="level1"><div class="li"> countreviews <language-dir> <phase-list> <phase-name> -- count the number of strings and words under review</div> +</li> +<li class="level1"><div class="li"> checkinpo <language-dir> <phase-list> <phase-name> -- cvs checkin the files in the given phase</div> +</li> +<li class="level1"><div class="li"> creategsi <language-dir> <en-US.gsi> <traget-language> -- creates a BZ2 GSI/SDF file for the language against the en-US GSI file</div> +</li> +<li class="level1"><div class="li"> reviewsinout <language> <phase-name> -- counts the number of review files returned vs sent and shows which are missing</div> +</li> +<li class="level1"><div class="li"> reviewsdiff <language> <phase-name> -- create a diff between what was sent for review and what was returned</div> +</li> +</ul> + +</div> +<!-- SECTION "Commands" [923-4132] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +There are probably lots mostly the bug is that the command line options are pretty inconsistent + +</p> + +</div> +<!-- SECTION "Bugs" [4133-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-php.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-php.html new file mode 100644 index 0000000..8be13cd --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-php.html @@ -0,0 +1,79 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="php" id="php">PHP</a></h1> +<div class="level1"> + +<p> + +Many <a href="http://en.wikipedia.org/wiki/PHP" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/PHP">PHP</a> programs make use of a localisable string array. The toolkit support the full localisation of such files. +</p> + +</div> +<!-- SECTION "PHP" [1-143] --> +<h2><a name="example" id="example">Example</a></h2> +<div class="level2"> + +<p> + +The localisable string arrays appear like this: +</p> +<pre class="code php"><pre class="code php"><span class="kw2"><?php</span> +<span class="re0">$string</span><span class="br0">[</span><span class="st0">'name'</span><span class="br0">]</span> = <span class="st0">'value'</span></pre></pre> +</div> +<!-- SECTION "Example" [144-265] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> + +<p> + +Our format support allows: +</p> +<ul> +<li class="level1"><div class="li"> <acronym title="Hypertext Preprocessor">PHP</acronym> escaping (both for <a href="http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.single" class="urlextern" title="http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.single">single</a> and <a href="http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.double" class="urlextern" title="http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.double">double</a> quoted strings)</div> +</li> +<li class="level1"><div class="li"> Multiline entries</div> +</li> +<li class="level1"><div class="li"> Various layouts of the id: </div> +</li> +</ul> +<pre class="code php"><span class="re1">$string</span><span class="br0">[</span><span class="st0">'name'</span><span class="br0">]</span> +<span class="re1">$string</span><span class="br0">[</span>name<span class="br0">]</span> +<span class="re1">$string</span><span class="br0">[</span> <span class="st0">'name'</span> <span class="br0">]</span></pre> +</div> +<!-- SECTION "Conformance" [266-690] --> +<h2><a name="non-conformance" id="non-conformance">Non-Conformance</a></h2> +<div class="level2"> + +<p> + +The following are not yet supported: +</p> +<ul> +<li class="level1"><div class="li"> <acronym title="Hypertext Preprocessor">PHP</acronym> array syntax for localisation</div> +</li> +</ul> +<pre class="code php"><span class="re1">$lang</span> <span class="sy0">=</span> <a href="http://www.php.net/array"><span class="kw3">array</span></a><span class="br0">(</span> + <span class="st0">'name'</span> <span class="sy0">=></span> <span class="st0">'value'</span><span class="sy0">,</span> + <span class="st0">'name2'</span> <span class="sy0">=></span> <span class="st0">'value2'</span><span class="sy0">,</span> +<span class="br0">)</span><span class="sy0">;</span></pre><ul> +<li class="level1"><div class="li"> <a href="http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.heredoc" class="urlextern" title="http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.heredoc">herdoc</a> and <a href="http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.nowdoc" class="urlextern" title="http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.nowdoc">nowdoc</a> are not managed</div> +</li> +</ul> + +</div> +<!-- SECTION "Non-Conformance" [691-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-php2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-php2po.html new file mode 100644 index 0000000..da25740 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-php2po.html @@ -0,0 +1,225 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="php2po" id="php2po">php2po</a></h1> +<div class="level1"> + +<p> + +Converts <acronym title="Hypertext Preprocessor">PHP</acronym> localisable string arrays to Gettext <acronym title="Gettext Portable Object">PO</acronym> format. +</p> + +</div> +<!-- SECTION "php2po" [1-84] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">php2po [options] <php> <po> +po2php [options] <po> <php></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <php> </td><td class="col1 leftalign"> is a valid <acronym title="Hypertext Preprocessor">PHP</acronym> localisable file or directory of those files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a directory of <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="Gettext Portable Object Template">POT</acronym> files </td> + </tr> +</table> + +<p> + +Options (php2po): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in php format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in php format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> <a href="toolkit-duplicates_duplicatestyle.html" class="wikilink1" title="toolkit-duplicates_duplicatestyle.html">--duplicates=DUPLICATESTYLE</a> </td><td class="col1 leftalign"> what to do with duplicate strings (identical source text): merge, msgid_comment, msgctxt, keep, msgid_comment_all (default: 'msgctxt') </td> + </tr> +</table> + +<p> + +Options (po2php): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in php format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in php format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [85-2269] --> +<h2><a name="formats_supported" id="formats_supported">Formats Supported</a></h2> +<div class="level2"> + +<p> + +<acronym title="Hypertext Preprocessor">PHP</acronym> files need to be organized into separate languages per file and in the following format: + +</p> +<pre class="code">$variable = 'string';</pre> + +<p> + +If $variable is an array it should be declared with the square bracket syntax. For example, <code>$lang['var']</code>. +</p> + +</div> +<!-- SECTION "Formats Supported" [2270-2531] --> +<h3><a name="unsupported" id="unsupported">Unsupported</a></h3> +<div class="level3"> + +<p> + +The converter does not support arrays in the form: +</p> +<pre class="code php"><span class="re1">$variable</span> <span class="sy0">=</span> <a href="http://www.php.net/array"><span class="kw3">array</span></a><span class="br0">(</span> + name <span class="sy0">=></span> <span class="st0">'value'</span><span class="sy0">,</span> +<span class="br0">)</span></pre> +<p> +Gettext notations is also not supported, use the Gettext tools for those files. +</p> + +</div> +<!-- SECTION "Unsupported" [2532-2748] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> +This example looks at roundtrip of <acronym title="Hypertext Preprocessor">PHP</acronym> translations as well as recovery of existing translations. +</p> + +<p> +First we need to create a set of <acronym title="Gettext Portable Object Template">POT</acronym> files. + +</p> +<pre class="code">php2po -P lang/en pot/</pre> + +<p> + +All .php files found in the <code>lang/en</code> directory are converted to Gettext <acronym title="Gettext Portable Object Template">POT</acronym> files and placed in the <code>pot</code> directory. +</p> + +<p> +If you are translating for the first time then you can skip the next step. If you need to recovery your existing translations then we do the following: + +</p> +<pre class="code">php2po -t lang/en lang/zu po-zu/</pre> + +<p> + +Using the English <acronym title="Hypertext Preprocessor">PHP</acronym> files found in <code>lang/en</code> and your existing Zulu translation in <code>lang/zu</code> we create a set of <acronym title="Gettext Portable Object">PO</acronym> files in <code>po-zu</code>. These will now have your translations. Please be aware that in order for the to work 100% you need to have both English and Zulu at the same revision, if they are not you will have to review all translations. +</p> + +<p> +You are now in a position to translate your recovered translations or your new <acronym title="Gettext Portable Object Template">POT</acronym> files. +</p> + +<p> +Once translated you can convert back as follows: + +</p> +<pre class="code">po2php -t lang/en po-zu/ lang/zu</pre> + +<p> + +Your translations found in the Zulu <acronym title="Gettext Portable Object">PO</acronym> directory, <code>po-zu</code>, will be converted to <acronym title="Hypertext Preprocessor">PHP</acronym> using the files in <code>lang/en</code> as templates and placing your new translations in <code>lang/zu</code>. +</p> + +<p> +To update your translations simply redo the <acronym title="Gettext Portable Object Template">POT</acronym> creation step and make use of <a href="toolkit-pot2po.html" class="wikilink1" title="toolkit-pot2po.html">pot2po</a> to bring your translation up-to-date. +</p> + +</div> +<!-- SECTION "Examples" [2749-4091] --> +<h2><a name="issues" id="issues">Issues</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Support localisation variables using <code>array</code> is missing</div> +</li> +</ul> + +</div> +<!-- SECTION "Issues" [4092-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po.html new file mode 100644 index 0000000..ce9cd98 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po.html @@ -0,0 +1,111 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="po_files" id="po_files">PO Files</a></h1> +<div class="level1"> + +<p> +<acronym title="Gettext Portable Object">PO</acronym> files use the file format of the Gettext tools. See <a href="http://www.gnu.org/software/gettext/" class="urlextern" title="http://www.gnu.org/software/gettext/">http://www.gnu.org/software/gettext/</a> +</p> + +<p> +For information on KDE style <acronym title="Gettext Portable Object">PO</acronym> files, see <a href="http://public.planetmirror.com/pub/kde/devel/gettext-kde/" class="urlextern" title="http://public.planetmirror.com/pub/kde/devel/gettext-kde/">http://public.planetmirror.com/pub/kde/devel/gettext-kde/</a> +</p> + +</div> +<!-- SECTION "PO Files" [1-219] --> +<h2><a name="supported_features" id="supported_features">Supported Features</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Headers</div> +</li> +<li class="level1"><div class="li"> Plural forms and plural form handling</div> +</li> +<li class="level1"><div class="li"> Obsolete messages</div> +</li> +<li class="level1"><div class="li"> Message Context (msgctxt)</div> +</li> +</ul> + +</div> +<!-- SECTION "Supported Features" [220-359] --> +<h2><a name="supported_comments" id="supported_comments">Supported comments</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> normal comments <pre class="code"># this is another comment</pre> +</div> +</li> +<li class="level1"><div class="li"> automatic comments <pre class="code">#. comment extracted from the source code</pre> +</div> +</li> +<li class="level1"><div class="li"> source location comments <pre class="code">#: sourcefile.xxx:35</pre> +</div> +</li> +<li class="level1"><div class="li"> typecomments <pre class="code">#, fuzzy</pre> +</div> +</li> +<li class="level1"><div class="li"> visiblecomments <pre class="code">#_ note to translator (this is nonsense)</pre> + +<p> +This style is no longer used by tools like pofilter, they use normal comments to ensure that they work with Gettext tools. Handling of these will be removed in the future. +</p> +</div> +</li> +<li class="level1"><div class="li"> msgidcomments <pre class="code">magid "_: within msgid\n"</pre> + +<p> +Also know as KDE style comments as they are used by KDE for message disambiguation and comments to translators. +</p> +</div> +</li> +<li class="level1"><div class="li"> obsolete messages <pre class="code">#~ msgid "Blah" +#~ msgstr "Bleeh"</pre> +</div> +</li> +</ul> + +</div> +<!-- SECTION "Supported comments" [360-1114] --> +<h2><a name="unsupported_features" id="unsupported_features">Unsupported Features</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Unsupported Features" [1115-1149] --> +<h3><a name="previous_msgid" id="previous_msgid">Previous msgid</a></h3> +<div class="level3"> +<pre class="code">#| msgid "previous message"</pre> + +<p> + +In Gettext 0.16 +</p> + +</div> +<!-- SECTION "Previous msgid" [1150-1223] --> +<h3><a name="alternate_language" id="alternate_language">Alternate language</a></h3> +<div class="level3"> +<pre class="code">msgid "English" +msgid[af] "Engels"</pre> + +<p> + +Unsure of when or if this was added to Gettext. + +</p> + +</div> +<!-- SECTION "Alternate language" [1224-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2csv.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2csv.html new file mode 100644 index 0000000..f14e82c --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2csv.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/csv2po" class="wikilink1" title="toolkit:csv2po">csv2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2html.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2html.html new file mode 100644 index 0000000..2bfa7aa --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2html.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/html2po" class="wikilink1" title="toolkit:html2po">html2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2ini.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2ini.html new file mode 100644 index 0000000..1d2eb6d --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2ini.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/ini2po" class="wikilink1" title="toolkit:ini2po">ini2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2moz.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2moz.html new file mode 100644 index 0000000..d00bc56 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2moz.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/moz2po" class="wikilink1" title="toolkit:moz2po">moz2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2oo.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2oo.html new file mode 100644 index 0000000..c9d4d93 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2oo.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/oo2po" class="wikilink1" title="toolkit:oo2po">oo2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2php.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2php.html new file mode 100644 index 0000000..fdb6ebb --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2php.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/php2po" class="wikilink1" title="toolkit:php2po">php2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2prop.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2prop.html new file mode 100644 index 0000000..13d0644 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2prop.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/prop2po" class="wikilink1" title="toolkit:prop2po">prop2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2rc.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2rc.html new file mode 100644 index 0000000..a443470 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2rc.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/rc2po" class="wikilink1" title="toolkit:rc2po">rc2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2tmx.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2tmx.html new file mode 100644 index 0000000..0c45ec6 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2tmx.html @@ -0,0 +1,177 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="po2tmx" id="po2tmx">po2tmx</a></h1> +<div class="level1"> + +<p> + +Convert Gettext <acronym title="Gettext Portable Object">PO</acronym> files to a <acronym title="Translation Memory eXchange">TMX</acronym> translation memory file. <acronym title="Translation Memory eXchange">TMX</acronym> is the Translation Memory +eXchange format developed by <a href="http://lisa.org/" class="urlextern" title="http://lisa.org/">LISA</a> (Localization Industry Standards Association) +</p> + +</div> +<!-- SECTION "po2tmx" [1-215] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">po2tmx [options] --language <target> <po> <tmx></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a <acronym title="Gettext Portable Object">PO</acronym> file </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <tmx> </td><td class="col1 leftalign"> is a <acronym title="Translation Memory eXchange">TMX</acronym> file </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in tmx format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -lLANG, --language=LANG </td><td class="col1 leftalign"> set target language code (e.g. af-ZA) [required] </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --source-language=LANG </td><td class="col1 leftalign"> set source language code (default: en) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [216-1200] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">po2tmx -l xh browser.po browser.tmx</pre> + +<p> + +Use the Xhosa (<em>xh</em>) translations in the <acronym title="Gettext Portable Object">PO</acronym> file <em>browser.po</em> to create a <acronym title="Translation Memory eXchange">TMX</acronym> file called <em>browser.tmx</em> +</p> + +</div> +<!-- SECTION "Examples" [1201-1372] --> +<h2><a name="bugs_and_issues" id="bugs_and_issues">Bugs and issues</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Bugs and issues" [1373-1401] --> +<h3><a name="markup_stripping" id="markup_stripping">Markup stripping</a></h3> +<div class="level3"> + +<p> + +po2tmx conforms to <acronym title="Translation Memory eXchange">TMX</acronym> v1.4 without stripping markup. See the <a href="toolkit-tmx.html" class="wikilink1" title="toolkit-tmx.html">tmx</a> conformance page for more details. +</p> + +<p> +It has not been widely tested so your mileage may vary. +</p> + +</div> +<!-- SECTION "Markup stripping" [1402-1593] --> +<h3><a name="tmx_and_po_in_omegat" id="tmx_and_po_in_omegat">TMX and PO in OmegaT</a></h3> +<div class="level3"> + +<p> + +In some tools, like OmegaT, <acronym title="Gettext Portable Object">PO</acronym> files are parsed without expanding escaped sequences, even though such tools use <acronym title="Translation Memory eXchange">TMX</acronym> for translation memory. Keep this in mind when using po2tmx, because po2tmx converts \n and \t to newlines and tabs in the <acronym title="Translation Memory eXchange">TMX</acronym> file. If such a <acronym title="Translation Memory eXchange">TMX</acronym> file is used while translating <acronym title="Gettext Portable Object">PO</acronym> files in OmegaT, matching will be less than 100%. +</p> + +<p> +In other tools, such as Swordfish, the <acronym title="Gettext Portable Object">PO</acronym> comment “no-wrap” is interpreted in the same way as the equivalent function in <acronym title="Extensible Markup Language">XML</acronym>, which may also lead to mismatches if TMXes from po2tmx are used. +</p> + +<p> +There is nothing wrong with po2tmx, but if used in conjunction with tools that handle <acronym title="Gettext Portable Object">PO</acronym> files differently, it may lead to less than perfect matching. +</p> + +</div> +<!-- SECTION "TMX and PO in OmegaT" [1594-2319] --> +<h2><a name="tips" id="tips">Tips</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Tips" [2320-2337] --> +<h3><a name="tmx_with_only_unique_segments" id="tmx_with_only_unique_segments">TMX with only unique segments</a></h3> +<div class="level3"> + +<p> + +To create a <acronym title="Translation Memory eXchange">TMX</acronym> with no duplicates (in other words, only unique strings), use msgcat to first create a large <acronym title="Gettext Portable Object">PO</acronym> file with non-uniques removed. +</p> + +<p> +Steps for <acronym title="Microsoft">MS</acronym> Windows: +</p> + +<p> +1. Create a text file (say, allfiles.txt) that contains the paths of all the <acronym title="Gettext Portable Object">PO</acronym> files (in Linux just use the “find” command). The file should contain one path per line (relative or absolute). In <acronym title="Microsoft">MS</acronym> Windows, you can use <a href="toolkit-pikybasket.html" class="wikilink2" title="toolkit-pikybasket.html">PikyBasket</a>. In <acronym title="Microsoft">MS</acronym> Windows, make sure the file has no BOM. +</p> + +<p> +2. Do: msgcat -f allfiles.txt -u -o bigpofile.po +</p> + +<p> +3. Now do po2tmx on that bigpofile.po +</p> + +</div> +<!-- SECTION "TMX with only unique segments" [2338-2919] --> +<h2><a name="the_toolkit_s_tmx_versus_other_tools" id="the_toolkit_s_tmx_versus_other_tools">The Toolkit's TMX versus other tools</a></h2> +<div class="level2"> + +<p> + +Here is a page on <a href="toolkit-support_for_toolkit_tmx.html" class="wikilink1" title="toolkit-support_for_toolkit_tmx.html">support for toolkit tmx</a> by other tools (mostly <acronym title="Microsoft">MS</acronym> Windows). + +</p> + +</div> +<!-- SECTION "The Toolkit's TMX versus other tools" [2920-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2ts.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2ts.html new file mode 100644 index 0000000..e30ec9f --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2ts.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/ts2po" class="wikilink1" title="toolkit:ts2po">ts2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2txt.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2txt.html new file mode 100644 index 0000000..74472d7 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2txt.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/txt2po" class="wikilink1" title="toolkit:txt2po">txt2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2wordfast.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2wordfast.html new file mode 100644 index 0000000..00c8b1a --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2wordfast.html @@ -0,0 +1,106 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="po2wordfast" id="po2wordfast">po2wordfast</a></h1> +<div class="level1"> + +<p> + +<p><div class="noteclassic">Only in v1.1 of the Translate Toolkit +</div></p> +</p> + +<p> +Convert Gettext <acronym title="Gettext Portable Object">PO</acronym> files to a <a href="toolkit-wordfast.html" class="wikilink1" title="toolkit-wordfast.html">Wordfast</a> translation memory file. +</p> + +<p> +<a href="http://en.wikipedia.org/wiki/Wordfast" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Wordfast">Wordfast</a> is a popular Windows based computer-assisted translation tool. +</p> + +</div> +<!-- SECTION "po2wordfast" [1-230] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">po2wordfast [options] --language <target> <po> <wordfast></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <po> </td><td class="col1"> a <acronym title="Gettext Portable Object">PO</acronym> file or directory </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <wordfast> </td><td class="col1 leftalign"> a Wordfast translation memory file </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in tmx format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -lLANG, --language=LANG </td><td class="col1 leftalign"> set target language code (e.g. af-ZA) [required] </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --source-language=LANG </td><td class="col1 leftalign"> set source language code (default: en) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [231-1260] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">po2wordfast -l xh-ZA browser.po browser.txt</pre> + +<p> + +Use the Xhosa (<em>xh-ZA</em>) translations in the <acronym title="Gettext Portable Object">PO</acronym> file <em>browser.po</em> to create a Wordfast translation memory file called <em>browser.txt</em> +</p> + +</div> +<!-- SECTION "Examples" [1261-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2xliff.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2xliff.html new file mode 100644 index 0000000..18d0953 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-po2xliff.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/xliff2po" class="wikilink1" title="toolkit:xliff2po">xliff2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-poclean.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poclean.html new file mode 100644 index 0000000..2cc1e80 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poclean.html @@ -0,0 +1,107 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="poclean" id="poclean">poclean</a></h1> +<div class="level1"> + +<p> + +This is a rudimentary tool to produce a clean file from an unclean file (Trados/Wordfast) by stripping out the tw4win indicators. +</p> + +</div> +<!-- SECTION "poclean" [1-154] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">poclean <input> <output></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"> <input> </td><td class="col1"> is the text versions of the unclean <acronym title="Rich Text File">RTF</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <output> </td><td class="col1"> is the intended output file / directory </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in pot format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in po, pot formats </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [155-1105] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +To create a text version of the unclean <acronym title="Rich Text File">RTF</acronym> file, you need UnRTF, available here: <a href="http://www.gnu.org/software/unrtf/unrtf.html" class="urlextern" title="http://www.gnu.org/software/unrtf/unrtf.html">project site</a> or <a href="http://gnuwin32.sourceforge.net/packages/unrtf.htm" class="urlextern" title="http://gnuwin32.sourceforge.net/packages/unrtf.htm">here (windows)</a>. + +</p> +<pre class="code">unrtf translation.rtf --text > translation.po</pre> + +<p> + +You might need to convert the encoding of the file, with iconv, for example: +</p> +<pre class="code">iconv -f latin1 -t utf-8 translation.po > new_translation.po</pre> + +<p> + +Now you can clean the file with poclean +</p> +<pre class="code">poclean new_translation.po clean_translation.po</pre> + +</div> +<!-- SECTION "Examples" [1106-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocommentclean.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocommentclean.html new file mode 100644 index 0000000..1eaec41 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocommentclean.html @@ -0,0 +1,86 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pocommentclean" id="pocommentclean">pocommentclean</a></h1> +<div class="level1"> + +<p> + +pocommentclean will remove all translator comments from a directory of <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +</div> +<!-- SECTION "pocommentclean" [1-112] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="http://man.cx/sed" class="interwiki iw_man" title="http://man.cx/sed">sed</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Prerequisites" [113-158] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> + +<p> + +pocommentclean [--backup] <po> +</p> + +<p> +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> po </td><td class="col1 leftalign"> is a directory of existing <acronym title="Gettext Portable Object">PO</acronym> files that you want to clean </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> -- backup </td><td class="col1 leftalign"> Create a backup file for each <acronym title="Gettext Portable Object">PO</acronym> file converted, .po.bak </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [159-381] --> +<h2><a name="operation" id="operation">Operation</a></h2> +<div class="level2"> + +<p> + +Using sed pocommentclean will delete all lines starting with # but which are not standard Gettext <acronym title="Gettext Portable Object">PO</acronym> format lines. So it won't delete developer comments (#.), obsolete messages (#~), flags (#,) or locations (#:). +</p> + +</div> +<!-- SECTION "Operation" [382-619] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +pocommentclean cannot clean individual <acronym title="Gettext Portable Object">PO</acronym> files, it only cleans directories + +</p> + +</div> +<!-- SECTION "Bugs" [620-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocompendium.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocompendium.html new file mode 100644 index 0000000..d69764f --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocompendium.html @@ -0,0 +1,147 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pocompendium" id="pocompendium">pocompendium</a></h1> +<div class="level1"> + +<p> + +Takes a directory of translated <acronym title="Gettext Portable Object">PO</acronym> files and creates a single <acronym title="Gettext Portable Object">PO</acronym> files called a +<acronym title="Gettext Portable Object">PO</acronym> compendium. This compendium can be used to review word choice conflicts or +as input during a merge using <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a>. +</p> + +</div> +<!-- SECTION "pocompendium" [1-235] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> + +<p> + +GNU Gettext: +</p> +<ul> +<li class="level1"><div class="li"> <a href="http://man.cx/msgsttrib" class="interwiki iw_man" title="http://man.cx/msgsttrib">msgsttrib</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://man.cx/msgcat" class="interwiki iw_man" title="http://man.cx/msgcat">msgcat</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://man.cx/msghack" class="interwiki iw_man" title="http://man.cx/msghack">msghack</a> (may not be present on your installation of Gettext, but is only required for the invert command)</div> +</li> +<li class="level1"><div class="li"> <a href="http://man.cx/msgfilter" class="interwiki iw_man" title="http://man.cx/msgfilter">msgfilter</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Prerequisites" [236-461] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">pocompendium [options] output.po <-d po-directory(ies)|po-file(s)></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> output.po </td><td class="col1 leftalign"> the name of the output <acronym title="Gettext Portable Object">PO</acronym> compendium </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> po-directory(ies) </td><td class="col1 leftalign"> one or more directories to use as input for the compendium </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> po-file(s) </td><td class="col1 leftalign"> one or more <acronym title="Gettext Portable Object">PO</acronym> files to use as input for the compendium </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> -v, --invert </td><td class="col1 leftalign"> swap the msgid and msgstr in the input <acronym title="Gettext Portable Object">PO</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -e, --errors </td><td class="col1 leftalign"> only return those msg blocks that have conflicts </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> -i, --ignore-case </td><td class="col1 leftalign"> drops all msgstr's to lowercase </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> -st, -tilde, --strip-accel-amp </td><td class="col1 leftalign"> remove all & style accelerator markers </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> -sa, -amp, --strip-accel-tilde </td><td class="col1 leftalign"> remove all ~ style accelerator markers </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -su, --strip-accel-under </td><td class="col1 leftalign"> remove all _ style accelerator markers </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [462-1260] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<ol> +<li class="level1"><div class="li"> <em>Compendium creation</em> --- create a compendium with all your translations to use as input during a message merge either when migrating an existing project or starting a new one.</div> +</li> +<li class="level1"><div class="li"> <em>Conflicting translations</em> --- use <em>- -errors</em> to find where you have translated an English string differently. Many times this is OK but often it will pick up subtle spelling mistakes or help you to migrate older translations to a newer choice of words</div> +</li> +<li class="level1"><div class="li"> <em>Conflicting word choice</em> --- use <em>- -invert</em> and <em>- -errors</em> to get a compendium file that show how you have used a translated word for different English words. You might have chosen a word that is valid for both of the English expressions but that in the context of computers would cause confusion for the user. You can now easily identify these words and make changes in the underlying translations.</div> +</li> +</ol> + +</div> +<!-- SECTION "Examples" [1261-2144] --> +<h2><a name="narrowing_results" id="narrowing_results">Narrowing Results</a></h2> +<div class="level2"> + +<p> + +<acronym title="Gettext Portable Object">PO</acronym> files treat slight changes in capitalisation, accelerator, punctuation and +whitespace as different translations. In cases 2) and 3) above it is sometimes +useful to remove the inconsistencies so that you can focus on the errors in +translation not on shifts in capitals. To this end you can use the following: + <em>--ignore-case</em>, <em>--strip-accel-amp</em>, <em>--strip-accel-tilde</em>, <em>--strip-accel-under</em> +</p> + +</div> +<!-- SECTION "Narrowing Results" [2145-2581] --> +<h2><a name="operation" id="operation">Operation</a></h2> +<div class="level2"> + +<p> + +pocompendium makes use of the Gettext tool msgcat to perform its task. It +traverses the <acronym title="Gettext Portable Object">PO</acronym> directories and cat's all found <acronym title="Gettext Portable Object">PO</acronym> files into the single +compendium output file. It then uses msgattrib to extract only certain messages, msghack to +invert messages and msgfilter to convert messages to lowercase. +</p> + +</div> +<!-- SECTION "Operation" [2582-2912] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +There are some absolute/relative path name issues + +</p> + +</div> +<!-- SECTION "Bugs" [2913-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocompile.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocompile.html new file mode 100644 index 0000000..bae6027 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocompile.html @@ -0,0 +1,122 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pocompile" id="pocompile">pocompile</a></h1> +<div class="level1"> + +<p> + +Compile <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files into <acronym title="Gettext Machine Object">MO</acronym> (Machine Object) files. <acronym title="Gettext Machine Object">MO</acronym> files are installed on your computer and +allow a Gettext enabled computer to provide the translations for the application. +</p> + +</div> +<!-- SECTION "pocompile" [1-211] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">pocompile <po> <mo></pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <po/xliff> </td><td class="col1"> is a standard <acronym title="Gettext Portable Object">PO</acronym> file, <acronym title="XML Localization Interchange File Format">XLIFF</acronym> file or directory </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <mo> </td><td class="col1"> is the output <acronym title="Gettext Machine Object">MO</acronym> file or directory of <acronym title="Gettext Machine Object">MO</acronym> files </td> + </tr> +</table> + +<p> + +Options: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in xlf, po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in mo format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [212-1233] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">pocompile --fuzzy file.po file.mo</pre> + +<p> + +Creates a new <acronym title="Gettext Machine Object">MO</acronym> file called <em>file.mo</em> based on the translation in the <acronym title="Gettext Portable Object">PO</acronym> file <em>file.po</em>. By using the <em>--fuzzy</em> +option we use all translations including those marked fuzzy. +</p> +<pre class="code">pocompile file.xlf file.mo</pre> + +<p> + +Create an <acronym title="Gettext Machine Object">MO</acronym> file from an <acronym title="XML Localization Interchange File Format">XLIFF</acronym> file called <em>file.xlf</em> (available from version 1.1 of the toolkit). +</p> + +</div> +<!-- SECTION "Examples" [1234-1610] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +Gettext plurals and msgctxt are not handled before version 1.1 of the toolkit. +</p> + +<p> +The .mo implementation does not support Gettext hash tables. + +</p> + +</div> +<!-- SECTION "Bugs" [1611-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-poconflict.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poconflict.html new file mode 100644 index 0000000..54855b6 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poconflict.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/poconflicts" class="wikilink1" title="toolkit:poconflicts">poconflicts</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-poconflicts.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poconflicts.html new file mode 100644 index 0000000..0806838 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poconflicts.html @@ -0,0 +1,154 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="poconflicts" id="poconflicts">poconflicts</a></h1> +<div class="level1"> + +<p> + +poconflicts takes a <acronym title="Gettext Portable Object">PO</acronym> file and creates an set of output <acronym title="Gettext Portable Object">PO</acronym> files that contain messages that conflict. During any translation project that involves a large amount of work or a number of translators you will see message conflicts. A conflict is where the same English message has been translated differently (in some languages this may have been intentional). Conflicts occur due to different translation style or a shift in translations as the translators or project mature. +</p> + +<p> +poconflicts allows you to quickly identify these problem messages, investigate and correct them. To merge the files back, they have to be restructured into the correct directory structure using <a href="toolkit-porestructure.html" class="wikilink1" title="toolkit-porestructure.html">porestructure</a> in order to enable merging using <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a>. +</p> + +</div> +<!-- SECTION "poconflicts" [1-766] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">poconflicts [options] <po> <conflicts></pre> + +<p> + +Where: +</p> +<ul> +<li class="level1"><div class="li"> <po> -- is a directory of existing <acronym title="Gettext Portable Object">PO</acronym> files or an individual <acronym title="Gettext Portable Object">PO</acronym> file</div> +</li> +<li class="level1"><div class="li"> <conflicts> -- is a directory containing one <acronym title="Gettext Portable Object">PO</acronym> file for each conflict</div> +</li> +</ul> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -I, --ignore-case </td><td class="col1 leftalign"> ignore case distinctions </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -v, --invert </td><td class="col1 leftalign"> invert the conflicts thus extracting conflicting destination words </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> <a href="toolkit-accelerator_accelerator.html" class="wikilink1" title="toolkit-accelerator_accelerator.html">--accelerator=ACCELERATORS</a> </td><td class="col1 leftalign"> ignores the given accelerator characters when matching </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [767-1939] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +Here are some examples that demonstrate the usefulness of poconflict + +</p> +<pre class="code">poconflicts --accelerator=~ -I xhosa conflicts</pre> + +<p> + +This extracts messages from the <acronym title="Gettext Portable Object">PO</acronym> files in the <em>xhosa</em> directory and places a new <acronym title="Gettext Portable Object">PO</acronym> file for each identified conflict in <em>conflicts</em>. We are working with <a href="openoffice.org.html" class="wikilink2" title="openoffice.org.html">openoffice.org</a> files and we therefore use the tilde (<em>~</em>) as the accelerator marker (with this set <em>F~ile</em> is considered the same as <em>~File</em>). We are also ignoring the case of the message using <em>-I</em> (thus <em>File</em> is considered the same as <em>file</em> or <em>FILE</em>) +</p> + +<p> +Another useful option is to look at the inverted conflicts. This will detect target words that have been used to translate different source words. + +</p> +<pre class="code">poconflicts --accelerator=~ -I -v xhosa conflicts</pre> + +<p> + +Now in the <em>conflicts</em> directory we will find <acronym title="Gettext Portable Object">PO</acronym> files based on the Xhosa word. We can now check where a Xhosa word has been used for different +source or English words. Often there is no problem but you might find cases where the same Xhosa word was used for Delete and Cancel -- clearly a +usability issue. +</p> + +<p> +The translator makes the needed corrections to the files and then we can proceed to merge the results back into the <acronym title="Gettext Portable Object">PO</acronym> files. Unchanged entries can be removed. +</p> + +<p> +Now restructure the files to resemble the original directory structure using <a href="toolkit-porestructure.html" class="wikilink1" title="toolkit-porestructure.html">porestructure</a>: + +</p> +<pre class="code">porestructure -i conflicts -o conflicts_tree</pre> + +<p> + +Now merge the changes back using pomerge: + +</p> +<pre class="code">pomerge -t xhosa -i conflicts_tree -o xhosa</pre> + +<p> + +This takes the corrected files from <em>conflicts_tree</em> and merge them into the files in <em>xhosa</em> using the same files as templates. +</p> + +</div> +<!-- SECTION "Examples" [1940-3565] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None Known + +</p> + +</div> +<!-- SECTION "Bugs" [3566-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocount.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocount.html new file mode 100644 index 0000000..0d628bb --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pocount.html @@ -0,0 +1,107 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pocount" id="pocount">pocount</a></h1> +<div class="level1"> + +<p> + +pocount will count the number of strings and words in translatable files. +</p> + +<p> +Supported formates include: <acronym title="Gettext Portable Object">PO</acronym> and <acronym title="XML Localization Interchange File Format">XLIFF</acronym>. Almost all bilingual file formats supported by the Translate Toolkit will work with pocount, including: <a href="toolkit-tmx.html" class="wikilink1" title="toolkit-tmx.html">TMX</a>, <a href="toolkit-tbx.html" class="wikilink1" title="toolkit-tbx.html">TBX</a>, <a href="toolkit-mo.html" class="wikilink1" title="toolkit-mo.html">.mo</a>, <a href="toolkit-qm.html" class="wikilink1" title="toolkit-qm.html">.qm</a>, <a href="toolkit-wordfast.html" class="wikilink1" title="toolkit-wordfast.html">Wordfast</a> .txt. +</p> + +<p> +A number of other <a href="toolkit-formats.html" class="wikilink1" title="toolkit-formats.html">formats</a> should be countable as the toolkit develops. Note that only multilingual formats based the storage <a href="toolkit-base_classes.html" class="wikilink1" title="toolkit-base_classes.html">base class</a> are supported, but that includes almost all storage formats. +</p> + +</div> +<!-- SECTION "pocount" [1-522] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">pocount [--csv] [directory|file(s)]</pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <blank> </td><td class="col1 leftalign"> will recurse through all files from the current directory </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> directory </td><td class="col1 leftalign"> will recurse and count all files in the specified directory </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> file(s) </td><td class="col1 leftalign"> will count all files specified </td> + </tr> +</table> + +<p> + +Options: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --csv </td><td class="col1 leftalign"> changes the output format to <acronym title="Comma Seperated Value">CSV</acronym> (Comma Separated Values) for import into a spreadsheet </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [523-907] --> +<h2><a name="output" id="output">Output</a></h2> +<div class="level2"> + +<p> + +In normal mode the following output is given: +</p> +<pre class="code">avmedia/source/viewer.po +type strings words (source) words (translation) +translated: 1 3 3 +fuzzy: 0 0 n/a +untranslated: 4 22 n/a +Total: 5 25 3 +review 1 3 n/a</pre> + +<p> + +In <acronym title="Comma Seperated Value">CSV</acronym> mode the following output is shown: +</p> +<pre class="code">Filename, Translated Messages, Translated Source Words, Translated Target Words, Fuzzy Messages, Fuzzy Source Words, Untranslated Messages, Untranslated Source Words, Review Messages, Review Source Words +avmedia/source/viewer.po, 1, 3, 3, 0, 0, 4, 22, 1, 3</pre> + +<p> + +Totals are not provided in <acronym title="Comma Seperated Value">CSV</acronym> mode. In normal mode a grand total and file count is provided if the number of files is greater than one. +</p> + +</div> +<!-- SECTION "Output" [908-1752] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> There are some miscounts related to word breaks.</div> +</li> +</ul> + +</div> +<!-- SECTION "Bugs" [1753-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-podebug.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-podebug.html new file mode 100644 index 0000000..a492f5a --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-podebug.html @@ -0,0 +1,229 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="podebug" id="podebug">podebug</a></h1> +<div class="level1"> + +<p> + +Insert <a href="http://en.wikipedia.org/wiki/pseudo-translation" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/pseudo-translation">pseudo-translations</a> (also called <a href="http://en.wikipedia.org/wiki/pseudolocalization" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/pseudolocalization">pseudolocalization</a>) or debug markers into target text in <acronym title="XML Localization Interchange File Format">XLIFF</acronym>, Gettex <acronym title="Gettext Portable Object">PO</acronym> and other localization files. +</p> + +<p> +The pseudo translation or debig markers make it easy to reference and locate strings when your translated application is running. +</p> + +<p> +Use it to: +</p> +<ul> +<li class="level1"><div class="li"> Target your translations: see what files are being referenced for string appearing in your programs.</div> +</li> +<li class="level1"><div class="li"> Debug translations: if you know in what file the message occurs then you can quickly find it and fix it.</div> +</li> +<li class="level1"><div class="li"> Check that everything is translatable: any English only text needs to be analysed so that it can be localised.</div> +</li> +<li class="level1"><div class="li"> Check for Unicode compliance: by inserting Unicode text outside of the Latin range it allows you to check that your program can handle non-Latin correctly.</div> +</li> +</ul> + +</div> +<!-- SECTION "podebug" [1-839] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">podebug [options] [-f format] <in> <out></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> -f </td><td class="col1 leftalign"> is an optional format strings </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <in> </td><td class="col1 leftalign"> is an input directory or localisation file file </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> <out> </td><td class="col1 leftalign"> is an output directory or localisation file, if missing output will be to standard out. </td> + </tr> +</table> + +<p> + +Options: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -fFORMAT, --format=FORMAT </td><td class="col1 leftalign"> specify format string </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> <a href="toolkit-rewrite_style.html" class="wikilink1" title="toolkit-rewrite_style.html">--rewrite=STYLE</a> </td><td class="col1"> the translation rewrite style: xxx, en, blank, chef (v1.2), unicode (v1.2) </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> --ignore=APPLICATION </td><td class="col1 leftalign"> apply tagging ignore rules for the given application: kde, gtk, openoffice, mozilla (v1.1.1) </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> --hash=LENGTH </td><td class="col1"> add an md5 hash to translations (v1.1) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [840-2274] --> +<h2><a name="formats" id="formats">Formats</a></h2> +<div class="level2"> + +<p> + +A format string can have these various options: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"> f </td><td class="col1 leftalign"> full filename including directory </td> + </tr> + <tr class="row1"> + <td class="col0"> F </td><td class="col1 leftalign"> as %f but with .po file extension </td> + </tr> + <tr class="row2"> + <td class="col0"> b </td><td class="col1 leftalign"> base of filename </td> + </tr> + <tr class="row3"> + <td class="col0"> B </td><td class="col1 leftalign"> base of filename with .po file extension </td> + </tr> + <tr class="row4"> + <td class="col0"> d </td><td class="col1 leftalign"> directory name </td> + </tr> + <tr class="row5"> + <td class="col0"> s </td><td class="col1 leftalign"> preset OpenOffice.org modifier </td> + </tr> + <tr class="row6"> + <td class="col0"> c </td><td class="col1 leftalign"> use only consonants </td> + </tr> + <tr class="row7"> + <td class="col0"> N </td><td class="col1 leftalign"> a set number of characters </td> + </tr> +</table> + +<p> + +A format string may look like this: + +</p> +<ul> +<li class="level1"><div class="li"> ”%cf” - the full filename without vowels</div> +</li> +<li class="level1"><div class="li"> ”[%10cb] ” - the first ten character after compressing the base of the filename and place it in square brackets with a space before the real message</div> +</li> +<li class="level1"><div class="li"> ”[%5cd - %cB] ” - the first 5 consonants of the directory, followed by a dash then the consonants of the filename with a .po extension. All surrounded by square brackets with a space before the translations.</div> +</li> +</ul> + +<p> + +Complex format strings may make it too difficult to actually read the translation, so you are probably best served using as short a string as possible. +</p> + +</div> +<!-- SECTION "Formats" [2275-3252] --> +<h2><a name="rewriting_style" id="rewriting_style">Rewriting (style)</a></h2> +<div class="level2"> + +<p> + +The rewriting options are designed to change the target text in various ways (c.f. the various <a href="toolkit-rewrite_style.html" class="wikilink1" title="toolkit-rewrite_style.html">rewriting styles</a> available). This is mostly valuable for debugging English text. The 'xxx' rewriter is useful in that it allows you to identify text that has not localisable as that text will lack the xxx characters. +</p> + +<p> +The 'en' rewriter can be used to prepare English hashed (see below) files for quickly finding strings that have spelling or other errors. It can also be used to create a translated English file which can then be used for other purposes such as British English translation. +</p> + +</div> +<!-- SECTION "Rewriting (style)" [3253-3892] --> +<h2><a name="ignoring_messages" id="ignoring_messages">Ignoring messages</a></h2> +<div class="level2"> + +<p> + +In some applications their are translations that should not be translated (usually these are configuration options). If you do translate them then the application will fail to compile or run. +</p> + +<p> +The <code>--ignore</code> option allows you to specify the application for which you are producing <acronym title="Gettext Portable Object">PO</acronym> debug files. In this case it will then not mark certain of the <acronym title="Gettext Portable Object">PO</acronym> entries with debug messages. +</p> + +<p> +In Mozilla we do not mark lone <code>.accesskey</code>, <code>.width</code>, <code>.height</code>, etc since these can really be thought of as configuration options. +</p> + +</div> +<!-- SECTION "Ignoring messages" [3893-4447] --> +<h2><a name="hashing" id="hashing">Hashing</a></h2> +<div class="level2"> + +<p> + +Sometimes you find an error in a string. But it is difficult to search for the occurance of the error. In order to make +it easy to find a string in your files we can produce a hash on the strings location and other data. This produces +unique alphanumeric sequences which are prepended to the target text. Thus now in your application you have your translated +text and a alphanumeric value. Its is then easy to search for that value and find your problem string. +</p> + +</div> +<!-- SECTION "Hashing" [4448-4938] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +Marking exceptions are hard coded for OpenOffice.org. They should be configurable for any application. + +</p> + +</div> +<!-- SECTION "Bugs" [4939-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-poen.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poen.html new file mode 100644 index 0000000..8f797a8 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poen.html @@ -0,0 +1,100 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="poen" id="poen">poen</a></h1> +<div class="level1"> + +<p> + +<p><div class="notewarning"> +poen has been removed from Translate Toolkit > 1.2. Rather use <a href="toolkit-podebug.html" class="wikilink1" title="toolkit-podebug.html">podebug</a> as follows: + +</p> +<pre class="code"> +podebug --rewrite=en -f "" pot/ po/ +</pre> + +<p> + + +</div></p> +</p> + +<p> +Initialises a directory English <acronym title="Gettext Portable Object">PO</acronym> files by taking <acronym title="Gettext Portable Object Template">POT</acronym> files and copying the msgid to the msgstr. +</p> + +<p> +This is useful for translators who use CAT tools that overwrite/overtype existing text. They can setup their tool to overwrite msgstr entries which will now be in English. +</p> + +</div> +<!-- SECTION "poen" [1-458] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> + +<p> + +GNU Gettext +</p> + +</div> +<!-- SECTION "Prerequisites" [459-501] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">poen [options] <pot> <en></pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <pot> </td><td class="col1 leftalign"> a directory of <acronym title="Gettext Portable Object Template">POT</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <en> </td><td class="col1 leftalign"> a new directory that contains <acronym title="Gettext Portable Object">PO</acronym> files with English translations </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --no-wrap </td><td class="col1 leftalign"> do not break long message lines, longer than the output page width, into several lines </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> --po </td><td class="col1 leftalign"> process .po files instead of the default .pot files </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [502-861] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known + +</p> + +</div> +<!-- SECTION "Bugs" [862-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pofilter.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pofilter.html new file mode 100644 index 0000000..626ecae --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pofilter.html @@ -0,0 +1,209 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pofilter" id="pofilter">pofilter</a></h1> +<div class="level1"> + +<p> + +Pofilter allows you to run a <a href="toolkit-pofilter_tests.html" class="wikilink1" title="toolkit-pofilter_tests.html">number of checks</a> against your <acronym title="Gettext Portable Object">PO</acronym> files. These checks +are designed to pick up problems with capitalisation, accelerators, variables, etc. Those messages +that fail any of the checks are output and marked so that you can correct them. +</p> + +<p> +Use pofilter -l to get a list of available checks. +</p> + +<p> +Once you have corrected the errors in your <acronym title="Gettext Portable Object">PO</acronym> files you can merge the corrections into your existing translated <acronym title="Gettext Portable Object">PO</acronym> files using <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a>. +</p> + +</div> +<!-- SECTION "pofilter" [1-500] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">pofilter [options] <in> <out></pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <in> </td><td class="col1"> the input file or directory which contains <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <out> </td><td class="col1 leftalign"> the output file or directory that contains <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files that fail the various tests </td> + </tr> +</table> + +<p> + +Options: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1"> read from INPUT in pot, po, xlf formats (<acronym title="XML Localization Interchange File Format">XLIFF</acronym> since version 1.0) </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1"> write to OUTPUT in po, pot, xlf formats (<acronym title="XML Localization Interchange File Format">XLIFF</acronym> since version 1.0) </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation (set mode) </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -l, --listfilters </td><td class="col1 leftalign"> list filters available </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --review </td><td class="col1 leftalign"> include elements marked for review (default) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --noreview </td><td class="col1 leftalign"> exclude elements marked for review </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> include elements marked fuzzy (default) </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> exclude elements marked fuzzy </td> + </tr> + <tr class="row14"> + <td class="col0 leftalign"> --header </td><td class="col1 leftalign"> include a <acronym title="Gettext Portable Object">PO</acronym> header in the output </td> + </tr> + <tr class="row15"> + <td class="col0 leftalign"> --nonotes </td><td class="col1 leftalign"> don't add notes about the errors (since version 1.3) </td> + </tr> + <tr class="row16"> + <td class="col0 leftalign"> --autocorrect </td><td class="col1 leftalign"> output automatic corrections where possible rather than describing issues </td> + </tr> + <tr class="row17"> + <td class="col0 leftalign"> --language=LANG </td><td class="col1"> set target language code (e.g. af-ZA) [required for spell check]. This will help to make pofilter aware of the conventions of your language </td> + </tr> + <tr class="row18"> + <td class="col0 leftalign"> --openoffice </td><td class="col1 leftalign"> use the standard checks for OpenOffice translations </td> + </tr> + <tr class="row19"> + <td class="col0 leftalign"> --mozilla </td><td class="col1 leftalign"> use the standard checks for Mozilla translations </td> + </tr> + <tr class="row20"> + <td class="col0 leftalign"> --gnome </td><td class="col1 leftalign"> use the standard checks for Gnome translations </td> + </tr> + <tr class="row21"> + <td class="col0 leftalign"> --kde </td><td class="col1 leftalign"> use the standard checks for KDE translations </td> + </tr> + <tr class="row22"> + <td class="col0 leftalign"> --wx </td><td class="col1"> use the standard checks for wxWidgets translations (since version 1.1) - identical to --kde </td> + </tr> + <tr class="row23"> + <td class="col0 leftalign"> --excludefilter=FILTER </td><td class="col1 leftalign"> don't use FILTER when filtering </td> + </tr> + <tr class="row24"> + <td class="col0 leftalign"> -tFILTER, --test=FILTER </td><td class="col1 leftalign"> only use test FILTERs specified with this option when filtering </td> + </tr> + <tr class="row25"> + <td class="col0 leftalign"> --notranslatefile=FILE </td><td class="col1 leftalign"> read list of untranslatable words from FILE (must not be translated) </td> + </tr> + <tr class="row26"> + <td class="col0 leftalign"> --musttranslatefile=FILE </td><td class="col1 leftalign"> read list of translatable words from FILE (must be translated) </td> + </tr> + <tr class="row27"> + <td class="col0 leftalign"> --validcharsfile=FILE </td><td class="col1 leftalign"> read list of all valid characters from FILE (must be in UTF-8) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [501-3080] --> +<h2><a name="example" id="example">Example</a></h2> +<div class="level2"> + +<p> + +Here are some examples to demonstrate how to use pofilter: + +</p> +<pre class="code">pofilter --openoffice af af-check</pre> + +<p> + +Use the default settings (accelerator and variables) for OpenOffice.org. Check all <acronym title="Gettext Portable Object">PO</acronym> files in <em>af</em> and output any messages +that fail the check in <em>af-check</em> (create the directory if it does not already exist). + +</p> +<pre class="code">pofilter -t isfuzzy -t untranslated zu zu-check</pre> + +<p> + +Only run the <em>isfuzzy</em> and <em>untranslated</em> checks, this will extract all messages that are either fuzzy or untranslated. + +</p> +<pre class="code">pofilter --excludefilter=simplecaps --nofuzzy nso nso-check</pre> + +<p> + +Run all filters except <em>simplecaps</em>. You might want to do this if your language does not make use of capitalisation or if the test is +creating too many false positives. Also only run the checks against messages that are not marked fuzzy. This is useful if you +have already marked problem strings as fuzzy or you know that the fuzzy strings are bad, with this option you don't have to see the +obviously wrong messages. + +</p> +<pre class="code">pofilter --language=fr dir dir-check</pre> + +<p> + +Tell pofilter that you are checking French translations so that it can take the conventions of the language into account (for things like punctuation, spacing, quoting, etc.) It will also disable some tests that are not meaningful for your language, like capitalisation checks for languages that don't have capital letters. + +</p> +<pre class="code">pofilter -l</pre> + +<p> + +List all the available checks. +</p> + +</div> +<!-- SECTION "Example" [3081-4492] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +There are minor bugs in the filters. Most relate to false positives, corner cases or minor changes for better fault description. + +</p> + +</div> +<!-- SECTION "Bugs" [4493-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pofilter_tests.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pofilter_tests.html new file mode 100644 index 0000000..2ab495a --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pofilter_tests.html @@ -0,0 +1,800 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="descriptions_of_all_pofilter_tests" id="descriptions_of_all_pofilter_tests">Descriptions of all pofilter tests</a></h1> +<div class="level1"> + +<p> + +The following are descriptions of the tests available in <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> and Pootle with some +details about what type of errors they are useful to test for and the +limitations of each test. +</p> + +<p> +Keep in mind that the software might point to errors which are not necessarily wrong (false positives). +</p> + +<p> +Currently there are 47 tests. You can always get a list of the currently available tests by running: +</p> + +<p> +<code>pofilter -l</code> +</p> + +<p> +To see test specific to a specific targetted application or group of applications run: +</p> + +<p> +<code>pofilter --gnome -l</code> +</p> + +</div> +<!-- SECTION "Descriptions of all pofilter tests" [1-579] --> +<h2><a name="adding_new_tests_and_new_language_adaptations" id="adding_new_tests_and_new_language_adaptations">Adding new tests and new language adaptations</a></h2> +<div class="level2"> + +<p> + +If you have an idea for a new test or want to add target language adaptations for your language then please help us with information about your test idea and the specifics of your language. +</p> + +</div> +<!-- SECTION "Adding new tests and new language adaptations" [580-829] --> +<h2><a name="test_classification" id="test_classification">Test Classification</a></h2> +<div class="level2"> + +<p> + +Some tests are more important than others so we have classified them to help +you determine which to run first. + +</p> +<ul> +<li class="level1"><div class="li"> Critical -- can break a program</div> +<ul> +<li class="level2"><div class="li"> <a href="toolkit-pofilter_tests.html#accelerators" class="wikilink1" title="toolkit-pofilter_tests.html">accelerators</a>, <a href="toolkit-pofilter_tests.html#escapes" class="wikilink1" title="toolkit-pofilter_tests.html">escapes</a>, <a href="toolkit-pofilter_tests.html#newlines" class="wikilink1" title="toolkit-pofilter_tests.html">newlines</a>, <a href="toolkit-pofilter_tests.html#nplurals" class="wikilink1" title="toolkit-pofilter_tests.html">nplurals</a>, <a href="toolkit-pofilter_tests.html#printf" class="wikilink1" title="toolkit-pofilter_tests.html">printf</a>, <a href="toolkit-pofilter_tests.html#tabs" class="wikilink1" title="toolkit-pofilter_tests.html">tabs</a>, <a href="toolkit-pofilter_tests.html#variables" class="wikilink1" title="toolkit-pofilter_tests.html">variables</a>, <a href="toolkit-pofilter_tests.html#xmltags" class="wikilink1" title="toolkit-pofilter_tests.html">xmltags</a></div> +</li> +</ul> +</li> +</ul> +<ul> +<li class="level1"><div class="li"> Functional -- may confuse the user</div> +<ul> +<li class="level2"><div class="li"> <a href="toolkit-pofilter_tests.html#acronyms" class="wikilink1" title="toolkit-pofilter_tests.html">acronyms</a>, <a href="toolkit-pofilter_tests.html#blank" class="wikilink1" title="toolkit-pofilter_tests.html">blank</a>, <a href="toolkit-pofilter_tests.html#emails" class="wikilink1" title="toolkit-pofilter_tests.html">emails</a>, <a href="toolkit-pofilter_tests.html#filepaths" class="wikilink1" title="toolkit-pofilter_tests.html">filepaths</a>, <a href="toolkit-pofilter_tests.html#functions" class="wikilink1" title="toolkit-pofilter_tests.html">functions</a>, <a href="toolkit-pofilter_tests.html#gconf" class="wikilink1" title="toolkit-pofilter_tests.html">gconf</a>, <a href="toolkit-pofilter_tests.html#kdecomments" class="wikilink1" title="toolkit-pofilter_tests.html">kdecomments</a>, <a href="toolkit-pofilter_tests.html#long" class="wikilink1" title="toolkit-pofilter_tests.html">long</a>, <a href="toolkit-pofilter_tests.html#musttranslatewords" class="wikilink1" title="toolkit-pofilter_tests.html">musttranslatewords</a>, <a href="toolkit-pofilter_tests.html#notranslatewords" class="wikilink1" title="toolkit-pofilter_tests.html">notranslatewords</a>, <a href="toolkit-pofilter_tests.html#numbers" class="wikilink1" title="toolkit-pofilter_tests.html">numbers</a>, <a href="toolkit-pofilter_tests.html#options" class="wikilink1" title="toolkit-pofilter_tests.html">options</a> (v1.1), <a href="toolkit-pofilter_tests.html#purepunc" class="wikilink1" title="toolkit-pofilter_tests.html">purepunc</a>, <a href="toolkit-pofilter_tests.html#sentencecount" class="wikilink1" title="toolkit-pofilter_tests.html">sentencecount</a>, <a href="toolkit-pofilter_tests.html#short" class="wikilink1" title="toolkit-pofilter_tests.html">short</a>, <a href="toolkit-pofilter_tests.html#spellcheck" class="wikilink1" title="toolkit-pofilter_tests.html">spellcheck</a>, <a href="toolkit-pofilter_tests.html#urls" class="wikilink1" title="toolkit-pofilter_tests.html">urls</a>, <a href="toolkit-pofilter_tests.html#unchanged" class="wikilink1" title="toolkit-pofilter_tests.html">unchanged</a></div> +</li> +</ul> +</li> +</ul> +<ul> +<li class="level1"><div class="li"> Cosmetic -- make it look better</div> +<ul> +<li class="level2"><div class="li"> <a href="toolkit-pofilter_tests.html#brackets" class="wikilink1" title="toolkit-pofilter_tests.html">brackets</a>, <a href="toolkit-pofilter_tests.html#doublequoting" class="wikilink1" title="toolkit-pofilter_tests.html">doublequoting</a>, <a href="toolkit-pofilter_tests.html#doublespacing" class="wikilink1" title="toolkit-pofilter_tests.html">doublespacing</a>, <a href="toolkit-pofilter_tests.html#doublewords" class="wikilink1" title="toolkit-pofilter_tests.html">doublewords</a>, <a href="toolkit-pofilter_tests.html#endpunc" class="wikilink1" title="toolkit-pofilter_tests.html">endpunc</a>, <a href="toolkit-pofilter_tests.html#endwhitespace" class="wikilink1" title="toolkit-pofilter_tests.html">endwhitespace</a>, <a href="toolkit-pofilter_tests.html#puncspacing" class="wikilink1" title="toolkit-pofilter_tests.html">puncspacing</a>, <a href="toolkit-pofilter_tests.html#simplecaps" class="wikilink1" title="toolkit-pofilter_tests.html">simplecaps</a>, <a href="toolkit-pofilter_tests.html#simpleplurals" class="wikilink1" title="toolkit-pofilter_tests.html">simpleplurals</a>, <a href="toolkit-pofilter_tests.html#startcaps" class="wikilink1" title="toolkit-pofilter_tests.html">startcaps</a>, <a href="toolkit-pofilter_tests.html#singlequoting" class="wikilink1" title="toolkit-pofilter_tests.html">singlequoting</a>, <a href="toolkit-pofilter_tests.html#startpunc" class="wikilink1" title="toolkit-pofilter_tests.html">startpunc</a>, <a href="toolkit-pofilter_tests.html#startwhitespace" class="wikilink1" title="toolkit-pofilter_tests.html">startwhitespace</a>, <a href="toolkit-pofilter_tests.html#validchars" class="wikilink1" title="toolkit-pofilter_tests.html">validchars</a></div> +</li> +</ul> +</li> +</ul> +<ul> +<li class="level1"><div class="li"> Extraction -- useful mainly for extracting certain types of string</div> +<ul> +<li class="level2"><div class="li"> <a href="toolkit-pofilter_tests.html#compendiumconflicts" class="wikilink1" title="toolkit-pofilter_tests.html">compendiumconflicts</a>, <a href="toolkit-pofilter_tests.html#credits" class="wikilink1" title="toolkit-pofilter_tests.html">credits</a> (v1.1), <a href="toolkit-pofilter_tests.html#hassuggestion" class="wikilink1" title="toolkit-pofilter_tests.html">hassuggestion</a> (v1.1), <a href="toolkit-pofilter_tests.html#isfuzzy" class="wikilink1" title="toolkit-pofilter_tests.html">isfuzzy</a>, <a href="toolkit-pofilter_tests.html#isreview" class="wikilink1" title="toolkit-pofilter_tests.html">isreview</a>, <a href="toolkit-pofilter_tests.html#untranslated" class="wikilink1" title="toolkit-pofilter_tests.html">untranslated</a></div> +</li> +</ul> +</li> +</ul> + +</div> +<!-- SECTION "Test Classification" [830-2603] --> +<h2><a name="test_description" id="test_description">Test Description</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Test Description" [2604-2633] --> +<h3><a name="accelerators" id="accelerators">accelerators</a></h3> +<div class="level3"> + +<p> + +checks whether accelerators are consistent between the two strings. +</p> + +<p> +Make sure you use the --mozilla, --kde, etc options so that pofilter knows which type of accelerator it is looking for. The test will pick up accelerators that are missing and ones that shouldn't be there. +</p> + +</div> +<!-- SECTION "accelerators" [2634-2934] --> +<h3><a name="acronyms" id="acronyms">acronyms</a></h3> +<div class="level3"> + +<p> + +checks that acronyms that appear are unchanged +</p> + +<p> +If the acronym <acronym title="Uniform Resource Locator">URL</acronym> appears in the original this test will check that it appears in the translation. Translating acronyms is a language decision but many languages leave them unchanged in that case this test is useful for tracking down translations of the acronym and correcting them. +</p> + +</div> +<!-- SECTION "acronyms" [2935-3288] --> +<h3><a name="blank" id="blank">blank</a></h3> +<div class="level3"> + +<p> + +checks whether a translation is totally blank +</p> + +<p> +This will check to see if a translation has inadvertently been translated as blank ie as spaces. This is different from untranslated which is completely empty. This test is useful in that if something is translated as ” ” it will appear to most tools as if it is translated. +</p> + +</div> +<!-- SECTION "blank" [3289-3632] --> +<h3><a name="brackets" id="brackets">brackets</a></h3> +<div class="level3"> + +<p> + +checks that the number of brackets in both strings match +</p> + +<p> +If ([{ or }]) appear in the original this will check that the same number appear in the translation. +</p> + +</div> +<!-- SECTION "brackets" [3633-3812] --> +<h3><a name="compendiumconflicts" id="compendiumconflicts">compendiumconflicts</a></h3> +<div class="level3"> + +<p> + +checks for Gettext compendium conflicts (#-#-#-#-#) +</p> + +<p> +When you use msgcat to create a <acronym title="Gettext Portable Object">PO</acronym> compendium it will insert #-#-#-#-# into entries that are not consistent. If the compendium is used later in a +message merge then these conflicts will appear in your translations. This test quickly extracts those for correction. +</p> + +</div> +<!-- SECTION "compendiumconflicts" [3813-4163] --> +<h3><a name="credits" id="credits">credits</a></h3> +<div class="level3"> + +<p> + +checks for messages containing translation credits instead of normal translations. +</p> + +<p> +Some projects have consistent ways of giving credit to translators by having a unit or two where translators can fill in their name and possibly their contact details. This test allows you to find these units easily to check that they are completed correctly and also disables other tests that might incorrectly get triggered for these units (such as urls, emails, etc.) +</p> + +</div> +<!-- SECTION "credits" [4164-4638] --> +<h3><a name="doublequoting" id="doublequoting">doublequoting</a></h3> +<div class="level3"> + +<p> + +checks whether doublequoting is consistent between the two strings +</p> + +<p> +Checks on double quotes ” to ensure that you have the same number in both the original and the translated string. +</p> + +</div> +<!-- SECTION "doublequoting" [4639-4846] --> +<h3><a name="doublespacing" id="doublespacing">doublespacing</a></h3> +<div class="level3"> + +<p> + +checks for bad double-spaces by comparing to original +</p> + +<p> +This will identify if you have [space][space] in when you don't have it in the original or it appears in the original but not in your translation. Some of these are spurious and how you correct them depends on the conventions of your language. +</p> + +</div> +<!-- SECTION "doublespacing" [4847-5171] --> +<h3><a name="doublewords" id="doublewords">doublewords</a></h3> +<div class="level3"> + +<p> + +checks for repeated words in the translation +</p> + +<p> +Words that have been repeated in a translation will be highlighted with this test e.g. “the the”, “a a”. These are generally typos that need correcting. Some languages may have valid repeated words in their structure, in that case either ignore those instances or switch this test off using the --excludefilters option. +</p> + +</div> +<!-- SECTION "doublewords" [5172-5564] --> +<h3><a name="emails" id="emails">emails</a></h3> +<div class="level3"> + +<p> + +checks to see that emails are not translated +</p> + +<p> +Generally you should not be translating email addresses. This check will look to see that email addresses e.g. info@example.com are not translated. In some cases of course you should translate the address but generally you shouldn't. +</p> + +</div> +<!-- SECTION "emails" [5565-5865] --> +<h3><a name="endpunc" id="endpunc">endpunc</a></h3> +<div class="level3"> + +<p> + +checks whether punctuation at the end of the strings match +</p> + +<p> +This will ensure that the ending of your translation has the same punctuation as the original. E.g. if it ends in :[space] then so should yours. It is useful for ensuring that you have ellipses […] in all your translations, not simply three separate full-stops. You may pick up some errors in the original: feel free to keep your translation and notify the programmers. In some languages, characters such as ? ! are always preceded by a space e.g. [space]? — do what your language customs dictate. Other false positives you will notice are, for example, if through changes in word-order you add ”), etc. at the end of the sentence. Do not change these: your language word-order takes precedence. +</p> + +<p> +It must be noted that if you are tempted to leave out [full-stop] or [colon] or add [full-stop] to a sentence, that often these have been done for a reason, e.g. a list where fullstops make it look cluttered. So, initially match them with the English, and make changes once the program is being used. +</p> + +</div> +<!-- SECTION "endpunc" [5866-6951] --> +<h3><a name="endwhitespace" id="endwhitespace">endwhitespace</a></h3> +<div class="level3"> + +<p> + +checks whether whitespace at the end of the strings matches +</p> + +<p> +Operates the same as endpunc but is only concerned with whitespace. This filter is particularly useful for those strings which will evidently be followed by another string in the program, e.g. [Password: ] or [Enter your username: ]. The whitespace is an inherent part of the string. This filter makes sure you don't miss those important but otherwise invisible spaces! +</p> + +</div> +<!-- SECTION "endwhitespace" [6952-7408] --> +<h3><a name="escapes" id="escapes">escapes</a></h3> +<div class="level3"> + +<p> + +checks whether escaping is consistent between the two strings +</p> + +<p> +Checks escapes such as <code>\n</code> <code>\uNNNN</code> to ensure that if they exist in the original that you have them in the translation. +</p> + +</div> +<!-- SECTION "escapes" [7409-7616] --> +<h3><a name="filepaths" id="filepaths">filepaths</a></h3> +<div class="level3"> + +<p> + +checks that file paths have not been translated +</p> + +<p> +Checks that paths such as <code>/home/user1</code> have not been translated. Generally you do not translate a file-path, unless it is being used as an example, e.g. [your_user_name/path/to/filename.conf]. +</p> + +</div> +<!-- SECTION "filepaths" [7617-7884] --> +<h3><a name="functions" id="functions">functions</a></h3> +<div class="level3"> + +<p> + +checks to see that function names are not translated +</p> + +<p> +Checks that function names eg. <code>rgb()</code> or <code>getEntity.Name()</code> are not translated. +</p> + +</div> +<!-- SECTION "functions" [7885-8045] --> +<h3><a name="gconf" id="gconf">gconf</a></h3> +<div class="level3"> + +<p> + +Checks if we have any gconf config settings translated +</p> + +<p> +Gconf settings should not be translated so this check checks that gconf settings such as “name” or “modification_date” are not translated in the translation. It allows you to change the surrounding quotes but will ensure that the setting values remain untranslated. +</p> + +</div> +<!-- SECTION "gconf" [8046-8386] --> +<h3><a name="hassuggestion" id="hassuggestion">hassuggestion</a></h3> +<div class="level3"> + +<p> + +Checks if there is at least one suggested translation for this unit +</p> + +<p> +If a message has a suggestion (an alternate translation stored in alt-trans units in <acronym title="XML Localization Interchange File Format">XLIFF</acronym> and .pending files in <acronym title="Gettext Portable Object">PO</acronym>) then these will be extracted. This is used by Pootle and is probably only useful in pofilter when using <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files. +</p> + +</div> +<!-- SECTION "hassuggestion" [8387-8716] --> +<h3><a name="isfuzzy" id="isfuzzy">isfuzzy</a></h3> +<div class="level3"> + +<p> + +check if the po element has been marked fuzzy +</p> + +<p> +If a message is marked fuzzy in the <acronym title="Gettext Portable Object">PO</acronym> file then it is extracted. Note this is different from --fuzzy and --nofuzzy options which specify whether tests should be performed against messages marked fuzzy +</p> + +</div> +<!-- SECTION "isfuzzy" [8717-8986] --> +<h3><a name="isreview" id="isreview">isreview</a></h3> +<div class="level3"> + +<p> + +check if the po element has been marked review +</p> + +<p> +If you have made use of the 'review' flags in your translations: + +</p> +<pre class="code"># (review) reason for review +# (pofilter) testname: explanation for translator</pre> + +<p> + +Then if a message is marked for review in the <acronym title="Gettext Portable Object">PO</acronym> file it will be extracted. Note this is different from --review and --noreview options which specify whether tests should be performed against messages already marked as under review. +</p> + +</div> +<!-- SECTION "isreview" [8987-9438] --> +<h3><a name="kdecomments" id="kdecomments">kdecomments</a></h3> +<div class="level3"> + +<p> + +checks to ensure that no KDE style comments appear in the translation +</p> + +<p> +KDE style translator comments appear in <acronym title="Gettext Portable Object">PO</acronym> files as “_: comment\n”. New translators often translate the comment. This test tries to identify instances where the comment has been translated. +</p> + +</div> +<!-- SECTION "kdecomments" [9439-9724] --> +<h3><a name="long" id="long">long</a></h3> +<div class="level3"> + +<p> + +checks whether a translation is much longer than the original string +</p> + +<p> +This is most useful in the special case where the translation is multiple characters long +while the source text is only 1 character long. Otherwise, we use a general ratio that +will catch very big differences but is set conservatively to limit the number of false positives. +</p> + +</div> +<!-- SECTION "long" [9725-10088] --> +<h3><a name="musttranslatewords" id="musttranslatewords">musttranslatewords</a></h3> +<div class="level3"> + +<p> + +checks that words configured as definitely translatable don't appear in the translation +</p> + +<p> +If for instance in your language you decide that you must translate 'OK' then this test will flag +any occurances of 'OK' in the translation if it appeared in the source string. You must specify a +file containing all of the <em>must translate</em> words using <em>--musttranslatefile</em>. +</p> + +</div> +<!-- SECTION "musttranslatewords" [10089-10489] --> +<h3><a name="newlines" id="newlines">newlines</a></h3> +<div class="level3"> + +<p> + +checks whether newlines are consistent between the two strings +</p> + +<p> +Counts the number of \n newlines (and variants such as \r\n) and reports and error if they differ. +</p> + +</div> +<!-- SECTION "newlines" [10490-10673] --> +<h3><a name="nplurals" id="nplurals">nplurals</a></h3> +<div class="level3"> + +<p> + +checks for the correct number of noun forms for plural translations. +</p> + +<p> +This uses the plural information in the language module of the toolkit. This is the same as the Gettext nplural value. It will check that the number of plurals required is the same as the number supplied in your translation. +</p> + +</div> +<!-- SECTION "nplurals" [10674-10991] --> +<h3><a name="notranslatewords" id="notranslatewords">notranslatewords</a></h3> +<div class="level3"> + +<p> + +checks that words configured as untranslatable appear in the translation too +</p> + +<p> +Many brand names should not be translated, this test allows you to easily make sure that words like: Word, Excel, Impress, Calc, +etc. are not translated. You must specify a file containing all of the <em>no translate</em> words using <em>--notranslatefile</em>. +</p> + +</div> +<!-- SECTION "notranslatewords" [10992-11352] --> +<h3><a name="numbers" id="numbers">numbers</a></h3> +<div class="level3"> + +<p> + +checks whether numbers of various forms are consistent between the two strings +</p> + +<p> +You will see some errors where you have either written the number in full or converted it to the digit in your translation. Also changes in order will trigger this error. +</p> + +</div> +<!-- SECTION "numbers" [11353-11625] --> +<h3><a name="options" id="options">options</a></h3> +<div class="level3"> + +<p> + +checks that options are not translated +</p> + +<p> +In messages that contain command line options, such as '--help', this test will check that these remain untranslated. These could be translated in the future if programs can create a mechanism to allow this, but currently they are not translated. If the options has a parameter, e.g. '--file=FILE', then the test will check that the parameter has been translated. +</p> + +</div> +<!-- SECTION "options" [11626-12052] --> +<h3><a name="printf" id="printf">printf</a></h3> +<div class="level3"> + +<p> + +checks whether printf format strings match +</p> + +<p> +If the printf formatting variables are not identical, then this will indicate an error. Prinf statements are used by programs to format output in a human readable form (they are place holders for variable data). They allow you to specify lengths of string variables, string padding, number padding, precision, etc. (See <a href="http://en.wikipedia.org/wiki/Printf" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Printf">Printf</a> for more details). Generally they will look like this: %d, %5.2f, %100s, etc. The test can also manage variables-reordering using the %1$s syntax. The variables' type and details following data are tested to ensure that they are strictly identical, but they may be reordered. +</p> + +</div> +<!-- SECTION "printf" [12053-12729] --> +<h3><a name="puncspacing" id="puncspacing">puncspacing</a></h3> +<div class="level3"> + +<p> + +checks for bad spacing after punctuation +</p> + +<p> +In the case of [full-stop][space] in the original, this test checks that your translation does not remove the space. It checks also for [comma], [colon], etc. +</p> + +</div> +<!-- SECTION "puncspacing" [12730-12955] --> +<h3><a name="purepunc" id="purepunc">purepunc</a></h3> +<div class="level3"> + +<p> + +checks that strings that are purely punctuation are not changed +</p> + +<p> +This extracts strings like ”+” or ”-” as these usually should not be changed. +</p> + +</div> +<!-- SECTION "purepunc" [12956-13119] --> +<h3><a name="sentencecount" id="sentencecount">sentencecount</a></h3> +<div class="level3"> + +<p> + +checks that the number of sentences in both strings match +</p> + +<p> +Adds the number of fullstops to see that the sentence count is the same between the original and translated string. You may not always want to use this test, if you find you often need to reformat your translation, because the original is badly-expressed, or because the structure of your language works better that way. Do what works best for your language: it's the sense of the original you want to convey, not every dot and p or q. +</p> + +</div> +<!-- SECTION "sentencecount" [13120-13640] --> +<h3><a name="short" id="short">short</a></h3> +<div class="level3"> + +<p> + +checks whether a translation is much shorter than the original string +</p> + +<p> +This is most useful in the special case where the translation is 1 characters long +while the source text is multiple characters long. Otherwise, we use a general ratio that +will catch very big differences but is set conservatively to limit the number of false positives. +</p> + +</div> +<!-- SECTION "short" [13641-14002] --> +<h3><a name="simplecaps" id="simplecaps">simplecaps</a></h3> +<div class="level3"> + +<p> + +checks the capitalisation of two strings isn't wildly different +</p> + +<p> +This will pick up many false positives, so don't be a slave to it. It is useful for identifying translations that don't start with a capital letter (upper-case letter) when they should, or those that do when they shouldn't. It will also highlight sentences that have extra capitals; depending on the capitalisation convention of your language, you might want to change these to Title Case, or change them all to normal sentence case. +</p> + +</div> +<!-- SECTION "simplecaps" [14003-14526] --> +<h3><a name="simpleplurals" id="simpleplurals">simpleplurals</a></h3> +<div class="level3"> + +<p> + +checks for English style plural(s) for you to review +</p> + +<p> +This test will extract any message that contains words with a final ”(s)” in the source text. You can then inspect the message, +to check that the correct <a href="l10n-pluralforms.html" class="wikilink1" title="l10n-pluralforms.html">plural form</a> has been used for your language. In some languages, plurals are made by adding +text at the beginning of words, making the English style messy. In this case, they often revert to the plural form. +This test allows an editor to check that the plurals used are correct. Be aware that this test may create a number of false positives. +</p> + +</div> +<!-- SECTION "simpleplurals" [14527-15128] --> +<h3><a name="singlequoting" id="singlequoting">singlequoting</a></h3> +<div class="level3"> + +<p> + +checks whether singlequoting is consistent between the two strings +</p> + +<p> +The same as doublequoting but checks for the ' character. Because this is used in contractions like it's and in possessive forms like user's, this test can output spurious errors if your language doesn't use such forms. If a quote appears at the end of a sentence in the translation, i.e. '[full-stop], this might not be detected properly by the check. +</p> + +</div> +<!-- SECTION "singlequoting" [15129-15577] --> +<h3><a name="spellcheck" id="spellcheck">spellcheck</a></h3> +<div class="level3"> + +<p> + +checks for words that don't pass a spell-check +</p> + +<p> +This test will check for for misspelled words in your translation. The test first checks for misspelled words in the original (usually English) text, and adds those to an +exclusion list. The advantage of this exclusion is that many words that are specific to the application will not raise errors e.g. program names, brand names, function names. +</p> + +<p> +The checker works with <a href="http://pyenchant.sourceforge.net/" class="urlextern" title="http://pyenchant.sourceforge.net/">PyEnchant</a>, failing that it works with <a href="http://jtoolkit.sourceforge.net/" class="urlextern" title="http://jtoolkit.sourceforge.net/">jToolkit's</a> spelling module. You will need to have one of these +installed for the checker to work. Plus, of course, a spell checker dictionary for your language (for example, one of <a href="http://ftp.gnu.org/gnu/aspell/dict/" class="urlextern" title="http://ftp.gnu.org/gnu/aspell/dict/">the aspell dictionaries</a>). This test will only work if you have specified the <em>--language</em> option. +</p> + +<p> +The pofilter error that is created lists the misspelled word, plus all the suggestions returned from the spell checker. That makes it easy for you to +identify the word and select a suggestion. +</p> + +</div> +<!-- SECTION "spellcheck" [15578-16651] --> +<h3><a name="startcaps" id="startcaps">startcaps</a></h3> +<div class="level3"> + +<p> + +checks that the message starts with the correct capitalisation +</p> + +<p> +After stripping whitespace and common punctuation characters, it then checks to see that the first remaining character is correctly capitalised. So, if the sentence starts with an upper-case letter, and the translation does not, an error is produced. This check does not <em>yet</em> consider locale information to determine which characters are considered to be upper-case in your locale. +</p> + +</div> +<!-- SECTION "startcaps" [16652-17124] --> +<h3><a name="startpunc" id="startpunc">startpunc</a></h3> +<div class="level3"> + +<p> + +checks whether punctuation at the beginning of the strings match +</p> + +<p> +Operates as endpunc but you will probably see fewer errors. +</p> + +</div> +<!-- SECTION "startpunc" [17125-17272] --> +<h3><a name="startwhitespace" id="startwhitespace">startwhitespace</a></h3> +<div class="level3"> + +<p> + +checks whether whitespace at the beginning of the strings matches +</p> + +<p> +As in endwhitespace but you will see fewer errors. +</p> + +</div> +<!-- SECTION "startwhitespace" [17273-17418] --> +<h3><a name="tabs" id="tabs">tabs</a></h3> +<div class="level3"> + +<p> + +checks whether tabs are consistent between the two strings +</p> + +<p> +Counts the number of \t tab markers and reports an error if they differ. +</p> + +</div> +<!-- SECTION "tabs" [17419-17568] --> +<h3><a name="unchanged" id="unchanged">unchanged</a></h3> +<div class="level3"> + +<p> + +checks whether a translation is basically identical to the original string +</p> + +<p> +This checks to see if the translation isn't just a copy of the English original. Sometimes, this is what you want, but other times you will detect words that should have been translated. +</p> + +</div> +<!-- SECTION "unchanged" [17569-17854] --> +<h3><a name="untranslated" id="untranslated">untranslated</a></h3> +<div class="level3"> + +<p> + +checks whether a string has been translated at all +</p> + +<p> +This check is really only useful if you want to extract untranslated strings so that they can be translated independently of the main work. +</p> + +</div> +<!-- SECTION "untranslated" [17855-18071] --> +<h3><a name="urls" id="urls">urls</a></h3> +<div class="level3"> + +<p> + +checks to see that URLs are not translated +</p> + +<p> +This checks only basic URLs (http, ftp, mailto etc.) not all URIs (e.g. afp, smb, file). Generally, you don't want to translate URLs, unless they are example URLs (<a href="http://your_server.com/filename.html" class="urlextern" title="http://your_server.com/filename.html">http://your_server.com/filename.html</a>). If the <acronym title="Uniform Resource Locator">URL</acronym> is for configuration information, then you need to query the developers about placing config. information in <acronym title="Gettext Portable Object">PO</acronym> files. It shouldn't really be there, unless it is very clearly marked: such information should go into a configuration file. +</p> + +</div> +<!-- SECTION "urls" [18072-18586] --> +<h3><a name="validchars" id="validchars">validchars</a></h3> +<div class="level3"> + +<p> + +checks that only characters specified as valid appear in the translation +</p> + +<p> +Often during character conversion to and from UTF-8 you get some strange characters appearing in your translation. This test presents a simple +way to try and identify such errors. +</p> + +<p> +This test will only run of you specify the <code>--validcharsfile</code> command line option. This file contains all the characters that are valid in your language. You must use UTF-8 encoding for the characters in the file. +</p> + +<p> +If the test finds any characters not in your valid characters file then the test will print the character together with its Unicode value (e.g. 002B). +</p> + +</div> +<!-- SECTION "validchars" [18587-19235] --> +<h3><a name="variables" id="variables">variables</a></h3> +<div class="level3"> + +<p> + +checks whether variables of various forms are consistent between the two strings +</p> + +<p> +This checks to make sure that variables that appear in the original also appear in the translation. Make sure you use the --kde, --openoffice, etc flags as these define what variables will be searched for. It does not at the moment cope with variables that use the reordering syntax of Gettext <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +</div> +<!-- SECTION "variables" [19236-19646] --> +<h3><a name="xmltags" id="xmltags">xmltags</a></h3> +<div class="level3"> + +<p> + +checks that <acronym title="Extensible Markup Language">XML</acronym>/<acronym title="HyperText Markup Language">HTML</acronym> tags have not been translated +</p> + +<p> +This check finds the number of tags in the source string and checks that the same number are in the translation. If the counts don't match then either the tag is missing or it was mistakenly translated by the translator, both of which are errors. +</p> + +<p> +The check ignores tags or things that look like tags that cover the whole string eg ”<Error>” but will produce false positives for things like “An <Error> occurred” as here “Error” should be translated. It also will detect a translated alt tag in e.g. <img src=bob.png alt=“blah”> as an error when in fact it is correct. + +</p> + +</div> +<!-- SECTION "xmltags" [19647-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-poglossary.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poglossary.html new file mode 100644 index 0000000..4fa6ef8 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poglossary.html @@ -0,0 +1,96 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + +<p> +<p><div class="noteclassic">poglossary has been superseded by <a href="toolkit-poterminology.html" class="wikilink1" title="toolkit-poterminology.html">poterminology</a> +</div></p> +</p> + + + +<h1><a name="poglossary" id="poglossary">poglossary</a></h1> +<div class="level1"> + +<p> + +This tool takes a directory of translated <acronym title="Gettext Portable Object">PO</acronym> files and creates a single <acronym title="Gettext Portable Object">PO</acronym> file containing terms and / or phrases that can be used as a glossary. This compendium can be used to review word choice of a subset of words, and can be a useful start for a your <a href="pootle-terminology_matching.html" class="wikilink1" title="pootle-terminology_matching.html">terminology</a> in Pootle or many other offline editors. +</p> + +</div> +<!-- SECTION "poglossary" [67-436] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> + +<p> + +The Translate Toolkit +</p> + +<p> +GNU Gettext: +</p> +<ul> +<li class="level1"><div class="li"> <a href="http://man.cx/msgattrib" class="interwiki iw_man" title="http://man.cx/msgattrib">msgattrib</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://man.cx/msgcat" class="interwiki iw_man" title="http://man.cx/msgcat">msgcat</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://man.cx/msgfilter" class="interwiki iw_man" title="http://man.cx/msgfilter">msgfilter</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Prerequisites" [437-565] --> +<h2><a name="latest_version" id="latest_version">Latest version</a></h2> +<div class="level2"> + +<p> + +poglossary is not distributed with all versions of the toolkit. You can get the <a href="http://translate.svn.sourceforge.net/viewvc/*checkout*/translate/src//trunk/tools/poglossary" class="interwiki iw_svn" title="http://translate.svn.sourceforge.net/viewvc/*checkout*/translate/src//trunk/tools/poglossary">latest version from Subversion</a> +</p> + +</div> +<!-- SECTION "Latest version" [566-740] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">poglossary <language-iso-code> <input-dir> <project-name></pre> + +<p> +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> language-iso-code </td><td class="col1 leftalign"> the <a href="http://en.wikipedia.org/wiki/ISO%20639" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/ISO%20639">ISO 639</a> code for your language (eg AF for Afrikaans, EN for English, etc) </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> input-dir </td><td class="col1 leftalign"> the directory with <acronym title="Gettext Portable Object">PO</acronym> files from which you want to extract terms </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> project-name </td><td class="col1 leftalign"> the name of the project or domain from which you are extract terms </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [741-1128] --> +<h2><a name="operation" id="operation">Operation</a></h2> +<div class="level2"> + +<p> + +poglossary makes use of <a href="toolkit-pocompendium.html" class="wikilink1" title="toolkit-pocompendium.html">pocompendium</a> and some tools of the translate toolkit. It searches for all short terms and phrases in the <acronym title="Gettext Portable Object">PO</acronym> files from the input directory and combines it into one file. Output is given in <acronym title="Gettext Portable Object">PO</acronym>, <acronym title="Comma Seperated Value">CSV</acronym> and <acronym title="TermBase eXchange">TBX</acronym> formats. + +</p> + +</div> +<!-- SECTION "Operation" [1129-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pogrep.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pogrep.html new file mode 100644 index 0000000..47fa396 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pogrep.html @@ -0,0 +1,154 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pogrep" id="pogrep">pogrep</a></h1> +<div class="level1"> + +<p> + +The pogrep tool extracts messages that match a regular expression into a new set +of <acronym title="Gettext Portable Object">PO</acronym> files that can be examined, edited and corrected. These corrections can +then be merged using <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a>. +</p> + +</div> +<!-- SECTION "pogrep" [1-217] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">pogrep [options] <in> <out></pre> + +<p> + +Where: +</p> + +<p> +<em>In</em> and <em>out</em> are either directories or files. <em>Out</em> will contain <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="XML Localization Interchange File Format">XLIFF</acronym> files +with only those messages that match the regular expression that was you searched for. +</p> + +<p> +Options: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1"> read from INPUT in po, pot, xlf formats (<acronym title="XML Localization Interchange File Format">XLIFF</acronym> since version 1.0) </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1"> write to OUTPUT in po, pot, xlf formats (<acronym title="XML Localization Interchange File Format">XLIFF</acronym> since version 1.0) </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation (set mode) </td> + </tr> + <tr class="row9"> + <td class="col0"> --search=SEARCHPARTS </td><td class="col1 leftalign"> searches the given parts (source, target, notes, locations) </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -I, --ignore-case </td><td class="col1 leftalign"> ignore case distinctions </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> -e, --regexp </td><td class="col1 leftalign"> use regular expression matching </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> -v, --invert-match </td><td class="col1 leftalign"> select non-matching lines </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> <a href="toolkit-accelerator_accelerator.html" class="wikilink1" title="toolkit-accelerator_accelerator.html">--accelerator=ACCELERATOR</a> </td><td class="col1 leftalign"> ignores the given accelerator when matching </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [218-1541] --> +<h2><a name="example" id="example">Example</a></h2> +<div class="level2"> +<pre class="code">pogrep --accelerator="_" --search msgid -I -e "software|hardware" only-zu only-zu-check</pre> + +<p> + +Search for the words “software” or “hardware” in the msgid field. Ignore case +(-I) and treat the underscore (_) character as an accelerator key. Search +through all <acronym title="Gettext Portable Object">PO</acronym> files in the directory “only-zu” and place any matches in <acronym title="Gettext Portable Object">PO</acronym> +files in the directory “only-zu-check”. This would be useful to run if you know that +the word for software and hardware has been changed during the course of translation and +you want to check and correct all these instances. + +</p> +<pre class="code">pogrep --search=msgid -e '^\w+(\s+\w+){0,3}$' -i templates -o short-words</pre> + +<p> + +Find all messages in the <em>templates</em> directory that have between 1 and 4 words and place them +in <em>short-words</em>. Use this if you want to see quick results by translating messages that +are most likely menu entries or dialogue labels. + +</p> +<pre class="code">pogrep --search=msgstr -I -e "Ifayile" zu zu-check</pre> + +<p> + +Search all translations for the occurrence of <em>Ifayile</em>. You would use this to check if words have +been used correctly. Useful if you find problematic use of the same word for different concepts. +You can use <a href="toolkit-pocompendium.html" class="wikilink1" title="toolkit-pocompendium.html">pocompendium</a> to find these conflicts. +</p> + +</div> +<!-- SECTION "Example" [1542-2737] --> +<h2><a name="notes" id="notes">Notes</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Notes" [2738-2756] --> +<h3><a name="unicode_normalization" id="unicode_normalization">Unicode normalization</a></h3> +<div class="level3"> + +<p> + +pogrep will normalize Unicode strings (from v1.1). This allows you to search for strings that contain the same character but that are using precomposed Unicode characters or which are composed using another composition recipe. While an individual user will in all likelihood only compose characters in one way, normalization ensures that data created in a team setting can be shared. +</p> + +</div> +<!-- SECTION "Unicode normalization" [2757-3176] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known + +</p> + +</div> +<!-- SECTION "Bugs" [3177-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pomerge.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pomerge.html new file mode 100644 index 0000000..4676070 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pomerge.html @@ -0,0 +1,142 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pomerge" id="pomerge">pomerge</a></h1> +<div class="level1"> + +<p> + +Pomerge will merge corrected <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="XML Localization Interchange File Format">XLIFF</acronym> files (or snippets) into your existing <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="XML Localization Interchange File Format">XLIFF</acronym> files. Usually you would extract +errors using <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a>, make corrections to these <acronym title="Gettext Portable Object">PO</acronym> (or <acronym title="XML Localization Interchange File Format">XLIFF</acronym>) snippets then merge them back using pomerge. You +could also use <a href="toolkit-pogrep.html" class="wikilink1" title="toolkit-pogrep.html">pogrep</a> to extract a number of messages matching a certain string, make corrections then merge +the correction back using pomerge. +</p> + +<p> +It is probably best to run pomerge against files stored in some kind of version control system so that +you can monitor what changes were made. +</p> + +<p> +Pomerge will also attempt to make as small a change as possible to the text, making it easier to +see the changes using your version control system. +</p> + +</div> +<!-- SECTION "pomerge" [1-705] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">pomerge [options] [-t <template>] -i <input> -o <output></pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <template> </td><td class="col1 leftalign"> is a set of reference <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="XML Localization Interchange File Format">XLIFF</acronym> files, either the originals or a set of <acronym title="Gettext Portable Object Template">POT</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <input> </td><td class="col1 leftalign"> contains the corrected files that are to override content in <output> </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> <output> </td><td class="col1 leftalign"> contains the files whose content will be overridden by <input>. This can be the same directory as <template> </td> + </tr> +</table> + +<p> + +Options: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot and xlf formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot and xlf formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in po, pot and xlf formats </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation (set mode) </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --mergeblanks=MERGEBLANKS </td><td class="col1 leftalign"> whether to overwrite existing translations with blank translations (yes/no) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --mergecomments=MERGECOMMENTS </td><td class="col1 leftalign"> whether to merge comments as well as translations (yes/no) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [706-2108] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +These examples show pomerge in action. + +</p> +<pre class="code">pomerge -t af -i af-check -o af</pre> + +<p> + +Take corrections from <em>af-check</em> merge them with the templates in <em>af</em> and output into <em>af</em>. Thus merge af-check and override entries found in <em>af</em>. Do this only if you are using a version control system so that you can check what changes pomerge made or if you have complete and utter confidence in this tool. + +</p> +<pre class="code">pomerge --mergeblanks=yes -t af -i af-check -o af-new</pre> + +<p> + +Merge the corrections from <em>af-check</em> with templates in <em>af</em> and output to <em>af-new</em>. If an entry is blank in <em>af-check</em> then make it blank in the output in <em>af-new</em>. +</p> + +</div> +<!-- SECTION "Examples" [2109-2762] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +Seems to have trouble merging KDE style comments back. + +</p> + +</div> +<!-- SECTION "Bugs" [2763-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pomigrate2.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pomigrate2.html new file mode 100644 index 0000000..ea0b09b --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pomigrate2.html @@ -0,0 +1,139 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pomigrate2" id="pomigrate2">pomigrate2</a></h1> +<div class="level1"> + +<p> + +pomigrate2 aims to move an existing translation to a new +version based on updated <acronym title="Gettext Portable Object">PO</acronym> Template files automatically without user intervention. +Therefore it is ideal for when you are +migrating many languages or migrating from related but divergent products e.g. +Mozilla to Firefox. +</p> + +</div> +<!-- SECTION "pomigrate2" [1-309] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> + +<p> + +GNU Gettext: +</p> +<ul> +<li class="level1"><div class="li"> <a href="http://man.cx/msginit" class="interwiki iw_man" title="http://man.cx/msginit">msginit</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://man.cx/msgcat" class="interwiki iw_man" title="http://man.cx/msgcat">msgcat</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://man.cx/msgmerge" class="interwiki iw_man" title="http://man.cx/msgmerge">msgmerge</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Prerequisites" [310-412] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> + +<p> + +pomigrate [options] <from> <to> <new templates> +</p> + +<p> +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> from </td><td class="col1 leftalign"> is a directory of existing <acronym title="Gettext Portable Object">PO</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> to </td><td class="col1 leftalign"> is the directory where the migrated <acronym title="Gettext Portable Object">PO</acronym> files will be stored </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> new templates </td><td class="col1 leftalign"> this is the directory that contains the <acronym title="Gettext Portable Object">PO</acronym> Template files </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"> -F, --use-fuzzy-matching </td><td class="col1 leftalign"> use fuzzy algorithms when merging to attempt to match strings </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -C, --use-compendium </td><td class="col1"> create and use a compendium built from the migrating files </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> -C, --use-compendium=some-compendium.po </td><td class="col1 leftalign"> use an external compendium during the migration </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> --no-wrap </td><td class="col1"> do not wrap long lines </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> --locale </td><td class="col1 leftalign"> set locale for newly born files </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -q, --quiet </td><td class="col1 leftalign"> suppress most output </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -p, --pot2po </td><td class="col1 leftalign"> use pot2po instead of msgmerge to migrate </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [413-1247] --> +<h2><a name="operation" id="operation">Operation</a></h2> +<div class="level2"> + +<p> + +pomigrate2 makes use of the Gettext tools msgmerge or Translate Toolkit's <a href="toolkit-pot2po.html" class="wikilink1" title="toolkit-pot2po.html">pot2po</a> +to perform its merging tasks. +</p> + +<p> +It firstly finds all files with the same name and location in the <from> directory +as in the <template> directory and copies these to the <to> directory. If there is no +file in the <from> directory to match one needed by the <template> directory then +it will msgcat all files in the <from> directory with the same name and copy them to +the correct destination in the <to> directory. If all of that fails then +msginit is used to initialise any missing <acronym title="Gettext Portable Object">PO</acronym> files. +</p> + +<p> +Lastly all the files in <to> are merged using msgmerge or pot2po. This process updates the files +to match the layout and messages in <templates>. Optionally, by using --use-compendium, +a compendium of all the translations in <from> can be created to be used in the final merge process. +</p> + +</div> +<!-- SECTION "Operation" [1248-2145] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known + +</p> + +</div> +<!-- SECTION "Bugs" [2146-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-popuretext.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-popuretext.html new file mode 100644 index 0000000..15832c3 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-popuretext.html @@ -0,0 +1,75 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="popuretext" id="popuretext">popuretext</a></h1> +<div class="level1"> + +<p> + +Extracts all the source text from a directory of <acronym title="Gettext Portable Object Template">POT</acronym> files, removing <acronym title="Gettext Portable Object">PO</acronym> headers and optionally the accelerator keys. +</p> + +<p> +If you want to use other tools to analyse the text within a translation project to for instance use word frequency to create an initial glossary then this tool is the starting point to get hold of the pure text. +</p> + +</div> +<!-- SECTION "popuretext" [1-357] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> + +<p> + +GNU Gettext +</p> + +</div> +<!-- SECTION "Prerequisites" [358-400] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">popuretext <pot-dir> <file.txt> [accelerator]</pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> pot-dir </td><td class="col1 leftalign"> a directory containing <acronym title="Gettext Portable Object Template">POT</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> file.txt </td><td class="col1 leftalign"> file that contains the output text </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> accelerator </td><td class="col1 leftalign"> optional: accelerator marker to be removed from the text </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [401-656] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known + +</p> + +</div> +<!-- SECTION "Bugs" [657-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-poreencode.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poreencode.html new file mode 100644 index 0000000..8cd547f --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poreencode.html @@ -0,0 +1,89 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="poreencode" id="poreencode">poreencode</a></h1> +<div class="level1"> + +<p> + +Takes a directory of existing <acronym title="Gettext Portable Object">PO</acronym> files and converts them to a given encoding. +</p> + +</div> +<!-- SECTION "poreencode" [1-105] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> + +<p> + +GNU Gettext +</p> + +</div> +<!-- SECTION "Prerequisites" [106-148] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">poreencode <encoding> <PO directory></pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> encoding </td><td class="col1 leftalign"> is the encoding you would like to convert to eg. UTF-8 </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <acronym title="Gettext Portable Object">PO</acronym> directory </td><td class="col1 leftalign"> is a directory of existing <acronym title="Gettext Portable Object">PO</acronym> files </td> + </tr> +</table> + +<p> + +Its is best to backup files before the conversion or to perform it against <acronym title="Concurrent Versions System">CVS</acronym> +which prevents a potential loss of data. +</p> + +</div> +<!-- SECTION "Usage" [149-469] --> +<h2><a name="operation" id="operation">Operation</a></h2> +<div class="level2"> + +<p> + +poreencode makes use of the Gettext tool <a href="http://man.cx/msgconv" class="interwiki iw_man" title="http://man.cx/msgconv">msgconv</a> to perform its task. It +traverses the <acronym title="Gettext Portable Object">PO</acronym> directory and finds all <acronym title="Gettext Portable Object">PO</acronym> file. It uses msgconv to +convert the <acronym title="Gettext Portable Object">PO</acronym> file from its existing encoding to the new encoding. +</p> + +</div> +<!-- SECTION "Operation" [470-713] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +Like most Gettext tools they do a little bit more than documented, msgconv will +decide which strings are in fact fuzzy and delete fuzzy marking - not a lot but +you do need to diff (this probably related to #, fuzzy entries that are not +placed in the place Gettext expects them). + +</p> + +</div> +<!-- SECTION "Bugs" [714-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-porestructure.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-porestructure.html new file mode 100644 index 0000000..c035367 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-porestructure.html @@ -0,0 +1,106 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="porestructure" id="porestructure">porestructure</a></h1> +<div class="level1"> + +<p> + +porestructure takes the <acronym title="Gettext Portable Object">PO</acronym> files output by <a href="toolkit-poconflicts.html" class="wikilink1" title="toolkit-poconflicts.html">poconflicts</a> (a flat structure), and recreates the directory structure according to the poonflict location comments found in each <acronym title="Gettext Portable Object">PO</acronym> message. After being restructured, the messages in the resulting directory structure can be merged back using <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a>. +</p> + +<p> +Since poconflicts adds conflicting messages, from many different <acronym title="Gettext Portable Object">PO</acronym> files, into a single <acronym title="Gettext Portable Object">PO</acronym> file, the original structure of the files and directories are lost and the new <acronym title="Gettext Portable Object">PO</acronym> files are output to a single directory. The original structure information is left in ”(pofilter)” comments for each <acronym title="Gettext Portable Object">PO</acronym> element. +</p> + +</div> +<!-- SECTION "porestructure" [1-637] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">porestructure [options] <conflicts> <po> </pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <conflicts> </td><td class="col1 leftalign"> is a directory containing one the corrected output from poconflict </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is an output directory to write the restructured files to </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [638-1566] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +The documentation for poconflicts has <a href="toolkit-poconflicts.html#examples" class="wikilink1" title="toolkit-poconflicts.html">examples</a> for the complete process using poconflict, porestructure, and pomerge. +</p> + +</div> +<!-- SECTION "Examples" [1567-1723] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None Known + +</p> + +</div> +<!-- SECTION "Bugs" [1724-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-posegment.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-posegment.html new file mode 100644 index 0000000..862107f --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-posegment.html @@ -0,0 +1,141 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="posegment" id="posegment">posegment</a></h1> +<div class="level1"> + +<p> + +posegment takes a Gettext <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> file and segments the entries, generating a new file with revised and smaller translation units. +</p> + +<p> +This is useful for the creation of a file that can be used as a Translation Memory (e.g. when using <a href="pootle-updatetm.html" class="wikilink1" title="pootle-updatetm.html">updatetm</a> to create translation memory for Pootle) as you should get better matching after you have exposed translated sentences that might occur elsewhere in your work. +</p> + +<p> +Posegment won't do very advanced sentence boundary detection and alignment, but has customisations for the punctuation rules of several languages (Amharic, Afrikaans, Arabic, Armenian, Chinese, Greek, Japanese, Khmer, Oriya, Persian). For the purpose of increasing your TM (as described below), it is already very useful. Give it a try and help us to improve it even more for your language. +</p> + +</div> +<!-- SECTION "posegment" [1-834] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">posegment [options] <input> <segmented></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"> <input> </td><td class="col1 leftalign"> translations to be segmented </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <segmented> </td><td class="col1 centeralign"> translations segmented at the sentence level </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in pot format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row10"> + <td class="col0"> -l, --language=LANG </td><td class="col1"> the target language code </td> + </tr> + <tr class="row11"> + <td class="col0"> --source-language=LANG </td><td class="col1"> the source language code (default 'en') </td> + </tr> + <tr class="row12"> + <td class="col0"> --keepspaces </td><td class="col1"> Disable automatic stripping of whitespace </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [835-1971] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +You want to reuse all of your Pidgin translations in another Instant Messenger: + +</p> +<pre class="code">posegment pidgin-af.po pidgin-af-segmented.po</pre> + +<p> + +Now all of our Pidgin translation are available, segmented at a sentence level, to be used as a Translation Memory for our other translation work. +</p> + +<p> +You can do the same at a project level. Here we want to segment all of our OpenOffice.org translation work, a few hundred files: + +</p> +<pre class="code">posegment af/ af-segmented/</pre> + +<p> + +We start with all our files in <code>af</code> which are now duplicated in <code>af-segmented</code> except files are now fully segmented. +</p> + +</div> +<!-- SECTION "Examples" [1972-2555] --> +<h2><a name="issues" id="issues">Issues</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> If the toolkit doesn't have segmentation rules for your language then it will default to English which might be incorrect.</div> +</li> +<li class="level1"><div class="li"> Segmentation does not guarantee reuse as your TM software needs to know how to segment when matching. If you use software that doesn't do segmentation, you can consider joining the original and the segmented files together with msgcat, to get the best of both worlds.</div> +</li> +<li class="level1"><div class="li"> You cannot (yet) use the tool to break a file into segments, translate, and then recreate as the segmented file does not know which parts should be joined together to recreate a file.</div> +</li> +</ul> + +</div> +<!-- SECTION "Issues" [2556-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-posplit.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-posplit.html new file mode 100644 index 0000000..6edab98 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-posplit.html @@ -0,0 +1,67 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="posplit" id="posplit">posplit</a></h1> +<div class="level1"> + +<p> + +Takes an existing <acronym title="Gettext Portable Object">PO</acronym> file and splits it into three components: translated, +untranslated and fuzzy. This is useful for reviewing translations or for +extracting good translations from a compendium file. +</p> + +</div> +<!-- SECTION "posplit" [1-226] --> +<h2><a name="prerequisites" id="prerequisites">Prerequisites</a></h2> +<div class="level2"> + +<p> + +GNU Gettext +</p> + +</div> +<!-- SECTION "Prerequisites" [227-270] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">posplit ./file.po</pre> + +<p> + +Where: + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> file.po </td><td class="col1 leftalign"> is an existing <acronym title="Gettext Portable Object">PO</acronym> file or <acronym title="Gettext Portable Object">PO</acronym> compendium </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [271-377] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +Some relative path bugs thus the need for ./ before file.po + +</p> + +</div> +<!-- SECTION "Bugs" [378-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-poswap.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poswap.html new file mode 100644 index 0000000..b1dac7f --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poswap.html @@ -0,0 +1,153 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="poswap" id="poswap">poswap</a></h1> +<div class="level1"> + +<p> + +This tool builds a new translation file with the target text (translation) of the input file(s) as source language of the output file it creates. +</p> + +<p> +This makes it possible to have French as the source file for translation, rather than English. Note that this requires no change in the software project and is only a manipulation of the strings in the existing files. The only requirement for this tool is a French translation. +</p> + +<p> +It can also be used to convert translatable files that use logical IDs instead of source text into a format usable by human localisers. +</p> + +</div> +<!-- SECTION "poswap" [1-586] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">poswap [options] <newsource> [-t current] <new></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"> <newsource> </td><td class="col1"> is the translations (preferably 100% translated) of the preferred source language (like French) </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <current> </td><td class="col1"> is the (optional) current English based translation in your intended target language </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> <new> </td><td class="col1"> is the intended output file / directory </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in pot format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in po, pot formats </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --reverse </td><td class="col1 leftalign"> Do the inverse operation (converting back to a normal English based file). See the examples. </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [587-1830] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +Ensure that the two po files / directories correspond 100% to the same pot file before using +this. +</p> + +<p> +To start a fresh Afrikaans (af) translation from Dutch (nl): +</p> +<pre class="code"> poswap nl.po nl-af.po</pre> + +<p> +This initialises a new, empty file nl-af.po with Dutch as the source language. +</p> + +<p> +To change the nl-af.po file back to the expected English based af.po: +</p> +<pre class="code"> poswap --reverse nl.po -t nl-af.po af.po</pre> + +<p> + +To translate Kurdish (ku) through French (fr): +</p> +<pre class="code"> poswap -i fr/ -t ku/ -o fr-ku/</pre> + +<p> + +This will take the existing (English based) Kurdish translation in ku/ and produce files in fr-ku with French as the source language and Kurdish as the target language. +</p> + +<p> +To convert the fr-ku files back to en-ku: +</p> +<pre class="code"> poswap --reverse -i fr/ -t fr-ku/ -o en-ku/</pre> + +<p> +This recreates the English based Kurdish translation from the French based files previously created in fr-ku/. +</p> + +</div> +<!-- SECTION "Examples" [1831-2690] --> +<h2><a name="issues" id="issues">Issues</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Behaviour is undetermined if the two files don't match 100%. If <acronym title="Gettext Portable Object">PO</acronym> files are based in the same template, there should be no problem.</div> +</li> +<li class="level1"><div class="li"> We should probably be doing fuzzy matching in future to ease the migration over the lifetime of a changing French translation.</div> +</li> +</ul> + +</div> +<!-- SECTION "Issues" [2691-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pot2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pot2po.html new file mode 100644 index 0000000..eab06bb --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pot2po.html @@ -0,0 +1,164 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pot2po" id="pot2po">pot2po</a></h1> +<div class="level1"> + +<p> + +Convert a Gettext <acronym title="Gettext Portable Object">PO</acronym> Template file to a <acronym title="Gettext Portable Object">PO</acronym> file and merge in existing +translations if they are present. A translation memory (compendium) can also be used for fuzzy matching. This corresponds to a large extent with the program “msgmerge” from the gettext package. +</p> + +</div> +<!-- SECTION "pot2po" [1-287] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">pot2po [options] <pot> <po></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <pot> </td><td class="col1 leftalign"> is a <acronym title="Gettext Portable Object">PO</acronym> Template (<acronym title="Gettext Portable Object Template">POT</acronym>) file or directory of <acronym title="Gettext Portable Object Template">POT</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a <acronym title="Gettext Portable Object">PO</acronym> file or a directory of <acronym title="Gettext Portable Object">PO</acronym> files </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in pot format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1"> read from TEMPLATE in po, pot formats (old translations) </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --tm=TM </td><td class="col1 leftalign"> The file to use as translation memory when fuzzy matching </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> -sMIN_SIMILARITY, --similarity=MIN_SIMILARITY </td><td class="col1"> The minimum similarity for inclusion (default: 75%) </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> --nofuzzymatching </td><td class="col1 leftalign"> Disable all fuzzy matching </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [288-1598] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">pot2po -t zu-1.0.1 pot-2.0.2 zu-2.0.2</pre> + +<p> + +Here we are initialising the <acronym title="Gettext Portable Object">PO</acronym> files in <em>zu-2.0.2</em> based on the <acronym title="Gettext Portable Object Template">POT</acronym> files in <em>pot-2.0.2</em>. We are using the old translations in <em>zu-1.0.1</em> as templates so that we can reuse our existing translations in the new files. +</p> + +<p> +If the <acronym title="Gettext Portable Object Template">POT</acronym> files have undergone major reshuffling then you may want to use <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a> which can now use pot2po as its merging backend. pomigrate2 will do its best to migrate your files to the correct locations before merging. It will also make make use of a compendium if requested. + +</p> +<pre class="code">pot2po --tm=compendium.po --similarity=60 -t xh-old pot xh-new</pre> + +<p> + +With this update we are using <em>compendium.po</em> as a translations memory (you can make use of other files such as <acronym title="Translation Memory eXchange">TMX</acronym>, etc). We will accept any match that scores above <em>60%</em>. +</p> + +</div> +<!-- SECTION "Examples" [1599-2421] --> +<h2><a name="merging" id="merging">Merging</a></h2> +<div class="level2"> + +<p> + +It helps to understand when and how pot2po will merge. The default is to follow msgmerge's behaviour but we add some extra features with fuzzy matching: + +</p> +<ul> +<li class="level1"><div class="li"> If everything matches we carry that across</div> +</li> +<li class="level1"><div class="li"> We can resurrect obsolete messages for reuse</div> +</li> +<li class="level1"><div class="li"> Messages no longer used are made obsolete</div> +</li> +<li class="level1"><div class="li"> If we cannot find a match we will first look through the current and obsolete messages and then through any global translation memory</div> +</li> +<li class="level1"><div class="li"> Fuzzy matching makes use of the <a href="toolkit-levenshtein_distance.html" class="wikilink1" title="toolkit-levenshtein_distance.html">Levenshtein distance</a> algorithm to detect the best matches</div> +</li> +</ul> + +</div> +<!-- SECTION "Merging" [2422-2976] --> +<h2><a name="performance" id="performance">Performance</a></h2> +<div class="level2"> + +<p> + +Fuzzy matches are usually of good quality. Installation of the <a href="https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=260161" class="urlextern" title="https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=260161">python-Levenshtein</a> package will speed up fuzzy matching. Without this a Python based matcher is used which is considerably slower. +</p> + +<p> +Install psyco for additional speedup (it is used by most toolkit tools if it is installed.) +</p> + +</div> +<!-- SECTION "Performance" [2977-3372] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a> and pot2po should probably become one.</div> +</li> +</ul> + +</div> +<!-- SECTION "Bugs" [3373-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-poterminology.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poterminology.html new file mode 100644 index 0000000..226c75b --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poterminology.html @@ -0,0 +1,379 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="poterminology" id="poterminology">poterminology</a></h1> +<div class="level1"> + +<p> + +poterminology takes Gettext <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="Gettext Portable Object Template">POT</acronym> files and extracts potential terminology. +</p> + +<p> +This is useful as a first step before translating a new project (or an existing project into a new target language) as it allows you to define key terminology for consistency in translations. The resulting terminology <acronym title="Gettext Portable Object">PO</acronym> files can be used by Pootle to provide suggestions while translating. +</p> + +<p> +Generally, all the input files should have the same source language, and either be <acronym title="Gettext Portable Object Template">POT</acronym> files (with no translations) or <acronym title="Gettext Portable Object">PO</acronym> files with translations to the same target language. +</p> + +<p> +The more separate <acronym title="Gettext Portable Object">PO</acronym> files you use to generate terminology, the better your results will be, but poterminology can be used with just a single input file. +</p> + +<p> +<p><div class="noteclassic">New in v1.2 +</div></p> + +</p> + +</div> +<!-- SECTION "poterminology" [1-756] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">poterminology [options] <input> <terminology></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"> <input> </td><td class="col1 leftalign"> translations to be examined for terminology </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <terminology> </td><td class="col1 leftalign"> extracted potential terminology </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in pot, po formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -u UPDATEFILE, --update=UPDATEFILE </td><td class="col1"> update terminology in UPDATEFILE </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -S STOPFILE, --stopword-list=STOPFILE </td><td class="col1 leftalign"> read stopword (term exclusion) list from STOPFILE (default site-packages/translate/share/stoplist-en) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> -F, --fold-titlecase </td><td class="col1 leftalign"> fold “Title Case” to lowercase (default) </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> -C, --preserve-case </td><td class="col1 leftalign"> preserve all uppercase/lowercase </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> -I, --ignore-case </td><td class="col1 leftalign"> make all terms lowercase </td> + </tr> + <tr class="row14"> + <td class="col0"> --accelerator=ACCELERATORS </td><td class="col1 leftalign"> ignores the given accelerator characters when matching (accelerator characters probably require quoting) </td> + </tr> + <tr class="row15"> + <td class="col0 leftalign"> -t LENGTH, --term-words=LENGTH </td><td class="col1 leftalign"> generate terms of up to LENGTH words (default 3) </td> + </tr> + <tr class="row16"> + <td class="col0 leftalign"> --inputs-needed=MIN </td><td class="col1 leftalign"> omit terms appearing in less than MIN input files (default 2, or 1 if only one input file) </td> + </tr> + <tr class="row17"> + <td class="col0 leftalign"> --fullmsg-needed=MIN </td><td class="col1 leftalign"> omit full message terms appearing in less than MIN different messages (default 1) </td> + </tr> + <tr class="row18"> + <td class="col0 leftalign"> --substr-needed=MIN </td><td class="col1 leftalign"> omit substring-only terms appearing in less than MIN different messages (default 2) </td> + </tr> + <tr class="row19"> + <td class="col0 leftalign"> --locs-needed=MIN </td><td class="col1 leftalign"> omit terms appearing in less than MIN different original program locations (default 2) </td> + </tr> + <tr class="row20"> + <td class="col0 leftalign"> --sort=ORDER </td><td class="col1 leftalign"> output sort order(s): frequency, dictionary, length (default is all orders in the above priority) </td> + </tr> + <tr class="row21"> + <td class="col0 leftalign"> --source-language=LANG </td><td class="col1 leftalign"> the source language code (default 'en') </td> + </tr> + <tr class="row22"> + <td class="col0 leftalign"> -v, --invert </td><td class="col1 leftalign"> invert the source and target languages for terminology </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [757-3035] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +You want to generate a terminology file for Pootle that will be used to provide suggestions for translating Pootle itself: + +</p> +<pre class="code">poterminology Pootle/po/pootle/templates/*.pot .</pre> + +<p> + +This results in a <code>./pootle-terminology.pot</code> output file with 23 terms (from “file” to “does not exist”) - without any translations. +</p> + +<p> +The default output file can be added to a Pootle project to provide <a href="pootle-terminology_matching.html" class="wikilink1" title="pootle-terminology_matching.html">terminology matching</a> suggestions for that project; alternately a special Terminology project can be used and it will provide terminology suggestions for all projects that do not have a pootle-terminology.po file. +</p> + +<p> +Generating a terminology file containing automatically extracted translations is possible as well, by using <acronym title="Gettext Portable Object">PO</acronym> files with translations for the input files: + +</p> +<pre class="code">poterminology Pootle/po/pootle/fi/*.po --output fi/pootle-terminology.po \ + --sort dictionary</pre> + +<p> + +Using <acronym title="Gettext Portable Object">PO</acronym> files with Finnish translations, you get an output file that contains the same 23 terms, with translations of eight terms - one (“login”) is fuzzy due to slightly different translations in jToolkit and Pootle. The file is sorted in alphabetical order (by source term, not translated term), which can be useful when comparing different terminology files. +</p> + +<p> +Even though there is no translation of Pootle into Kinyarwanda, you can use the Gnome UI terminology <acronym title="Gettext Portable Object">PO</acronym> file as a source for translations; in order to extract only the terms common to jToolkit and Pootle this command includes the <acronym title="Gettext Portable Object Template">POT</acronym> output from the first step above (which is redundant) and require terms to appear in three different input sources: + +</p> +<pre class="code">poterminology Pootle/po/pootle/templates/*.pot pootle-terminology.pot \ + Pootle/po/terminology/rw/gnome/rw.po --inputs-needed=3 -o terminology/rw.po</pre> + +<p> + +Of the 23 terms, 16 have Kinyarwanda translations extracted from the Gnome UI terminology. +</p> + +<p> +For a language like Spanish, with both Pootle translations and Gnome terminology available, 18 translations (2 fuzzy) are generated by the following command, which initializes the terminology file from the <acronym title="Gettext Portable Object Template">POT</acronym> output from the first step, and then uses --update to specify that the pootle-es.po file is to be used both for input and output: + +</p> +<pre class="code">cp pootle-terminology.pot glossary-es.po; +poterminology --inputs=3 --update glossary-es.po \ + Pootle/po/pootle/es/*.po Pootle/po/terminology/es/gnome/es.po</pre> + +</div> +<!-- SECTION "Examples" [3036-5390] --> +<h3><a name="reduced_terminology_glossaries" id="reduced_terminology_glossaries">Reduced terminology glossaries</a></h3> +<div class="level3"> + +<p> + +If you want to generate a terminology file containing only single words, not phrases, you can use -t/--term-words to control this. If your input files are very large and/or you have a lot of input files, and you are finding that poterminology is taking too much time and memory to run, reducing the phrase size from the default value of 3 can be helpful. +</p> + +<p> +For example, running poterminology on the subversion trunk with the default phrase size can take quite some time and may not even complete on a small-memory system, but with --term-words=1 the initial number of terms is reduced by half, and the thresholding process can complete: + +</p> +<pre class="code">poterminology --progress=none -t 1 translate</pre> +<pre class="code">1297 terms from 64039 units in 216 files +254 terms after thresholding +254 terms after subphrase reduction</pre> + +<p> + +The first line of output indicates the number of input files and translation units (messages), with the number of unique terms present after removing C and Python format specifiers (e.g. %d), <acronym title="Extensible Markup Language">XML</acronym>/<acronym title="HyperText Markup Language">HTML</acronym> <elements> and &entities; and performing stoplist elimination. +</p> + +<p> +The second line gives the number of terms remaining after applying threshold filtering (discussed in more detail below) to eliminate terms that are not sufficiently “common” in the input files. +</p> + +<p> +The third line gives the number of terms remaining after eliminating subphrases that did not occur independently. In this case, since the term-words limit is 1, there are no subphrases and so the number is the same as on the second line. +</p> + +<p> +However, in the first example above (generating terminology for Pootle itself), the term “not exist” passes the stoplist and threshold filters, but all occurrences of this term also contained the term “does not exist” which also passes the stoplist and threshold filters. Given this duplication, the shorter phrase is eliminated in favor of the longer one, resulting in 23 terms (out of 25 that pass the threshold filters). + +</p> + +</div> +<!-- SECTION "Reduced terminology glossaries" [5391-7357] --> +<h2><a name="reducing_output_terminology_with_thresholding_options" id="reducing_output_terminology_with_thresholding_options">Reducing output terminology with thresholding options</a></h2> +<div class="level2"> + +<p> + +Depending on the size and number of the source files, and the desired scope of the output terminology file, there are several thresholding filters that can be adjusted to allow fewer or more terms in the output file. We have seen above how one (--inputs-needed) can be used to require that terms be present in multiple input files, but there are also other thresholds that can be adjusted to control the size of the output terminology file. + +</p> +<ul> +<li class="level1"><div class="li"> --inputs-needed</div> +</li> +</ul> + +<p> + +This is the most flexible and powerful thresholding control. The default value is 2, unless only one input file (not counting an --update argument) is provided, in which case the threshold is 1 to avoid filtering out all terms and generating an empty output terminology file. +</p> + +<p> +By copying input files and providing them multiple times as inputs, you can even achieve “weighted” thresholding, so that for example, all terms in one original input file will pass thresholding, while other files may be filtered. A simple version of this technique was used above to incorporate translations from the Gnome terminology <acronym title="Gettext Portable Object">PO</acronym> files without having it affect the terms that passed the threshold filters. + +</p> +<ul> +<li class="level1"><div class="li"> --locs-needed</div> +</li> +</ul> + +<p> + +Rather than requiring that a term appear in multiple input <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="Gettext Portable Object Template">POT</acronym> files, this requires that it have been present in multiple source code files, as evidenced by location comments in the <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="Gettext Portable Object Template">POT</acronym> sources. +</p> + +<p> +This threshold can be helpful in eliminating over-specialized terminology that you don't want when multiple <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="Gettext Portable Object Template">POT</acronym> files are generated from the same sources (via included header or library files). +</p> + +<p> +Note that some <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="Gettext Portable Object Template">POT</acronym> files have function names rather than source file names in the location comments; in this case the threshold will be on multiple functions, which may need to be set higher to be effective. +</p> + +<p> +Not all <acronym title="Gettext Portable Object">PO</acronym>/<acronym title="Gettext Portable Object Template">POT</acronym> files contain proper location comments. If your input files don't have (good) location comments and the output terminology file is reduced to zero or very few entries by thresholding, you may need to override the default value for this threshold and set it to 0, which disables this check. +</p> + +<p> +The setting of the --locs-needed comment has another effect, which is that location comments in the output terminology file will be limited to twice that number; a location comment indicating the number of additional locations not specified will be added instead of the omitted locations. + +</p> +<ul> +<li class="level1"><div class="li"> --fullmsg-needed</div> +</li> +</ul> +<ul> +<li class="level1"><div class="li"> --substr-needed</div> +</li> +</ul> + +<p> + +These two thresholds specify the number of different translation units (messages) in which a term must appear; they both work in the same way, but the first one applies to terms which appear as complete translation units in one or more of the source files (full message terms), and the second one to all other terms (substring terms). Note that translations are extracted only for full message terms; poterminology cannot identify the corresponding substring in a translation. +</p> + +<p> +If you are working with a single input file without useful location comments, increasing these thresholds may be the only way to effectively reduce the output terminology. Generally, you should increase the --substr-needed threshold first, as the full message terms are more likely to be useful terminology. +</p> + +</div> +<!-- SECTION "Reducing output terminology with thresholding options" [7358-10647] --> +<h2><a name="stop_word_files" id="stop_word_files">Stop word files</a></h2> +<div class="level2"> + +<p> + +Much of the power of poterminology in generating useful terminology files is due to the default stop word file that it uses. This file contains words and regular expressions that poterminology will ignore when generating terms, so that the output terminology doesn't have tons of useless entries like “the 16” or “Z”. +</p> + +<p> +In most cases, the default stop word list will work well, but you may want to replace it with your own version, or possibly just supplement or override certain entries. The default <a href="toolkit-poterminology_stopword_file.html" class="wikilink1" title="toolkit-poterminology_stopword_file.html">poterminology stopword file</a> contains comments that describe the syntax and operation of these files. +</p> + +<p> +If you want to completely replace the stopword list (for example, if your source language is French rather than English) you could do it with a command like this: + +</p> +<pre class="code">poterminology --stopword-list=stoplist-fr logiciel/ -o glossaire.po</pre> + +<p> + +If you merely want to modify the standard stopword list with your own additions and overrides, you must explicitly specify the default list first: + +</p> +<pre class="code">poterminology -S /usr/lib/python2.5/site-packages/translate/share/stoplist-en \ + -S my-stoplist po/ -o terminology.po</pre> + +<p> + +You can use poterminology --help to see the default stopword list pathname, which may differ from the one shown above. +</p> + +<p> +Note that if you are using multiple stopword list files, as in the above, they will all be subject to the same case mapping (fold “Title Case” to lower case by default) - if you specify a different case mapping in the second file it will override the mapping for all the stopword list files. + +</p> + +</div> +<!-- SECTION "Stop word files" [10648-12203] --> +<h2><a name="issues" id="issues">Issues</a></h2> +<div class="level2"> + +<p> + +When using poterminology on Windows systems, file globbing for input is not supported (unless you have a version of Python built with cygwin, which is not common). On Windows, a command like “poterminology -o test.po podir/*.po” will fail with an error “No such file or directory: 'podir\\*.po'” instead of expanding the podir/*.po glob expression. (This problem affects all Translate Toolkit command-line tools, not just poterminology.) You can work around this problem by making sure that the directory does not contain any files (or subdirectories) that you do not want to use for input, and just giving the directory name as the argument, e.g. “poterminology -o test.po podir” for the case above. +</p> + +<p> +When using terminology files generated by poterminology as input, a plethora of translator comments marked with (poterminology) may be generated, with the number of these increasing on each iteration. You may wish to run <a href="toolkit-pocommentclean.html" class="wikilink1" title="toolkit-pocommentclean.html">pocommentclean</a> (or a slightly modified version of it which only removes (poterminology) comments) on the input and/or output files, especially since translator comments are displayed as tooltips by Pootle (thankfully, they are truncated at a few dozen characters). +</p> + +<p> +Currently, any translation items using plural forms will be entirely ignored for terminology extraction. The singular form for the item should be used, but this is not yet implemented (it is tracked as bug <a href="http://bugs.locamotion.org/show_bug.cgi?id=532" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=532">532</a>). +</p> + +<p> +Default threshold settings may eliminate all output terms; in this case, poterminology should suggest threshold option settings that would allow output to be generated (this enhancement is tracked as “bug” <a href="http://bugs.locamotion.org/show_bug.cgi?id=582" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=582">582</a>). +</p> + +<p> +While poterminology ignores <acronym title="Extensible Markup Language">XML</acronym>/<acronym title="HyperText Markup Language">HTML</acronym> entities and elements and %-style format strings (for C and Python), it does not ignore all types of “variables” that may occur, particularly in OpenOffice.org, Mozilla, or Gnome localization files. These other types should be ignored as well (this enhancement is tracked as “bug” <a href="http://bugs.locamotion.org/show_bug.cgi?id=598" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=598">598</a>). +</p> + +<p> +Terms containing only words that are ignored individually, but not excluded from phrases (e.g. “you are you”) may be generated by poterminology, but aren't generally useful. Adding a new threshold option --nonstop-needed could allow these to be suppressed. +</p> + +<p> +Pootle ignores parenthetical comments in source text when performing terminology matching; this allows for terms like “scan (verb)” and “scan (noun)” to both be provided as suggestions for a message containing “scan.” poterminology does not provide any special handling for these, but it could use them to provide better handling of different translations for a single term. This would be an improvement over the current approach, which marks the term fuzzy and includes all variants, with location information in {} braces in the automatically extracted translation. +</p> + +<p> +Currently, message context information (<acronym title="Gettext Portable Object">PO</acronym> msgctxt) is not used in any way; this could provide an additional source of information for distinguishing variants of the same term. +</p> + +<p> +A single execution of poterminology can only perform automatic translation extraction for a single target language - having the ability to handle all target languages in one run would allow a single command to generate all terminology for an entire project. Additionally, this could provide even more information for identifying variant terms by comparing the number of target languages that have variant translations. + +</p> + +</div> +<!-- SECTION "Issues" [12204-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-poterminology_stopword_file.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poterminology_stopword_file.html new file mode 100644 index 0000000..c82f1ab --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-poterminology_stopword_file.html @@ -0,0 +1,231 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="stopword_file_format" id="stopword_file_format">Stopword file format</a></h1> +<div class="level1"> + +<p> + +The default stopword file for <a href="toolkit-poterminology.html" class="wikilink1" title="toolkit-poterminology.html">poterminology</a> describes the syntax of these files and provides a good default for most applications using English source text. You can find the location of the default stopword file by looking at the output of poterminology --help, or using the following command: + +</p> +<pre class="code">poterminology --manpage | sed -n '/STOPFILE/s/.*(\(.*\)).*/\1/p'</pre> + +<p> + +<p><div class="noteclassic">New in v1.2 +</div></p> +</p> + +</div> +<!-- SECTION "Stopword file format" [1-430] --> +<h2><a name="overview" id="overview">Overview</a></h2> +<div class="level2"> + +<p> + +The basic syntax of this file is line-oriented, with the first character of each line determining its function. The order of the lines is generally not significant (with one exception noted below), and the selection of function characters was made so that an <acronym title="American Standard Code for Information Interchange">ASCII</acronym> sort of the file would leave it in a generally logical order (except for comment lines). +</p> + +<p> +Apart from comment lines (which begin with '#') and empty lines (which are also ignored), there are three general types of lines, which may appear in any order: + +</p> +<ul> +<li class="level1"><div class="li"> case mapping specifiers</div> +</li> +</ul> +<ul> +<li class="level1"><div class="li"> stoplist regular expressions</div> +</li> +</ul> +<ul> +<li class="level1"><div class="li"> stoplist words</div> +</li> +</ul> + +</div> +<!-- SECTION "Overview" [431-1053] --> +<h3><a name="case_mapping_specifiers" id="case_mapping_specifiers">Case mapping specifiers</a></h3> +<div class="level3"> + +<p> + +A line beginning with a '<strong>!</strong>' specifies upper-/lower-case mapping for words or phrases before comparison with this stoplist (no mapping is applied to the words or regular expressions in this file, only to the source messages). The second character on this line must be one of the following: + +</p> +<ul> +<li class="level1"><div class="li"> <strong>C</strong> no uppercase / lowercase mapping is performed</div> +</li> +<li class="level1"><div class="li"> <strong>F</strong> 'Title Case” words / terms are folded to lower case (default)</div> +</li> +<li class="level1"><div class="li"> <strong>I</strong> all words are mapped to lowercase</div> +</li> +</ul> + +<p> + +These correspond to the equivalent --preserve-case / --fold-titlecase / --ignore-case options to poterminology, but are completely independent and only apply to stoplist matching. You can run poterminology with -I to map all terms to lowercase, and if the case mapping specifier in the stopword file is '<strong>!C</strong>' a stoplist with “pootle” in it will not prevent a term containing “Pootle” from passing the stoplist (and then being mapped to “pootle”). +</p> + +<p> +There should only be one case mapping specifier in a stoplist file; if more than one are present, the last one will take precedence over the others, and its mapping will apply to all entries. If multiple stoplist files are used, the last case mapping specifier processed will apply to all entries <strong>in all files</strong>. +</p> + +</div> +<!-- SECTION "Case mapping specifiers" [1054-2325] --> +<h3><a name="stoplist_regular_expressions" id="stoplist_regular_expressions">Stoplist regular expressions</a></h3> +<div class="level3"> + +<p> + +Lines beginning with a '<strong>/</strong>' are regular expression patterns - any word that matches will be ignored by itself, and any phrase containing it will be excluded as well. The regular expression consists of all characters on the line following the initial '/' - these are extended regular expressions, so grouping, alternation, and such are available. +</p> + +<p> +Regular expression patterns are only checked if the word itself does not appear in the stoplist file as a word entry. The regular expression patterns are always applied to individual words, not phrases, and must match the entire word (i.e. they are anchored both at the start and end). +</p> + +<p> +Use regular expressions sparingly, as evaluating them for every word in the source files can be expensive. In addition to stoplist regular expressions, poterminology has precompiled patterns for C and Python format specifiers (e.g. %d) and <acronym title="Extensible Markup Language">XML</acronym>/<acronym title="HyperText Markup Language">HTML</acronym> <elements> and &entities; - these are removed before stoplist processing and it is not possible to override this. +</p> + +</div> +<!-- SECTION "Stoplist regular expressions" [2326-3370] --> +<h3><a name="stoplist_words" id="stoplist_words">Stoplist words</a></h3> +<div class="level3"> + +<p> + +All other lines should begin with one of the following characters, which indicate whether the word should be <strong>ignored</strong> (as a word alone), <strong>disregarded</strong> in a phrase (i.e. a phrase containing it is allowed, and the word does not count against the --term-words length limit), or any phrase containing it should be <strong>excluded</strong>. + +</p> +<ul> +<li class="level1"><div class="li"> <strong>+</strong> allow word alone, allow phrases containing it</div> +</li> +<li class="level1"><div class="li"> <strong>:</strong> allow word alone, disregarded (for --term-word-length) inside phrase</div> +</li> +<li class="level1"><div class="li"> <strong><</strong> allow word alone, but exclude any phrase containing it</div> +</li> +<li class="level1"><div class="li"> <strong>=</strong> ignore word alone, but allow phrases containing it</div> +</li> +<li class="level1"><div class="li"> <strong>></strong> ignore word alone, disregarded (for --term-word-length) inside phrase</div> +</li> +<li class="level1"><div class="li"> <strong>@</strong> ignore word alone, and exclude any phrase containing it</div> +</li> +</ul> + +<p> + +Generally '+' is only needed for exceptions to regular expression patterns, but it may also be used to override an entry in a previous stoplist if you are using multiple stoplists. +</p> + +<p> +Note that if a word appears multiple times in a stoplist file with different function characters preceding it, the <em class="u">last entry will take precedence</em> over the others. This is the only exception to the general rule that order is not important in stopword files. +</p> + +</div> +<!-- SECTION "Stoplist words" [3371-4581] --> +<h2><a name="default_file_example" id="default_file_example">Default file example</a></h2> +<div class="level2"> +<pre class="code"># apply title-case folding to words before comparing with this stoplist +!F</pre> + +<p> + +The fold-titlecase setting is the default, even if it were not explicitly specified. This allows capitalized words at the start of a sentence (e.g. “Who”) to match a stopword “who” but allows acronyms like WHO (World Health Organization) to be included in the terminology. If you are using poterminology with source files that contain large amounts of ALL UPPERCASE TEXT you may find the ignore-case setting to be preferable. + +</p> +<pre class="code"># override regex match below for phrases with 'no' ++no</pre> + +<p> + +The regular expression /..? below would normally match the word 'no' and both ignore it as a term and exclude any phrases containing it. The above will allow it to appear as a term and in phrases. + +</p> +<pre class="code"># ignore all one or two-character words (unless =word appears below) +/..? +# ignore words with parenthesis, typically function() calls and the like +/.*\(.* +# ignore numbers, both cardinal (e.g. 1,234.0) and ordinal (e.g. 1st, 22nd) +/[0-9,.]+(st|nd|rd|th)?</pre> + +<p> + +These regular expressions ignore a lot of uninteresting terms that are typically code or other things that shouldn't be translated anyhow. There are many exceptions to the one or two-character word pattern in the default stoplist file, not only with = like '=in' but also '+no' and ':on' and '<ok' and '>of'. + +</p> +<pre class="code"># allow these words by themselves and don't count against length for phrases +:off +:on</pre> + +<p> + +These prepositions are common as button text and thus useful to have as terms; they also form an important part of phrases so are disregarded for term word count to allow for slightly longer phrases including them. + +</p> +<pre class="code"># allow these words by themselves, but ignore any phrases containing them +<first +<hello +<last</pre> + +<p> + +These are words that are worth including in a terminology, as they are common in applications, but which aren't generally part of idiomatic phrases. + +</p> +<pre class="code"># ignore these words by themselves, but allow phrases containing them +=able +=about +=actually +=ad +=as +=at</pre> + +<p> + +This is the largest category of stoplist words, and these are all just rather common words. The purpose of a terminology list is to provide specific translation suggestions for the harder words or phrases, not provide a general dictionary, so these words are not of interest by themselves, but may well be part of an interesting phrase. + +</p> +<pre class="code"># ignore these words by themselves, but allow phrases containing them, and +# don't count against length for phrases +# +# (possible additions to this list for multi-lingual text: >di >el >le) +# +>a +>an +>and</pre> + +<p> + +These very common words aren't of interest by themselves, but often form an important part of phrases so are disregarded for term word count to allow for slightly longer phrases including them. + +</p> +<pre class="code"># ignore these words and any phrases containing them +@ain't +@aint +@al +@are</pre> + +<p> + +These are “junk” words that are not only uninteresting by themselves, they generally do not contribute anything to the phrases containing them. +</p> + +</div> +<!-- SECTION "Default file example" [4582-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-pretranslate.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pretranslate.html new file mode 100644 index 0000000..fe917d6 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-pretranslate.html @@ -0,0 +1,151 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="pretranslate" id="pretranslate">pretranslate</a></h1> +<div class="level1"> + +<p> + +Merge existing translations from an old translation file to a new one as well as fill any missing translations from translation memory via fuzzy matching. +</p> + +<p> +This functionality used to be part of pot2po and corresponds to “msgmerge” from the gettext package. +</p> + +<p> +pretranslate works on <acronym title="Gettext Portable Object">PO</acronym> and <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files. +</p> + +</div> +<!-- SECTION "pretranslate" [1-329] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">pretranslate [options] <input> <output></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <input> </td><td class="col1 leftalign"> is the translation file or directory to be pretranslate </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <output> </td><td class="col1 leftalign"> is the translation file or a directory where the pretranslated version will be stored </td> + </tr> +</table> + +<p> + +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in pot format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1"> read old translations from TEMPLATE </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --tm=TM </td><td class="col1 leftalign"> The file to use as translation memory when fuzzy matching </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> -sMIN_SIMILARITY, --similarity=MIN_SIMILARITY </td><td class="col1"> The minimum similarity for inclusion (default: 75%) </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> --nofuzzymatching </td><td class="col1 leftalign"> Disable all fuzzy matching </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [330-1603] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">pretranslate -t zu-1.0.1 -tm zu_tm.po zu-2.0.2 zu-2.0.2-translated </pre> + +<p> + +Here we are pretranslating the <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files in <em>zu-2.0.2</em> using the old translations in <em>zu-1.0.1</em> and fuzzy matches from the zu_tm.po +compendium. the result is stored in <em>zu-2.0.2-translate</em> +</p> + +<p> +unlike pot2po pretranslate will not change anything in the input file except merge translations, no reordering or changes to headers. +</p> + +</div> +<!-- SECTION "Examples" [1604-2036] --> +<h2><a name="merging" id="merging">Merging</a></h2> +<div class="level2"> + +<p> + +It helps to understand when and how pretranslate will merge. The default is to follow msgmerge's behaviour but we add some extra features with fuzzy matching: + +</p> +<ul> +<li class="level1"><div class="li"> If everything matches we carry that across</div> +</li> +<li class="level1"><div class="li"> We can resurrect obsolete messages for reuse</div> +</li> +<li class="level1"><div class="li"> If we cannot find a match we will first look through the current and obsolete messages and then through any global translation memory</div> +</li> +<li class="level1"><div class="li"> Fuzzy matching makes use of the <a href="toolkit-levenshtein_distance.html" class="wikilink1" title="toolkit-levenshtein_distance.html">Levenshtein distance</a> algorithm to detect the best matches</div> +</li> +</ul> + +</div> +<!-- SECTION "Merging" [2037-2551] --> +<h2><a name="performance" id="performance">Performance</a></h2> +<div class="level2"> + +<p> + +Fuzzy matches are usually of good quality. Installation of the <a href="https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=260161" class="urlextern" title="https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=260161">python-Levenshtein</a> package will speed up fuzzy matching. Without this a Python based matcher is used which is considerably slower. +</p> + +<p> +Install psyco for additional speedup (it is used by most toolkit tools if it is installed.) +</p> + +</div> +<!-- SECTION "Performance" [2552-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-progress_progress.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-progress_progress.html new file mode 100644 index 0000000..8a94f44 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-progress_progress.html @@ -0,0 +1,118 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="progress_progress" id="progress_progress">--progress=PROGRESS</a></h1> +<div class="level1"> + +<p> + +All of the programs can give visual feedback. This options allows you to select the style of that feedback. +</p> + +<p> +In the examples we are converting and OpenOffice.org 2.0 sdf/gsi file into <acronym title="Gettext Portable Object Template">POT</acronym> files using <a href="toolkit-oo2po.html" class="wikilink1" title="toolkit-oo2po.html">oo2po</a>. +</p> + +</div> +<!-- SECTION "--progress=PROGRESS" [1-248] --> +<h2><a name="none" id="none">none</a></h2> +<div class="level2"> + +<p> + +No visual feedback, this is useful if you want to use any of the scripts as part of another script and don't +want feedback to interfere with the operation. +</p> +<pre class="code bash"><pre class="code bash"><span class="br0">[</span>dwayne@laptop OOo20<span class="br0">]</span>$ oo2po -P --<span class="re2">progress=</span>none en-US.sdf pot +<span class="br0">[</span>dwayne@laptop OOo20<span class="br0">]</span>$</pre></pre> +</div> +<!-- SECTION "none" [249-529] --> +<h2><a name="dots" id="dots">dots</a></h2> +<div class="level2"> + +<p> + +Use visual dots to represent progress. Each dot represent a file that has been processed. +</p> +<pre class="code bash"><pre class="code bash"><span class="br0">[</span>dwayne@laptop OOo20<span class="br0">]</span>$ oo2po -P --<span class="re2">progress=</span>dots en-US.sdf pot +............................................................................................. +............................................................................................. +......................................... +<span class="br0">[</span>dwayne@laptop OOo20<span class="br0">]</span>$</pre></pre> +</div> +<!-- SECTION "dots" [530-975] --> +<h2><a name="bar_default" id="bar_default">bar (default)</a></h2> +<div class="level2"> + +<p> + +Use a progress bar consisting of hashes (#) to show progress. +</p> +<pre class="code bash"><pre class="code bash"><span class="br0">[</span>dwayne@laptop OOo20<span class="br0">]</span>$ oo2po -P --<span class="re2">progress=</span>bar en-US.sdf pot +processing <span class="nu0">227</span> files... +<span class="br0">[</span><span class="re3">############################## <span class="br0">]</span> <span class="nu0">69</span>%</span></pre></pre> +<p> +This is the default mode of operation, therefore this command would create the same output. +</p> +<pre class="code bash"><pre class="code bash"><span class="br0">[</span>dwayne@laptop OOo20<span class="br0">]</span>$ oo2po -P en-US.sdf pot</pre></pre> +</div> +<!-- SECTION "bar (default)" [976-1385] --> +<h2><a name="verbose" id="verbose">verbose</a></h2> +<div class="level2"> + +<p> + +Combine the hash (#) progress bar form the <em>bar</em> option with the actual names of files that have been processed. +</p> +<pre class="code bash"><pre class="code bash"><span class="br0">[</span>dwayne@laptop OOo20<span class="br0">]</span>$ oo2po -P --<span class="re2">progress=</span>verbose en-US.sdf pot +processing <span class="nu0">227</span> files... +so3/src.oo +dbaccess/<span class="kw3">source</span>/ui/uno.oo +helpcontent2/<span class="kw3">source</span>/text/shared.oo +wizards/<span class="kw3">source</span>/formwizard.oo +sch/<span class="kw3">source</span>/ui/dlg.oo +helpcontent2/<span class="kw3">source</span>/text/sbasic/shared/<span class="nu0">01</span>.oo +dbaccess/<span class="kw3">source</span>/core/resource.oo +svtools/<span class="kw3">source</span>/sbx.oo +dbaccess/<span class="kw3">source</span>/ui/relationdesign.oo +scp2/<span class="kw3">source</span>/writer.oo +filter/<span class="kw3">source</span>/xsltdialog.oo +<span class="br0">[</span><span class="re3">## <span class="br0">]</span> <span class="nu0">5</span>%</span></pre></pre> +</div> +<!-- SECTION "verbose" [1386-1992] --> +<h2><a name="names" id="names">names</a></h2> +<div class="level2"> + +<p> + +Prints out only the filenames without any other progress indicator. This is +a good option when outputting to a log file rather than a terminal. +</p> +<pre class="code bash"><pre class="code bash"><span class="br0">[</span>dwayne@laptop OOo20<span class="br0">]</span>$ oo2po -P --<span class="re2">progress=</span>names en-US.sdf pot +so3/src.oo +dbaccess/<span class="kw3">source</span>/ui/uno.oo +helpcontent2/<span class="kw3">source</span>/text/shared.oo +wizards/<span class="kw3">source</span>/formwizard.oo +sch/<span class="kw3">source</span>/ui/dlg.oo +helpcontent2/<span class="kw3">source</span>/text/sbasic/shared/<span class="nu0">01</span>.oo +dbaccess/<span class="kw3">source</span>/core/resource.oo +svtools/<span class="kw3">source</span>/sbx.oo +dbaccess/<span class="kw3">source</span>/ui/relationdesign.oo +scp2/<span class="kw3">source</span>/writer.oo +filter/<span class="kw3">source</span>/xsltdialog.oo</pre></pre> +</div> +<!-- SECTION "names" [1993-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-prop2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-prop2po.html new file mode 100644 index 0000000..c29d239 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-prop2po.html @@ -0,0 +1,264 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="prop2po_and_po2prop" id="prop2po_and_po2prop">prop2po and po2prop</a></h1> +<div class="level1"> + +<p> + +Convert between Java property files (.properties) and Gettext <acronym title="Gettext Portable Object">PO</acronym> format. +</p> + +<p> +Note: this tool completely eliminates the need for <a href="toolkit-prop2po.html#doing_away_with_native2ascii" class="wikilink1" title="toolkit-prop2po.html">native2ascii</a> as po2prop does the correct escaping to the Latin1 encoding that is needed by Java. +</p> + +</div> +<!-- SECTION "prop2po and po2prop" [1-300] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">prop2po [options] <property> <po> +po2prop [options] -t <template> <po> <property></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <property> </td><td class="col1 leftalign"> is a directory containing property files or an individual property file </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a directory containing <acronym title="Gettext Portable Object">PO</acronym> files and an individual property file </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> <template> </td><td class="col1 leftalign"> is a directory of template property files or a single template property file </td> + </tr> +</table> + +<p> + +Options (prop2po): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in properties format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in properties format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> <a href="toolkit-duplicates_duplicatestyle.html" class="wikilink1" title="toolkit-duplicates_duplicatestyle.html">--duplicates=DUPLICATESTYLE</a> </td><td class="col1 leftalign"> what to do with duplicate strings (identical source text): merge (default), msgid_comment, msgctxt, keep, msgid_comment_all </td> + </tr> +</table> + +<p> + +Options (po2prop): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in properties format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in properties format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> <a href="toolkit-personality_type.html" class="wikilink1" title="toolkit-personality_type.html">--personality=TYPE</a> </td><td class="col1 leftalign"> set the output behaviour: java (default), mozilla </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [301-2740] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +These examples demonstrate most of the useful invocations of prop2po: +</p> + +</div> +<!-- SECTION "Examples" [2741-2833] --> +<h3><a name="creating_pot_files" id="creating_pot_files">Creating POT files</a></h3> +<div class="level3"> +<pre class="code">prop2po -P properties pot</pre> + +<p> + +Extract messages from <em>properties</em> directory and place them in a directory called <em>pot</em>. The -P option ensures that we create <acronym title="Gettext Portable Object Template">POT</acronym> files instead of <acronym title="Gettext Portable Object">PO</acronym> files. + +</p> +<pre class="code">prop2po -P file.properties file.pot</pre> + +<p> + +Extract messages from <em>file.properties</em> and place them in <em>file.pot</em>. +</p> + +</div> +<!-- SECTION "Creating POT files" [2834-3169] --> +<h3><a name="creating_po_files_from_existing_work" id="creating_po_files_from_existing_work">Creating PO files from existing work</a></h3> +<div class="level3"> +<pre class="code">prop2po --duplicates=msgctxt -t reference zu zu-po</pre> + +<p> + +Extract all existing Zulu messages from <em>zu</em> directory and place the resultant <acronym title="Gettext Portable Object">PO</acronym> files in a directory called <em>zu-po</em>. If you find duplicate messages in a file then use Gettext's mgsctxt to disambiguate them. During the merge we use the .properties files in <em>reference</em> as templates and as the source of the English text for the msgid. Once you have your <acronym title="Gettext Portable Object">PO</acronym> files you might want to use <a href="toolkit-pomigrate2.html" class="wikilink1" title="toolkit-pomigrate2.html">pomigrate2</a> to ensure that your <acronym title="Gettext Portable Object">PO</acronym> files match the latest <acronym title="Gettext Portable Object Template">POT</acronym> files. +</p> + +</div> +<!-- SECTION "Creating PO files from existing work" [3170-3739] --> +<h3><a name="creating_.properties_files_from_your_translations" id="creating_.properties_files_from_your_translations">Creating .properties files from your translations</a></h3> +<div class="level3"> +<pre class="code">po2prop -t reference zu-po zu</pre> + +<p> + +Using our translations found in <em>zu-po</em> and the templates found in <em>reference</em> we create a new set of property files in <em>zu</em>. These new property files will look exactly like those found in the templates, but with the text changed to the translation. Any fuzzy entry in our <acronym title="Gettext Portable Object">PO</acronym> files will be ignored and any untranslated item will be placed in <em>zu</em> in English. The .properties file created will be based on the Java specification and will thus use escaped Unicode. Where + +</p> +<pre class="code">ṽḁḽṻḝ</pre> + +<p> + +Will appear in the files as: + +</p> +<pre class="code">\u1E7D\u1E01\u1E3D\u1E7B\u1E1D</pre> + +<p> + +To get output as used by Mozilla localisation do the following: + +</p> +<pre class="code">po2prop --personality=mozilla -t reference zu-po zu</pre> + +<p> + +This will do exactly the same as above except that the output will now appear as real Unicode characters in UTF-8 encoding. +</p> + +</div> +<!-- SECTION "Creating .properties files from your translations" [3740-4644] --> +<h2><a name="doing_away_with_native2ascii" id="doing_away_with_native2ascii">Doing away with native2ascii</a></h2> +<div class="level2"> + +<p> + +The <a href="http://man.cx/native2ascii" class="interwiki iw_man" title="http://man.cx/native2ascii">native2ascii</a> command is the traditional tool of property file localisers. With prop2po there is no need to use this command or to ever work directly with the escaped Unicode. +</p> + +<p> +If you are working mostly with Gettext <acronym title="Gettext Portable Object">PO</acronym> files then this is a double benefit as you can now use your favourite <acronym title="Gettext Portable Object">PO</acronym> editor to translate Java applications. Your process would now look like this: + +</p> +<pre class="code">prop2po some.properties some.po</pre> + +<p> + +Firstly create a <acronym title="Gettext Portable Object">PO</acronym> file that you can translate. Now translate it in your favourite <acronym title="Gettext Portable Object">PO</acronym> editor. + +</p> +<pre class="code">po2prop -t some.properties some.po some-other.properties</pre> + +<p> + +Using the original properties file as a template we preserve all layout and comments, combined with your <acronym title="Gettext Portable Object">PO</acronym> translation we create a new translate properties file. During this whole process we have not needed to understand or process any escaping prop2po and po2prop handle that all automatically. +</p> + +<p> +If you have existing translations you can recover them as follows: + +</p> +<pre class="code">prop2po -t some.properties translations.properties translations.po</pre> + +<p> + +This takes the default English properties file and combines it with your translate properties file and created a <acronym title="Gettext Portable Object">PO</acronym> file. You now continue translating using your <acronym title="Gettext Portable Object">PO</acronym> file. +</p> + +</div> +<!-- SECTION "Doing away with native2ascii" [4645-5873] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known. + +</p> + +</div> +<!-- SECTION "Bugs" [5874-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-properties.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-properties.html new file mode 100644 index 0000000..4b90b4d --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-properties.html @@ -0,0 +1,65 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="mozilla_and_java_properties_files" id="mozilla_and_java_properties_files">Mozilla and Java properties files</a></h1> +<div class="level1"> + +<p> + +The Translate Toolkit can manage Java .properties files +</p> + +</div> +<!-- SECTION "Mozilla and Java properties files" [1-106] --> +<h2><a name="features" id="features">Features</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Fully manage Java escaping (Mozilla non-escaped form is also handled)</div> +</li> +<li class="level1"><div class="li"> Preserves the layout of the original source file in the translated version</div> +</li> +</ul> + +</div> +<!-- SECTION "Features" [107-282] --> +<h2><a name="not_implemented" id="not_implemented">Not implemented</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Does not fold access keys together as done in the Mozilla <a href="toolkit-dtd.html" class="wikilink1" title="toolkit-dtd.html">DTD</a> format.</div> +</li> +</ul> + +</div> +<!-- SECTION "Not implemented" [283-391] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">editmenu.label = "Edit" +saveas.label = "Save As"</pre> + +</div> +<!-- SECTION "Examples" [392-468] --> +<h2><a name="references" id="references">References</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Java Properties Class <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html#load(java.io.InputStream)" class="urlextern" title="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html#load(java.io.InputStream)">load method</a> describes the properties format.</div> +</li> +<li class="level1"><div class="li"> <a href="http://java.sun.com/dtd/properties.dtd" class="urlextern" title="http://java.sun.com/dtd/properties.dtd">http://java.sun.com/dtd/properties.dtd</a> - alternate <acronym title="Extensible Markup Language">XML</acronym> based property representation</div> +</li> +</ul> + +</div> +<!-- SECTION "References" [469-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-psyco_mode.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-psyco_mode.html new file mode 100644 index 0000000..e45ba6f --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-psyco_mode.html @@ -0,0 +1,74 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="psyco_mode" id="psyco_mode">--psyco=MODE</a></h1> +<div class="level1"> + +<p> + +Psyco is an optimiser for Python programs. It takes the sections that are run often or that could benefit from being compiled and compiles them into machine language. This machine code is executed instead of the Python code. +</p> + +<p> +If you didn't understand any of that then simply understand that it makes you program run faster if it is installed. +</p> + +<p> +By default it is switched on, so you can safely ignore this option and benefit from psyco optimisations anyway. +</p> + +<p> +Note psyco only works on i386 architectures. +</p> + +<p> +To install psyco, you can look for it in your distribution's packages, or obtain it here: <a href="http://psyco.sourceforge.net/" class="urlextern" title="http://psyco.sourceforge.net/">http://psyco.sourceforge.net/</a> +</p> + +</div> +<!-- SECTION "--psyco=MODE" [1-655] --> +<h2><a name="none" id="none">none</a></h2> +<div class="level2"> + +<p> + +Switch psyco optimisation off. +</p> + +</div> +<!-- SECTION "none" [656-705] --> +<h2><a name="full_default" id="full_default">full (default)</a></h2> +<div class="level2"> + +<p> + +This is the default option, even if no --psyco command line options is specified. It will try to optimise everything, so potentially it might consume more memory. +</p> + +</div> +<!-- SECTION "full (default)" [706-897] --> +<h2><a name="profile" id="profile">profile</a></h2> +<div class="level2"> + +<p> + +This tries to selectively compile certain program parts, and therefore should consume less memory. + +</p> + +</div> +<!-- SECTION "profile" [898-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-qm.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-qm.html new file mode 100644 index 0000000..918db3c --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-qm.html @@ -0,0 +1,58 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="qt_.qm" id="qt_.qm">Qt .qm</a></h1> +<div class="level1"> + +<p> + +NOTE: In still to be released 1.1 of the toolkit +</p> + +<p> +A .qm file is a compiled Qt <a href="toolkit-ts.html" class="wikilink1" title="toolkit-ts.html">.ts</a> file. In many ways it is similar to Gettext, in that it uses a hashing table to lookup the translated text. In older version they store only the hash and the translation which doesn't make the format useful for recovering translated text. +</p> + +</div> +<!-- SECTION "Qt .qm" [1-351] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> + +<p> + +The toolkit can read .qm files correctly. There are some unimplemented aspects of the message block, but these seem to be legacy features and require examples to be able to implement the feature. +</p> + +<p> +The .qm implementation cannot write a .qm file, thus you are only able to use this format in a read-only context: counting messages (<a href="toolkit-pocount.html" class="wikilink1" title="toolkit-pocount.html">pocount</a>), reading in messages for a TM or using it as a source format for a converter e.g. a possible qm2xliff converter. +</p> + +</div> +<!-- SECTION "Conformance" [352-837] --> +<h2><a name="todo" id="todo">TODO</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Writing</div> +<ul> +<li class="level2"><div class="li"> Hash algorithm </div> +</li> +</ul> +</li> +</ul> + +</div> +<!-- SECTION "TODO" [838-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-qt_phrase_book.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-qt_phrase_book.html new file mode 100644 index 0000000..7b18aa4 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-qt_phrase_book.html @@ -0,0 +1,71 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="qt_phrase_book_.qph" id="qt_phrase_book_.qph">Qt Phrase Book (.qph)</a></h1> +<div class="level1"> + +<p> + +<p><div class="noteclassic">New in 1.2 +</div></p> +</p> + +<p> +Qt Linguist allows a translator to collect common phrases into a phrase book. This plays a role of glossary lookup as opposed to translation memory. +</p> + +</div> +<!-- SECTION "Qt Phrase Book (.qph)" [1-213] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> + +<p> + +There is no formal definition of the format, although it follows a simple structure: + +</p> +<pre class="code"><!DOCTYPE QPH><QPH> + <phrase> + <source>Source</source> + <target>Target</target> + <definition>Optional definition</definition> + </phrase> +</QPH></pre> + +</div> +<!-- SECTION "Conformance" [214-494] --> +<h2><a name="missing_features" id="missing_features">Missing features</a></h2> +<div class="level2"> + +<p> + +There are no missing features in our support in the toolkit. The only slight difference are: + +</p> +<ul> +<li class="level1"><div class="li"> We don't focus on adding and removing items, just updating and reading</div> +</li> +<li class="level1"><div class="li"> Comments are not properly escaped on reading, they might be on writing</div> +</li> +<li class="level1"><div class="li"> An <acronym title="Extensible Markup Language">XML</acronym> header is output on writing while it seems that no files in the wild contain an <acronym title="Extensible Markup Language">XML</acronym> header.</div> +</li> +<li class="level1"><div class="li"> The <code><definition></code> is aimed at users, the toolkits addnote feature focuses on programmer, translators, etc comments while there is really only one source of comments in a .qph. This causes duplication on the offline editor.</div> +</li> +</ul> + +</div> +<!-- SECTION "Missing features" [495-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-quoting_and_escaping.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-quoting_and_escaping.html new file mode 100644 index 0000000..b067d1a --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-quoting_and_escaping.html @@ -0,0 +1,87 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="quoting_and_escaping" id="quoting_and_escaping">Quoting and Escaping</a></h1> +<div class="level1"> + +<p> + +Different translation <a href="toolkit-formats.html" class="wikilink1" title="toolkit-formats.html">formats</a> handle quoting and escaping strings differently. This is meant to be a common page which outlines the differences +</p> + +</div> +<!-- SECTION "Quoting and Escaping" [1-185] --> +<h2><a name="po_format" id="po_format">PO format</a></h2> +<div class="level2"> + +<p> + +Strings are quoted using double quotes. For long strings multiline quotes are done by opening and closing the quotes on each line. Usually in this case the first line is left blank. The splitting of strings over lines is transparent i.e. it does not imply line breaks in the translated strings. +</p> + +<p> +Escaping is done with a backslash. An escaped double quote (\”) corresponds to a double quote in the original string. \n for newline, \t for tabs etc are used. Backslashes can be escaped to to give a native backslash. +</p> + +<p> +See also <a href="guide-translation-escaping.html" class="wikilink1" title="guide-translation-escaping.html">escaping</a> in the translation guide. +</p> + +<p> +Example + +</p> +<pre class="code">msgid "" +"This is a long string with a \n newline, a \" double quote, and a \\ backslash." +"There is no space between the . at the end of the last sentence " +"and the T at the beginning of this one."</pre> + +</div> +<!-- SECTION "PO format" [186-1009] --> +<h2><a name="dtd_format" id="dtd_format">DTD format</a></h2> +<div class="level2"> + +<p> + +Strings are quoted using either double or single quotes. The quoting character may not occur within the string. There is no provision for escaping. <acronym title="Extensible Markup Language">XML</acronym> entities can be used e.g. <code>&apos;</code> can be used to denote a single quote within the single-quoted string. +</p> + +<p> +Some <acronym title="Document Type Definition">DTD</acronym> files seem to have backslash-escapes, but these are anomalies: see <a href="http://groups.google.com/group/mozilla.dev.l10n/browse_thread/thread/58256c1f59c22798/b4bac2de4182f3e0" class="urlextern" title="http://groups.google.com/group/mozilla.dev.l10n/browse_thread/thread/58256c1f59c22798/b4bac2de4182f3e0">discussion thread on Mozilla l10n-dev</a> +</p> + +</div> +<!-- SECTION "DTD format" [1010-1515] --> +<h2><a name="mozilla_properties_format" id="mozilla_properties_format">Mozilla properties format</a></h2> +<div class="level2"> + +<p> + +Note that this section does not describe the Java properties files, even though they are quite similar. +</p> + +<p> +See <a href="http://www.xulplanet.com/tutorials/xultu/locprops.html" class="urlextern" title="http://www.xulplanet.com/tutorials/xultu/locprops.html">http://www.xulplanet.com/tutorials/xultu/locprops.html</a> +</p> + +<p> +It seems that the literal string “\n” (a backslash followed by the character 'n') and “\t” and “\r” can not be encoded in properties files. This is the assumption of the toolkit. + +</p> + +</div> +<!-- SECTION "Mozilla properties format" [1516-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-rc.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-rc.html new file mode 100644 index 0000000..930f285 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-rc.html @@ -0,0 +1,79 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="windows_rc_files" id="windows_rc_files">Windows RC files</a></h1> +<div class="level1"> + +<p> + +Windows .rc files, or resource files, are used to store translatable text, dialogs, menu, etc. for Windows application. +</p> + +<p> +<p><div class="noteclassic">New in v1.2 +</div></p> +</p> + +</div> +<!-- SECTION "Windows RC files" [1-180] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> + +<p> + +The actual specification of .rc files is hard to come by. The parser was built using <a href="http://en.wikipedia.org/wiki/Wine%20%28software%29" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Wine%20%28software%29">WINE</a> .rc files as a reference. This was done as WINE is a good target for .rc translations. We are confident though that the extraction will prove robust for all .rc files. +</p> + +</div> +<!-- SECTION "Conformance" [181-494] --> +<h2><a name="useful_resource" id="useful_resource">Useful resource</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="http://www.soft-gems.net:8080/browse/RC-Converter" class="urlextern" title="http://www.soft-gems.net:8080/browse/RC-Converter">RC converter</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://www.reactos.org/wiki/index.php/Translating_introduction" class="urlextern" title="http://www.reactos.org/wiki/index.php/Translating_introduction">ReactOS translation instructions</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Useful resource" [495-699] --> +<h2><a name="supported_elements" id="supported_elements">Supported elements</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> DIALOG, DIALOGEX: All translatables</div> +</li> +<li class="level1"><div class="li"> MENU: POPUP, MENUITEM</div> +</li> +<li class="level1"><div class="li"> STRINGTABLE</div> +</li> +<li class="level1"><div class="li"> LANGUAGE: We only parse the first language tag, further LANGUAGE section are ignored</div> +</li> +</ul> + +</div> +<!-- SECTION "Supported elements" [700-904] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> There may be problems with very deeply nested MENU's</div> +</li> +<li class="level1"><div class="li"> LANGUAGE elements cannot yet be updated in <a href="toolkit-po2rc.html" class="wikilink1" title="toolkit-po2rc.html">po2rc</a> (Bug <a href="http://bugs.locamotion.org/show_bug.cgi?id=360" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=360">360</a>)</div> +</li> +</ul> + +</div> +<!-- SECTION "Bugs" [905-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-rc2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-rc2po.html new file mode 100644 index 0000000..0290919 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-rc2po.html @@ -0,0 +1,220 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="rc2po" id="rc2po">rc2po</a></h1> +<div class="level1"> + +<p> + +Converts Windows Resource .rc files to Gettext <acronym title="Gettext Portable Object">PO</acronym> format. +</p> + +<p> +<p><div class="noteclassic">New in v1.2 +</div></p> +</p> + +</div> +<!-- SECTION "rc2po" [1-106] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">rc2po [options] <rc> <po> +po2rc [options] -t <rc> <po> <rc></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <rc> </td><td class="col1 leftalign"> is a valid Windows Resource file or directory of those files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a directory of <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="Gettext Portable Object Template">POT</acronym> files </td> + </tr> +</table> + +<p> + +Options (rc2po): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in php format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in php format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --charset=CHARSET </td><td class="col1 leftalign"> charset to use to decode the RC files (default: cp1252) </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> <a href="toolkit-duplicates_duplicatestyle.html" class="wikilink1" title="toolkit-duplicates_duplicatestyle.html">--duplicates=DUPLICATESTYLE</a> </td><td class="col1 leftalign"> what to do with duplicate strings (identical source text): merge, msgid_comment, msgctxt, keep, msgid_comment_all (default: 'msgctxt') </td> + </tr> +</table> + +<p> + +Options (po2rc): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in php format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in php format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --charset=CHARSET </td><td class="col1 leftalign"> charset to use to decode the RC files (default: utf-8) </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [107-2484] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +This example looks at roundtrip of Windows Resource translations as well as recovery of existing translations. +</p> + +<p> +First we need to create a set of <acronym title="Gettext Portable Object Template">POT</acronym> files. + +</p> +<pre class="code">rc2po -P lang/ pot/</pre> + +<p> + +All .rc files found in the <code>lang/</code> directory are converted to Gettext <acronym title="Gettext Portable Object Template">POT</acronym> files and placed in the <code>pot/</code> directory. +</p> + +<p> +If you are translating for the first time then you can skip the next step. If you need to recovery your existing translations then we do the following: + +</p> +<pre class="code">rc2po -t lang zu po-zu/</pre> + +<p> + +Using the English .rc files found in <code>lang</code> and your existing Zulu translation in <code>zu</code> we create a set of <acronym title="Gettext Portable Object">PO</acronym> files in <code>po-zu</code>. These will now have your translations. Please be aware that in order for the to work 100% you need to have both English and Zulu at the same revision, if they are not you will have to review all translations. Also the .rc files may be in different encoding, we cannot at the moment process files of different encodings and assume both are in the same encoding supplied. +</p> + +<p> +You are now in a position to translate your recovered translations or your new <acronym title="Gettext Portable Object Template">POT</acronym> files. +</p> + +<p> +Once translated you can convert back as follows: + +</p> +<pre class="code">po2rc -t lang/ po-zu/ zu/</pre> + +<p> + +Your translations found in the Zulu <acronym title="Gettext Portable Object">PO</acronym> directory, <code>po-zu</code>, will be converted to .rc using the files in <code>lang/</code> as templates and placing your new translations in <code>zu/</code>. +</p> + +<p> +To update your translations simply redo the <acronym title="Gettext Portable Object Template">POT</acronym> creation step and make use of <a href="toolkit-pot2po.html" class="wikilink1" title="toolkit-pot2po.html">pot2po</a> to bring your translation up-to-date. +</p> + +</div> +<!-- SECTION "Examples" [2485-3971] --> +<h2><a name="issues" id="issues">Issues</a></h2> +<div class="level2"> + +<p> + +If you are recovering translation using <code>rc2po -t en.rc xx.rc xx.po</code> then both en.rc and xx.rc need to be in the same encoding. +</p> + +<p> +There might be problems with MENUs that are deaply nested. +</p> + +</div> +<!-- SECTION "Issues" [3972-4182] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known + +</p> + +</div> +<!-- SECTION "Bugs" [4183-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-rewrite_style.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-rewrite_style.html new file mode 100644 index 0000000..eff8679 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-rewrite_style.html @@ -0,0 +1,130 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="rewrite_style" id="rewrite_style">--rewrite=STYLE</a></h1> +<div class="level1"> + +<p> + +podebug allows you to rewrite the output text in a number of ways. +</p> + +</div> +<!-- SECTION "--rewrite=STYLE" [1-99] --> +<h2><a name="xxx" id="xxx">xxx</a></h2> +<div class="level2"> + +<p> + +The source text is surrounded by xxx as follows + +</p> +<pre class="code">msgid "English" +msgstr "xxxEnglishxxx"</pre> + +<p> + +This is useful when you want to identify which text is localisable. There might be text in your application which you cannot localise this will allow you to quickly identify that text. +</p> + +</div> +<!-- SECTION "xxx" [100-396] --> +<h2><a name="en" id="en">en</a></h2> +<div class="level2"> + +<p> + +The source text is copied to the target + +</p> +<pre class="code">msgid "English" +msgstr "English"</pre> + +<p> + +In this way you can create translations that contain only the source text. Useful if you are preparing a roundtrip test or want to start an English derived translation such as British English. It produces the same results as <a href="http://man.cx/msgen" class="interwiki iw_man" title="http://man.cx/msgen">msgen</a> but with the advantage that you can add debug markers. +</p> + +</div> +<!-- SECTION "en" [397-789] --> +<h2><a name="blank" id="blank">blank</a></h2> +<div class="level2"> + +<p> + +This simply empties your current translations + +</p> +<pre class="code">msgid "English" +msgstr ""</pre> + +<p> + +When you have a set of translation files but no template this allows you to essentially convert a <acronym title="Gettext Portable Object">PO</acronym> into a <acronym title="Gettext Portable Object Template">POT</acronym> file. This mimics the --empty functionality of <a href="http://man.cx/msghack" class="interwiki iw_man" title="http://man.cx/msghack">msghack</a> +</p> + +</div> +<!-- SECTION "blank" [790-1064] --> +<h2><a name="chef" id="chef">chef</a></h2> +<div class="level2"> + +<p> + +New in version 1.2 +</p> + +<p> +Rewrites the source text using mock Swedish as popularised by the <a href="http://en.wikipedia.org/wiki/Swedish%20Chef" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Swedish%20Chef">Swedish Chef</a>. + +</p> +<pre class="code">msgid "English" +msgstr "Ingleesh"</pre> + +<p> + +This is probably only useful for some fun. It's not guaranteed that every string will be rewritten as the mock Swedish rules might not apply thus its not ideal for identifying untranslatable strings. +</p> + +</div> +<!-- SECTION "chef" [1065-1431] --> +<h2><a name="unicode" id="unicode">unicode</a></h2> +<div class="level2"> + +<p> + +New in version 1.2 +</p> + +<p> +Rewrites the source text with Unicode characters that looks like the Latin characters that they are replacing. + +</p> +<pre class="code">msgid "English" +msgstr "Ḗƞɠŀīşħ"</pre> + +<p> + +This allows a translator or programmer to test a programs ability to use Unicode message strings. By using characters in the Unicode range but that are related to the plain Latin characters that they replace we ensure that the messages are still readable. +</p> + +<p> +Note: The rewrite rule will also rewrite variables which will cause problems in some situations. Run <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> as a quick method to fix up rewritten variables. + +</p> + +</div> +<!-- SECTION "unicode" [1432-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-running_the_tools_on_microsoft_windows.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-running_the_tools_on_microsoft_windows.html new file mode 100644 index 0000000..16f4a6d --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-running_the_tools_on_microsoft_windows.html @@ -0,0 +1,82 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="running_the_tools_on_microsoft_windows" id="running_the_tools_on_microsoft_windows">Running the tools on Microsoft Windows</a></h1> +<div class="level1"> + +<p> + +Since the toolkit is written in Python, it should work perfectly on Windows. +</p> + +</div> +<!-- SECTION "Running the tools on Microsoft Windows" [1-132] --> +<h2><a name="add_the_toolkit_to_your_path" id="add_the_toolkit_to_your_path">Add the toolkit to your path</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Add the toolkit to your path" [133-175] --> +<h3><a name="windows_9598" id="windows_9598">Windows 95/98</a></h3> +<div class="level3"> + +<p> + +You might need to add the installation directory of the translate toolkit to your path + +</p> +<pre class="code">path "C:\Program Files\translate-toolkit\"</pre> + +<p> + +This will work for one session, but will be lost when you reboot again. Therefore you might want to add it to the autoexec.bat file. +</p> + +</div> +<!-- SECTION "Windows 95/98" [176-468] --> +<h3><a name="windows_2000xp" id="windows_2000xp">Windows 2000/XP</a></h3> +<div class="level3"> + +<p> + +You can add to the path permanently. Check <a href="http://www.computerhope.com/issues/ch000549.htm" class="urlextern" title="http://www.computerhope.com/issues/ch000549.htm">this</a> useful guide. You should add the following to your path: + +</p> +<pre class="code">C:\Programs Files\translate-toolkit\</pre> + +<p> + +If you have the <a href="http://gnuwin32.sourceforge.net/packages/gettext.htm" class="urlextern" title="http://gnuwin32.sourceforge.net/packages/gettext.htm">Gettext tools</a> installed, add it to your path as well: + +</p> +<pre class="code">C:\Program Files\GnuWin32\bin\</pre> + +</div> +<!-- SECTION "Windows 2000/XP" [469-857] --> +<h2><a name="change_windows_file_to_unix_file" id="change_windows_file_to_unix_file">Change Windows file to Unix file</a></h2> +<div class="level2"> + +<p> + +Some programs in Windows will add CRLFs to the file which is considered rather poor practice for l10ns that require Unix files. To fix a text file, drag and drop it to the dos2unix.exe utility at Bastet.com: +</p> + +<p> +<a href="http://www.bastet.com/" class="urlextern" title="http://www.bastet.com/">http://www.bastet.com/</a> +</p> + +</div> +<!-- SECTION "Change Windows file to Unix file" [858-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-support_for_toolkit_tmx.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-support_for_toolkit_tmx.html new file mode 100644 index 0000000..65585f2 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-support_for_toolkit_tmx.html @@ -0,0 +1,131 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h2><a name="support_for_tmx" id="support_for_tmx">Support for TMX</a></h2> +<div class="level2"> + +<p> + +Although <acronym title="Translation Memory eXchange">TMX</acronym> is supposed to be an exchange standard, not all tools create or read standard <acronym title="Translation Memory eXchange">TMX</acronym> files, and consequently some tools may not be able to use the Toolkit's TMXes and vice versa. +</p> + +<p> +Have a good Unicode editor handy so that you can fiddle with the encoding of the file in extreme cases. For <acronym title="Microsoft">MS</acronym> Windows users, we suggest Babelpad. +</p> + +</div> + +<h4><a name="how_they_were_tested" id="how_they_were_tested">How they were tested</a></h4> +<div class="level4"> + +<p> + +I tested other tools by checking if they import Toolkit TMXes without complaint, and in some cases if I could get translation matches from it. I tested their TMXes with the Toolkit by doing a pocount on the <acronym title="Translation Memory eXchange">TMX</acronym> and doing a pot2po (with --tm=file.tmx) on a file with known matches. +</p> + +</div> +<!-- SECTION "Support for TMX" [2-682] --> +<h3><a name="support_for_toolkit_tmxes" id="support_for_toolkit_tmxes">Support for Toolkit TMXes</a></h3> +<div class="level3"> + +</div> + +<h4><a name="cafetran_2007" id="cafetran_2007">Cafetran 2007</a></h4> +<div class="level4"> + +<p> + +Seems fully compatible with Tranlate-toolkit, in both directions. Cafetran imports our <acronym title="Translation Memory eXchange">TMX</acronym> without complaints. A Cafetran user was able to read and use one of our TMXes, and we were able to test and use one of the Cafetran user's TMXes. +</p> + +</div> + +<h4><a name="wordfast_5" id="wordfast_5">Wordfast 5</a></h4> +<div class="level4"> + +<p> + +Fully compatible with Translate-toolkit. Wordfast opens our TMXes directly and converts them to its own internal format. Wordfast can also export to <acronym title="Translation Memory eXchange">TMX</acronym>, which can be read by our tools. Remember, Wordfast's Unicode format is UTF16LE with BOM, so if you run into problems, try converting it by character encoding. Wordfast 3 and 4 should also work. +</p> + +</div> + +<h4><a name="trados_2007_workbench_8" id="trados_2007_workbench_8">Trados 2007 (Workbench 8)</a></h4> +<div class="level4"> + +<p> + +Possibly compatible with Translate-toolkit. To import using Trados, first create a Trados TM and then import the <acronym title="Translation Memory eXchange">TMX</acronym> into it. Trados did import our test <acronym title="Translation Memory eXchange">TMX</acronym> (22000 segments) but it lost about 30% of the segments in the process. Our tools can read TMXes exported from Trados. +</p> + +</div> + +<h4><a name="omegat_1.6" id="omegat_1.6">OmegaT 1.6</a></h4> +<div class="level4"> + +<p> + +Fully compatible with Translate-toolkit. Simply place our TMXes in the /tm/ folder of your project. All of OmegaT's exported TMXes can be read by the Translate-toolkit -- although which one you use will depend on what your workflow is (i.e. with OmegaT's internal tags or without them). +</p> + +</div> +<!-- SECTION "Support for Toolkit TMXes" [683-1979] --> +<h3><a name="no_or_little_support_for_toolkit_tmxes" id="no_or_little_support_for_toolkit_tmxes">No or little support for Toolkit TMXes</a></h3> +<div class="level3"> + +</div> + +<h4><a name="aid_trans_professional_2.0" id="aid_trans_professional_2.0">Aid Trans Professional 2.0</a></h4> +<div class="level4"> + +<p> + +Actually, this tool is still in beta and it kept crashing when I tested it, but I was able to discover one thing: the <acronym title="Translation Memory eXchange">TMX</acronym> <acronym title="Document Type Definition">DTD</acronym> (called tmx14.dtd) must be in the same folder as the <acronym title="Translation Memory eXchange">TMX</acronym> file you're trying to import. +</p> + +</div> + +<h4><a name="transolution" id="transolution">Transolution</a></h4> +<div class="level4"> + +<p> + +I was unable to test this tool because I couldn't figure out how it works. +</p> + +</div> + +<h4><a name="across" id="across">Across</a></h4> +<div class="level4"> + +<p> + +This tool was too big for me to test (several hundreds of megabytes). +</p> + +</div> + +<h4><a name="deja_vu" id="deja_vu">Deja Vu</a></h4> +<div class="level4"> + +<p> + +I was unable to test this tool because I couldn't figure out how it works. +</p> + +</div> +<!-- SECTION "No or little support for Toolkit TMXes" [1980-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-symb2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-symb2po.html new file mode 100644 index 0000000..8a3c05f --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-symb2po.html @@ -0,0 +1,238 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="symb2po" id="symb2po">symb2po</a></h1> +<div class="level1"> + +<p> + +Converts Symbian-style translation files to <acronym title="Gettext Portable Object">PO</acronym> files and vice versa. The Symbian translation files currently have a strong Buddycloud flavour, but the tools will be made more general as the need arises. +</p> + +<p> +<p><div class="noteclassic">These tools currently only appear in the development version of the toolkit. You can get it by <a href="toolkit-installation.html" class="wikilink1" title="toolkit-installation.html">checking out the code from Subverion</a> +</div></p> +</p> + +</div> +<!-- SECTION "symb2po" [1-398] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">symb2po [options] [-t <target_lang_symb>] <source_lang_symb> <po> +po2symb [options] -t <target_lang_symb> <po> <target_lang_symb></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <target_lang_symb> </td><td class="col1 leftalign"> is a valid Symbian translation file or directory of those files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <source_lang_symb> </td><td class="col1 leftalign"> is a valid Symbian translation file or directory of those files </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="Gettext Portable Object Template">POT</acronym> file or a directory of <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="Gettext Portable Object Template">POT</acronym> files </td> + </tr> +</table> + +<p> + +Options (symb2po): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in php format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in the Symbian translation format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> +</table> + +<p> + +Options (po2symb): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in php format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -t TEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in the Symbian translation format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [399-2499] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Examples" [2500-2521] --> +<h3><a name="symb2po1" id="symb2po1">symb2po</a></h3> +<div class="level3"> + +<p> + +The most common use of symb2po, is to generate a <acronym title="Gettext Portable Object Template">POT</acronym> (<acronym title="Gettext Portable Object">PO</acronym> template) file from the English translation (note that the tool currently expects the Symbian translation file to end with the extension .r01, which is the code for English translation files). This file then serves as the source document from which all translations will be derived. +</p> + +<p> +To create a <acronym title="Gettext Portable Object Template">POT</acronym> file called <code>my_project.pot</code> from the source Symbian translation file <code>my_project.r01</code>, the following is executed: + +</p> +<pre class="code">symb2po my_project.r01 my_project.pot</pre> + +<p> + +In order to re-use existing translations in the Symbian translation format, symb2po can merge that translation into the source Symbian translation to produce a translated <acronym title="Gettext Portable Object">PO</acronym> file. The existing Symbian translation file is specified with the <code>-t</code> flag. +</p> + +<p> +To create a file called <code>my_project-en-fr.po</code> (this is not the recommended <acronym title="Gettext Portable Object">PO</acronym> naming convention) from the source Symbian translation file <code>my_project.r01</code> and its French translation <code>my_project.r02</code>, execute: + +</p> +<pre class="code">symb2po -t my_project.r02 my_project.r01 my_project-en-fr.po</pre> + +<p> + +<p><div class="noteclassic">Ensure that the English and French files are well aligned, in other words, no changes to the source text should have happened since the translation was done. +</div></p> +</p> + +</div> +<!-- SECTION "symb2po" [2522-3764] --> +<h3><a name="po2symb" id="po2symb">po2symb</a></h3> +<div class="level3"> + +<p> + +The po2symb tool is used to extract the translations in a <acronym title="Gettext Portable Object">PO</acronym> into a template Symbian translation file. The template Symbian translation file supplies the “shape” of the generated file (formatting and comments). +</p> + +<p> +In order to produce a French Symbian translation file using the English Symbian translation file <code>my_project.r01</code> as a template and the <acronym title="Gettext Portable Object">PO</acronym> file <code>my_project-en-fr.po</code> (this is not the recommended <acronym title="Gettext Portable Object">PO</acronym> naming convention) as the source document, execute: + +</p> +<pre class="code">po2symb -t my_project.r01 my_project-en-fr.po my_project.r02</pre> + +</div> +<!-- SECTION "po2symb" [3765-4314] --> +<h2><a name="notes" id="notes">Notes</a></h2> +<div class="level2"> + +<p> + +The tools won't touch anything appearing between lines marked as + +</p> +<pre class="code">// DO NOT TRANSLATE</pre> + +<p> + +The string <code>r_string_languagegroup_name</code> is used to set the <code>Language-Team</code> <acronym title="Gettext Portable Object">PO</acronym> header field. +</p> + +<p> +The Symbian translation header field <code>Author</code> is used to set the <code>Last-Translator</code> <acronym title="Gettext Portable Object">PO</acronym> header field. +</p> + +</div> +<!-- SECTION "Notes" [4315-4625] --> +<h2><a name="issues" id="issues">Issues</a></h2> +<div class="level2"> + +<p> + +The file format is heavily tilted towards the Buddycould implementation +</p> + +<p> +The tools do nothing with the <code>Name</code> and <code>Description</code> Symbian header fields. This means that <code>po2symb</code> will just copy the values in the supplied template. So you might see something such as + +</p> +<pre class="code">Description : Localisation File : English</pre> + +<p> + +in a generated French translation file. +</p> + +</div> +<!-- SECTION "Issues" [4626-5003] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +Probably many, since this software hasn't been tested much yet. +</p> + +</div> +<!-- SECTION "Bugs" [5004-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-tbx.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-tbx.html new file mode 100644 index 0000000..fb48976 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-tbx.html @@ -0,0 +1,195 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="tbx" id="tbx">TBX</a></h1> +<div class="level1"> + +<p> +<acronym title="TermBase eXchange">TBX</acronym> is the LISA standard for terminology and term exchange. +</p> + +<p> +For information on more file formats, see <a href="toolkit-conformance.html" class="wikilink1" title="toolkit-conformance.html">conformance</a>. +</p> + +</div> +<!-- SECTION "TBX" [1-139] --> +<h2><a name="references" id="references">References</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> <a href="http://www.lisa.org/standards/tbx/" class="urlextern" title="http://www.lisa.org/standards/tbx/">Standard home page</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://www.lisa.org/TBX-Specification.33.0.html" class="urlextern" title="http://www.lisa.org/TBX-Specification.33.0.html">Specification</a></div> +</li> +<li class="level1"><div class="li"> <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=45797" class="urlextern" title="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=45797">ISO 30042</a> - <acronym title="TermBase eXchange">TBX</acronym> is an approved <acronym title="International Organization for Standardization">ISO</acronym> standard</div> +</li> +</ul> + +</div> +<!-- SECTION "References" [140-434] --> +<h2><a name="standard_conformance" id="standard_conformance">Standard conformance</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Standard conformance" [435-467] --> +<h3><a name="done" id="done">Done</a></h3> +<div class="level3"> +<ul> +<li class="level1"><div class="li"> Basic file creation</div> +</li> +<li class="level1"><div class="li"> Creating a bilingual list from <acronym title="Comma Seperated Value">CSV</acronym> with <a href="toolkit-csv2tbx.html" class="wikilink1" title="toolkit-csv2tbx.html">csv2tbx</a></div> +</li> +<li class="level1"><div class="li"> Using <tig> tags, not ntig</div> +</li> +</ul> + +</div> +<!-- SECTION "Done" [468-594] --> +<h3><a name="todo" id="todo">Todo</a></h3> +<div class="level3"> +<ul> +<li class="level1"><div class="li"> id attributes for termEntry tags</div> +</li> +<li class="level1"><div class="li"> ntig, read and write</div> +</li> +<li class="level1"><div class="li"> multiple languages</div> +</li> +<li class="level1"><div class="li"> synonyms</div> +</li> +<li class="level1"><div class="li"> cross references</div> +</li> +<li class="level1"><div class="li"> abbreviations</div> +</li> +<li class="level1"><div class="li"> definitions</div> +</li> +<li class="level1"><div class="li"> context</div> +</li> +<li class="level1"><div class="li"> parts of speech</div> +</li> +</ul> + +</div> +<!-- SECTION "Todo" [595-795] --> +<h2><a name="implementation_notes_for_missing_features" id="implementation_notes_for_missing_features">Implementation notes for missing features</a></h2> +<div class="level2"> + +<p> + +Note here: + +</p> +<ul> +<li class="level1"><div class="li"> NLS - South African National Language Services - Multilingual Maths Dictionary</div> +</li> +</ul> + +</div> +<!-- SECTION "Implementation notes for missing features" [796-946] --> +<h3><a name="synonyms" id="synonyms">Synonyms</a></h3> +<div class="level3"> + +<p> +NLS: Extra listing<br/> + +<acronym title="TermBase eXchange">TBX</acronym>: + +</p> +<pre class="code xml"><pre class="code xml"><span class="sc3"><span class="re1"><termNote</span> <span class="re0">type</span>=<span class="st0">"termNote"</span><span class="re2">></span></span>synonym<span class="sc3"><span class="re1"></termNote<span class="re2">></span></span></span></pre></pre> +<p> +according to this <acronym title="TermBase eXchange">TBX</acronym> documentation. In another place: +</p> +<pre class="code xml"><pre class="code xml"><span class="sc3"><span class="re1"><termNote</span> <span class="re0">type</span>=<span class="st0">"termType"</span><span class="re2">></span></span>synonym<span class="sc3"><span class="re1"></termNote<span class="re2">></span></span></span></pre></pre> +<p> +inside a <termGrp>, following <term> +</p> + +</div> +<!-- SECTION "Synonyms" [947-1215] --> +<h3><a name="definition" id="definition">Definition</a></h3> +<div class="level3"> + +<p> +NLS: term {definition/contextual information}<br/> + +<acronym title="TermBase eXchange">TBX</acronym> + +</p> +<pre class="code xml"><pre class="code xml"><span class="sc3"><span class="re1"><descripGrp<span class="re2">></span></span></span> + <span class="sc3"><span class="re1"><descrip</span> <span class="re0">type</span>=<span class="st0">"definition"</span><span class="re2">></span></span>The longish definition of the term<span class="sc3"><span class="re1"></descrip<span class="re2">></span></span></span> +<span class="sc3"><span class="re1"></descripGrp<span class="re2">></span></span></span></pre></pre> +<p> +inside langSet +<descript> can probably be used directly under langSet +</p> + +</div> +<!-- SECTION "Definition" [1216-1481] --> +<h3><a name="context" id="context">Context</a></h3> +<div class="level3"> + +<p> +NLS: term {definition/contextual information} (see above)<br/> + +<acronym title="TermBase eXchange">TBX</acronym>: + +</p> +<pre class="code xml"><pre class="code xml"><span class="sc3"><span class="re1"><descrip</span> <span class="re0">type</span>=<span class="st0">"context"</span><span class="re2">></span></span>A usually somewhat longer contextual sentence.<span class="sc3"><span class="re1"></descrip<span class="re2">></span></span></span></pre></pre> +<p> +inside <ntig> +</p> + +</div> +<!-- SECTION "Context" [1482-1680] --> +<h3><a name="parts_of_speech" id="parts_of_speech">Parts of speech</a></h3> +<div class="level3"> + +<p> +NLS: term v. (or adj, or n.)<br/> + +<acronym title="TermBase eXchange">TBX</acronym>: + +</p> +<pre class="code xml"><pre class="code xml"><span class="sc3"><span class="re1"><termNote</span> <span class="re0">type</span>=<span class="st0">"partOfSpeech"</span> <span class="re2">></span></span>noun<span class="sc3"><span class="re1"></termNote<span class="re2">></span></span></span></pre></pre> +<p> +following <term> +</p> + +</div> +<!-- SECTION "Parts of speech" [1681-1828] --> +<h3><a name="cross_reference" id="cross_reference">Cross reference</a></h3> +<div class="level3"> + +<p> +NLS: alternate term → real lemma<br/> + +<acronym title="TermBase eXchange">TBX</acronym>: <ref> TODO +</p> + +</div> +<!-- SECTION "Cross reference" [1829-1907] --> +<h3><a name="abbreviations" id="abbreviations">Abbreviations</a></h3> +<div class="level3"> + +<p> +NLS: same as alternate term: a.m. → before noon<br/> + +<acronym title="TermBase eXchange">TBX</acronym>: TODO + +</p> + +</div> +<!-- SECTION "Abbreviations" [1908-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-text.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-text.html new file mode 100644 index 0000000..997ff23 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-text.html @@ -0,0 +1,50 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="simple_text_documents" id="simple_text_documents">Simple Text Documents</a></h1> +<div class="level1"> + +<p> + +The Translate Toolkit can process simple Text files. This is very useful for translating installation files and READMEs. The processing of these files is performed by the <a href="toolkit-txt2po.html" class="wikilink1" title="toolkit-txt2po.html">txt2po</a> converter. +</p> + +<p> +In some cases you will need to adjust the source text for the conversion management to work well. This is because the text file format support considered units to be space separated blocks of text. +</p> + +</div> +<!-- SECTION "Simple Text Documents" [1-434] --> +<h2><a name="example" id="example">Example</a></h2> +<div class="level2"> +<pre class="code">Heading +======= + +Paragraph One + +Paragraph Two: +* First bullet +* Second bullet</pre> + +<p> + +This example will result in three units. The first will include the underline in the header. The third will include all the bullet points in one paragraph together with the paragraph lead in. + +</p> + +</div> +<!-- SECTION "Example" [435-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-tiki2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-tiki2po.html new file mode 100644 index 0000000..00a75a1 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-tiki2po.html @@ -0,0 +1,156 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="tiki2po" id="tiki2po">tiki2po</a></h1> +<div class="level1"> + +<p> + +Converts <a href="http://tikiwiki.org" class="urlextern" title="http://tikiwiki.org">TikiWiki</a> language.php files to Gettext <acronym title="Gettext Portable Object">PO</acronym> format. +</p> + +</div> +<!-- SECTION "tiki2po" [1-107] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">tiki2po [options] <tiki> <po> +po2tiki [options] <po> <tiki></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <tiki> </td><td class="col1 leftalign"> is a valid language.php file for TikiWiki </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a <acronym title="Gettext Portable Object">PO</acronym> file </td> + </tr> +</table> + +<p> + +Options (tiki2po): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in php format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0"> --include-unused </td><td class="col1"> When converting, include strings in the “unused” section? </td> + </tr> +</table> + +<p> + +Options (po2tiki): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -i INPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -x EXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -o OUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in php format </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [108-1582] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> + +<p> + +These examples demonstrate the use of tiki2po: + +</p> +<pre class="code">tiki2po language.php language.po</pre> + +<p> + +Convert the tiki language.php file to .po + +</p> +<pre class="code">po2tiki language.po language.php</pre> + +<p> + +Convert a .po file to a tiki language.php file +</p> + +</div> +<!-- SECTION "Examples" [1583-1816] --> +<h2><a name="notes" id="notes">Notes</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Templates are not currently supported.</div> +</li> +</ul> + +</div> +<!-- SECTION "Notes" [1817-1879] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +None known + +</p> + +</div> +<!-- SECTION "Bugs" [1880-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-tmserver.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-tmserver.html new file mode 100644 index 0000000..4b4dc1e --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-tmserver.html @@ -0,0 +1,100 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="tmserver" id="tmserver">tmserver</a></h1> +<div class="level1"> + +<p> +tmserver is a Translation Memory service that can be queried via <acronym title="Hyper Text Transfer Protocol">HTTP</acronym> using a simple REST like <acronym title="Uniform Resource Locator">URL</acronym>/http and data is exchanged between server and client encoded in JSON +</p> + +</div> +<!-- SECTION "tmserver" [1-192] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> + +<p> +tmserver.py --bind=HOSTNAME --port=PORT [--tmdb=TMDBFILE] [--import-translation-file=TMFILE [--import-source-lang=SOURCE_LANG] [--import-target-lang=TARGET_LANG]] +</p> + +<p> +TMDBFILE is the sqlite database file containing <a href="toolkit-tmdb.html" class="wikilink2" title="toolkit-tmdb.html">tmdb</a> translation memory data, if not specified a new temporary database is created +</p> + +<p> +TMFILE is a translation file (po, xliff, etc.) that should be imported into the database (mostly useful when no tmdb file is specified). +</p> + +<p> +Options: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0"> -h, --help </td><td class="col1"> show this help message and exit </td> + </tr> + <tr class="row1"> + <td class="col0"> -d TMDBFILE, --tmdb=TMDBFILE </td><td class="col1"> translation memory database </td> + </tr> + <tr class="row2"> + <td class="col0"> -f TMFILES, --import-translation-file=TMFILE </td><td class="col1"> translation file to import into the database </td> + </tr> + <tr class="row3"> + <td class="col0"> -t TARGET_LANG, --import-target-lang=TARGET_LANG </td><td class="col1"> target language of translation files </td> + </tr> + <tr class="row4"> + <td class="col0"> -s SOURCE_LANG, --import-source-lang=SOURCE_LANG </td><td class="col1"> source language of translation files </td> + </tr> + <tr class="row5"> + <td class="col0"> -b BIND, --bind=HOSTNAME </td><td class="col1"> adress to bind server to </td> + </tr> + <tr class="row6"> + <td class="col0"> -p PORT, --port=PORT </td><td class="col1"> port to listen on </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [193-1151] --> +<h2><a name="testing" id="testing">Testing</a></h2> +<div class="level2"> + +<p> +easiest way to run the server for testing is to pass it a large translation file (maybe generated by <a href="toolkit-pocompendium.html" class="wikilink1" title="toolkit-pocompendium.html">pocompendium</a>) to create a tmdb database on the fly. + +</p> +<pre class="code"> tmserver -b localhost -p 8080 -f compendium.po -s en_US -t ar</pre> + +<p> + +The server can be queried using a webbrowser. the url would be <a href="http://HOST:PORT/tmserver/SOURCE_LANG/TARGET_LANG/unit/STRING" class="urlextern" title="http://HOST:PORT/tmserver/SOURCE_LANG/TARGET_LANG/unit/STRING">http://HOST:PORT/tmserver/SOURCE_LANG/TARGET_LANG/unit/STRING</a> +</p> + +<p> +So to see suggestions for “open file” try the url <a href="http://localhost:8080/tmserver/en_US/ar/unit/open+file" class="urlextern" title="http://localhost:8080/tmserver/en_US/ar/unit/open+file">http://localhost:8080/tmserver/en_US/ar/unit/open+file</a> +</p> + +</div> +<!-- SECTION "Testing" [1152-1627] --> +<h2><a name="api" id="api">API</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "API" [1628-1643] --> +<h2><a name="example_client" id="example_client">Example Client</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Example Client" [1644-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-tmx.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-tmx.html new file mode 100644 index 0000000..2bd2b19 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-tmx.html @@ -0,0 +1,54 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="tmx" id="tmx">TMX</a></h1> +<div class="level1"> + +<p> +<acronym title="Translation Memory eXchange">TMX</acronym> is the LISA standard for translation memories. See <a href="http://www.lisa.org/standards/tmx" class="urlextern" title="http://www.lisa.org/standards/tmx">http://www.lisa.org/standards/tmx</a>. +</p> + +</div> +<!-- SECTION "TMX" [1-109] --> +<h2><a name="standard_conformance" id="standard_conformance">Standard conformance</a></h2> +<div class="level2"> + +<p> + +<img src="images/smileys/fixme.gif" align="middle" alt="FIXME" />: I think with base class and string escaping we now do strip markup in as much as we have relatively standard escaping (DB) +</p> + +<p> +Summary: <acronym title="Translation Memory eXchange">TMX</acronym> version 1.4 conformance to Level 1, except that no markup is stripped. +</p> +<ul> +<li class="level1"><div class="li"> All required header fields are supplied.</div> +</li> +<li class="level1"><div class="li"> The adminlang field in the header is always English.</div> +</li> +<li class="level1"><div class="li"> None of the optional header fields are supplied.</div> +</li> +<li class="level1"><div class="li"> We assume that only two languages are used (source and single target language).</div> +</li> +<li class="level1"><div class="li"> No special consideration for segmentation.</div> +</li> +<li class="level1"><div class="li"> Currently text is treated as plain text, in other words no markup like <acronym title="HyperText Markup Language">HTML</acronym> inside messages are stripped or interpreted as it should be for complete Level 1 conformance.</div> +</li> +</ul> + +</div> +<!-- SECTION "Standard conformance" [110-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-ts.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ts.html new file mode 100644 index 0000000..5f67889 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ts.html @@ -0,0 +1,84 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="qt_.ts" id="qt_.ts">Qt .ts</a></h1> +<div class="level1"> + +<p> + +The Qt toolkit uses a .ts file format to store translations which are traditionally edited using Qt Linguist. +</p> + +<p> +The format is <acronym title="Extensible Markup Language">XML</acronym> and seems to only have been documented properly in Qt 4.3 + +</p> +<ul> +<li class="level1"><div class="li"> <a href="http://doc.trolltech.com/4.3/linguist-ts-file-format.html" class="urlextern" title="http://doc.trolltech.com/4.3/linguist-ts-file-format.html">DTD Specification</a>: Qt 4.3</div> +</li> +<li class="level1"><div class="li"> <a href="http://svn.ez.no/svn/ezcomponents/trunk/Translation/docs/linguist-format.txt" class="urlextern" title="http://svn.ez.no/svn/ezcomponents/trunk/Translation/docs/linguist-format.txt">http://svn.ez.no/svn/ezcomponents/trunk/Translation/docs/linguist-format.txt</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Qt .ts" [1-388] --> +<h2><a name="complete" id="complete">Complete</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Context</div> +</li> +<li class="level1"><div class="li"> Message: status (unfinished, finished), source, translation</div> +</li> +</ul> + +</div> +<!-- SECTION "Complete" [389-487] --> +<h2><a name="todo" id="todo">TODO</a></h2> +<div class="level2"> + +<p> + +<p><div class="noteclassic">A new parser has been added to the toolkit in v1.2. This allows pocount and other users to work with v1.1 of the .ts format. This corrects almost all of the issues listed below. The converters po2ts and ts2po continue to use the older storage class and thus continue to experience some of these problems. +</div></p> + +</p> +<ul> +<li class="level1"><div class="li"> Compliance with above <acronym title="Document Type Definition">DTD</acronym></div> +</li> +<li class="level1"><div class="li"> byte: within various text areas</div> +</li> +<li class="level1"><div class="li"> translation: obsolete (currently handled with comments in conversion to <acronym title="Gettext Portable Object">PO</acronym>. But should be able to convert Obsolete <acronym title="Gettext Portable Object">PO</acronym> back into obsolete TS. This might mean moving this format properly onto the base class).</div> +</li> +</ul> + +</div> +<!-- SECTION "TODO" [488-1106] --> +<h2><a name="validate" id="validate">Validate</a></h2> +<div class="level2"> + +<p> + +These might work but need validation + +</p> +<ul> +<li class="level1"><div class="li"> Encoding handling for non-UTF-8 file encodings</div> +</li> +</ul> + +</div> +<!-- SECTION "Validate" [1107-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-ts2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ts2po.html new file mode 100644 index 0000000..1bd4687 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-ts2po.html @@ -0,0 +1,157 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="ts2po_and_po2ts" id="ts2po_and_po2ts">ts2po and po2ts</a></h1> +<div class="level1"> + +<p> + +Convert Qt .ts localization files to Gettext .po format files using ts2po and convert the translated +<acronym title="Gettext Portable Object">PO</acronym> files back to TS using po2ts. +</p> + +<p> +The Qt toolkit comes with a localization application, Qt Linguist, however you might wish to standardise +on one localization tool. ts2po allows you to standardise on the <acronym title="Gettext Portable Object">PO</acronym> format and <acronym title="Gettext Portable Object">PO</acronym> related tools. +</p> + +</div> +<!-- SECTION "ts2po and po2ts" [1-372] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">ts2po [options] <ts> <po> +po2ts [options] <po> <ts></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <ts> </td><td class="col1 leftalign"> is a Qt .ts file or directory that contains .ts files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a <acronym title="Gettext Portable Object">PO</acronym> file or a directory of <acronym title="Gettext Portable Object">PO</acronym> files </td> + </tr> +</table> + +<p> + +Options (ts2po): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in ts format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> +</table> + +<p> + +Options (po2ts): +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in ts format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in ts format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [373-2152] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">ts2po -P psi.ts psi.pot</pre> + +<p> + +This will create a <acronym title="Gettext Portable Object Template">POT</acronym> file called <em>psi.pot</em> from the Qt .ts file called <em>psi.ts</em>. + +</p> +<pre class="code">po2ts af.po psi_af.ts</pre> + +<p> + +Now take your translated <acronym title="Gettext Portable Object">PO</acronym> files <em>af.po</em> and convert it into a translated Qt .ts file, <em>psi_af.ts</em>. Note: you +need to use the tools from the Qt toolkit to create the compiled .qm language files for the application. +</p> + +</div> +<!-- SECTION "Examples" [2153-2537] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +There are probably still some bugs related to migrating the various attributes across for the different formats. + +</p> + +</div> +<!-- SECTION "Bugs" [2538-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-txt2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-txt2po.html new file mode 100644 index 0000000..0919b0c --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-txt2po.html @@ -0,0 +1,298 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="txt2po_and_po2txt" id="txt2po_and_po2txt">txt2po and po2txt</a></h1> +<div class="level1"> + +<p> + +txt2po allows you to use the same principles of <acronym title="Gettext Portable Object">PO</acronym> files with normal text +files. In <acronym title="Gettext Portable Object">PO</acronym> only items that change are marked fuzzy and only new items need +to be translated, unchanged items remain unchanged for the translation. +</p> + +</div> +<!-- SECTION "txt2po and po2txt" [1-260] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">txt2po [options] <foo.txt> <foo.po> +po2txt [options] [-t <foo.txt>] <XX.po> <foo-XX.txt></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> foo.txt </td><td class="col1 leftalign"> is the input plain text file </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> foo.po </td><td class="col1 leftalign"> is an empty <acronym title="Gettext Portable Object">PO</acronym> file that may be translated </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> XX.po </td><td class="col1 leftalign"> is a <acronym title="Gettext Portable Object">PO</acronym> file translated into the XX language </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> foo-XX.txt </td><td class="col1 leftalign"> is the foo.txt file translated into language XX </td> + </tr> +</table> + +<p> + +Options (txt2po): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in *, txt formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> --flavour=FLAVOUR </td><td class="col1 leftalign"> The flavour of text file: plain (default), dokuwiki, mediawiki </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --encoding </td><td class="col1 leftalign"> encoding of the input file </td> + </tr> +</table> + +<p> +Options (po2txt): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in txt format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in txt format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -wWRAP, --wrap=WRAP </td><td class="col1 leftalign"> set number of columns to wrap text at </td> + </tr> + <tr class="row11"> + <td class="col0 leftalign"> --fuzzy </td><td class="col1 leftalign"> use translations marked fuzzy </td> + </tr> + <tr class="row12"> + <td class="col0 leftalign"> --nofuzzy </td><td class="col1 leftalign"> don't use translations marked fuzzy (default) </td> + </tr> + <tr class="row13"> + <td class="col0 leftalign"> --encoding </td><td class="col1 leftalign"> encoding of the template file </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [261-2630] --> +<h2><a name="a_roundtrip_example" id="a_roundtrip_example">A roundtrip example</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "A roundtrip example" [2631-2663] --> +<h3><a name="preparing_input_files" id="preparing_input_files">Preparing input files</a></h3> +<div class="level3"> + +<p> + +With <strong>txt2po</strong> a text file is broken down into sections. Each section is +separated by a line of whitespace. Each section will appear as a msgid in the +<acronym title="Gettext Portable Object">PO</acronym> file. Because of this simple method of breaking up the input file it might +be necessary to alter the layout of your input file. For instance you might +want to separate a heading from a paragraph by using whitespace. +</p> + +<p> +For steps in a process you would want to leave a blank line between each step +so that each step can be translated independently. +</p> + +<p> +For a list of items you might want to group them together so that a translator +could for example place them in alphabetic order for their translation. +</p> + +<p> +Once the input file is prepared you can proceed to the next step. +</p> + +</div> +<!-- SECTION "Preparing input files" [2664-3421] --> +<h3><a name="creating_the_pot_files" id="creating_the_pot_files">Creating the POT files</a></h3> +<div class="level3"> + +<p> + +This is simple: + +</p> +<pre class="code">txt2po -P TEXT_FILE text_file.pot</pre> + +<p> + +A translator would copy the <acronym title="Gettext Portable Object Template">POT</acronym> file to their own <acronym title="Gettext Portable Object">PO</acronym> file and then create translations of the entries. +If you wish to create a <acronym title="Gettext Portable Object">PO</acronym> file and not a <acronym title="Gettext Portable Object Template">POT</acronym> file then leave off the <em>-P</em> option. +</p> + +<p> + +You might want to manually edit the <acronym title="Gettext Portable Object Template">POT</acronym> file to remove items that should not be +translated. For instance if part of the document is a license you might want +to remove those if you do not want the license translated for legal reasons. +</p> + +</div> +<!-- SECTION "Creating the POT files" [3422-3937] --> +<h3><a name="translating" id="translating">Translating</a></h3> +<div class="level3"> + +<p> + +Translate as normal. However translators should be aware that writers of the +text file may have used spaces, dashes, equals, underscores and other aids to +indicate things such as: + +</p> +<ul> +<li class="level1"><div class="li"> Headings and sub-headings</div> +</li> +<li class="level4"><div class="li"> Code examples, command lines examples</div> +</li> +<li class="level4"><div class="li"> Various lists</div> +</li> +<li class="level4"><div class="li"> etc</div> +</li> +</ul> + +<p> + +They will need to adapt these to work in their language being aware of how they +will appear once they are merged with the original text document. +</p> + +</div> +<!-- SECTION "Translating" [3938-4413] --> +<h3><a name="creating_a_translated_text_file" id="creating_a_translated_text_file">Creating a translated text file</a></h3> +<div class="level3"> + +<p> + +With the translations complete you can create a translated text file like this: + +</p> +<pre class="code">po2txt -w 75 -t TEXT_FILE translated.po TEXT_FILE.translated</pre> + +<p> + +This uses the original text file as a template and creates a new translated text +file using the translations found in the <acronym title="Gettext Portable Object">PO</acronym> file. +</p> + +<p> +The <em>-w</em> command allows you to reflow the translated text to <em>N</em> number of +characters, otherwise the text will appear as one long line. +</p> + +</div> +<!-- SECTION "Creating a translated text file" [4414-4874] --> +<h2><a name="help_with_wiki_syntax" id="help_with_wiki_syntax">Help with Wiki syntax</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Help with Wiki syntax" [4875-4910] --> +<h3><a name="dokuwiki" id="dokuwiki">dokuwiki</a></h3> +<div class="level3"> + +<p> + +To retrieve the raw syntax for your dokuwiki page add '?do=export_raw' to you <acronym title="Uniform Resource Locator">URL</acronym>. The following would retrieve this current page in raw dokuwiki format <a href="http://translate.sourceforge.net/wiki/toolkit/txt2po?do=export_raw" class="urlextern" title="http://translate.sourceforge.net/wiki/toolkit/txt2po?do=export_raw">http://translate.sourceforge.net/wiki/toolkit/txt2po?do=export_raw</a> + +</p> +<pre class="code">wget http://translate.sourceforge.net/wiki/toolkit/txt2po?do=export_raw -O txt2po.txt +txt2po --flavour=dokuwiki -P txt2po.txt txt2po.pot +# edit txt2po.pot +po2txt -t txt2po.txt fr.po fr.txt</pre> + +<p> + +First we retrieve the file in raw dokuwiki format, then we create a <acronym title="Gettext Portable Object Template">POT</acronym> file for editing. We created a French translation and using po2txt plus the original file as a template we output fr.txt which is a French version of the original txt2po.txt. This file can now be uploaded to the wiki server. +</p> + +</div> +<!-- SECTION "dokuwiki" [4911-5655] --> +<h3><a name="mediawiki" id="mediawiki">MediaWiki</a></h3> +<div class="level3"> + +<p> + +To retrieve the raw media wiki syntax add '?action=raw' to you wiki <acronym title="Uniform Resource Locator">URL</acronym>. The following retrieves the Translate Toolkit page from Wikipedia in raw MediaWiki format <a href="http://en.wikipedia.org/wiki/Translate_Toolkit?action=raw" class="urlextern" title="http://en.wikipedia.org/wiki/Translate_Toolkit?action=raw">http://en.wikipedia.org/wiki/Translate_Toolkit?action=raw</a> or <a href="http://en.wikipedia.org/w/index.php?title=Pootle&action=raw" class="urlextern" title="http://en.wikipedia.org/w/index.php?title=Pootle&action=raw">http://en.wikipedia.org/w/index.php?title=Pootle&action=raw</a>. +</p> + +<p> +to process follow the instructions above but substituting the MediaWiki retrieval method. + +</p> + +</div> +<!-- SECTION "MediaWiki" [5656-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-using_csv2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-using_csv2po.html new file mode 100644 index 0000000..049b99c --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-using_csv2po.html @@ -0,0 +1,290 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="using_csv2po" id="using_csv2po">Using csv2po</a></h1> +<div class="level1"> + +<p> + +<a href="toolkit-csv2po.html" class="wikilink1" title="toolkit-csv2po.html">csv2po</a> allows you to create <acronym title="Comma Seperated Value">CSV</acronym> files from <acronym title="Gettext Portable Object">PO</acronym> files. This allows you to +send translation work to translators who do not or cannot use <acronym title="Gettext Portable Object">PO</acronym> Editors but who +can use a Spreadsheet. +</p> + +</div> +<!-- SECTION "Using csv2po" [1-210] --> +<h2><a name="quickstart" id="quickstart">Quickstart</a></h2> +<div class="level2"> +<ol> +<li class="level1"><div class="li"> <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> --fuzzy --review -t untranslated <po-dir> <po-filtered-dir> (this step is optional)</div> +</li> +<li class="level1"><div class="li"> divide into sections</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-csv2po.html" class="wikilink1" title="toolkit-csv2po.html">po2csv</a> <po-dir|po-filtered-dir> <csv-out></div> +</li> +<li class="level1"><div class="li"> edit in Excel or OpenOffice.org Calc</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-csv2po.html" class="wikilink1" title="toolkit-csv2po.html">csv2po</a> --charset=windows-1250 -t templates <csv-in> <po-in> (you must work against a template directory, the charset option corrects problems with characters sets)</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-phase.html" class="wikilink1" title="toolkit-phase.html">phase</a> - to do basic checks sort out encoding issues</div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a> --mergeblank=no -t <po-dir> <po-in> <po-dir></div> +</li> +<li class="level1"><div class="li"> cvs diff -u > x.diff --- check the changes</div> +</li> +<li class="level1"><div class="li"> cvs ci --- commit changes</div> +</li> +</ol> + +</div> +<!-- SECTION "Quickstart" [211-829] --> +<h2><a name="detailed_description" id="detailed_description">Detailed Description</a></h2> +<div class="level2"> + +<p> + +po2csv allows you to send <acronym title="Comma Seperated Value">CSV</acronym> files, which can be edited in any spreadsheet, to +a translator. This document outlines the process to follow from the raw po +files → <acronym title="Comma Seperated Value">CSV</acronym> files → back to <acronym title="Gettext Portable Object">PO</acronym>. We also look at a case where you may have +submitted a subset of the <acronym title="Gettext Portable Object">PO</acronym> files for translation and you need to integrate +these. +</p> + +</div> +<!-- SECTION "Detailed Description" [830-1181] --> +<h3><a name="creating_a_subset" id="creating_a_subset">Creating a subset</a></h3> +<div class="level3"> + +<p> + +This step is optional. +</p> + +<p> +To send a translator only those messages that are untranslated, fuzzy or need +review run: + +</p> +<pre class="code">pofilter --isfuzzy --isreview -t untranslated <po-dir> <po-filtered-dir></pre> + +</div> +<!-- SECTION "Creating a subset" [1182-1401] --> +<h3><a name="divide_into_sections" id="divide_into_sections">Divide into sections</a></h3> +<div class="level3"> + +<p> + +You might want to divide the work into sections if you are apportioning it to +different translators. In that case create new directories: + +</p> +<pre class="code">eg. po-filtered-dir-1 po-filtered-dir-2 +or po-filtered-dir-bob po-filtered-dir-mary</pre> + +<p> + +Copy files from <em>po-filtered-dir</em> to <em>po-filtered-dir-N</em> in a way that balance the +work or apportions the amounts you want for each translator. Try to keep +sections together and not break them up to much eg. Give one translator all +the OpenOffice.org Calc work don't split it between two people - this is just a +simple measure to ensure constancy. +</p> + +<p> +Now continue as normal and convert to <acronym title="Comma Seperated Value">CSV</acronym> and perform word counts for each +separate directory. +</p> + +</div> +<!-- SECTION "Divide into sections" [1402-2114] --> +<h3><a name="creating_the_csv_files" id="creating_the_csv_files">Creating the CSV files</a></h3> +<div class="level3"> +<pre class="code">po2csv <po-dir|po-filtered-dir> <csv-out></pre> + +<p> + +This will create a set of <acronym title="Comma Seperated Value">CSV</acronym> files in <em>csv-out</em> which you can compress using zip +(we use zip because most people are Windows users) +</p> + +</div> +<!-- SECTION "Creating the CSV files" [2115-2329] --> +<h3><a name="creating_a_word_count" id="creating_a_word_count">Creating a word count</a></h3> +<div class="level3"> + +<p> + +Professional translators work on source word counts. So we create a word count +to go with the file + +</p> +<pre class="code">pocount ` find po-dir|po-filtered-dir -name "*.po"`</pre> + +<p> + +We work on source words regardless of whether the string is fuzzy or not. You +might want to get a lower rate for work on fuzzy strings. +</p> + +<p> +Place the word count file in both the <acronym title="Gettext Portable Object">PO</acronym> and <acronym title="Comma Seperated Value">CSV</acronym> directory to avoid the problem +of finding it later. Check the number to make sure you haven't inadvertently +including something that you didn't want in. +</p> + +</div> +<!-- SECTION "Creating a word count" [2330-2860] --> +<h3><a name="package_the_csv_files" id="package_the_csv_files">Package the CSV files</a></h3> +<div class="level3"> +<pre class="code">zip -r9 work.zip <csv-out></pre> + +</div> +<!-- SECTION "Package the CSV files" [2861-2923] --> +<h3><a name="translating" id="translating">Translating</a></h3> +<div class="level3"> + +<p> + +Translators can use most Spreadsheets. Excel works well. However there are a +few problems with spreadsheets: + +</p> +<ul> +<li class="level1"><div class="li"> Encoding - you can sort that out later</div> +</li> +<li class="level1"><div class="li"> Strings that start with ' - most spreadsheets treat cells starting with ' as text and gobble up the '. A work around is to escape those like this \'. po2csv should do this for you.</div> +</li> +<li class="level1"><div class="li"> Autocorrect - Excel changes … to a single character and does other odd things. pofilter will help catch these later.</div> +</li> +<li class="level1"><div class="li"> Sentences with + - or +- will create errors and the translators will have to escape them as \+ \- \+-</div> +</li> +<li class="level1"><div class="li"> Sentences that only contain numbers can get broken: “1.” will be converted to “1”</div> +</li> +</ul> + +</div> +<!-- SECTION "Translating" [2924-3603] --> +<h3><a name="converting_excel_spreadsheets_to_csv_file" id="converting_excel_spreadsheets_to_csv_file">Converting Excel spreadsheets to CSV file</a></h3> +<div class="level3"> + +<p> + +You can, and should, keep your files as <acronym title="Comma Seperated Value">CSV</acronym> files. However, many translators are not the best wizzes at using their spreadsheet. In this case +many files will have been changed to XLS files. To convert them by hand is tedious and error prone. Rather make use of <a href="http://freshmeat.net/projects/xlhtml/" class="urlextern" title="http://freshmeat.net/projects/xlhtml/">xlHtml</a> which can do all the work for you. + +</p> +<pre class="code">xlhtml -xp:0 -csv file.xls > file.csv</pre> + +</div> +<!-- SECTION "Converting Excel spreadsheets to CSV file" [3604-4047] --> +<h3><a name="converting_csv_back_to_po" id="converting_csv_back_to_po">Converting CSV back to PO</a></h3> +<div class="level3"> + +<p> + +Extract the <acronym title="Comma Seperated Value">CSV</acronym> files here we assume they are in <em>csv-in</em>. + +</p> +<pre class="code">csv2po --charset=windows-1250 -t <templates> <csv-in> <po-in></pre> + +<p> + +This will create new <acronym title="Gettext Portable Object">PO</acronym> files in <em>po-in</em> based on the <acronym title="Comma Seperated Value">CSV</acronym> files in the +<em>csv-in</em> and the template <acronym title="Gettext Portable Object">PO</acronym> files in <em>templates</em>. You shouldn't run +the csv2po command without templates as this allows you to preserve the original file layout. +Only run it without -t if you are dealing with a partial part of the <acronym title="Gettext Portable Object">PO</acronym> that you will +merge back using a <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a>. +</p> + +<p> +Note (1): running csv2po using the input <acronym title="Gettext Portable Object">PO</acronym> files as templates give spurious +results. It should probably be made to work but doesn't +</p> + +<p> +Note (2): you might have encoding problems with the returned files. Use the +--charset option to convert the file from another encoding (all <acronym title="Gettext Portable Object">PO</acronym> files are created using UTF-8). +Usually Windows user will be using something like WINDOWS-1250. Check the file after conversion to +see that characters are in fact correct if not try another encoding. +</p> + +</div> +<!-- SECTION "Converting CSV back to PO" [4048-5055] --> +<h3><a name="checking_the_new_po_files" id="checking_the_new_po_files">Checking the new PO files</a></h3> +<div class="level3"> + +<p> + +Use <a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> to run checks against your new files. Read <a href="toolkit-using_pofilter.html" class="wikilink1" title="toolkit-using_pofilter.html">using pofilter</a> to get a good idea of how to use the tool. +</p> + +</div> +<!-- SECTION "Checking the new PO files" [5056-5215] --> +<h3><a name="removing_fuzzies" id="removing_fuzzies">Removing fuzzies</a></h3> +<div class="level3"> + +<p> + +When you merge work back that you know is good you want to make sure that it +overrides the fuzzy status of the existing translations, in order to do that +you need to remove the ”#, fuzzy” markers. +</p> + +<p> +This is best performed against <acronym title="Concurrent Versions System">CVS</acronym> otherwise who knows what changed. +</p> +<pre class="code bash"><pre class="code bash">po-in-<span class="re2">dir=</span>your-incomming-po-files +po-<span class="re2">dir=</span>your-existing-po-files + +<span class="kw1">for</span> pofile <span class="kw1">in</span> `<span class="kw3">cd</span> <span class="re1">$po</span>-in-dir; find . -name <span class="st0">"*.po"</span>` +<span class="kw1">do</span> + egrep -v <span class="st0">"^#, fuzzy"</span> < <span class="re1">$po</span>-dir/<span class="re1">$pofile</span> > <span class="re1">$po</span>-dir/<span class="re0">$<span class="br0">{</span>pofile<span class="br0">}</span></span>.unfuzzy && \ + mv <span class="re1">$po</span>-dir/<span class="re0">$<span class="br0">{</span>pofile<span class="br0">}</span></span>.unfuzzy <span class="re1">$po</span>-dir/<span class="re1">$pofile</span> +<span class="kw1">done</span></pre></pre> +</div> +<!-- SECTION "Removing fuzzies" [5216-5787] --> +<h3><a name="merging_po_files_into_the_main_po_files" id="merging_po_files_into_the_main_po_files">Merging PO files into the main PO files</a></h3> +<div class="level3"> + +<p> + +This step would not be necessary if the <acronym title="Comma Seperated Value">CSV</acronym> contained the complete <acronym title="Gettext Portable Object">PO</acronym> file. It +is only needed when the translator has been editing a subset of the whole <acronym title="Gettext Portable Object">PO</acronym> +file. + +</p> +<pre class="code">pomerge --mergeblank=no -t po-dir -i po-in -o po-dir </pre> + +<p> + +This will take <acronym title="Gettext Portable Object">PO</acronym> files from <em>po-in</em> merge them with those in <em>po-dir</em> using <em>po-dir</em> +as the template -- ie overwriting files in <em>po-dir</em>. It will also ignore entries +that have blank msgstr's ie it will not merge untranslated items. The default +behaviour of pomerge is to take all changes from <em>po-in</em> and apply them to +<em>po-dir</em> by overriding this we can ignore all untranslated items. +</p> + +<p> +There is no option to override the status of the destination <acronym title="Gettext Portable Object">PO</acronym> files +with that of the input <acronym title="Gettext Portable Object">PO</acronym>. Therefore all your entries that were fuzzy in the +destination will still be fuzzy even thought the input was corrected. If you +are confident that all your input is correct then relook at the previous section on removing fuzzies. + +</p> + +</div> +<!-- SECTION "Merging PO files into the main PO files" [5788-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-using_oo2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-using_oo2po.html new file mode 100644 index 0000000..17323a7 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-using_oo2po.html @@ -0,0 +1,105 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="creating_openoffice.org_pot_files" id="creating_openoffice.org_pot_files">Creating OpenOffice.org POT files</a></h1> +<div class="level1"> + +<p> + +This quick start guide shows you how to create the <acronym title="Gettext Portable Object">PO</acronym> Template files +for your OpenOffice.org translation. +</p> + +</div> +<!-- SECTION "Creating OpenOffice.org POT files" [1-156] --> +<h2><a name="quick_start" id="quick_start">Quick Start</a></h2> +<div class="level2"> +<ol> +<li class="level1"><div class="li"> <a href="ftp://ftp.linux.cz/pub/localization/OpenOffice.org/devel/POT" class="urlextern" title="ftp://ftp.linux.cz/pub/localization/OpenOffice.org/devel/POT">Download the latest POT and GSI files</a></div> +</li> +<li class="level1"><div class="li"> <a href="toolkit-oo2po.html" class="wikilink1" title="toolkit-oo2po.html">oo2po</a> -P <gsi> <new-pots></div> +</li> +</ol> + +</div> +<!-- SECTION "Quick Start" [157-323] --> +<h2><a name="detailed_description" id="detailed_description">Detailed Description</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Detailed Description" [324-357] --> +<h3><a name="download_the_latest_pot_and_gsi_files" id="download_the_latest_pot_and_gsi_files">Download the latest POT and GSI files</a></h3> +<div class="level3"> + +<p> + +The <acronym title="Gettext Portable Object Template">POT</acronym> files produced by Pavel Janik contain the associated en-US.sdf file that you need to create your own languages SDF file. This is the +same file that produces the <acronym title="Gettext Portable Object Template">POT</acronym> files. So to begin translating you don't need to go further than this. +</p> + +<p> + * <a href="ftp://ftp.linux.cz/pub/localization/OpenOffice.org/devel/POT" class="urlextern" title="ftp://ftp.linux.cz/pub/localization/OpenOffice.org/devel/POT">Download the latest POT and GSI files</a> +</p> + +<p> +However, you will need this file if you need to use some of the other features of <a href="toolkit-oo2po.html" class="wikilink1" title="toolkit-oo2po.html">oo2po</a> such as changing the source language from English. +</p> + +</div> +<!-- SECTION "Download the latest POT and GSI files" [358-904] --> +<h3><a name="produce_the_pot_files_using_oo2po" id="produce_the_pot_files_using_oo2po">Produce the POT files using oo2po</a></h3> +<div class="level3"> +<pre class="code">oo2po -P <gsi> <new-pots> +oo2po -P en-US.gsi pot</pre> + +<p> + +This takes the <em>en-US.gsi</em> file and creates <acronym title="Gettext Portable Object Template">POT</acronym> files in the <em>pot</em> directory. The <em>-P</em> option ensures +that .pot files are created instead of .po file. +</p> + +<p> +If you want to create one large .pot file instead of a lot of small ones, you should use the + +</p> +<pre class="code">oo2po -P --multifile=onefile en-US.gsi pot</pre> + +<p> + +option as described in <a href="toolkit-oo2po.html" class="wikilink1" title="toolkit-oo2po.html">oo2po</a>. +</p> + +</div> +<!-- SECTION "Produce the POT files using oo2po" [905-1337] --> +<h3><a name="produce_a_pot_files_with_french_source_text" id="produce_a_pot_files_with_french_source_text">Produce a POT files with French source text</a></h3> +<div class="level3"> + +<p> + +You will need to have access to a French GSI file. The following commands will create a set of <acronym title="Gettext Portable Object Template">POT</acronym> files with French as the source language: + +</p> +<pre class="code">oo2po -P --source-language=fr fr.gsi pot-fr</pre> + +<p> + +This will take translations from <em>fr.gsi</em> and create a set of <acronym title="Gettext Portable Object Template">POT</acronym> files in <em>pot-fr</em>. These <acronym title="Gettext Portable Object Template">POT</acronym> files will have French as the source language. You need to make sure that fr.gsi is in fact up to date. + +</p> + +</div> +<!-- SECTION "Produce a POT files with French source text" [1338-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-using_pofilter.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-using_pofilter.html new file mode 100644 index 0000000..0111090 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-using_pofilter.html @@ -0,0 +1,237 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="checking_your_files_with_po_filter" id="checking_your_files_with_po_filter">Checking your files with PO filter</a></h1> +<div class="level1"> + +<p> + +<a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> allows you to check your <acronym title="Gettext Portable Object">PO</acronym> or <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files for certain common errors. This quickstart guide takes +you through the process of using this tool, making corrections and merging your correction back into your translations. +</p> + +<p> +Other tools that can help with quality assurance are listed <a href="toolkit-index.html#quality_assurance" class="wikilink1" title="toolkit-index.html">here</a>. +</p> + +</div> +<!-- SECTION "Checking your files with PO filter" [1-379] --> +<h2><a name="quickstart" id="quickstart">Quickstart</a></h2> +<div class="level2"> +<ol> +<li class="level1"><div class="li"> pofilter -l (select a filter)</div> +</li> +<li class="level1"><div class="li"> pofilter -i existing_files/ -o errors/ [-t specific tests] [--excludefilter don't perform specific tests]</div> +</li> +<li class="level1"><div class="li"> vim errors/*.po (delete items you don't want changed, set fuzzy if needed, delete if not needed)</div> +</li> +<li class="level1"><div class="li"> pomerge -i errors/ -o existing_files/ -t existing_files/ (will overwrite existing files)</div> +</li> +<li class="level1"><div class="li"> cvs diff -u existing_files/ > x.diff</div> +</li> +<li class="level1"><div class="li"> vim x.diff (check to see that the updates are what you want)</div> +</li> +<li class="level1"><div class="li"> cvs ci existing_files/</div> +</li> +</ol> + +</div> +<!-- SECTION "Quickstart" [380-875] --> +<h2><a name="detailed_description" id="detailed_description">Detailed Description</a></h2> +<div class="level2"> + +<p> + +<a href="toolkit-pofilter.html" class="wikilink1" title="toolkit-pofilter.html">pofilter</a> runs a number of checks against your translation files. Any messages that fail are output to a set of new files (in the same structure as the source/input files). You then edit these new/output files to correct any errors. Once you are satisfied with your corrections these corrected files are then merged back into the original files using <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a>. +</p> + +</div> +<!-- SECTION "Detailed Description" [876-1280] --> +<h3><a name="extracting_errors" id="extracting_errors">Extracting Errors</a></h3> +<div class="level3"> + +<p> + +pofilter will run all tests unless you use the -t or --excludefilter options. There are over <a href="toolkit-pofilter_tests.html" class="wikilink1" title="toolkit-pofilter_tests.html">38 tests</a> and pofilter +can itself provide you with a current list of all the available checks: + +</p> +<pre class="code">pofilter -l</pre> + +<p> + +We want to run the: accelerators, escapes, variables and xmltags tests as these are the ones most likely to break programs at runtime. We are also working with OpenOffice.org <acronym title="Gettext Portable Object">PO</acronym> files created using <a href="toolkit-oo2po.html" class="wikilink1" title="toolkit-oo2po.html">oo2po</a> so we want to ensure that we set the accelerator key marker and variables definitions correctly. + +</p> +<pre class="code">pofilter -t accelerators -t escapes -t variables -t xmltags --openoffice existing_files errors</pre> + +<p> + +Any messages that fail one of the 4 checks will be placed in files in <em>errors</em>. We also used the <em>--openoffice</em> option to ensure that the tool is aware of the OpenOffice.org accelerator marker (<em>~</em>) and the OpenOffice.org variable styles (OpenOffice.org has over 10 variable styles). You can also specify other styles of project including GNOME, KDE or Mozilla. +</p> + +<p> +You can also specify whether you want fuzzy entries included and checked, by specifying the --fuzzy parameter. By default this is off because fuzzy strings are usually known to be broken and +will be reviewed by translators anyway. +</p> + +<p> +Similarly you can include items marked for review by specifying --review or --ingnorereview. +By default review items are included. This is not part of the standard Gettext +format. We have allowed entries like this when we want to communicate to someone +what error we have picked up: + +</p> +<pre class="code"># (review) - wrong word for gallery chosen</pre> + +<p> + +You can run pofilter without the -t option. This runs all the checks. This +can be confusing if you have a lot of errors as you easily lose focus. One strategy +is to run each test individually. This allows you to +focus on one problem at a time across a number of files. It is much easier to +correct end punctuation on its own then to correct many different types of +errors. For a small file it is probably best to run all of the test together. +</p> + +<p> +By using the <em>--autocorrect</em> option you can automatically correct some very common errors. Use with caution though. This option assumes you use the same punctuation style as the source text. +</p> + +</div> +<!-- SECTION "Extracting Errors" [1281-3516] --> +<h3><a name="edit_the_files" id="edit_the_files">Edit the files</a></h3> +<div class="level3"> + +<p> + +Once the errors have been marked you can edit them with any text editor or <acronym title="Gettext Portable Object">PO</acronym> editor eg. <a href="guide-kbabel.html" class="wikilink1" title="guide-kbabel.html">KBabel</a> or vi. +You will be editing the files in the <em>errors</em> directory. Only messages that failed +one of the tests will be present. If no messages failed then there will be no error <acronym title="Gettext Portable Object">PO</acronym> file for the source <acronym title="Gettext Portable Object">PO</acronym> file. +Only critical errors are marked fuzzy - all others are simply marked with the pofilter marker. +Critical errors are marked fuzzy as this allows you to simply merge them back into you <acronym title="Gettext Portable Object">PO</acronym> files and then rely on the fact that +all po2* tools will ignore a message marked fuzzy. This allows you to quickly eliminate messages that can break builds. +</p> + +<p> +To edit run: + +</p> +<pre class="code">vi `find errors -name "*.po"` +kbabel `find errors -name "*.po"`</pre> + +<p> + +or similar command. +</p> + +<p> +The pofilter marker helps you determine what error was discovered: + +</p> +<pre class="code"># (pofilter) <test> - <explanation of test error></pre> + +<p> + +Use the test description to help you determine what is wrong with the message. Remember that all your changes will +be ported back into the <acronym title="Gettext Portable Object">PO</acronym> files. So if you leave a string fuzzy in the error +files, it will become fuzzy in the main files when you merge the corrected file back into the main file. Therefore +delete anything you do not want to migrate back when you merge the files. Delete the test comments and fuzzy markings +as needed. Leave them in if you want another translator to see them. +</p> + +<p> +The computer can get it wrong, so an error that pofilter finds may in fact not be an error. We'd like +to hear about these false positives so that we can improve the checks. Also if you have some checks that +you have added or ideas for better checks, then let us know. +</p> + +</div> +<!-- SECTION "Edit the files" [3517-5202] --> +<h3><a name="merging_your_corrections_back_into_the_originals" id="merging_your_corrections_back_into_the_originals">Merging your corrections back into the originals</a></h3> +<div class="level3"> + +<p> + +After correcting the errors in the <acronym title="Gettext Portable Object">PO</acronym> files its time to merge these corrections +back into the originals using <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a>. + +</p> +<pre class="code">pomerge -t existing_files -i errors -o files_without_errors</pre> + +<p> + +If -t and -o are the same directory, the corrections will be merged into the +existing files. Do this only if you are using some kind of version control system +so that you can check the changes made by <a href="toolkit-pomerge.html" class="wikilink1" title="toolkit-pomerge.html">pomerge</a>. +</p> + +</div> +<!-- SECTION "Merging your corrections back into the originals" [5203-5666] --> +<h3><a name="checking_the_corrections" id="checking_the_corrections">Checking the corrections</a></h3> +<div class="level3"> + +<p> + +We have done this against <acronym title="Concurrent Versions System">CVS</acronym> but you could run a normal diff between a good +copy and your modifications. Thus we assume in the last step that we merged +the corrections into the existing translations: + +</p> +<pre class="code">pomerge -t existing_files -i errors -o existing_files</pre> + +<p> + +Now we check the changes using <em>cvs diff</em>: + +</p> +<pre class="code">cvs diff -u existing_files > x.diff</pre> + +<p> + +This creates a unified diff (one with + and - lines so you can see what was +added and what was removed) in the file x.diff + +</p> +<pre class="code">vim x.diff</pre> + +<p> + +Check the diff file in any editor, here we use vim. You should check to see +that the changes you requested are going in and that something major did not go +wrong. Also look to see if you haven't left any lines with ”# (pofilter): test description” +which should have been deleted from the error checking <acronym title="Gettext Portable Object">PO</acronym> files. Also check +for stray fuzzy markers that shouldn't have been added. You will have to make +corrections in the files in <em>existing_files</em> not in <em>errors</em>. +</p> + +<p> +When you are happy that the changes are correct run: + +</p> +<pre class="code">cvs ci existing_files</pre> + +<p> + +Congratulations you have helped eliminate a number of errors that could give problems +when running the application. Now you might want to look at +running some of the other tests that check for style and uniformity in translation. + +</p> + +</div> +<!-- SECTION "Checking the corrections" [5667-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-wiki.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-wiki.html new file mode 100644 index 0000000..5353dee --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-wiki.html @@ -0,0 +1,80 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="wiki_syntax" id="wiki_syntax">Wiki Syntax</a></h1> +<div class="level1"> + +<p> + +The Translate Toolkit can manage Wiki syntax pages. This is implemented as part of the <a href="toolkit-text.html" class="wikilink1" title="toolkit-text.html">text</a> format and the conversion is supported in <a href="toolkit-txt2po.html" class="wikilink1" title="toolkit-txt2po.html">txt2po</a>. +</p> + +<p> +Those who edit wikis will appreciate that wiki text is simply a normal text document edited using a form of wiki syntax. Whether the final storage is a database or a flat file the part that a user edits is a simple text file. +</p> + +<p> +The format does not support all features of the wiki syntax and will simply dump the full form if it doesn't understand the text. But structures such as headers and lists are understood and the filter can remove these are correctly add them. +</p> + +</div> +<!-- SECTION "Wiki Syntax" [1-651] --> +<h2><a name="supported_wiki_formats" id="supported_wiki_formats">Supported Wiki Formats</a></h2> +<div class="level2"> + +<p> + +The following is a list of the wikis supported together with a list of the items that we can process: + +</p> +<ul> +<li class="level1"><div class="li"> <a href="http://wiki.splitbrain.org/wiki:dokuwiki" class="urlextern" title="http://wiki.splitbrain.org/wiki:dokuwiki">docuwiki</a> - heading, bullet, numbered list</div> +</li> +<li class="level1"><div class="li"> <a href="http://www.mediawiki.org/wiki/MediaWiki" class="urlextern" title="http://www.mediawiki.org/wiki/MediaWiki">MediaWiki</a> - heading, bullet, numbered list</div> +</li> +</ul> + +</div> +<!-- SECTION "Supported Wiki Formats" [652-974] --> +<h2><a name="possible_uses" id="possible_uses">Possible uses</a></h2> +<div class="level2"> + +<p> + +As part of a localisation process for a wiki this format and the filters could be used to provide a good localisation of existing wiki content. +</p> + +<p> +With further enhancement the tool could probably be capable of converting from one wiki syntax to another, but that is of course not its main aim +</p> + +</div> +<!-- SECTION "Possible uses" [975-1293] --> +<h2><a name="additional_notes_on_mediawiki" id="additional_notes_on_mediawiki">Additional notes on MediaWiki</a></h2> +<div class="level2"> + +<p> + +Media wiki can also export in <acronym title="Extensible Markup Language">XML</acronym> format, see <a href="http://en.wikipedia.org/wiki/Special:Export" class="urlextern" title="http://en.wikipedia.org/wiki/Special:Export">http://en.wikipedia.org/wiki/Special:Export</a> and <a href="http://www.mediawiki.org/wiki/Manual:Parameters_to_Special:Export" class="urlextern" title="http://www.mediawiki.org/wiki/Manual:Parameters_to_Special:Export">http://www.mediawiki.org/wiki/Manual:Parameters_to_Special:Export</a> this however exports in <acronym title="Extensible Markup Language">XML</acronym> so not directly usable by txt2po. +</p> + +<p> +For importing please see <a href="http://en.wikipedia.org/wiki/Help:Import" class="urlextern" title="http://en.wikipedia.org/wiki/Help:Import">http://en.wikipedia.org/wiki/Help:Import</a> this is disabled on most wikis so not directly usable currently. +</p> + +</div> +<!-- SECTION "Additional notes on MediaWiki" [1294-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-wml.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-wml.html new file mode 100644 index 0000000..7fe30e0 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-wml.html @@ -0,0 +1,50 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="wireless_markup_language" id="wireless_markup_language">Wireless Markup Language</a></h1> +<div class="level1"> + +<p> +This page documents the support for <a href="http://en.wikipedia.org/wiki/Wireless%20Markup%20Language" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Wireless%20Markup%20Language">WML</a> and is used for planning our work on it. For more information about <acronym title="Wireless Markup Language">WML</acronym>, see …. +</p> + +<p> +This is implemented as a generic <acronym title="Extensible Markup Language">XML</acronym> document type that is handled similarly to the way the <a href="developers-projects-odf.html" class="wikilink1" title="developers-projects-odf.html">ODF</a> project handles ODF documents. +</p> + +</div> +<!-- SECTION "Wireless Markup Language" [1-346] --> +<h2><a name="supported_versions" id="supported_versions">Supported versions</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Supported versions" [347-378] --> +<h2><a name="supported_features" id="supported_features">Supported features</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Supported features" [379-409] --> +<h3><a name="translatable_content" id="translatable_content">Translatable content</a></h3> +<div class="level3"> + +</div> +<!-- SECTION "Translatable content" [410-441] --> +<h3><a name="untranslatable_content" id="untranslatable_content">Untranslatable content</a></h3> +<div class="level3"> + +</div> +<!-- SECTION "Untranslatable content" [442-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-wordfast.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-wordfast.html new file mode 100644 index 0000000..db9bdeb --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-wordfast.html @@ -0,0 +1,52 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="wordfast_translation_memory" id="wordfast_translation_memory">Wordfast Translation Memory</a></h1> +<div class="level1"> + +<p> + +(Only in v1.1) +</p> + +<p> +The Wordfast format, as used by the <a href="http://en.wikipedia.org/wiki/Wordfast" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Wordfast">Wordfast</a> translation tool, is a simple tab delimited file. +</p> + +<p> +The storage format can read and write Wordfast TM files. +</p> + +</div> +<!-- SECTION "Wordfast Translation Memory" [1-221] --> +<h2><a name="conformance" id="conformance">Conformance</a></h2> +<div class="level2"> +<ul> +<li class="level1"><div class="li"> Escaping - The format correctly handles Wordfast &'XX; escaping and will unescape and escape seamlessly.</div> +</li> +<li class="level1"><div class="li"> Soft-breaks - these are not managed and are left as escaped</div> +</li> +<li class="level1"><div class="li"> Replaceables - these are not managed</div> +</li> +<li class="level1"><div class="li"> Header - Only basic updating and reading of the header is implemented</div> +</li> +<li class="level1"><div class="li"> Tab-separated value (TSV) - the format correctly handles the TSV format used by Wordfast. There is no quoting, Windows newlines are used and the \t is used as a delimiter (see <a href="http://bugs.locamotion.org/show_bug.cgi?id=472" class="interwiki iw_bug" title="http://bugs.locamotion.org/show_bug.cgi?id=472">472</a>)</div> +</li> +</ul> + +</div> +<!-- SECTION "Conformance" [222-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-xliff.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-xliff.html new file mode 100644 index 0000000..962dcdb --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-xliff.html @@ -0,0 +1,118 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="xliff" id="xliff">XLIFF</a></h1> +<div class="level1"> + +<p> + +<acronym title="XML Localization Interchange File Format">XLIFF</acronym> is the OASIS standard for translation. See <a href="http://www.oasis-open.org/committees/xliff/documents/xliff-specification.htm" class="urlextern" title="http://www.oasis-open.org/committees/xliff/documents/xliff-specification.htm">http://www.oasis-open.org/committees/xliff/documents/xliff-specification.htm</a>. +</p> + +</div> +<!-- SECTION "XLIFF" [1-153] --> +<h2><a name="flavours" id="flavours">Flavours</a></h2> +<div class="level2"> + +<p> + +<acronym title="XML Localization Interchange File Format">XLIFF</acronym> also had documents that specify the conversion from various standard source documents and localisation formats. + +</p> +<ul> +<li class="level1"><div class="li"> <acronym title="Gettext Portable Object">PO</acronym> - For conformance to the po2xliff <acronym title="specification">spec</acronym>, see <a href="toolkit-xliff2po.html" class="wikilink1" title="toolkit-xliff2po.html">xliff2po</a>.</div> +<ul> +<li class="level2"><div class="li"> Draft <a href="http://docs.oasis-open.org/xliff/v1.2/xliff-profile-po/xliff-profile-po-1.2.html" class="urlextern" title="http://docs.oasis-open.org/xliff/v1.2/xliff-profile-po/xliff-profile-po-1.2.html">XLIFF 1.2 Representation Guide for Gettext PO</a></div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> <acronym title="HyperText Markup Language">HTML</acronym> - not implemented</div> +<ul> +<li class="level2"><div class="li"> Draft <a href="http://docs.oasis-open.org/xliff/v1.2/xliff-profile-html/xliff-profile-html-1.2.html" class="urlextern" title="http://docs.oasis-open.org/xliff/v1.2/xliff-profile-html/xliff-profile-html-1.2.html">XLIFF 1.2 Representation Guide for HTML</a></div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> Java (includes .properties and Java resource bundles) - not implemented</div> +<ul> +<li class="level2"><div class="li"> Draft <a href="http://docs.oasis-open.org/xliff/v1.2/xliff-profile-java/xliff-profile-java-v1.2.html" class="urlextern" title="http://docs.oasis-open.org/xliff/v1.2/xliff-profile-java/xliff-profile-java-v1.2.html">XLIFF 1.2 Representation Guide for Java Resource Bundles</a></div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> ICU Resource Bundles - not officially being developed by <acronym title="XML Localization Interchange File Format">XLIFF</acronym> - Proposed <a href="http://www.icu-project.org/repos/icu/icuhtml/trunk/design/locale/xliff-profile-icuresourcebundle-1.2.htm" class="urlextern" title="http://www.icu-project.org/repos/icu/icuhtml/trunk/design/locale/xliff-profile-icuresourcebundle-1.2.htm">representation guide</a></div> +</li> +</ul> + +</div> +<!-- SECTION "Flavours" [154-1114] --> +<h2><a name="standard_conformance" id="standard_conformance">Standard conformance</a></h2> +<div class="level2"> + +</div> +<!-- SECTION "Standard conformance" [1115-1149] --> +<h3><a name="done" id="done">Done</a></h3> +<div class="level3"> +<ul> +<li class="level1"><div class="li"> File creation and parsing</div> +</li> +<li class="level1"><div class="li"> <acronym title="Application Programming Interface">API</acronym> can create multiple files in one <acronym title="XML Localization Interchange File Format">XLIFF</acronym> (some tools only read the first file)</div> +</li> +<li class="level1"><div class="li"> source-language attribute</div> +</li> +<li class="level1"><div class="li"> trans-unit with</div> +<ul> +<li class="level2"><div class="li"> note: addnote() and getnotes()</div> +</li> +<li class="level2"><div class="li"> state</div> +<ul> +<li class="level4"><div class="li"> fuzzy: isfuzzy() and markfuzzy()</div> +</li> +<li class="level4"><div class="li"> translated: marktranslated()</div> +</li> +<li class="level4"><div class="li"> approved</div> +</li> +<li class="level4"><div class="li"> needs-review-transaltion: isreview(), markreviewneeded()</div> +</li> +</ul> +</li> +<li class="level2"><div class="li"> id: setid()</div> +</li> +<li class="level2"><div class="li"> context-group: createcontextgroup()</div> +</li> +</ul> +</li> +<li class="level1"><div class="li"> context groups</div> +</li> +<li class="level1"><div class="li"> alt-trans</div> +</li> +</ul> + +</div> +<!-- SECTION "Done" [1150-1644] --> +<h2><a name="xliff_and_other_tools" id="xliff_and_other_tools">XLIFF and other tools</a></h2> +<div class="level2"> + +<p> + +Here is a small report on <acronym title="XML Localization Interchange File Format">XLIFF</acronym> and <acronym title="Microsoft">MS</acronym> Windows tools: +</p> + +<p> +<a href="http://translate.sourceforge.net/wiki/guide/tools/xliff_support_by_ms_windows_programs" class="urlextern" title="http://translate.sourceforge.net/wiki/guide/tools/xliff_support_by_ms_windows_programs">http://translate.sourceforge.net/wiki/guide/tools/xliff_support_by_ms_windows_programs</a> +</p> + +</div> +<!-- SECTION "XLIFF and other tools" [1645-] --></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-xliff2oo.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-xliff2oo.html new file mode 100644 index 0000000..c9d4d93 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-xliff2oo.html @@ -0,0 +1,15 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> +<div class="noteredirect">This page has been moved, the new location is <a href="/opt/sf/software/offline-doku-0.1.1/toolkit/oo2po" class="wikilink1" title="toolkit:oo2po">oo2po</a>.</div></body> +</html> diff --git a/translate-toolkit-1.3.0/translate/doc/user/toolkit-xliff2po.html b/translate-toolkit-1.3.0/translate/doc/user/toolkit-xliff2po.html new file mode 100644 index 0000000..b3090e9 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/user/toolkit-xliff2po.html @@ -0,0 +1,162 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> + <title></title> + <link rel="stylesheet" media="screen" type="text/css" href="./style.css" /> + <link rel="stylesheet" media="screen" type="text/css" href="./design.css" /> + <link rel="stylesheet" media="print" type="text/css" href="./print.css" /> + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +</head> +<body> +<a href=.>start</a></br> + + + +<h1><a name="xliff2po_and_po2xliff" id="xliff2po_and_po2xliff">xliff2po and po2xliff</a></h1> +<div class="level1"> + +<p> + +Converts <acronym title="XML Localization Interchange File Format">XLIFF</acronym> localization files to Gettext <acronym title="Gettext Portable Object">PO</acronym> files. <acronym title="XML Localization Interchange File Format">XLIFF</acronym> is the <acronym title="Extensible Markup Language">XML</acronym> Localization Interchange File Format +developed by <a href="http://lisa.org/" class="urlextern" title="http://lisa.org/">LISA</a> (The Localization Industry Standards Authority) to allow translation +work to be standardised no matter what the source format and to allow the work to be freely moved from tool to +tool. +</p> + +</div> +<!-- SECTION "xliff2po and po2xliff" [1-374] --> +<h2><a name="usage" id="usage">Usage</a></h2> +<div class="level2"> +<pre class="code">po2xliff [options] <po> <xliff> +xliff2po [options] <xliff> <po></pre> + +<p> + +Where: +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> <po> </td><td class="col1 leftalign"> is a <acronym title="Gettext Portable Object">PO</acronym> file or directory of <acronym title="Gettext Portable Object">PO</acronym> files </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> <xliff> </td><td class="col1 leftalign"> is an <acronym title="XML Localization Interchange File Format">XLIFF</acronym> file or directory of <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files </td> + </tr> +</table> + +<p> + +Options (xliff2po): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in xliff format </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in po, pot formats </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> +</table> + +<p> + +Options (po2xliff): + +</p> +<table class="inline"> + <tr class="row0"> + <td class="col0 leftalign"> --version </td><td class="col1 leftalign"> show program's version number and exit </td> + </tr> + <tr class="row1"> + <td class="col0 leftalign"> -h, --help </td><td class="col1 leftalign"> show this help message and exit </td> + </tr> + <tr class="row2"> + <td class="col0 leftalign"> --manpage </td><td class="col1 leftalign"> output a manpage based on the help </td> + </tr> + <tr class="row3"> + <td class="col0 leftalign"> <a href="toolkit-progress_progress.html" class="wikilink1" title="toolkit-progress_progress.html">--progress=PROGRESS</a> </td><td class="col1 leftalign"> show progress as: dots, none, bar, names, verbose </td> + </tr> + <tr class="row4"> + <td class="col0 leftalign"> <a href="toolkit-errorlevel_errorlevel.html" class="wikilink1" title="toolkit-errorlevel_errorlevel.html">--errorlevel=ERRORLEVEL</a> </td><td class="col1 leftalign"> show errorlevel as: none, message, exception, traceback </td> + </tr> + <tr class="row5"> + <td class="col0 leftalign"> -iINPUT, --input=INPUT </td><td class="col1 leftalign"> read from INPUT in po, pot formats </td> + </tr> + <tr class="row6"> + <td class="col0 leftalign"> -xEXCLUDE, --exclude=EXCLUDE </td><td class="col1 leftalign"> exclude names matching EXCLUDE from input paths </td> + </tr> + <tr class="row7"> + <td class="col0 leftalign"> -oOUTPUT, --output=OUTPUT </td><td class="col1 leftalign"> write to OUTPUT in xliff format </td> + </tr> + <tr class="row8"> + <td class="col0 leftalign"> -tTEMPLATE, --template=TEMPLATE </td><td class="col1 leftalign"> read from TEMPLATE in xliff format </td> + </tr> + <tr class="row9"> + <td class="col0 leftalign"> <a href="toolkit-psyco_mode.html" class="wikilink1" title="toolkit-psyco_mode.html">--psyco=MODE</a> </td><td class="col1 leftalign"> use psyco to speed up the operation, modes: none, full, profile </td> + </tr> + <tr class="row10"> + <td class="col0 leftalign"> -P, --pot </td><td class="col1 leftalign"> output <acronym title="Gettext Portable Object">PO</acronym> Templates (.pot) rather than <acronym title="Gettext Portable Object">PO</acronym> files (.po) </td> + </tr> +</table> + +</div> +<!-- SECTION "Usage" [375-2276] --> +<h2><a name="examples" id="examples">Examples</a></h2> +<div class="level2"> +<pre class="code">xliff2po -P xliff pot</pre> + +<p> + +Create <acronym title="Gettext Portable Object Template">POT</acronym> files from the <acronym title="XML Localization Interchange File Format">XLIFF</acronym> files found in directory <em>xliff</em> and output them to the directory <em>pot</em> + +</p> +<pre class="code">po2xliff xh xh-xlf</pre> + +<p> + +Convert the Xhosa <acronym title="Gettext Portable Object">PO</acronym> files in <em>xh</em> to <acronym title="XML Localization Interchange File Format">XLIFF</acronym> and place them in <em>xh-xlf</em> +</p> + +</div> +<!-- SECTION "Examples" [2277-2530] --> +<h2><a name="bugs" id="bugs">Bugs</a></h2> +<div class="level2"> + +<p> + +This filter is not yet extensively used… expect bugs. See <a href="toolkit-xliff.html" class="wikilink1" title="toolkit-xliff.html">xliff</a> to see how well our implementation conforms to the standard. +</p> + +<p> +The <acronym title="Gettext Portable Object">PO</acronym> plural implementation is still very new and needs active testing. + +</p> + +</div> +<!-- SECTION "Bugs" [2531-] --></body> +</html> |