translation-quick-start-guide/en_US Translating_Documentation.xml, 1.7, 1.8

[Noriko Mizumoto (noriko)]

Author: noriko

Update of /cvs/docs/translation-quick-start-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv29747

Modified Files:
	Translating_Documentation.xml 
Log Message:
sec4.1 Getting Started. the clarification of username added. sec4.3 Using Translation App. sample document changed which has LINGUAS file, and added howto add lang code. changed some expression related to the step of Check Integrity and Commit Work.


Index: Translating_Documentation.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/en_US/Translating_Documentation.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Translating_Documentation.xml	18 Apr 2008 00:57:45 -0000	1.7
+++ Translating_Documentation.xml	18 Apr 2008 03:44:19 -0000	1.8
@@ -58,7 +58,7 @@
     <para>
       The Fedora documentation is stored in a CVS repository under the
       directory <filename>docs/</filename>.  To list the available
-      modules, run the following commands:
+      modules, run the following commands (where <replaceable>username</replaceable> is replaced with your Fedora account username):
     </para>
 
     <screen><command><![CDATA[export CVSROOT=:ext:]]><replaceable>username</replaceable><![CDATA[@cvs.fedoraproject.org:/cvs/docs]]></command>
@@ -115,7 +115,7 @@
       <title>Creating Common Files</title>
 
       <para>
-	If you are creating the first-ever translation for a locale, you
+	Only if you are creating the first-ever translation for a locale, you
 	must first translate some common files used in all documents for
 	your locale.  The common files are located in <filename
 	class="directory">docs-common/common/</filename>.
@@ -246,9 +246,10 @@
 	    In a terminal, go to the directory of the document you want
 	    to translate:
 	  </para>
-	  
+<!-- change the example document to use which contains LINGUAS file (noriko) 	  
 	<screen><command><![CDATA[cd ~/docs/example-tutorial]]></command></screen>
-
+/-->
+	<screen><command><![CDATA[cd ~/docs/translation-quick-start-guide/]]></command></screen>
 	</step>
 	<step>
 	<title>Add Locale to List</title>
@@ -260,8 +261,14 @@
 	    you are translating has not been updated, notify the &FDP;
 	    or file a bug using &BZ;.</para>
 	  <para>Add your translation language code to the list in the
-	  <filename>po/LINGUAS</filename> file.  <emphasis>Keep the list
-	    in alphabetical order.</emphasis></para>
+	  <filename>po/LINGUAS</filename> file using your preferred editor. For example,
+  	  </para>
+	  <screen><command><![CDATA[vi po/LINGUAS]]></command></screen>
+	  <para>
+	    Press 'a' to modify and add your language code. Once added, save it and exit the editor.
+    	  </para>
+	  <para><emphasis>keeping the list in alphabetical order.</emphasis> 
+	  </para>
 	</step>
 	<step>
 	<title>Create PO File</title>
@@ -292,7 +299,7 @@
      </para>
 	<screen><command><![CDATA[make html-]]><replaceable>pt_BR</replaceable></command></screen>
 	<para>You can read the resulting HTML files with a Web
-	  browser.</para>
+	  browser. If no HTML is created, the error message(s) can be found in the output. Please resolve them before commit.</para>
 	<important>
 	  <title>Always Test Your Translation</title>
 	    <para>
@@ -305,7 +312,7 @@
       <step>
 	<title>Commit Work</title>
 	<para>
-	    When you have finished your translation, commit the <filename class="extension">.po</filename> file. You may note the percent complete or some other useful message at commit time.
+		Before commit your <filename class="extension">.po</filename> file, always make sure that the html has been generated successfully. You may note the percent complete or some other useful message at commit time.
 	  </para>
 
 	<screen><command><![CDATA[cvs ci -m ]]><replaceable>'Translating... 400/10/126'</replaceable><![CDATA[ po/]]><replaceable>pt_BR</replaceable><![CDATA[.po]]></command></screen>