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

Fri Sep 25 16:25:40 UTC 2009

Author: runa
Date: 2009-09-25 12:25:40 -0400 (Fri, 25 Sep 2009)
New Revision: 20668

Modified:
   translation/trunk/tools/gsoc09/HOWTO
   translation/trunk/tools/gsoc09/README
Log:
updated the documentation

Modified: translation/trunk/tools/gsoc09/HOWTO
===================================================================

--- translation/trunk/tools/gsoc09/HOWTO	2009-09-25 16:12:04 UTC (rev 20667)
+++ translation/trunk/tools/gsoc09/HOWTO	2009-09-25 16:25:40 UTC (rev 20668)
@@ -11,17 +11,9 @@
 for Unix. It is a document description language based on XML for
 creating content and user interfaces.
 
-A .pot file is a template file which contains a list of all the
-translatable strings extracted from the sources (in this case, the .wml
-files).
+Pootle is a web portal designed to ease the translation process. See
+http://translation.torproject.org/
 
-The translator would normally derive a .po file from the template before
-translating. This is something that Pootle will do for us.
-
-Pootle is 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. See http://translation.torproject.org/
-
 Before you get to work, you will need to check out a copy of the website:
 
 	svn co https://tor-svn.freehaven.net/svn/website/trunk website
@@ -34,10 +26,10 @@
 need the two scripts wml2po.sh and po2wml.sh. You can find these in
 website/.
 
-Before running any of the scripts, make sure you have set the correct
-location of the different directories. You need to set the full path.
-You also need to have po4a installed. More information about the scripts
-and what to do if something goes wrong can be found in
+Before running any of the scripts, make sure you have checked out the
+website and the translation module in the same directory. You also need
+to have po4a installed. More information about the scripts and what to
+do if something goes wrong can be found in
 translation/tools/gsoc09/README.
 
 1. Convert the existing translations
@@ -92,24 +84,16 @@
 2. Update the translations
 --------------------------
 
-To convert new .wml files to .pot and to update existing .pot files, run
-wml2po.sh. This script will convert/update all the .wml files to .pot
-files and put them in translation/projects/website/templates. The script
-does not commit the files automatically unless you uncomment a line.
-After running the script, you need to restart Pootle to make sure it
-knows about the new and updated files.
+To convert new .wml files to .po and to update existing .po files, run
+wml2po.sh. This script will convert and update all of the English .wml
+files to .po files for all languages under translation/projects/website
+(excluding the templates directory and .svn), and also create the
+subdirectories needed.
 
-Once you have created and updated a bunch of .pot files, it's time to
-let Pootle generate .po files for all supported languages. Log in to the
-Pootle admin interface, click on "Admin" and "Projects". Choose the
-project you want to edit (i.e. "website") and click on "update
-languages".
+The script does not commit the files automatically, so remember to do
+that after running the script. After running the script, you need to
+restart Pootle to make sure it knows about the new and updated files.
 
-Note: new and updated .po files will _not_ be added/committed to the
-repository automatically. This will have to be done on the machine that
-Pootle is currently running on. Use 'svn stat' to see the list of files
-that are new and/or changed, and add/commit these files manually.
-
 3. Write the translated documents
 ---------------------------------
 

Modified: translation/trunk/tools/gsoc09/README
===================================================================
--- translation/trunk/tools/gsoc09/README	2009-09-25 16:12:04 UTC (rev 20667)
+++ translation/trunk/tools/gsoc09/README	2009-09-25 16:25:40 UTC (rev 20668)
@@ -17,10 +17,7 @@
 
 
 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 pot
-files should be put in a directory named templates so that Pootle can
-convert the files to .po for all supported languages.
+translation process. See http://translation.torproject.org
 
 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,
@@ -29,15 +26,16 @@
 tags.
 
 The basics of wml2po:
-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.
+This script converts all of the English wml files to po files for all
+languages under translation/projects/website (excluding the templates
+directory and .svn), 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:
 This script converts all of the translated po files back to wml files
@@ -55,10 +53,10 @@
 If the file is listed in the logfile:
 
 0. You can convert the file manually using the following command.
-   Remember to edit the .pot after and set the correct encoding, charset
+   Remember to edit the .po after and set the correct encoding, charset
    and copyright.
 
-   po4a-gettextize -f wml -m "foo.wml" -p "foo.pot" --master-charset utf-8
+   po4a-gettextize -f wml -m "foo.wml" -p "foo.po" --master-charset utf-8
 
 1. The problem is most likely a tag in the .wml that is not closed. The
    solution here is to close the tag and try again. 

