translation-quick-start-guide/en_US doc-entities.xml, 1.1, 1.2 translation-quick-start.xml, 1.2, 1.3

[Paul W. Frields (pfrields)]

Author: pfrields

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

Modified Files:
	doc-entities.xml translation-quick-start.xml 
Log Message:
Add section on common entities files, and admonition on disabled locales


Index: doc-entities.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/en_US/doc-entities.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- doc-entities.xml	27 May 2006 14:38:30 -0000	1.1
+++ doc-entities.xml	28 May 2006 19:00:46 -0000	1.2
@@ -10,11 +10,11 @@
     </entity>
     <entity name="DOCVERSION">
       <comment>Document version</comment>
-      <text>0.3</text>
+      <text>0.3.1</text>
     </entity>
     <entity name="DOCDATE">
       <comment>Revision date</comment>
-      <text>2006-05-27</text>
+      <text>2006-05-28</text>
     </entity>
     <entity name="DOCID">
       <comment>Revision ID</comment>


Index: translation-quick-start.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/en_US/translation-quick-start.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- translation-quick-start.xml	27 May 2006 14:38:30 -0000	1.2
+++ translation-quick-start.xml	28 May 2006 19:00:46 -0000	1.3
@@ -356,6 +356,57 @@
 
     </section>
 
+    <section id="sn-creating-entities">
+      <title>Creating Common Entities Files</title>
+
+      <para>
+	If you are creating the first-ever translation for a locale, you
+	must first translate the common entities files.  The common
+	entities are located in <filename
+	class="directory">docs-common/common/entities</filename>.
+      </para>
+
+      <procedure>
+	<step>
+	  <para>
+	    Read the <filename>README.txt</filename> file in that module
+	    and follow the directions to create new entities.
+	  </para>
+	</step>
+	<step>
+	  <para>
+	    Once you have created common entities for your locale and
+	    committed the results to CVS, create a locale file for the
+	    legal notice:
+	  </para>
+
+<screen>
+<command>cd docs-common/common/</command>
+<command>cp legalnotice-opl-en_US.xml legalnotice-opl-<replaceable>pt_BR</replaceable>.xml</command>
+</screen>
+
+	</step>
+	<step>
+	  <para>
+	    Then commit that file to CVS also:
+	  </para>
+
+<screen>
+<command>cvs add legalnotice-opl-<replaceable>pt_BR</replaceable>.xml</command>
+<command>cvs ci -m 'Added legal notice for <replaceable>pt_BR</replaceable>' legalnotice-opl-<replaceable>pt_BR</replaceable>.xml</command>
+</screen>
+
+	</step>
+      </procedure>
+      <important>
+	  <title>Build Errors</title>
+	  <para>
+	    If you do not create these common entities, building your
+	    document may fail.
+	  </para>
+      </important>
+    </section>
+
     <section id="sn-translating-with-apps">
       <title>Using Translation Applications</title>
       <note>
@@ -402,6 +453,16 @@
 <computeroutput>OTHERS = it <userinput><replaceable>pt_BR</replaceable></userinput></computeroutput>
 </screen>
 
+	  <note>
+	    <title>Disabled Translations</title>
+	    <para>
+	      Often, if a translation are not complete, document editors
+	      will disable it by putting it behind a comment sign (#) in
+	      the <varname>OTHERS</varname> variable.  To enable a
+	      translation, make sure it <emphasis>precedes</emphasis>
+	      any comment sign.
+	    </para>
+	  </note>
 	</step>
 	<step>
 	  <para>