Copyright: ® Corsoft Corporation


Help Contents
Contents

Overview

 Introduction

 CorDoc Quick Start

 Product Support

Using CorDoc

 Using the Environment

 Viewing Screen files

 Sorting Objects

 Searching Objects

 Creating Application Hierarchy

 Viewing Application Hierarchy

 Creating Cross Reference

 Viewing Cross Reference

 Reports

Other Help Topics

 Toolbar and Keyboard Shortcuts

 Icon Definitions


 Introduction

CorDoc assists developers in documentation and maintenance of ObjectView™ based applications.  CorDoc can analyze ObjectView™ applications and create an hierarchical chart to display the application flow.  It can analyze ObjectView™ screen files (OBV) and display object attributes, properties and other pertinent information in an easy to understand format.  It can analyze ObjectView™ script files (OBS) and display a complete cross-reference for all the variables, subroutines and functions used within the script in a lucid graphical format.

CorDoc also generates reports in graphical format.  CorDoc provides a unique capability to document the source code in an enhanced manner to distinguish the difference between the code from its remarks and functions from ViewScript construct.


 CorDoc Quick Start

CorDoc is an application documentation and maintenance tool for ObjectView™ based applications.  It supports an ability to generate Cross Reference for Variables, Subroutines and Functions above and beyond all existing features in current Sherlock's View (Application Overview) module (Currently, provided with Enterprise Edition of ObjectView™).  CorDoc provides the following features:

Related Topics:

 Multiple Document Interface Support

 Project Management Support

 Support for Building Application Hierarchy

 Support for Screen Resource Management

 Support for Sorting Objects

 Code Color Support

 Support for code greater than 32KB

 Cross Reference Support

 Support for Impact Analysis

 Support for Printing Objects information

 Support for Printing Scripts and Include files


 Multiple Document Interface Support

Enables opening multiple files at the same time.  It provides capability to view only various types of ObjectView™ development files and relationships, including:

•	Application Hierarchical Tree (.TRE) file

•	ObjectView™ Screen Source (.OBV) file(s)

•	ObjectView™ Script Source (.OBS) file(s)

•	Associated Source Include (.INC) file(s)

•	CorDoc Cross Reference (.XRF) file


 Project Management Support

CorDoc provides an ability to view a file or a collection of files as an application.  The application may be defined:

•	As a project (.PRJ) file, defined by CorEdit environment

•	As a list (.LST) file, defined by ObjectView™ Resource Manager

•	As all files within the working directory


 Support for Building Application Hierarchy

CorDoc can read all the files within the selected project (.PRJ) file or a list (.LST) file and build an application hierarchy.  This helps in understanding the program flow, the layers of relationship between various screens, their links with each other and their behavior.

An application may consist of more than one screen.  An application is invoked by starting with the first screen.  The application navigates from one screen to the other, either at the same level (using Chain command), or establishes a parent child relationship with modeless or modal behavior (using Popup, WinPopup, Popin, WinPopin, ModalPopup, etc.).

CorDoc can read the entire application (Screen resource and its associated scripts) to generate an hierarchy which is presented in a graphical tree format with each screen and its associates scripts and include files as nodes on the tree with different images signifying the relationship and nature of the window.


 Support for Screen Resource Management

CorDoc can analyze each screen resource and list all of its available objects.  This helps you visualize each object, its associated attributes, properties, events, commands, parameters, hot keys, etc.  All objects within the screen can be sorted by their name, their type or by their command.  It also helps users locate any redundant or duplicate objects, if any, on the screen, including menus that may no longer exist.


 Support for Sorting Objects

CorDoc provides a list of all objects within any selected screen (.OBV) file.  For each selected object, it can present a set of attributes, events processed and its properties.  It also lists any associated command and its parameters.

A screen may contain various objects.  CorDoc provides a capability to list all its objects by either its name, its type, or its associated command.


 Code Color Support

CorDoc provides a way to view the menus and code associated with the screen, if any.  The code is presented in color, with ObjectView™ commands in magenta, ViewScript syntax in red, strings enclosed within double quotes in blue and remarks/comments in green.  This is the default color selection as provided in CorEdit environment.


 Support for code greater than 32KB

CorDoc provides the capability to view source code files greater than 32KB in size, in an event application source was developed using other scripting editors like CorEdit.


 Cross Reference Support

