ezDOC for Paradox
Version 2.0
This short guide highlights the important features and functions of ezDOC 2.0 from Woll2Woll Software.
What is ezDOC?
ezDOC is much like a Swiss Army knife in that it’s comprised of five different utilities bundled together in a single product. ezDOC provides Paradox for Windows developers a set of tools that assists them in developing, delivering and documenting their applications. Each of the tools included with ezDOC are listed below:
- ezDOC - Main Documentor. Professional quality technical documentation generator.
- ezArchitect. Hierarchical diagram of an entire application’s architecture.
- ezSearch. Globally search a selected set of PW source files for a text value.
- ezCompare. Compare any two PW forms or libraries for source code differences.
- ezDeliver. Deliver all programmer-selected PW source files in a single operation.
Benefits of Using ezDOC - An Overview
ezDOC was developed to meet the demanding professional needs of both corporate and independent Paradox for Windows developers. The product continues to be enhanced based on suggestions from existing ezDOC customers, insuring that all reports are of a professional, high-quality nature suitable for inclusion in a client’s technical documentation package.
Quick and Easy Application Documentation
Of major concern to developers is a utility’s availability, ease of use and how much interaction is required from them. ezDOC is available to the developer at all times directly from the Paradox for Windows Tools menu. It also lives up to its name since it’s very "easy" to use. Simply select the report destination, any number of files, check the reports you want and click the Generate button. All of your requested reports will be generated in a single run session. Other documentation tools limit the developer to selecting only a single report type for each print run, thus increasing the developer’s required interaction time with the utility, not to mention the extra time it takes to generate a complete set of client documentation.
Professional, Consistent and Flexible Design
Professional developers require a high-degree of flexibility to customize reports for specific projects and client requirements. ezDOC meets these needs head-on by providing a modifiable main title and subtitle, along with developer-defined tab stop and font size settings. In addition, most ezDOC reports are provided in an undelivered state so the developer can further customize individual reports to meet their needs.
Fastest Possible Report Generation Speed
Developers are also concerned with how fast a utility operates. With this concern in mind, many of ezDOC’s behind-the-scenes functions are written in C++, being compiled into .EXE or .DLL files, providing developers with the fastest report generation speeds possible.
Visually-Oriented Documentation
ezDOC maintains the consistency of the Paradox for Windows visual development environment by providing developers with visual form documentation. ObjectPAL code is added to visual objects that appear on a form and ezDOC provides the developer with not only a plain graphic output of the form, but can optionally number selected objects for easy cross-reference purposes to the ObjectPAL source code reports.
Database Architecture Report
ezDOC 2.0 includes a new diagramming tool, ezArchitecture, that creates a hierarchical diagram of all file-level objects contained in a Paradox for Windows database, or application. When a developer needs to know where a particular form, table or other Paradox for Windows file-level object is referenced, and how it is referenced (data model, referential integrity or table lookup), ezArchitecture’s Database Architecture report provides the answer.
Additional Development Tools
ezDOC includes three additional tools that aid in the Paradox for Windows (PW) application development process, each one being immediately available via the PW Tools menu. ezSearch gives developers a means of globally searching all, or developer-selected, PW source files (scripts, libraries and forms) for any text value. ezCompare provides the developer with a tool that compares the source code content of two files (script, library or form) reporting the source code or hierarchical differences by object and method. ezDeliver automatically delivers all developer-selected source files and provides data such as compiled code size, symbol table size, data size and the number of methods in the source file.
Main Functions and Features
ezDOC - Main Documentor
- Available directly from the Paradox for Windows Tools menu.
- Right-clicking option text displays a related options dialog box, similar to inspecting an object in Paradox for Windows, providing a cleaner ezDOC window.
- Easily change global report options such as title, subtitle, tab stops and font sizes by clicking the Set Prefs button.
- Obtain on-line, context-sensitive help by pressing F1 or by clicking the Help button.
- Report destination options include:
- Text File.When selected, only those report options that can be represented as text are highlighted; all others are automatically dimmed. The text output can optionally be displayed with an editor of the developer’s choice.
- Screen Preview. When selected, the developer is allowed to select only a single report option, since the screen can display only a single document at any given time.
- Printer. When selected, all report options are available to the developer.
- Table Documentation:
Right-clicking within the Table Report Options area displays a dialog box that allows you to select the report type and sort order. Two pre-defined sets of table reports are provided with ezDOC: Brief and Detailed. The Brief report selection prints data in portrait mode that contain less data than the Detailed report selection which prints data in landscape mode. Additional developer-defined reports can be added to the list of available table reports.
The developer can also choose between three different report sort orders: Field Name, Field Type and Field Number. Developer-selectable table reports include:
- Field Structure. Produces a field-by-field listing of a table’s structure items, such as field number, name, type, size ValCheck and table lookup information.
- File Statistics. Produces a file-by-file listing of all table-related DOS files, including the file name, size, attributes, date and time.
- Index Structure. Produces an itemized list of Secondary Indexes and its related information.
- Referential Integrity. Produces an itemized list of all Referential Integrity rules defined for a table.
- Security Information. Produces a report listing each Auxiliary Password defined for a table, including its table, family and field rights.
- Table Properties. Produces a listing of all property values assigned to a table, such as name, type, field count, logical record size, physical record size, key size, index count, and more.
- Form and Report Documentation:
- ObjectPAL Source. Produces a listing of all ObjectPAL source code contained within any Paradox for Windows source file, such as a form, script, library, etc.
- Object Tree. Produces a hierarchical diagram of all objects contained within a form or report, displaying objects that contain source code in reverse video (black box with white text).
- Object Properties. Produces a report listing Property Name, Object Name, Class and Property Value, sorted by either Property Name or Object Name, defined for each object on a form or report. The developer can select specific properties to be reported, a pre-defined group of properties and the sort order by right-clicking the Object Properties text.
- Visual Cross References. Produces a graphical image of a form in one of three modes (object/source code cross reference, view mode or display mode), or a report in design mode. Selection of specific objects to be included and setting of cross-reference filters are defined by right-clicking the Visual Cross Ref. text.
- Data Model Documentation:
- Diagram. Produces a graphical diagram of a data model for a form, report or data model object.
- Link Fields. Produces a graphical diagram showing the link relationships between each pair of tables in a data model, including field names and relationship type.
- Tables. Produces a listing of table relationship properties for each table in a data model, including read only, strict translation, auto append and filters.
- Selection of the Paradox for Windows files to be processed is accomplished by clicking the Select Files button. The Select Files dialog box opens, where you can select any number of any file types, mix and match style, including Reference Files you specify via the Paradox for Windows Project Viewer. The developer can select multiple file types only when Printer is selected as the report destination. Multiple files can only be selected when the destination is not Screen Preview.
When you click the Generate ezReport button, ezDOC will generate all selected reports for all selected file types, automatically, without any further intervention on the part of the developer. This built-in intelligence is a welcome time saver for developers, as ezDOC can document an entire application while the developer takes a break or enjoys a relaxing lunch.
ezArchitecture - Database Architecture Diagram
- Available directly from the Paradox for Windows Tools menu.
- Object Types to Include. This option grouping allows the developer to select the specific Paradox for Windows file types to be included in the Database Architecture Diagram and include forms, Windows help files, libraries, queries, reports, scripts, tables and misc., such as SQL, binary and graphics. The developer may include as many or as few object types as desired.
- Related Tables to Include. This option grouping allows the developer to select the reason for including a table object type in the report, such as Data Model Tables, Referential Integrity and Table Lookup. Each table in the resulting diagram is then denoted with a D, R or T respectively.
- The diagram may be sorted by either object Name or Type.
- The root object file is entered into the Selected File textbox by clicking in the textbox and using the Select Root Object dialog box.
- The initial font size is entered into the Font Size textbox by clicking in the textbox and entering a new font size in the Enter Font Size dialog box. Font size is dynamically set by ezArchitecture while generating the diagram, so as much of the diagram can be fit into the initial display window as possible.
- Literals that contain one of the selected object file extensions can optionally be included in the diagram by selecting the Include all literal references to object types checkbox.
- Click the Show Architecture button to create the Database Architecture diagram. ezArchitecture begins by opening the starting file you specified and searching for occurrences of the specified object types. Each matching object type located is logged and then opened and scanned in a recursive manner until all requested object types have been scanned for requested object types and table relationships.
- Once the Database Architecture diagram window is open, the diagram can be further customized before printing in two ways. First, by highlighting a specific object type, which is accomplished by opening the View menu and choosing the Highlight Filter option. Second, by changing the font size, which is accomplished by opening the View menu and selecting the Font Size option.
- The diagram is printed by opening the File menu and selecting the Print option. Printer Setup is also available from the File menu.
ezSearch - Global Source File Searching Utility
- Available directly from the Paradox for Windows Tools menu.
- Similar to the GREP utility found in many development environments. Globally searches all developer-specified Paradox for Windows source files (forms and libraries) for a developer-specified text value or regular expression.
- Selectable search types include Word Match, Literal Match and Pattern Match.
- Case sensitivity is developer-defined as active or inactive.
- All matches are listed in Paradox for Windows object notation, including the object name, method name and the relative line number within the method.
ezCompare - Source File Comparison Utility
- Available directly from the Paradox for Windows Tools menu.
- Automatically compares any two developer-specified Paradox for Windows forms or libraries reporting all source code differences and/or object tree hierarchy changes between the two files.
- Options include case sensitivity, white space compression, maximum number of consecutive mismatches and resynchronize count.
- Report is sorted by method name and lists all source code lines that are different between the to files, including relative line numbers.
ezDeliver - Automated Source File Delivery Utility
- Available directly from the Paradox for Windows Tools menu.
- Automatically deliver any number of developer-selected Paradox for Windows source files into the same or a different directory.
- Optionally have ezDeliver select only those source files that have been changed since the last compile.
- Displays the file name, compile status, compiled code size, compile seconds, symbol table size, data size and method count.
- Highlights files that exceed developer-defined upper limits for compiled code size and symbol table size with a red background.
- Optionally print a report of all source files that were compiled.
ezDOC Requirements
In order to run ezDOC 2.0, the developer’s PC must contain a functional copy of Paradox for Windows version 5.0. ezDOC does not have any requirements above or beyond those necessary to run Paradox for Windows.
Availability & Pricing
ezDOC 2.0 is available immediately at retail price of $149, for a single- user version, $99 for each additional user or $425 for an unlimited number of users Site License. Until November 31, 1994, ezDialogs can be purchased with ezDOC for a special bundle price of $249. All prices are in U.S. dollars valid for U.S. and Canada customers only. Foreign dealer prices may vary depending on country. Visa, Mastercard and American Express are accepted.
Support
ezDOC 2.0 includes unlimited free software support via phone, fax and CompuServe.
Company Information
Founded in 1993 by Roy S. Woll, Woll2Woll Software is dedicated to producing high-quality, professional, easy-to-use and affordable Paradox for Windows development tools. One of the first commercial vendors to provide development tools for the Paradox for Windows database development market, Woll2Woll creates products based on corporate and independent developer requirements that are not met in the Paradox for Windows product.
Headquartered in San Jose, California, Woll2Woll Software’s products currently include ezDOC, ezDialogs, and InfoPower.
Woll2Woll Software
2217 Rhone Dr.
Livermore, CA 94550
Sales:
1-800-WOL2WOL (1-800-965-2965)
Phone: (510) 371-1663
Fax: (510) 371-1664
| All pages copyright © 1995-2002 Woll2Woll Software |
| Phone (Sales): |
800-965-2965 (Toll Free U.S) |
|
925-371-1663 (International) |
| Fax: |
925-371-1664 |
| Email: |
sales@woll2woll.net |
| Last Modified: |
Wednesday, 28-Jan-2004 10:17:11 PST |
