Features

Docuproc will automatically generate a Table of Contents beginning with page "i" (Roman Numerals) if there are any Table of Contents entries marked in the text. There are two ways that entries are designated for entry in the Table of Contents, 1) designated in the Docuproc formatted mode, or 2) automatically entered in other modes.

If in the Docuproc mode, a number from 1 to 7 is placed in the first column. This is the level of the table entry. When printed in the Table of Contents, level 1 is always preceded by a blank line and left justified. Levels 2 through 7 are single spaced and indented. Level 2 is indented 2 spaces, level 3 is indented 4 spaces, and so forth. Any entry in the normal text may be centered, indented, or placed anywhere on the line. Each entry is first left justified as it is put into the Table of Contents. Levels above 1 will extract everything on the marked line that occurs before a ". " (period and two blanks) or a "- " (dash and two blanks).

If a table entry is marked, Docuproc will attempt to ensure that at least one nonblank line is also included on the same page of the output report. Therefore, if the marked table entry line would normally be printed at the bottom of the page and the first nonblank line after that at the top of the next page, then a page eject would be issued first before the entry line is printed.

If in the MODULA mode, all modules are included at level 1 and procedures are included at level 2. If standard documentation follows the procedure line, then the one line name and explanation is included in the Table of Contents, otherwise only the procedure name is included.

If in the Ada mode, the contents is generated just like MODULA, except a short description after the procedure name will be included.

Table of Figures

Docuproc will produce a table of figures immediately following the Table of Contents if any figure titles have been designated in the Docuproc formatted using the "8" in column 1. All entries in the Table of Figures are at the same level.

List of Tables

A List of Tables is produced after the Table of Figures if any table titles are marked in the Docuproc mode using the "9" in column 1. All entries in the List of Tables are at the same level.

Index

Entries may be included in the Index in two different ways, 1) by marking the word or phrase to be included in the Docuproc mode, and 2) by automatic entry of all module, procedure, program, subroutine, and function names when in one of the program source modes (MODULA or Ada). The Index is only printed if entries are made. If printed, the beginning page number of the Index is entered in the Table of Contents and the Index is printed after the normal body of the report.

Words or phrases marked in the Docuproc mode may be up to 20 characters in length. If the "end of index" mark does not appear before the maximum of 20 characters, only the first 20 characters are accepted. The first letter of the entry will be automatically capitalized so that the sorted order of the Index entries are logical and duplicate entries may be detected. If Index entries are duplicated, the various pages on which the duplicates appear are printed for that one entry in the Index.

Blocks of Text

It is often necessary to ensure that a block of text appear on the same page. This is true of figures, tables, and other types of text. To cause this always to happen, the user may mark the block with the "mark block" command in column 1. After the last line of the block, the "release block" command is given. A block is also released if another "mark block" command or "page eject" command is encountered.

Docuproc will attempt to keep the marked block on the same page (if the total block is less than the size of a page). If the block will fit in the space remaining on the current page, it will be printed there, otherwise it will begin at the top of the next page.

Form Blocks

Blocks of text may be marked within the document as Form Blocks. These markings are recognized by the THOR processor in the SAGE system as being assigned to a particular form, and therefore used to update or include forms within a SAGE application. This allows the inclusion of all or part of a document within the forms of SAGE applications for online documentation. The form block marking command is used to indicate the beginning of a block and also the end. The line in which the form block mark is found is not included in the report after processing through Docuproc. The form block command line ("F" in column 1) contains other information about the assigned form as well. One or more blanks are used as delimiters between fields on the line. The second field on the line contains the form name (18 characters of upper and/or lower case). The third field contains the lines of the form to be updated by the marked block of text. The end of the form block is marked by another form block command line which may be the start of a new form block or simply used as a terminator for the block and therefore contain no form name or line range. An example of the use of form blocking is:

        F Form1 5-12 HelpForm
        .
        . (block of text to be used in "Form1" lines 5-12)
        .
        F Form1 15-18
        .
        . (block of text to be used in "Form1" lines 15-18)
        .
        F Form2 3-23
        .
        . (block of text to be used in "Form2" lines 3-23)
        .
        F