CorDoc reads the entire script file with its associated include files to generate a cross-reference (.XRF) file, which can help you determine the occurrence of every variable and procedure (includes subroutines and functions) with reference to its Caller\Callee and its occurrence within the script file (line and column number).  The information is provided in graphical format and can also be exported in ASCII format (.REF) file to be used for other maintenance issues.


 Support for Impact Analysis

CorDoc provides an ability to generate impact analysis with the defined project or directory.  It provides an ability to search for an object, either by its name or its type or both.  It can search objects with partial names as well.  This is useful in determining the occurrence of a specified type of object within a project under consideration.  CorDoc does not provide an ability to change any screen resources.  However, if you intend to change or redefine existing object(s), CorDoc provides assistance in locating the objects within the defined application project or directory.


 Support for Printing Objects information

CorDoc can generate reports for all information portrayed on its screens.  Although, it is not totally WYSIWYG, it generates legible reports with information presented graphically for most reports.

For application documentation, it generates the output of a graphical tree.  The tree on the screen can be condensed or expanded at various nodes by double clicking at the node.  The output will generate a report with completely expanded tree.


 Support for Printing Scripts and Include files

CorDoc generates output for the source code within its script (.OBS) files.  For its screen preview, it presents the code in various different colors with ObjectView™ commands in magenta, ViewScript syntax in red, strings enclosed within double quotes in blue and remarks/comments in green.

The report generated will present ObjectView™ commands in italicized bold, ViewScript syntax in bold, remarks/comments in italics and rest of the code in normal/regular style.  It also presents a way to provide a configurable footnote with an option to include date and time when the report is printed.


 Product Support

In United States and Canada, the technical support for all modules of CorUtils for ObjectView™ can be obtained by calling Corsoft Corporation.  CorUtils for ObjectView™ comprises of three utilities:

•	CorEdit: Improved Scripting Environment.

•	CorLib: Enhanced set of function library.

•	CorDoc: Application and Screen documenting tool.

CorUtils for ObjectView™ was developed by Corsoft Corporation.

Corsoft Corporation, 411 Borel Avenue, Suite 507, San Mateo, California 94402

Ph: (415) 286-2870

Fax: (415) 286-2879


 Using the Environment

CorDoc is a Multiple Document Interface application and is developed with ObjectView™ using its C/C++ API.  It provides an ability to assist in documentation and maintenance of applications developed with ObjectView™.

CorDoc is a Multiple Document Interface application.  Most actions are accomplished via menu choices.  Toolbar provides an easy access to various menu choices and the status bar provides help and activity status at all times.

CorDoc Main Screen

Related Topics:

 Window Arrangement

 CorDoc Help


 Window Arrangement

Arranging windows and icons in different ways can be done through the Window menu.  Window and icons can be arranged in different ways using the options and methods described below:

•	The Cascade option enables the user to overlap windows so that each window's title remains visible.  If any icons are present, they will be arranged.

•	The Tile Horizontally option enables the user to re-size and arrange windows without overlap so that each window is wider than it is long.  If any icons are present, they will be arranged.

•	The Tile Vertically option enables the user to re-size and arrange windows without overlap so that each window is longer than it is wide.  If any icons are present, they will be arranged.

•	Arrange minimized windows with the Arrange Icons option.

•	Closing all window can be achieved using the Close All option.  Note:  If the file has changed, you are prompted with a message indicating that the file has changed.  You have the option: to save, to exit without saving or to cancel the operation.

•	Activating other windows can be achieved using the active window selection section within the Window menu.  This section will expand as more file are opened and contract as more file are closed.  The check mark at the beginning of the file name by the number indicates the active file.


 CorDoc Help

The options under Help menu opens the On-Line help for CorDoc.  This help file provides you to search for help on various topics, copy and print  data within topics.  It also provides a capability to invoke ObjectView™ On-Line help from within CorDoc On-Line help.  To seek help:

•	From the Help menu, choose Content... option to bring help contents .  The help file appears.  Toolbar shortcut:  .

•	Alternatively, choose Search... option for topics search dialog.


 Viewing Screen files

CorDoc provides the capability to view the resource information for any defined screen (.OBV) file.  The resource information screen provides a list of all properties of the screen (.OBV) file with its associated objects, their attributes, properties, events and also its menus and scripts, if defined for the screen.

