News
News, Updates and Links
News 2002
May
Supplements
Link Images in Text Files
Now images can be linked in text files for output formats Html and WinHelp.
Bug in Dialog "New project" removed
The former version of DocBuilder had a bug at this place: If you have called the dialog for defining source files inside the new project dialog, the new redefined source files were written in the (yet open) old project. Or, in case there is no old project, the program hangs up.
Adapt the editor for the Source Link
In the format WinHelp can be produced links between the documentation and the appropriate source files. In the dialog "Extras|Options" the standard entry "notepad.exe" can be adapted for the preferred editor.
Second Version of DocBuilder with some Innovations and Improvements
Double click in Message Window
If you double-click on a message in the Message Window and if this message starts with a file name and line number, then a text editor is opened at that place.
Title of Documentations in WinHelp and HTML
You can specify the global title of documentation now in a dialog (cf. menu Definitions).
Order of doc units based on input of source files
The former version of DocBuilder was unsatisfactory concerning the order of source files in output. Now the following principle is ensured without exception: The order in that you define the source files (in dialog Definitions/Source files) determines also the order of output in the final documentation, unless other definitions in DocBuilder Script file (*.dbs) determine another order.
For instance, you can manipulate the order of doc units in the final documentation by sort options. They are defined by the command ´@filtersort´ in DocBuilder Script File (*.dbs). An alphabetic sorting is available, too. However, in the default case the sort option ´@filtersort<UNIT_LOC>´ is valid. The effect is that the text units are sorted in the same order that is given by the order of text units in source files.
Obviously, this sort option applies only to the interior of one individual source file. Beyond the source file that order of source files remains valid, i.e. that order you have defined in the dialog for defining source files, unless the script file determines another order (e. g. by command ´@filefilter´).
Output Groups
If you want to assign different groups of source files to different sections in your documentation, you can assign the source files in the defining dialog to output groups. An output group is represented by a name ´XY´ and it is a set of source files (that are assigned to name ´XY´).
This name ´XY´ of an output group can be used in the DocBuilder Script File (*.dbs) instead of enumerating all source files that are assigned to this name.
We recommend to use the name of output groups in DocBuilder Script Files, i. e. in the command ´@filefilter´ instead of individual file names or file filters. Nevertheless, the latter case remains valid. By this procedure you can achieve that the exact set of source files can be changed easily without the need to change the DocBuilder Script File.
Then the recommended section begin in script file has this form:
@section ! opens a new section of your documentation
@filefilter! chooses the doc units of output group XY An typical example of a well structured documentation (including introductory text at beginning of sections) is demonstrated in the folder ´examples/cpp_extended´ of DocBuilder installation.
Links
DocBuilder Listings
