Quick-start

Six steps up to your first automatic documentation

On-line assistance

Please note, that on-line assistance is available in all dialogs of DocBuilder. Press F1. You can switch between Windows Help and HTML (see dialog Extras | Options).

The on-line assistance (as part of the user manual) was generated with DocBuilder. Thus several target formats exist at the same time (see also menu Output | Context Sensitive Help)

1. Installation of DocBuilder

Install DocBuilder into your program directory. The installation includes on-line documentation, examples and sample files that you can use and modify.

2. Creation of your working directory

Create your working directory, in which your first DocBuilder-project file (*.dbp) is to be stored. By default the output documentations were placed in subdirectories of this working directory.

3. Use an available DocBuilder script file

Copy a script file (e. g. simple.dbs or typical.dbs) from the installation folder 'examples' to your working directory. The DocBuilder script file serves for configuration of the resulting documentation (it determines table of contents, sub-entries per text unit etc.). May be you can leave this file unchanged at the beginning. However, there are many possibilities for configuring your custom-made documentation. For this purpose the sample script files are commented.

4. Start DocBuilder and open your first project

After start of DocBuilder you must create the first project (dialog File | New Project). Here the following minimum specifications are necessary:

• Define a name for the project file in your working directory
• Activate your script file in the working directory
• Define a subdirectory for the output
• Define your source files in the corresponding sub-dialog

5. Start the analysis

Now you must process the dialogs below menu 'Analysis' in sequence. Their purpose is to tell DocBuilder , what is to be detected in your sources. Please, use the on-line help hereby (press F1).

Start the analysis of source files (menu option Analysis | Start).

During the analysis error messages are generated, if problems with input arise. For processing errors select menu option Edit | First Error (or use F4). Not all errors must be eliminated in order to start the final step.

6. Generate output documentation

The analysis results in intermediate files. From these the offered target formats are produced (menu Output | Generate ...).

DocBuilder Home | Overview | Advantages | Concepts | Download | FAQ