7 10 Review Change Table of Contents

7.10 Review/Change Table of Contents

When the option to "Review/change Table of Contents" is chosen from the "Review/change objects in document" Menu a screen similar to this example is used to review, omit or reorder the sequence of subjects to be documented.

This screen displays the subjects which will be included into the document for the selected processes and functions, in the order in which they will appear. It is possible to omit or reorder the subjects into the desired sequence of subjects.

Any "other documents" which have been entered will also be shown in the Table of Contents. Files and fields which have been selected will not appear in the Table of Contents, as they will always appear in an Appendix in alphabetical order at the end of the document.

On the first review of the Table of Contents, the selected processes and functions will ordered into a pre-set sequence of subjects. Each process will be followed by any of its associated functions, and any other documents to be included will appear following processes and functions. The pre-set sequence of subjects for processes is:

• Technical Description of the process

• End User Description of the process

• Menu layout of the process

• Summary of functions for the process

• Summary of all files used by all functions within the process

• Summary of all fields used by all functions within the process

The pre-set sequence of subjects for functions being documented is:

• Technical Description of the function

• End User Description of the function

• Panel layouts used by the function

• MSL diagram for the function (Major Structure and Logic Diagram)

• Summary of all files used by the function

• Summary of all fields used by the function

• Call cross referencing for the function

• Report layouts for the function

To omit a subject, either blank out the order/omit field or enter "9999" into the order/omit field. To reorder a field, enter the desired sequence number. When enter is pressed, the Table of Contents will be redisplayed in the correct sequence, with omitted subjects at the end. Omitted subjects can be re-selected by entering a sequence number into the order/omit field.

If new objects are added to the list of objects to be documented following the first review of the Table of Contents, they will appear at the beginning of the Table of Contents so that they can be reordered into the correct sequence if desired.