READ RALLY User's Guide This document explains how to use the READ_RALLY application. The application is designed to process VAX RALLY Report Writer output into a VAX DOCUMENT file. Revision/Update Information: This is a new document. Digital Equipment Corporation READ RALLY User's Guide 1 Overview _________________________________________________ INTRODUCTION This document describes how to use the READ_RALLY application. It generally describes the purpose and concept of the application, lists the required software and software limitations, and describes the commands needed to use the application. You should be familiar with the VAX RALLY Report Utility before using this application. _________________________________________________ PURPOSE The READ_RALLY application was designed to translate the output from the VAX RALLY Report Utility into a file that can be processed by VAX DOCUMENT. This text file can then be processed with VAX DOCUMENT and then printed on a Postscript[TM] printer. _________________________________________________ DESCRIPTION The VAX RALLY Report Utility documents all the objects, action sites, and procedural code in your RALLY application in great detail. The problem is that humans can't always deal with so much detail at once, and often desire an organized overview of the application. READ_RALLY will document each major application objects into separate chapters, and it ignores many of the details of the applications. For example, it records very few of the cross-references and action sites. 2 READ RALLY User's Guide READ_RALLY was written in the VAX SCAN language over the course of almost a year in the developer's spare time. It should be understood that no attempt was made to make this a professional tool. _________________________________________________ REQUIRED SOFTWARE While this application only requires VAX VMS V5.3 to run, it is assumed that the user also has the following software: o VAX RALLY - minimum version V2.0 o VAX DOCUMENT - minimum version V1.0 _________________________________________________ DOCUMENT OUTPUT The user will be interested to know that the following VAX DOCUMENT features are used: o Index entries are created for all major and minor object types. The major objects entries are cross- referenced by object type. When an object is defined, a bold index entry is created. When an object is referenced by another object, a non-bold entry is created. o Objects that are called from within an ADL procedure (e.g. External Links, Parameter Packets and ADL procedures) are index. o Action sites in form/report packets (only) are documented and indexed. Form/report action sites are not documented or indexed. READ RALLY User's Guide 3 _________________________________________________ LIMITATIONS READ_RALLY has the following limitations: o Only External Links that use the Standard parameter passing mechanism are supported. o Report Utility files with cross-references are not supported. o There is a limitation in the number of form/report objects that are supported. It is currently set at around 600 objects. A minor change to the source code could produce a "big memory model" version that would extend that limitation. o Form/reports must have elements in them. At least a text area. 4 READ RALLY User's Guide To Run READ_RALLY _________________________________________________ STEPS To run READ_RALLY, you must perform the following: 1. Generate the input file using the following RALLY command: RALLY REPORT/NOHEADER - application_name/OUTPUT=application_name This will produce a Report Utility file with complete details, but no cross-references. The /NOHEADER qualifier will remove the page breaks. This qualifier is required. 2. Process the input file with READ_RALLY, using the following command: $ RUN READ_RALLY 3. Enter the name of the file to process. The default file type is '.DMP', which is the Report Utility's default. This will produce an SDML file suitable for processing with VAX DOCUMENT. 4. Process the output file with VAX DOCUMENT with the following command: DOCUMENT application_name REPORT */INDEX This will run VAX DOCUMENT using the REPORT doctype. The asterisk (*) will cause VAX DOCUMENT to list the available output devices on your system (e.g. LN03, Postscript, Mail, etc). 5. Choose the device you want. You can also substitute your favorite output device for the asterisk, so long as it is available. READ RALLY User's Guide 5 6. Print the file that DOCUMENT generates how ever is appropriate for your system. _________________________________________________ 6 READ RALLY User's Guide Support _________________________________________________ MAKING YOUR OWN CHANGES READ_RALLY is written entirely in VAX SCAN. SCAN was chosen because of its ability to efficiently process text strings and match patterns. In order to modify the source code, you will need the VAX SCAN compiler. See your Digital Sales Account Manager for this. (It is one of the least expensive compilers available.) _________________________________________________ SOURCE CODE The source code is composed of two files: o READ_RALLY.SCN-The main program o INDEX_ADL.SCN-Finds the callable components in the ADL code _________________________________________________ COMPILING AND LINKING Each source file should be compiled separately, and then linked together into the READ_RALLY.EXE executable image. _________________________________________________