Examples of How to Create DocumentationHTML Example For this you need a web browser, say FireFox or Mozilla. You can try
this in the robodoc root directory. It creates a document called
HDocs/masterindex.html plus a lot of smaller
documents from all the source files in the directory
Source.robodoc ./Source ./HDocs
RTF ExampleFor this you need an rtf reader, for instance
Word. You can try this in the robodoc root
directory.robodoc ./Source api
This will create a document called
api.rtf.By default the document looks pretty plain. There is no
chapter numbering or a table of contents, even if you asked for
it. All the information for this is included but not visible.
This is because chapter numbering and a table of contents are
generated by Word based on formatting information that is part of
a Word document but not part of a RTF document. To make it visible you include the generated document into a
bigger document with the right formatting options. This is best
done with a cut-and-paste operation. Use the cut-past-paste
special menu, and paste it as RTF formatted text into your Word
document.LaTeX Example For this you need latex and
makeindex. You can try this in the robodoc root
directory. It creates a single document called
api.dvi from all the source files in the
directory Source.robodoc ./Source api
latex api.tex
latex api.tex
makeindex api.idx
latex api.tex
xdvi api.dvi
XML DocBook Example
DocBook is a xml format to create technical documentation, see.
DocBook.org.
DocBook is quite nice. This manual for instance is written in DocBook and
automatically translated into html and pdf format.
You can use the DocBook output of ROBODoc to create several other formats,
for instance: html, pdf, html-help.
For this you need a tool that can process a DocBook file. There
are several of these tools.
DocBook with html outputThe easiest to use is xsltproc. It works under
Windows and Unix. A typical workflow under Windows is:
robodoc ./Source api
xsltproc api.xsl api.xml > api.html
Where api.xsl contains:
]]>
For this you need xsltproc. For Windows these can be found at
http://www.zlatkovic.com libxml.en.html,
and the stylesheets which can be found at
http://docbook.sourceforge.net/.
In the example above the style sheets are installed on e:/docbook/.
More information about xsl can be found at
http://www.sagehill.net/docbookxsl/.
DocBook with html help outputThe same program can be used to
create a html help file. For this you need
HTML Help Workshop. The workflow now is:
robodoc ./Source api
xsltproc api.xsl api.xml
hhc htmlhelp.hhp
Where api.xsl contains:
]]>