CorDoc also provides for a global view of your application with its application hierarchy structure.  All screens along with their scripts and include files that make up the ObjectView™ application are presented as various nodes on the tree.  Although there are more than just color differences with the images at these nodes, screens are shown in gray color and scripts in white.  Selecting a screen enables the Open button.  Clicking on it also invokes the window which presents the resource information about the selected screen (.OBV) file.

The Open OBV... command within the File menu also enables you to view the resource information for a screen (.OBV) file.

The screen presents all information as read-only.  It provides the window header information on the top followed by two tables: one for listing objects and other for presenting all attributes and their associated values for any selected object as shown in the figure below:

CorDoc Screen Resource Information

To open an .OBV file:

•	From the File menu, choose Open OBV... option.  The Open OBV File dialog appears.  Toolbar shortcut:  .

•	Select the drive and directory where the file is stored.  The default is the current drive and directory.

•	In the File Name Box, click a filename, then choose OK.  Double-clicking a filename is a shortcut.

•	The Resource Information Screen will display detailed information about the ObjectView™ screen you selected.

Note: If using Windows for Workgroups, you will see a Network button.  This button allows you to select OBV files found on the network.


 Sorting Objects

The resource information screen lists all objects within the screen (.OBV) file.  The list can be sorted by object name, type or command.

CorDoc Sort Option

Related Topics:

 Sort by Object Name

 Sort by Object Type

 Sort by Command


 Sort by Object Name

The Sort by Object Name option enables you to sort windows objects displayed in the Resource Information Screen in a ascending order by object name.  To sort objects by their name:

•	Ensure that the Resource Information Screen is open and active

•	From the View menu, choose Sort by Object Name option.  Objects listed within the Resource Information Screen are sorted in an ascending order by their name.  Toolbar shortcut:  .

•	If objects listed within the Resource Information Screen are sorted by their names, the toolbar icon will display: .


 Sort by Object Type

The Sort by Object Type option enables you to sort windows objects displayed in the Resource Information Screen in a ascending order by object type.  To sort objects by their type:

•	Ensure that the Resource Information Screen is open and active

•	From the View menu, choose Sort by Object Type option.  Objects listed within the Resource Information Screen are sorted in an ascending order by their type.  Toolbar shortcut:  .

•	If objects listed within the Resource Information Screen are sorted by their type, the toolbar icon will display: .


 Sort by Command

The Sort by Command option enables you to sort windows objects displayed in the Resource Information Screen in a ascending order by their command.  To sort objects by their command:

•	Ensure that the Resource Information Screen is open and active

•	From the View menu, choose Sort by Command option.  Objects listed within the Resource Information Screen are sorted in an ascending order by their type.  Toolbar shortcut:  .

•	If objects listed within the Resource Information Screen are sorted by their command, the toolbar icon will display: .


 Searching Objects

CorDoc provides a capability to search for objects within a predefined set of files.  The Search Object ... option within the File menu enables you to locate all instances of user specified objects within the defined set of .OBV files.  The set of .OBV files to search within can be specified as:

•	a particular sub directory

•	a list (.LST) file

•	a project (.PRJ) file

The search for an object can be specified by either its name and/or its type.  Specifying both narrows the search to a smaller result set.  The results of the search is displayed into the Search Results screen.  The Search results screen will display with label for your defined search criteria, list of filenames that contain objects with the specified criteria and the listing of searched objects that fall within the specified criteria as shown below:

CorDoc Search Results

Selecting any object from any file within the search window and clicking on open button will open the corresponding screen with the selected object as the default, displaying its attributes, properties, events and other pertinent details.

To search for an object:

•	From the File menu, choose Search Object... option.  The Search window appears.  Toolbar shortcut:  .

•	Specify Object Name to search for or asterisk (*) to search for all objects.  Partial names can be provided by appending the asterisk to the name.  Object Name is NOT case sensitive and Wild cards are allowed.  For example:

•	FID*:  Search for object with name beginning with FID and ending with any string.

•	FID?:  Search for object with name beginning with FID followed by any character.

•	FID1:  Search for object with name FID1.

•	Specify Object Type to search from the available options within the combo box or asterisk (*) to search for all object types.

