Changeset 3286 for trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

Timestamp:

May 3, 2007, 9:21:48 AM (16 years ago)

Author:

Martin Svensson

Message:

References #555 Complemented with information about using XsltProc? when compiling documentation source

File:

• trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml (modified) (1 diff)

trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

@@ -424 +424 @@
     </sect2>
     <sect2 id="write_docbook_doc.begin.generate">
-      <title>Generate the document</title>
-      <para>
-        There are two different types of format that is generated from the documentation
-        source. The format to view the documentation on-line will be the one with chunked
-        HTML pages where each chapter and section of first level are on separate
-        pages/files. The other format is a PDF-file that are most useful for printing and
-        distribution. Those two types of output are generated with the ant-target:
-        <userinput>ant docbook</userinput>
-        . This documentation is also generated with
-        <command>ant dist</command>
-        , which will put the output files in the right location for distribution.
-      </para>
+      <title>Generate output</title>
+
+      <sect3 id="write_docbook_doc.begin.generate.requirements">
+        <title>Requirements</title>
+        <para>
+          Those who have checked out the documentation source from repository or got the
+          source from a distribution package needs to compile it to get the pdf and html
+          documentation files. The compilation of the documentation source requires, beside Ant, that the XML-parser
+          Xsltproc is installed on the local computer. XsltProc and how it is installed, can
+          be found at
+          <ulink url="http://xmlsoft.org/XSLT/index.html"></ulink>.
+        </para>
+        <note>
+          <para>
+            There is an xml-parser in newer java-versions that can be used instead of
+            XsltProc but the compilation will most likely take much much longer time.
+            Therefore it's not recommended to be used when generating/compiling the
+            documentation in BASE 2.
+          </para>
+        </note>
+      </sect3>
+      <sect3 id="write_docbook_doc.begin.generate.compile">
+        <title>Compile - generate output files</title>
+        <para>
+          There are two different types of format that is generated from the documentation
+          source. The format to view the documentation on-line will be the one with
+          chunked HTML pages where each chapter and section of first level are on separate
+          pages/files. The other format is a PDF-file that are most useful for printing
+          and distribution. Those two types of output are generated with the ant-target:
+          <command>ant docbook</command>
+          . This documentation is also generated with
+          <command>ant dist</command>
+          , which will put the output files in the right location for distribution with
+          BASE 2.
+        </para>
+      </sect3>
     </sect2>
   </sect1>