2 <title>Extracting Documentation with ROBODoc</title>
4 <para>Now that you have prepared your source code for use with
5 ROBODoc you are ready to extract the documentation. There are
6 several choices to be made.</para>
9 <title>Single document or many smaller documents</title>
11 <para>First of all, ROBODoc can be used in three modes.</para>
15 <listitem><para>multidoc -- in this mode ROBODoc scans
16 all the source files in your source directory and creates a
17 separate document file for each of these in a document directory.
18 The document directory is created automatically. Its structure is
19 a mirror of the structure of your source directory.</para></listitem>
21 <listitem><para>singledoc -- in this mode ROBODoc scans all the source
22 files in your source directory and creates a single documentation
23 file that contains all the documentation extracted from your
24 source files. </para></listitem>
26 <listitem><para>singlefile -- in this mode ROBODoc scans a single source
27 file and creates a single documentation file.</para></listitem>
33 <title>multidoc</title>
35 <para>The multidoc mode is useful to create browsable documents.
36 For instance many small HTML files that can be viewed with a
37 web-browser. This mode requires the following arguments:</para>
41 --src <replaceable>source directory</replaceable>
42 --doc <replaceable>document directory</replaceable>
48 <para>An additional option that is useful with this mode is
49 <option>--index</option>, this creates a series of index files,
50 one for each header type.</para>
56 <title>singledoc</title>
58 <para> The singledoc mode is useful to create bulk documentation
59 that can be incorporated in other documents, or that can be
60 delivered to a client as a single document. For instance a file
61 created in RTF format can be included into a larger design
62 document written in Word format. This mode requires the following
67 --src <replaceable>source directory</replaceable>
68 --doc <replaceable>document file without extension</replaceable>
70 <replaceable>other options</replaceable>
74 <para>An additional option that is useful with this mode is
75 <option>--sections</option>, this causes the headers to follow a
76 section layout based on the module element hierarchy defined in the
83 <title>singlefile</title>
85 <para>The singlefile mode is not very useful. It is mainly used
86 for debugging purposes. This mode requires the following
91 --src <replaceable>source file</replaceable>
92 --doc <replaceable>document file</replaceable>
101 <title>Output formats</title>
103 <para>Your next choice is the output format. ROBODoc can create
104 documentation in several formats:</para>
107 <listitem><para>HTML, option <option>--html</option></para></listitem>
108 <listitem><para>RTF, option <option>--rtf</option></para></listitem>
109 <listitem><para>LaTeX, option <option>--latex</option></para></listitem>
110 <listitem><para>XML DocBook, option <option>--dbxml</option></para></listitem>
113 <para>What format to use depends on your wishes. If you want a
114 single printable document, use LaTeX or XML DocBook. If you want
115 a document that can be included into a larger (Word) document use
116 RTF. If you want something that is browsable use HTML, or use XML
117 DocBook and then convert it to HTML.</para>