Procedure documentation

The DOC statement is used to enter on-line help documentation for procedures.

This statement has the form:

DOC text

where

[text] is any character text to the end of the line.

When requesting help for a procedure, EASI will scan the procedure and print to your screen the text associated with every DOC statement it finds until it encounters a subtopic, a DOC_END statement, or the end of the procedure. It is standard practice to put DOC statements at the beginning of a procedure.

A special form of the DOC statement is used to identify subtopics. Subtopic identification lines have the form:

DOC # topic

where

[#] .... is a subtopic level from 1 to 9
[topic]  is a 1 to 15 character subtopic identifier

DOC statements associated with subtopics are only printed when the user requests them. The EASI online Help system will automatically scan the procedure and list the subtopics of any topic the user chooses.

Example:

DOC This is an example of on-line documentation
DOC 1 FIRST
DOC This line is associated with subtopic FIRST
DOC 2 SECOND
DOC These two lines are associated with subtopic SECOND
DOC which is itself a subtopic of FIRST.
DOC 3 THIRD
DOC This is a subtopic of SECOND.
DOC 3 FOURTH
DOC This is another subtopic of SECOND.
DOC 1 FIFTH
DOC This is another first-level subtopic like FIRST,
DOC but this topic has no subtopics of its own.

Note: There must be only one space between the DOC statement and the subtopic level number.

Also note that during procedure execution, DOC lines are ignored like REM statements.