[or-cvs] r20211: {translation} updated (translation/trunk/tools/gsoc09)

[runa at seul.org]

Author: runa
Date: 2009-08-03 15:38:03 -0400 (Mon, 03 Aug 2009)
New Revision: 20211

Modified:
   translation/trunk/tools/gsoc09/README
Log:
updated

Modified: translation/trunk/tools/gsoc09/README
===================================================================
--- translation/trunk/tools/gsoc09/README	2009-08-03 18:43:51 UTC (rev 20210)
+++ translation/trunk/tools/gsoc09/README	2009-08-03 19:38:03 UTC (rev 20211)
@@ -1,7 +1,8 @@
 # Author: Runa Sandvik, <runa.sandvik at gmail.com>
 # Google Summer of Code 2009
 
-This text will aim to explain the basics of wml2po and po2wml. 
+This text will aim to explain the basics of wml2po and po2wml, as well
+as give an outline of the process from a new .wml to a translated. wml.
 Feel free to email me with questions regarding this text and/or the
 code.
 
@@ -11,10 +12,42 @@
 3. You need to have md5sum installed on your machine (found in the
    coreutils-package on debian and ubuntu systems).
 
+The Tor Project is using Pootle, a web portal designed to ease the
+translation process. Given a bunch of pot (po-template) files, Pootle
+can generate the po files needed for all supported languages.
+
+The two scripts are using tools from the po4a framework. As long as the
+document you are trying to convert is well formed, i.e. all tags closed,
+there shouldn't be any problems. If there are, you might want to check
+if all of the tags are closed or if they have been defined as custom
+tags.
+
 The basics of wml2po:
-In short, wml2po converts all of the english files to po files and keeps
-them updated.
+This script converts all of the English wml files to pot files and keeps
+them updated. Converted files are being given a filename that shows what
+translation priority they hold. This is to make it easier for new
+translators to know where to begin. The script uses po4a-gettextize for
+new files and po4a-updatepo for pre-existing files. To make sure that
+existing files are not committed unless they have actually changed, the
+script calculates the md5sum of the file before and after it has been
+updated. The script also keeps a log of files that could not be
+processed.
 
 The basics of po2wml:
-In short, po2wml converts all of the translated po files back to wml
-files and keeps them updated.
+This script converts all of the translated po files back to wml files
+and keeps them updated. The script uses po4a-translate to convert the
+files. This tool will only write the translated document if 80% (default
+value that can be changed) or more have been translated. Note that if a
+80% of a po file has been translated into another language, the
+remaining 20% will be displayed in the original language when the file
+is converted to wml.
+
+An outline of the process:
+It might be useful to see the complete list of steps, from a new wml to
+a translated wml, and where the two scripts fit in.
+
+1. A new .wml file has been committed to the repository
+2. To convert this to .pot, run wml2po.sh
+3. Restart Pootle to make sure it knows about the new file
+4. In Pootle, generate the .po file for all the supported languages
+5. To convert the translated .po files back to .wml, run po2wml.sh