•	Select if the search is to be conducted within the specified drive and directory or within a list (.LST) or a project (.PRJ) file by clicking on the check box.

•	Clicking on the browse button will help browse to an appropriate directory or to select an appropriate list (.LST) file or project (.PRJ) file with a Select a directory or Select Searched LST or PRJ file dialog respectively.

•	In the Directories Box or File Name Box, click a directory or filename respectively, then choose OK.  Double-clicking on the selection is a shortcut.

•	The Search results Screen will display with label for your defined search criteria, list of filenames that contain objects with the specified criteria and the listing of searched objects that fall within the specified criteria.


 Creating Application Hierarchy

The Create Application Tree (TRE)... command within the File menu enables you to create a an application hierarchy (.TRE) file, which is displayed graphically in a tree view below.  All screens along with their scripts and include files that make up the ObjectView™ application are presented as various nodes on the tree.

Create a .TRE file:

•	An Application Hierarchy can only be done for a predefined application either by a list (.LST) file or a project (.PRJ) file.  Refer CorEdit documentation for creating a project (.PRJ) files and ObjectView™ Resource Manager for list (.LST) files.

•	From the File menu, choose Create Application TRE... option.  The Create TRE File dialog appears.  Toolbar shortcut:  .

•	Select either Make Run List (.LST) or CorEdit Project (.PRJ) from List Files of Type box.

•	Select the drive and directory where the file is stored.  The default is the current drive and directory.

•	CorDoc will take a few seconds, depending on the size of the application, to generate the Application Hierarchy (.TRE) file.  The Status Bar will track the progress of the TRE file build.

•	If a .TRE file already exists in the current working directory, a message will be prompted if you want to update it.

•	On creation of the .TRE file, you will be prompted with an option for viewing it at this time.  Affirmative action will display the application hierarchy


 Viewing Application Hierarchy

The Open TRE ... command within the File menu enables you to view an existing application hierarchy (.TRE) file.  It displays the graphical tree which shows the files that are called from one another within a particular project.

CorDoc Application Hierarchy

The application hierarchy defined by the .TRE file is sensitive to your work.  If it is opened after a part of the application (an .OBV or .OBS) is modified, CorDoc specifies the same and prompts a message if you wish to regenerate the .TRE file to reflect any new changes within the application.

The .TRE file represents an ObjectView™ application and is constructed from either a .LST file or a .PRJ file, both reference location of source files.  Moving the source files may cause unpredictable behavior.  It is advisable to retain .TRE file in the same sub directory as the application files in order for it to work properly.

To open a .TRE file:

•	From the File menu, choose Open TRE... option.  The Open TRE File dialog appears.  Toolbar shortcut:  .

•	Select the drive and directory where the file is stored.  The default is the current drive and directory.

•	In the File Name Box, click a filename, then choose OK.  Double-clicking a filename is a shortcut.

•	The Graphical Tree Screen will display the hierarchy of the selected application.

Note: If using Windows for Workgroups, you will see a Network button.  This button allows you to select OBV files found on the network.


 Creating Cross Reference

CorDoc provides for Cross Referencing capability within ObjectView™ script source.  For ObjectView™ applications, because each script in individually compiled and treated as a program, the cross reference is defined for each script.  However, ObjectView™ also provides the concept of precompiled scripts as Dynamic Libraries, the concept also known as OBXDLL.  CorDoc supports the OBXDLL calls for its cross referencing capability when the procedure is defined as an external OBXDLL (subroutine or function).

The process of creating Cross Reference involves in generating an .XRF file which retains all pertinent information such as: listing all procedures and variables from within the script file along with any other include files.  It presents this information in a graphical tree form where each node represents either a procedure or a variable.  Double clicking on each node expands the tree to list all instances of functions within the procedure and/or variables within the script.  Selecting each expanded node lists all references to the entry on that node, including the location of its definition as well as all references made by the caller.

The Create Cross Reference (XRF)... option within the File menu enables you to create a .XRF file, which is used to create a graphical tree view for a cross reference within ObjectView™ scripts.  To create a .XRF file:

•	For CorDoc to create an Cross Reference, it needs to have access to all the script (.OBS) file source as well as all the include (.INC) files referenced within the script.

•	From the File menu, choose Create Cross Reference (XRF)... option.  The Create Cross Reference dialog appears.  Toolbar shortcut:  .

