[or-cvs] r20286: {translation} created howto and updated readme (translation/trunk/tools/gsoc09)

[runa at seul.org]

Author: runa
Date: 2009-08-14 11:46:52 -0400 (Fri, 14 Aug 2009)
New Revision: 20286

Added:
   translation/trunk/tools/gsoc09/HOWTO
Modified:
   translation/trunk/tools/gsoc09/README
Log:
created howto and updated readme

Added: translation/trunk/tools/gsoc09/HOWTO
===================================================================
--- translation/trunk/tools/gsoc09/HOWTO	                        (rev 0)
+++ translation/trunk/tools/gsoc09/HOWTO	2009-08-14 15:46:52 UTC (rev 20286)
@@ -0,0 +1,55 @@
+# Author: Runa Sandvik, <runa.sandvik at gmail.com>
+# Google Summer of Code 2009
+
+This text will try to explain the full process from checking out a copy
+of the website to building and publishing it.
+
+1. Update translations
+----------------------
+
+First you will need to check out a copy of the website:
+
+	svn co https://tor-svn.freehaven.net/svn/website/trunk website
+
+You also need a copy of all the translations:
+
+	svn co https://tor-svn.freehaven.net/svn/translation/trunk/ translation
+
+The translated files will be in translation/projects/website. You also
+need the two scripts wml2po.sh and po2wml.sh. You can find these in
+translation/tools/gsoc09.
+
+Before running any of the scripts, make sure you have set the correct
+location of the wml and po directories. More information about the
+scripts and what to do if something goes wrong can be found in
+translation/tools/gsoc09/README.
+
+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. After
+running the script, you need to restart Pootle to make sure it knows
+about the new and updated files.
+
+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".
+
+Note that 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.
+
+2. Convert the translations
+---------------------------
+
+People tend to forget to click on the commit button in Pootle. Before
+converting the translated .po files, force Pootle to commit everything.
+
+When this is done, you can run po2wml.sh to write the translated
+documents. This script does not commit anything to the repository. It is
+therefore important that you run this script, before building and
+publishing the website, if you wish to include the most recent
+translations. The Makefile in website/ explains the process of building
+and publishing the website.

Modified: translation/trunk/tools/gsoc09/README
===================================================================
--- translation/trunk/tools/gsoc09/README	2009-08-14 13:44:06 UTC (rev 20285)
+++ translation/trunk/tools/gsoc09/README	2009-08-14 15:46:52 UTC (rev 20286)
@@ -1,10 +1,10 @@
 # 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, 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.
+This text will aim to explain the basics of wml2po and po2wml. For an
+explanation of the full process from checking out a copy of the website
+to building and publishing it, see the HOWTO. Feel free to email me with
+questions regarding this text and/or the code.
 
 Before running any of the scripts:
 
@@ -47,31 +47,6 @@
 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 to take. The
-process is the same both for new and updated .wml files. Note that new
-and updated .po files will have to be added/committed to the repository
-manually.
-
-1. Run wml2po.sh to convert the new and updated .wml files to .pot 
-
-2. Restart Pootle to make sure it knows about the new and updated .pot files.
-
-3. 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". Pootle will now generate .po files from
-   the new .pot files and updated the existing .po if necessary.
-
-4. New and updated .po files will not be added/committed to the
-   repository automatically. Use 'svn stat' to see the list of files
-   that are new and/or changed, and add/commit these files manually.
-
-5. People tend to forget to click on the commit-button in Pootle. Before
-   converting the translated .po files back .wml, force Pootle to commit
-   everything.
-
-6. Run po2wml.sh to convert the translated .po files back to .wml.
-
 Checklist:
 What do you do if one of the files aren't being converted? Here is a
 few, possible solutions.