[Po4a-commits] "po4a/share/doc po4a-build.xml,1.1,1.2"

[Neil Williams]

Update of /cvsroot/po4a/po4a/share/doc
In directory alioth:/tmp/cvs-serv29202/share/doc

Modified Files:
	po4a-build.xml 
Log Message:
	* MANIFEST: Add build and runtime documentation.
	* Makefile: Remove empty directories after install.
	* doc/po4a-build.conf.5.pod: Documentation for the
	po4a-build.conf file.
	* doc/po4a-runtime.7.pod: Documentation for using example
	files from po4a for runtime script translation.
	* doc/po4a.7.pod: Typo.
	* po4a-build.conf: Add section 5 and 7 POD content.
	* share/doc/po4a-build.xml: Document section 5 support.
	* share/po4a-build: Support section 5 for POD.
	* share/po4a-build.conf.example: Section 5 support.



Index: po4a-build.xml
===================================================================
RCS file: /cvsroot/po4a/po4a/share/doc/po4a-build.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- po4a-build.xml	6 Nov 2009 22:37:39 -0000	1.1
+++ po4a-build.xml	13 Nov 2009 10:46:41 -0000	1.2
@@ -42,8 +42,9 @@
     produce translated documentation as it can be to produce the current
     untranslated content.
     </para>
-    <para>Documentation in a format supported by <command>po4a</command>
-    can be built using <command>po4a-build</command>. Both the untranslated
+    <para>When <command>po4a</command> prepares the translated content
+    as POD or DocBook XML, the final documentation can then be built
+    using <command>po4a-build</command>. Both the untranslated
     and translated content is built as a single process, updating the POT
     files at the same time.
     </para>
@@ -74,13 +75,34 @@
     added and adding a second binary package (bar) allows the content for
     that package to kept separate.
     </para>
+    <refsect2 id="formats">
+      <title>Supported formats</title>
+      <para>Currently, <command>po4a-build</command> supports the
+      following combinations:
+      </para>
+      <orderedlist>
+        <listitem>Docbook XML for Section 1.</listitem>
+        <listitem>Docbook XML for Section 3.</listitem>
+        <listitem>DocBook XML for HTML.</listitem>
+        <listitem>POD for Section 1.</listitem>
+        <listitem>POD for Section 3.</listitem>
+        <listitem>POD for Section 5.</listitem>
+        <listitem>POD for Section 7.</listitem>
+      </orderedlist>
+      <para>All supported formats, in all supported combinations, can be
+      handled in a single <filename>po4a-build.conf</filename>
+      configuration file and in a single call to
+      <command>po4a-build</command>.
+      See <emphasis>po4a-build.conf (5)</emphasis>
+      </para>
+    </refsect2>
   </refsect1>
   <refsect1 id="config">
     <title>CONFIGURATION</title>
     <para><command>po4a-build</command> uses a default configuration file,
     <filename>po4a-build.conf</filename> which should be in the top level
     directory of your package VCS. (Use the <option>-f</option> option to
-    specify a different file.)
+    specify a different file.) See <emphasis>po4a-build.conf (5)</emphasis>
     </para>
     <example id="config">
     <title>example configuration file</title>