Processing

When Docuproc is first executed the following screen appears:

Figure: Main Docuproc Selection Form

This screen requires the user to enter the input source file, the output report file, and other parameters used in the report process. The meaning of these parameters is discussed in the following paragraphs.

Input File Name

The source file name may be that of the text or program source or it may be the name of a file that contains other file names. To indicate a source file (text, MODULA or Ada), the name of the file is entered and the field preceded by "Source file list? (Y/N)" would be left at the default, "N".

If there are several files that contain the source to be included in the final report, the file that contains the list of these files is entered as the "Input File Name" and the "Source file list" option is set to "Y". The file list is then read in and each file on the list is processed sequentially as it is encountered. For example, if the file name, "LIST", was entered as the input file name and the "Source file list" option set to "Y", then the LIST file should contain a list of source files such as the following:

TEXTFILE

TEXT2.DAT

MYPROG.MOD

HISPROG.FTN

In the previous example, each of the four source file names listed in the file, LIST, would be processed and the results written to the specified output report file.

Output File Name

The output file name is the name of the destination report file. This name may include the drive and directory specifications.

Report Type

The report type is valid only for program source such as MODULA and Ada which contains standard documentation. It defaults to the full report listing if the source is another input type mode. Standard documentation for MODULA type source consists of a comment header at the first of each procedure after the PROCEDURE statement. Parts of this header are then extracted to produce a summary of procedures, or a report of the special header contents. An example of a special comment header for MODULA follows. PROCEDURE SampleProcedure (A:CARDINAL; VAR B:CARDINAL);

        (**
        SampleProcedure This is a sample procedure
        J.D. Doe 01/01/87
        This procedure is a sample of many procedures which may
        be found within MODULA 2 source code.
        CALLING SEQUENCE -
        SampleProcedure (A,B)
        ENTRY -
        A:CARDINAL
        Entry value used in the SampleProcedure.
        EXIT -
        B:CARDINAL
        Value returned from the SampleProcedure
        *)

An example of Ada follows:

        PROCEDURE SampleProcedure (A:CARDINAL; VAR B:CARDINAL) is
        --*
        -- SampleProcedure This is a sample procedure
        --
        -- J.D. Doe 01/01/87
        --
        -- This procedure is a sample of many procedures which may
        -- be found within MODULA 2 source code.
        --
        -- CALLING SEQUENCE -
        --
        -- SampleProcedure (A,B)
        --
        -- ENTRY -
        --
        -- A:CARDINAL
        -- Entry value used in the SampleProcedure.
        --
        -- EXIT -
        --
        -- B:CARDINAL
        -- Value returned from the SampleProcedure
        --

Printer Type

A number of printers are supported by Docuproc. There may be several modes for each printer support. As shown in the previous example of the Docuproc options form, options are available for the EPSON printer using normal 80 column mode or 132 column mode and for the HP Laserjet printer in 80 column or 132 column mode. If neither printer type is being used, the "0 unknown" option should be used. The printer type also determines how many lines of report text will be allowed for each page.

Page Numbering Type

Docuproc may be directed to print the page numbers at the top, the bottom of each page, or not at all. If no page number is selected, the pagination at appropriate lines will still occur.

Input Source Type

Various types of source may be read and used by Docuproc. This option provides the user the capability of specifying which type of source file is initially being read. It currently supports the normal or Docuproc formatted report format, the MODULA mode, the Ada mode, and the normal (unformatted) ASCII file mode. Only the Docuproc report mode supports the column-1 type commands. There is one command, however, that appears in column 1 and is interpreted by any of these modes. This is the MODE command that causes the report mode to be redefined within the report. This acts the same as when the report mode is initially specified. A report may begin with the mode specified on the form and be changed to another mode part way through. The normal ASCII mode allows the pagination of an ASCII document that does not use column 1 for special command characters as with the Docuproc formatted mode.

Report Date and Report Time

If the date or time is requested to be printed on the page number line, these two fields specify the values to be used. When the option form is first presented, the current date and time from the system clock is presented. Either of these may be changed by the user before the report is printed to cause a different date and/or time to be used. If the option to print the date or time is not requested, the value for either is irrelevant.

First Page Number

Docuproc allows the user to specify the first page number (in Arabic numerals) of the output report. The default is set to 1. If this value is set to zero (0), then the first page will contain no page numbering and the second page will contain "page 1", the third "page 2" and so forth. Any pages that are numbered with Roman numerals in the report are independent of this page number series.

First Roman Numeral Page

Docuproc allows the user to specify the first page number (in Roman numerals) for the pages in the report that use this numbering scheme. The default is set to 1 (i). If this value is set to zero (0), then the first page to be printed with Roman numerals will contain no page numbering and the second page will contain "i", the third "ii" and so forth. Any pages numbered with the normal Arabic numerals in the report are independent of this page numbering. The Table of Contents as well as the other automatically generated tables are numbered with Roman numerals. If the body of the report contains any pages directed to be paginated with Roman Numerals, they will be numbered first and any automatically generated tables produced at the end will then continue on in the numbering sequence.

Number Lines

This option, if selected, will place a number in the left column of each line. Numbering will begin at 1 for each new input source file. If a line is longer than can be printed on one line, it will be completed on the next line of the report, but no line number will be assigned to it.

Center Page Number

If the page number is to be centered at the top or bottom of the page, this option is selected. If this is the case, only the number is printed. If the page number is not centered, then the word "page" precedes the number on the right side of the page.

Print Date or Print Time

The date and/or time may be selected to be printed on the page number line. If they are printed, they will be given the values shown in the "Report Date" and "Report Time" fields of the form. If the page number is printed on the right side of the report, the date will be on the left side and the time in the center of the page number line. If the page number is centered on the line, the date will be on the left side and the time on the right.

Reverse Output Pages

The output report file may be requested to be reversed. When this is done, the last page of the report appears first in the destination report file, then the next to last page and so forth. This is useful if using a printer that reverses the pages while printing. Go Back To Sage-ST TABLE OF CONTENTS