•	Select any script (.OBS) file for which you wish to generate the cross reference (.XRF) file.  Select the drive and directory where the file is stored.  The default is the current drive and directory.

•	CorDoc will take a few seconds, depending on the size of the script, to generate the Cross Reference (.XRF) file.  The bar will track the progress of the .XRF file build.

•	If a .XRF file already exists in the current working directory, a message will be prompted if you want to update it.

•	On creation of the .XRF file, you will be prompted with an option for viewing it at this time.  Affirmative action will display the Cross Reference.

Related Topics:

 Generate ASCII Reference File


 Generate ASCII Reference File

The Generate ASCII Reference File command enables generation of all information for the reference in an ASCII format.  It displays the pertinent information in a text format which shows cross references for Procedures, Variables, Procedures - Variables and a capability to export this all information to other environments.  To Generate ASCII Reference (.REF) File:

•	From the File menu, choose Cross Reference Option which cascades to menu option for Generating ASCII Reference File. This is a binary action and thus a click toggles the action of enabling and disabling it.


 Viewing Cross Reference

The cross reference tree refers to script file as the single unit for all source included which may be composed of several include (.INC) files, the original script (.OBS) file as well as calls to external script (.OBS) files which are treated as external (OBXDLL) calls.

The Open XRF... command within the File menu enables you to view an existing cross reference (.XRF) file.  It displays the graphical tree which shows various views for a script source:

•	Procedures: An ability to view a reference for all system commands and procedure (subroutines and functions) calls within user defined procedures (subroutines and functions) for a script file and determine the Caller/Callee relationship.

•	Variables: An ability to view a reference for all variables and constants within a script file and determine the definition and usage relationship.

•	Procedures - Variables: An ability to view a reference for all variables and constants within user defined procedures (subroutines and functions) for a script file and determine the definition and usage relationship.

•	All information (.REF) file: This is complete cross reference information provided in an ASCII file format for the script file and is recommended for generating reports.

The cross reference generated for your script and defined by the .XRF file is sensitive to your work.  If it is opened after a script (.OBS) file or its associated include (.INC) files have been modified, CorDoc specifies the same and prompts a message if you wish to regenerate the .XRF file to reflect any new changes within the script.

The .XRF file represents an ObjectView™ script source and is constructed from an .OBS file along with other .INC files and external reference calls to other .OBS files (used as OBXDLL), both reference location of source files.  Moving the source files may cause unpredictable behavior.  It is advisable to retain .XRF file in the same sub directory as the application files in order for it to work properly.

To open a .XRF file:

•	From the File menu, choose Open XRF... option.  The Open a Cross Reference File dialog appears.  Toolbar shortcut:  .

•	Select the drive and directory where the file is stored.  The default is the current drive and directory.

•	In the File Name Box, click a filename, then choose OK.  Double-clicking a filename is a shortcut.

•	The Graphical Tree Screen will display the cross reference of the selected script for available procedures as default.

Note: If using Windows for Workgroups, you will see a Network button.  This button allows you to select OBV files found on the network.

Related Topics:

 Procedures

 Variables

 Procedures - Variables

 All Information (REF) file


 Procedures

CorDoc provides an ability to view a reference for all system commands and procedure (subroutines and functions) calls within user defined procedures (subroutines and functions) for a script file and determine the Caller/Callee relationship.

CorDoc Cross Reference for Procedures

The tree comprises of all the procedures (subroutines and functions) as nodes within the selected script file.  Double clicking on a node expands the tree displaying all procedures (subroutines and functions) and system commands and functions being called within this procedure node.  Clicking on any sub-node would list the file and location of the definition of the selected sub-node along with all files and locations (including line numbers) where it has references or is called from.  Double clicking any line entry, either for definition or for caller references, would open the specified source in a new window with the selected procedure (subroutine or function).


 Variables

CorDoc provides an ability to view a reference for all variables and constants within a script file and determine the definition and usage relationship.

CorDoc Cross Reference for Variables

The tree comprises of all the variables and constants as nodes within the selected script file.  Clicking on any node would list the file and location of the definition of the selected variable or constant along with all files and locations (including line numbers) where it has references or is called from.  Double clicking any line entry, either for definition or for caller references, would open the specified source in a new window with the selected constant or variable.


 Procedures - Variables

