Compiling the Documentation for Project Group

When VBdocman is set properly, you can compile a new documentation for whole group.

Pressing Compile Group button in VBdocman dialog causes that every project in the group is compiled with its own settings. It acs exactly as thought you compiled them separately step-by-step. During this process VBdocman activates every project in the group so you can see how some source code windows are opened and then closed.

In addition to project documentation, VBdocman generates one master documentation in every project's output folder. Master documentation includes all project documentation in the group and its name is Group+. It doesn't physically contain all project's documentation. It only references them depending on output format. So you can freely make changes to sub-documents without the need of change master document. This is extremely useful in distributed team work. All sub documents are exactly the same as if generated for single project.

It is necessary that all projects are set to produce documentation of the same format (CHM, HTML or RTF).

So you have several projects, every generated its master document. You only need one of them because they are all the same, others can be deleted.

What to do next depends on output format. Let's assume we have group with two projects P1 and P2.

HTML Help (CHM)

This is the best format to make master documentation. Master document contains all projects in its table of contents, unified index and unified full-text search. All you need to do is copy all project documentation to the same folder. Copy one master document from any of the projects to that folder. So you have P1.chm, P2.chm and Group+.chm. To see master documentation open Group+.chm.

HTML

Master document contains links to all projects. Every project documentation must be placed in folder named exactly as the project. So create the proper folders in some folder e.g. doc. Then copy all project documentation to these folders. Copy one master document from any of the projects to doc folder. So you have P1 folder with documentation for P1, P2 folder with documentation for P1 and Group+.html. To see master documentation open Group+.html.

RTF

Master document contains all projects as embedded documents. All you need to do is copy all project documentation to the same folder. Copy one master document from any of the projects to that folder. So you have P1.rtf, P2.rtf and Group+.rtf. To see master documentation open Group+.rtf in MS Word.

First you see only master document with links to sub-documents. Go to outline view .

Expand sub-documents by clicking icon in toolbar. Now you should see all expanded documents and you can return to normal view.

XML

Master document Group+.xml contains a list of <project> tags with names of projects and corresponding XML file names.

HLP

Not supported.

 

See also how to compile single project.


Send feedback to Helixoft
© 2000-2005 Helixoft. All rights reserved.