Programmer Utilities › Lists › Convert Object Lists › Converting Member Lists into Text Documents

Converting Member Lists into Text Documents

The Toolkit command Build Document (YBLDDOC) helps with documentation.

The most convenient and flexible way of arranging documentation for preparation and maintenance is to divide it into small sub-documents. The sub-documents can then be linked together, using a master document that contains imbed references to each component. Thus:

• Different combinations of the same sub-documents can be used for different purposes, for example, manuals for different user departments.
• The separate documents that appear as the Help text for individual menu options and application programs, can be grouped together in any combination and order, and printed as a single document.

The Toolkit function Build Document (YBLDDOC) helps you prepare master documents. It converts a list of members, previously built and edited with the member list build and edit functions, into a master document containing all the necessary references to the documents in the member list.

For example, the help text for each Toolkit display is stored as a document in a file Y1HLPTXT in the Toolkit shipped library. The following three commands would print all the Help text for Toolkit:

YBLDMBRLST FILE(Y1HLPTXT) /* build list of documents */
YBLDDOC DOCUMENT(HLPINX) FILE(QGPL/QTXTSRC) TEXT(‘Help index’) /* convert list to document */
QSYS38/PRTDOC SRCFILE(QGPL/QTXTSRC) DOCUMENT(HLPINX) /* print it /