Workload Documentation › Special Documentation Features › User-Defined Documentation Segments › Format of Documentation Subsegments

Format of Documentation Subsegments

The format of documentation subsegments is exactly like the format of segments. Make the first statement of the subsegment #subsegment-name, and begin in column 1. Immediately following this statement is the subsegment documentation that is free-form. Control characters are not needed. Avoid beginning a documentation line with a # sign, which the system interprets as a segmentation control character. The system then tries to treat it as a start or an end of a subsegment or segment.

To terminate the documentation for this subsegment, a #END statement is required. The #END statement begins in column 1 and the format of this statement is as follows:

#END,subsegment-name

For every subsegment name defined, you must have a #END,subsegment-name control statement. Nesting of subsegments within other subsegments is not permitted. The #END,subsegment-name statement must occur before the next occurrence of a #subsegment-name or #segment-name statement.

The following shows an example of coding DAYTIME and AFTERHRS subsegments within the RECOVERY segment:

#RECOVERY
#DAYTIME
   .
   .    Daytime procedures go here
   .
#END,DAYTIME
#AFTERHRS
   .
   .    After hours procedures go here
   .
#END,AFTERHRS
#END,RECOVERY