CorDoc provides an ability to view a reference for all variables and constants within user defined procedures (subroutines and functions) for a script file and determine the definition and usage relationship.

CorDoc Cross Reference for Procedures - Variables

The tree comprises of all the procedures (subroutines and functions) as nodes within the selected script file.  Double clicking on a node expands the tree displaying all variables and constants being called within this procedure node.  Clicking on any sub-node would list the file and location of the definition of the selected variable or constant along with all files and locations (including line numbers) where it has references or is called from.  Double clicking any line entry, either for definition or for caller references, would open the specified source in a new window with the selected constant or variable.


 All Information (REF) file

CorDoc provides a complete cross reference information provided in ASCII file format for the script file and is recommended for generating reports.

CorDoc Cross Reference for all Information

CorDoc only generates the ASCII reference file if it has been enabled within the File menu, Cross reference option.  It displays the pertinent information in a text format which shows cross references for all procedures, variables, procedures - variables and a capability to export this all information to other environments.

Each screen has tremendous amount of information for cross reference, and with various available options like viewing procedures, variables, procedures - variables, it is presentable with a graphical tree approach.  However, attempting to view all information at the same time makes it very complex reference for on screen review.  The presentation format is ideally tailored for report.


 Reports

CorDoc provides an ability to generate various types of reports.  The different reports are generated from different types of Windows and can be enumerated as under:

1.	Screen File

2.	Application Tree

3.	Cross Reference Tree

4.	Search Results List

5.	Script File

6.	ASCII Reference File generated by cross reference

Related Topics:

 Print Reports...

 Page Setup ...


 Print Reports...

The Print ... command enables the user to print a hard copy version of the active CorDoc screen.  If no window child window exists within the CorDoc environment, Print will be disabled otherwise it will display an appropriate window with options.  To print:

•	Ensure that the correct window is open and active

•	From the File menu, choose Print... option.  The Print window appears.  Toolbar shortcut:  .

•	Select the appropriate options.  These options vary based on the active window and its available data that can be printed.

•	Print window also provides an option to select a printer and appropriately perform printer setup if you prefer to select printer, fonts, orientation, or any other option.

•	Accepting it will generate the appropriate output on the specified printer.


 Page Setup ...

The Page Setup... option enables the user to set the margins and specify a configurable footer.  The footer can only be of one line in length.  To setup the page:

•	From the File menu, choose Page Setup... option.  The Page Setup window appears.

•	Specify the footer desired for the report.  The footer provides support for two variables: &D for Date stamp and &T for Time stamp, when the report gets printed.

•	Specify the left, right, top and bottom page margins.  The margin size for each margin is in inches.


 Toolbar and Keyboard Shortcuts

 "Open OBV..." from File menu

 "Print..." from File menu

 "Search Object..." from File menu

 "Create Application Tree (TRE)..." from File menu

 "Open TRE..." from File menu

 "Create Cross Reference (XRF)..." from File menu

 "Open XRF..." from File menu

 "Sort by Object Name" from View menu

 "Sort by Object Type" from View menu

 "Sort by Command" from View menu

 "Content" from Help menu


 Icon Definitions

The following enumerates all the icon definitions being used within CorDoc environment.  The dual definitions apply for cases where the tree node may be collapsed or expanded.  If the node is collapsed and there exists one or more sub-node(s), the node will have association of blue color with the icon (or as listed in the first possible case below).

The icons can be categorized by: Application Hierarchy and by Cross Reference.

Related Topics:

 Application Hierarchy:

 Cross Reference


 Application Hierarchy:

 Script (.OBS) file node

 Include (.INC) file

 External Script (.OBS) file

 Child Screen (.OBV) file navigated by Popup command

 Child Screen (.OBV) file navigated by ModalPopup command

 Screen (.OBV) file navigated by Chain command

 Application Project (or List)

 Unknown File Type


 Cross Reference

 User Defined Subroutine

 User Defined Function

 Windows DLL Subroutine Call

 Windows DLL Function Call

 External User Defined Subroutine

 External User Defined Function

 ObjectView System Command

 ObjectView System Function

 Variable

 Constant

 User Defined Procedure (Function and Subroutine) Paramater

 User Defined Function Return Value