Source Directives

This appendix lists all of the types of directives, and indicates which of the Toolkit utilities use them.

Overview

Several of the Toolkit utilities make use of directives encoded in HLL source statements. All such directives are coded as special types of comment lines in the source.

The source types of HLL languages are classified by Toolkit as either fixed or floating:

For fixed source types, the directive control characters must always be in a particular column of the source.
For floating types, the directive control characters may appear in any column position, and the end of the directive should be shown by the use of the end comment characters (‘*/’).

Fixed Format Source Types

Fixed format source types are: RPG III, DDS, and COBOL. Directives may be specified either in columns six and seven (‘x*’), or in columns seven, eight and nine (‘*x:’).

Free Format Source Types

Free format source types are: CL, CMD, PLI.

The following table lists the different types of source directives:


Fixed Fmt Source 123456789	Free Fmt Source	Source Directive Type	Where Used
....*D:	/D: /	Debug breakpoint statement	YSTRDBG
...D*
....*H:	/H: /	Documentation synopsis		YDOCPGM
...H*
....*M:	/M: /	Documentation maintenance		YDOCPGM
....M*
*T .(1) :	/T: /	Title line	YCRTOVR	YDOCPGM
...T*			(2)
....*W:	/W: /	Documentation warning		YDOCPGM
...W*
....*Y:	/Y: /	Compile time override	YCRTOVR	YDOCPGM
...Y*			(2)
....*Z:	/Z: /	Compiler override	YCRTOVR	YDOCPGM
...Z*			(2)

(1) For RPG III source, ‘/TITLE’ may also be used

(2) Compile pre-processor directives should appear within the first twenty lines of a source member.

Examples

The following is an example of Toolkit Source directives for RPG III

The following is an example of Toolkit Source directives for CLP

The following is an example of Toolkit Source directives for CBL

The following table lists help text source directives:

Text Source	Source Directive Type	Where Used
. *T: text	Text title statement	YDSPHLP
. Y: text	Text index comment	YDSPHLP
. *YI: XXXXXXXXXX	Text index entry statement	YDSPHLP
. *YH: XXXXXXXXXX	Text index label statement	YDSPHLP

The following table lists help text CUA/Text directives:

Window Source	Source Directive Type	Where Used
. *YW: XXXXX	Window size	YDSPHLP
. YD: XXXXXXXX	Window format definition	YDSPHLP
. *YF: XX	Window format	YDSPHLP
. *YK: XXXXXXXXXX	Keys help vector	YDSPHLP

For explanations and examples of these directives, see the section Specifying Help Text Directives in the chapter "User Access Aids".