Editing a Documentation Template

Editing a Documentation Template

Overview

Documentation Object

Documentation Script Wizard

Generating an RTF Documentation Script with Wizard

Generating an DXY Documentation Script with Wizard

Overview

Editing a documentation template is certainly the most important step in the process of documentation generation and the quality of the documentation depends directly on it. This activity is carried out by a combined use of DTE and DA-C. DA-C prepares and integrates DGML scripts into the template, and DTE formats documentation attributes and inserts content independent of scripts.

When integrating DGML scripts, the Wizard can be a great help. All you have to do is form a report and select an object, that is form a documentation object and then specify in the Wizard which information on the documentation object you want to document. On the basis of this selection, the Wizard create an adequate DGML script. If you click the Add to Template button, the Wizard will insert this block of DGML scripts into the active documentation template at insertion point position, and if you click the Copy Script button, then the DGML script block will be transferred to the Clipboard.

If you have transferred the DGML script block to the Clipboard, you can later transfer it somewhere else using the Paste (Ctrl-V) command in DTE.

DGML scripts created by the Wizard according to your specification will be clearly set apart in the documentation template by a pair of #{ characters for the beginning and a pair of }# characters for the end of the DGML script. You can simply delete the entire block and repeat the process of integrating DGML scripts using the Wizard.

Documentation Object

A documentation object is anything you can select in DA-C and for which you can form documentation. The following can be documentation objects:

DA-C reports

Browser reports

Declarations, Uses, Assignment, CallsTo, CallsWithin, UsesWithin, Global <Symbols> and Search.

VCS reports

VCSHistory and VCSDifference.

Graphics reports

FlowChart, CallGraph, TypeGraph and Metrics.

Project data

Data on the project itself

Project, including VCS data

Project object data

File, including VCS data, Directory, Group, View, <Symbol>, where <Symbol> can be Function, Variable, Constant, Type and Macro.

Messages