This section describes the CST-Document model, which is used to create the documentation subprogram for a model. The documentation subprogram writes information about Natural Construct-generated modules to the Predict data dictionary.
This section covers the following topics:
After defining the generation and sample subprograms, you must generate the documentation subprogram to write information about Natural Construct-generated modules in the Predict data dictionary. This information includes a description of the module, as well as a description of the PF-keys and specification parameters for the module.
Note:
Before you can document information about the generated modules, you
must define the #PDAX-DESCS(*) field within the model PDA.
Generated using the CST-Document model, this subprogram creates a free-form description of the generated module using the specifications from the model panels. You can write this information in any language for which you have translated help text members.
The documentation subprogram writes the model description to Predict when the developer invokes the Save Specification and Source function or the Stow Specification and Source function on the Generation main menu and presses PF5 (optns). For a description of the Generation main menu, see Generation Main Menu, Natural Construct Generation.
Note:
For an example of a generated documentation subprogram, refer to
CUMND in the SYSCST library.
Use the CST-Document model to generate the documentation subprogram. This model has two specification panels:
CUGDMA CST-Document Subprogram CUGDMA0
Apr 02 Standard Parameters 1 of 2
Module name ........ CXMND___
Model name ......... ________________________________ *
Maps ............... ________ ________ ________ ________ ________ *
________ ________ ________ ________ ________ *
Translation LDAs ... ________ ________ ________ ________ ________ *
________ ________ ________ ________ ________ *
Title .............. Document ..._____________
Description ........ Writes Predict documentation for ...___________________
_______________________________________________________
_______________________________________________________
_______________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
help retrn quit right main |
The input fields on the Standard Parameters panel are:
| Field | Description |
|---|---|
| Module name | Name specified on the Generation main menu. The
name of the documentation subprogram must be alphanumeric and no more than
eight characters in length. Use the following naming convention:
CXxxD where xx uniquely identifies your model. |
| Model name | Name of the model that uses the documentation subprogram. The model must be defined. |
| Maps | Names of all maps (specification panels) used by the model. The documentation subprogram retrieves the specification parameters from the specified maps. |
| Translation LDAs | Names of the translation local data areas (LDAs) for the specified maps. You can specify the names of up to 10 translation LDAs. For information about translation LDAs, see Step 7: Create the Translation LDAs and Maintenance Maps. |
| Title | Title for the generated subprogram. The title identifies the subprogram for the List Generated Modules function on the Generation main menu and is used internally for program documentation. |
| Description | Brief description of the subprogram. The description is inserted in the banner at the beginning of the subprogram and is used internally for program documentation. |
CUGDMB CST-Document Subprogram CUGDMB0
Apr 02 Additional Parameters 2 of 2
Help Text .......... Type ..... _
Major .... ________________________________
Minor .... ________________________________
Description
1 ______________________________________________________________________
2 ______________________________________________________________________
3 ______________________________________________________________________
4 ______________________________________________________________________
5 ______________________________________________________________________
6 ______________________________________________________________________
7 ______________________________________________________________________
8 ______________________________________________________________________
9 ______________________________________________________________________
10 ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
help retrn quit left userX main |
On this panel, you do one of the following:
Specify the Type, Major, and Minor help text components in the applicable fields.
Natural Construct retrieves the description of all modules generated by the model from the Help Text subsystem.
Enter a brief description of all modules generated by the model on the lines displayed in the Description field.
The description is written to the Predict data dictionary.
CSGSAMPL Natural Construct CSGSM0
Apr 02 CST-Document User Exits 1 of 1
User Exit Exists Sample Required Conditional
-------------------------------- -------- ---------- -------- ------------
_ CHANGE-HISTORY Subprogram
_ LOCAL-DATA
_ START-OF-PROGRAM
_ ADDITIONAL-TRANSLATIONS
_ ADDITIONAL-INITIALIZATIONS Example
_ DESCRIBE-INPUTS Example
_ PF-KEYS Subprogram
_ MISCELLANEOUS-VARIABLES Subprogram
_ END-OF-PROGRAM |
For information about these user exits, see Supplied User Exits. For information about using the User Exit editor, see User Exit Editor, Natural Construct Generation.
