Architecture Documentation from DataFlex Source!
 DocuMentor

GETTING STARTED WITH DOCUMENTOR

DocMentor is a wizard-based Java application that uses the Java webstart technology to deliver, install and update the product.

Installing DocuMentor

Go to Mertech product downloads area, sign up or enter your email address (for registered users). Click on the DocuMentor icon in the product list .
This begins the download and installation process. If Java is not already installed on the computer, appropriate version of the Java runtime will be downloaded and installed automatically and Desktop shortcut as well as an entry in the program manager will also be created.

Launching Documentor

Once the installation process is complete, desktop short cut and program manager entry will have been created and the application will also launch automatically. The first dialog the user see is the Welcome Screen shown below.

DocuMentor Welcome Screen

Running the Free Edition

After the Welcome Screen, the user will see the license selection option. If a license file is available, (for Basic or Pro editions), point to that location. The license file can be kept at any location as long as the user has read rights to it. In the absence of a license file the user will be able to continue with the Free edition, as shown below.

License Selection Option

Workspace Selection

The next wizard dialog lets the user select the Visual DataFlex version and the appropriate workspaces.

Workspace Selection

Output Directory Selection

The next wizard dialog lets the user select the main application files (.src files), as well as select the output directory.

Output Directory Selection

Finish and Run

Click Finish on the Summary Dialog screen.

Finish

DocuMentor will start analyzing the application source. The total time taken will depend on your application size, processor speed and available memory. For application with 500,000 lines of code or more, it can take upward of an hour for generating the Pro report. The Free edition will be much faster as less information is processed and generated.

Viewing DocuMentor Report

After completing the report generation, the report will automatically launch in the default browser of the user. The starting page for the DocuMentor report is index.html. To run the report manually, open the directory that was specified as the DocuMentor Output directory above in Windows Explorer and then double-click on index.hml. Documentor has been tested on FireFox, Google Chrome, Windows Internet Explorer and Apple Safari.