Changeset 3286


Ignore:
Timestamp:
May 3, 2007, 9:21:48 AM (14 years ago)
Author:
Martin Svensson
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

    r3282 r3286  
    424424    </sect2>
    425425    <sect2 id="write_docbook_doc.begin.generate">
    426       <title>Generate the document</title>
    427       <para>
    428         There are two different types of format that is generated from the documentation
    429         source. The format to view the documentation on-line will be the one with chunked
    430         HTML pages where each chapter and section of first level are on separate
    431         pages/files. The other format is a PDF-file that are most useful for printing and
    432         distribution. Those two types of output are generated with the ant-target:
    433         <userinput>ant docbook</userinput>
    434         . This documentation is also generated with
    435         <command>ant dist</command>
    436         , which will put the output files in the right location for distribution.
    437       </para>
     426      <title>Generate output</title>
     427
     428      <sect3 id="write_docbook_doc.begin.generate.requirements">
     429        <title>Requirements</title>
     430        <para>
     431          Those who have checked out the documentation source from repository or got the
     432          source from a distribution package needs to compile it to get the pdf and html
     433          documentation files. The compilation of the documentation source requires, beside Ant, that the XML-parser
     434          Xsltproc is installed on the local computer. XsltProc and how it is installed, can
     435          be found at
     436          <ulink url="http://xmlsoft.org/XSLT/index.html"></ulink>.
     437        </para>
     438        <note>
     439          <para>
     440            There is an xml-parser in newer java-versions that can be used instead of
     441            XsltProc but the compilation will most likely take much much longer time.
     442            Therefore it's not recommended to be used when generating/compiling the
     443            documentation in BASE 2.
     444          </para>
     445        </note>
     446      </sect3>
     447      <sect3 id="write_docbook_doc.begin.generate.compile">
     448        <title>Compile - generate output files</title>
     449        <para>
     450          There are two different types of format that is generated from the documentation
     451          source. The format to view the documentation on-line will be the one with
     452          chunked HTML pages where each chapter and section of first level are on separate
     453          pages/files. The other format is a PDF-file that are most useful for printing
     454          and distribution. Those two types of output are generated with the ant-target:
     455          <command>ant docbook</command>
     456          . This documentation is also generated with
     457          <command>ant dist</command>
     458          , which will put the output files in the right location for distribution with
     459          BASE 2.
     460        </para>
     461      </sect3>
    438462    </sect2>
    439463  </sect1>
Note: See TracChangeset for help on using the changeset viewer.