GETTING STARTED WITH DOCUMENTOR
DocuMentor is a wizard-based Java application that uses the Java Web Start technology to deliver, install and update the product.
Go to the Mertech product downloads area, and 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 your computer, the appropriate version of the Java runtime is automatically downloaded and installed.
Once the installation process is complete, a desktop shortcut and program manager entry are created and the application launches automatically. The first dialog you see is the Welcome Screen shown below.
Click Next to see the license selection options. 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 you have read rights to it. In the absence of a license file, you can continue with the Free edition, as shown below.
Click Next to select the Visual DataFlex version and the appropriate workspace.
Output Directory Selection
The next wizard dialog lets you select the main application files (.src files) to be analyzed, and the output directory.
Report Detail Selection
You can limit the amount of information that is contained in the report through choices on the Report Detail dialog (this option is not available in the Free edition).
Finish and Run
Once all selections are made, click Finish on the Summary dialog screen.
DocuMentor starts analyzing the application source. The total time taken depends on your application size, processor speed and available memory. For applications with 500,000 lines of code or more, it can take upward of an hour to generate the Pro report. The Free edition is much faster as less information is processed and generated.
Viewing DocuMentor Report
After completing the report generation, the report automatically launches in the default browser. The starting page for the DocuMentor report is index.html. To run the report manually, open the DocuMentor Output directory (specified above) in Windows Explorer and then double-click index.hml. DocuMentor has been tested on FireFox, Google Chrome, Windows Internet Explorer and Apple Safari.
We recommend that you use a 64-bit OS to run DocuMentor.
- Windows XP, Vista 7, Server 2003 or later, Linux, MacOSX 64- or 32-bits
- At least 4 GIGs of RAM
- Adequate disk space depending on the size of the application
DocuMentor benefits the most with higher RAM. 32-bit Operating Systems typically do not allow applications to take advantage of more than 2 GIGs of RAM. We recommend that you use DocuMentor on 64-bit OS to take advantage of higher RAM access.
DocuMentor by default allocates 1 GIG of RAM for DocuMentor. Using the Java Webstart method of launching the application, this value cannot be changed dynamically. In order to increase the memory size, a Java application much be launched from the command line, specifying the amount of memory it can use.
Following are examples of launching DocuMentor with various memory allocation:
- 64-bit OS with memory allocation of 3GIGs
- 32-bit OS with memory allocation of 2GIGs
"C:\Program Files (x86)\Java\jdk1.6.0_25\bin\javaws -J-Xmx2g https://s3.amazonaws.com/content.documentor.mertechdata.com/jws/documentor.jnlp"