DDS32文档格式.docx

1、如果帮助信息是用UIM（HLPPNLGRP键字）定义的，则在帮助键按下时它不能做为指定项帮助来显示，但可以做扩充帮助来显示。如果帮助信息是用DDS（HLPRCD键字）定义的，则当按下帮助键时它不能做主帮助显示，但可以做辅助帮助显示，这时要在另外的帮助显示中用Page Up或Page Down键来做。当帮助信息是在文本中定义时（HLPDOC键字），*NONE值无用，因为此时即使按下帮助键也不会显示帮助信息。特殊值*FLD指出帮助区就是字段区。如果字段只占一行，则帮助区包括这行的第一个字符到最后一个字符中间的所有字符。如果一个字段不只占用了一行，则帮助区包括字段中的所有行的全部长度。例如，一个字段

2、从第3行第4列开始，在第5行第10列结束，则帮助区为从第3行的第1列到第5行的第80列区域。如果一个字段是选择字段或续入字段，则帮助区是由选择字段或续入字段占用的矩形区域组成。字段名参数指出定义帮助区的字段名。字段必须在有H规范的记录中。如果定义了选项号参数，帮助区是定义字段的选项区域。当指定一个选项号后，字段名必须是菜单条字段名或选项字段，所定义的选项号必须也在那个字段的MNUBARCHC或CHOICE键字中规定。选项号的有效值是大于0小于100的正整数。*CNST指出帮助区是常数字段区。这个区域包括字段的开头和结尾的属性字节。帮助标识参数是一个数字，它用来标识定义帮助区的常数字段。常数字段

3、必须存在有H规范的记录中，必须有用同一个帮助标识定义的HLPID键字。在H规范中必须至少定义一个HLPARA键字。当为每个H规范指定多个HLPARA键字时，必须使用显示尺条件方式。当为一个记录定义了多外H规范，帮助区可以发生重叠。当定义了多个H规范时，使用带有下列两个特点的第一个H定义：用HLPARA键字规定帮助区包含当前光标位置。键字HLPRCD、HLPPNLGRP、HLPDOC上的可选指示器在应用记录写往显示器时有效。下列规则适用于H规范：在17列的H是H规范开始的标志。在DDS中，H规范必须在记录层键字之后，在这个记录的第一个字段之前。每个H规范必须正好有一个HLPRCD、HLPPNLG

4、RP或HLPDOC键字，有一个HLPBDY或HLPEXCLD键字，还至少有一个HLPARA键字。H规范结束的标志是另一个17列的H或第一个字段。不能在子文件（SFL键字）记录格式中使用H规范。在与信息子文件（SFLMSGRCD键字）有关的子文件控制格式中不允许使用H规范。可选指示器对这个键字无效。图3-98和图3-99给出出如何规定HLPARA键字。 |.+.1.+.2.+.3.+.4.+.5.+.6.+.7.+.8 A HELP A HLPRCD（DFTHELP） A R RECORD1 A H HLPARA（1 5 3 15） A HLPDOC（FLDHELP DOC1 FOLDER1）

5、A A H HLPARA（*RCD） A HLPRCD（HELPRCD1） A H HLPARA（*NONE） A HLPRCD（HELPRCD2） A FIELD1 10A 2 5 A FIELD2 40A 10 10图3-98 规定HLPARA键字（例1）在此例中，第一个H规范中的HLPARA键字指明联机帮助信息文本DOC1使用从第1行第5列到第3行第15列的区域，当帮助键按下时如果光标在上述区域内，则文本DOC1在标号FLDHELP处开始显示。第二个H规范中的HLPARA键字指明记录RECORD1占有的区域（从1第2行到第10行）和联机帮助信息记录HELPRCD相关。当按下帮助键时如果光

6、标在第2行到第10行的任何位置（除在第一个H规范中定义的区域之外），则显示HELPRCD1。第三个H规范中的HLPARA键字指明没有区域和联机帮助信息HELPRCD2相关。HELPRCD只有在显示联机帮助信息时，按Page Up和Page Down键才能显示。 A HELP HLPRCD（DFTHELP） A R RECORD A H HLPARA（*FLD F1 1） A HLPRCD（UNDOHLP HLPLIB/HLPFILE） A H HLPARA（*FLD F1 2） A HLPRCD（MARKHLP HLPLIB/HLPFILE） A H HLPARA（*FLD F1 3） A H

7、LPRCD（COPYHLP HLPLIB/HLPFILE） A H HLPARA（*FLD F2） A HLPRCD（F2HLP HLPLIB/HLPFILE） A H HLPARA（*CNST 1） A HLPRCD（TITLEHLP HLPLIB/HLPFILE） A 1 37Title HLPID（1） A F1 2Y 0B 10 2SNGCHCFLD A CHOICE（1 Choice 1） A 01 CHOICE（2 Choice 2 A CHOICE（3 Choice 3 A F2 10A B 10 30图3-99 规定HLPARA键字（例2）前三个H规范中的HLPARA键字指明了

8、被Choice1，Choice2，Choice3占有的区域分别和联机帮助信息相关。如果没选选项2，则选项3上移一行，选择了的帮助区自动地随之移动。第四个H规范中的HLPARA键字指明F2区域与联机帮助信息相关。这个区域为第10行的第29列到第40列。第五个H规范的HLPARA键字指明常量标题区和联机帮助信息相关。这个区域在第1行的第36列到第42列。3.3.59 HLPBDY（帮助边界）当显示联机帮助信息时用这个帮助层键字限制联机帮助信息的可用性。这个键字没有参数。如果没有定义HLPBDY键字，与活动的H规范（所有显示记录累加）有关的联机帮助信息都可被用户访问。定义HLPBDY键字可以通过定义

9、边界把表分成子表。每个子表包含帮助边界之间定义的H规范。有HLPBDY键字的H规范要在边界之前考虑。如果用DDS（HLPRCD键字）定义联机帮助信息，当按下帮助键时用户只能访问包含所选用H规范的子表中的帮助信息。如果用UIM（HLPPNLGRP键字）定义帮助信息，则子表决定扩充帮助。扩充帮助包括文件层键字HLPPNLGRP，之后是包含为指定项帮助选择的H规范的子表。可选指示器对这个键字有效。图3-100给出如何规定HLPBDY键字。 A HLPTCD（DFTHELP） A* A* This is H-spec 1 A* This is H-spec 2 A HLPBDY A* This is

10、H-spec 3 A H HLPARA（4 5 6 15） A HLPRCD（HELPRCD3） A 90 HLPBDY A* This is H-spec 4 A H HLPARA（8 5 10 15） A HLPRCD（HELPRCD4） A FIELD1 10A 1 10图3-100 规定HLPBDY键字RECORD1的H规范的列表分成二个或三个子表，依据是帮助键按下时指示器90的状态。如果指示器90 OFF，则分成两个子表，第一个子表包含H规范1和2，第2个子表包含H规范3和4。如果指示器90为ON，则分成三个子表，第1个子表包含H规范1和2，第2个子表包含H规范3，第3个子表包含H规

11、范4。3.3.60 HLPCLR（帮助清除）用这个记录层键字清除活动的帮助规范的列表。当此记录显示时，只有定义在当前记录格式上或文件层上的联机帮助信息才是可访问的。如果没规定HLPCLR键字，则所有记录的帮助规范被累积起来显示并保持活动，直到包含帮助规范的记录被从显示上清除或者完全被另一个记录覆盖为止。定义HLPCLR键字的记录必须至少包含一个帮助规范。困为对一个有USRDSPMGT键字的复盖操作忽略帮助规范，使用有USRDSPMGT和PUTOVR键字的HLPCLR会导致没有联机帮助信息可显示。为了显示联机帮助信息，当PUTOVR起作用时要关闭HLPCLR的可选指示器。图3-101给出如何规定

12、HLPCLR键字。 A R RECORD1 USRDFN A HLPCLR A H HLPARA（1 10 1 30） A HLPRCD（RECORDA FILE1） A H HLPARA（4 10 4 30） A HLPDOC（A B C）图3-101 规定HLPCLR键字当显示RECORD1时，只有与在RECORD1中定义的两个帮助规范有关的联机帮助信息才能显示。3.3.61 HLPCMDKEY（帮助命令键）使用这个记录层键字可在一个应用帮助记录格式中，当按下命令注意键（CA）或命令功能键（CF）之后把控制转给应用程序，这个键字是在应用帮助记录格式中规定的。为了使控制权能返回，必须在应用记

13、录格式和应用帮助记录格式中都定义命令键。在有HLPCMDKEY键字的帮助记录中或在文件层上必须定义一个CA或CF键。如果没有定义CAnn或CFnn键，则会给出警告信息（错误级别为10）。如果在文件层规定的所有的CAnn和CFnn键及同一帮助记录的HLPCMDKEY有可选指示器，也发出10级警告信息。如果在应用帮助记录格式上为CA或CF键定义了应答指示器，则会给出警告信息（错误级别10）并且应答指示器会被忽略。如果在帮助记录上定义了这个键字，当工作站用户按下一个既在应用记录上定义也在应用帮助记录上定义的命令键，会发生如下情况：如果命令键是CAnn键，则没有数据从应用记录格式传给应用程序。如果命令

14、键是CFnn键，则数据从应用记录格式传给应用程序。命令键返回应用程序。命令键必须既在应用记录格式上定义，也在应用帮助记录格式上定义。如果只在应用记录格式上定义，则命令键不能在显示帮助记录格式时使用。如果只在应用帮助记录格式上定义，则命令键只会起键的作用，并且控制不能返回给程序。键字HLPCMDKEY不能在子文件上定义（SFL键字），也不能在子文件控制（SFLCTL键字）或用户定义（USRDFN）记录格式上定义。在有键字USRDSPMGT的文件中不能规定HLPCMDKEY键字。图3-102给出如何规定HLPCMDKEY键字。第一个记录是应用记录格式，第二个记录是应用帮助记录格式。 00010A

15、R APPRCD CA01 00020A CA03 00030A CF12（12） 00040A CA04 00050A HELP 00060A H HLPRCD（HELPRCD） 00070A HLPARA（1 1 24 80） 00080A 8 2THIS IS THE APPLICATION 00090A 9 2RECORD FORMAT 00100A INPUT1 10 B 12 10 00110A INPUT2 10 B 13 10 00120A INPUT3 10 B 14 20 00130A* 00140A R HELPRCD HLPCMDKEY 00150A CA01（11）

16、00160A CF03 00170A CF05 00180A CF12 00190A 5 8SPECIFY COMPANY NAME 00200A 6 9SPECIFY STREET 00210A 7 10SPECIFY CITY, STATE, ZIP图3-102 规定HLPCMDKEY键字如果用户是在应用帮助屏幕，会发生如下情况：如果按下CMD1键，控制会返给应用程序，但没有数据从应用记录格式传送到应用程序。因为应答指示器11是在帮助记录格式上定义的而不是在应用记录格式上，所以这个应答指示器为OFF。如果按下CMD12键，控制返给应用程序，数据从应用记录格式传送到应用程序。应答指示器12为

17、ON。如果按下CMD5键，功能和按下ENTER键一样。为了把控制返给程序必须既在应用帮助记录格式上，也在应用记录格式上定义相同的CA或CF键。如果按下CMD3键，功能类似于ENTER键，为了把控制返给应用程序，必须在应用帮助记录格式和应用记录格式中都规定相应的CA和CF键。如果按下了CMD4键，会产生指明CMD4键不允许使用的信息。为了使控制能够返回应用程序，必须既在应用记录格式上定义也在应用帮助记录格式上定义相同的CA或CF键。3.3.62 HLPDOC（帮助文本）用这个文件层或帮助层键字定义一个文本，用它作显示器上特定位置的帮助信息内容。这个键字的格式是： HLPDOC（联机帮助信息正文标

18、号名 文本名 文件夹名）联机帮助信息正文标号参数相对于一个联机帮助文本标号，为文本的起始显示位置做个标记。文本名参数指出包含联机帮助信息的联机文本。文件夹名参数指出包含文本的文件夹。因为一个文件夹能存在于另一个文件夹中，并且给出的任何文件夹或文本名，在它所在的文件件夹中都是唯一的，可能需要把几个文件夹名结合起来以标识一个文本/文件夹。在HLPDOC键字上定义的文件夹名可能只是个简单的文件夹名，它遵循和文本名一样的语法规则，或者可把文件夹名规定成一个联合的名字。参见1.2“语法规则”以了解文本、文件夹和标号的命名规定。如果以下两个条件成立，则显示在H规范层上HLPDOC键字中规定的文本内容：光标

19、位于H规范的帮助区（用HLPARA定义的）H规范是活动的（H规范层的HLPDOC键字的可选指示器决定H规范是否为活动。当包含当前光标位置的活动记录没有帮助区时，显示在文件层上用HLPDOC键字定义的文本。HLPDOC不能和HLPBDY，HLPNLGRP或HLPRTN一起定义。图3-103给出如何规定HLPDOC键字 A HLPDOC（START GENERAL.HLP HELP.F1） A R REC1 OVERLAY A H HLPDOC（LBL1 HELP#1 HELP.F1） A HLPARA（10 3 12 50） A H HLPARA（15 9 17 61） A 90 HLPDOC（

20、LBL2 HELP#2 HELP/FLD） A N90 HLPDOC（LBL3 HELP#3 HELP.F1/FLD）图3-103 规定HLPDOC键字由HELP键字使HELP键能够使用。在文件层上的HLPDOC键字指明，如果按下帮助键并且光标不在H规范层上HLPARA键字定义的帮助区中，则在HELP.F1文件夹中的文本GENERAL.HLP从帮助符号START处开始显示。在H规范层：第一个H规范指明，如果按下帮助键并且光标在第10行、第11行或第12行的3到50列之间，文件夹HELP.F1中的文本HELP#1从LBL1帮助标号处开始显示。第二个H规范指明，如记录REC1的指示器90为ON，按

21、下了帮助键，并且光标在第15、16或17行的9到61列之间，则在文件夹HELP/FLD中的文本HELP#2从帮助标号LBL2处开始显示。第三个H规范指明，如果记录REC1的指示器90为OFF，按下帮助键，并且光标在第15、16或17行的9到61列之间，那么文件夹HELP.F1/FLD中的文本HELP#3将从帮助标号LBL3处开始显示。3.3.63 HLPEXCLD（禁止帮助）用这个帮助层键字指明和这个帮助规范有关的联机帮助信息不能作为扩充帮助显示，但是可以作为指定项的帮助。如果没有定义这个键字，扩充帮助由与文件层的以及所有活动的帮助规范的HLPPNLGRP键字有关的联机帮助信息组成。这个键字只

22、允许在定义了HLPPNLGRP键字的H规范上使用。在HLPPNLGRP键字中每个参数至少有一个没有定义HLPEXCLD键字。如果所有定义了特殊帮助屏组名的帮助规范都被禁止，则在运行时，如果按下了帮助键并且光标位于和此帮助屏组名有关的帮助区中，则会给出错误信息。图3-104给出如何规定HLPEXCLD键字 A H HLPARA（1 12 8 14） A HLPPNLGRP（R1 PNLA） A H HLPARA（1 18 8 19） A HLPPNLGRP（R2 PNLA） A H HLPARA（1 35 8 37） A HLPEXCLD A H HLPARA（1 49 8 50）图3-104

23、规定HLPEXCLD 键字在图3-104中，HLPEXCLD键字可阻止帮助模块R1和R2作为扩充帮助显示两次。3.3.64 HLPFULL（全屏帮助）用这个文件层键字指出应用程序的帮助屏组帮助正文用整屏的方式显示，而不是用窗口显示。如果没有规定这个键字，联机帮助信息只在一个窗口中显示，除非为用户配置文件定义了*HLPFULL选项。当定义HLPFULL键字时，必须在文件层或在帮助层上定义HLPPNLGRP键字。图3-105给出如何定义HLPFULL键字。 A HLPPNLGRP（GENERAL LIBA/PNL1） A HLPFULL A HLPTITLE（Sample Screen A R R

24、ECOO1H A H HLPARA（4 10 4 29） A HLPPNLGRP（NAMETAG LIBA/PNL1） A 1 10 A NAME1 20A B 2 10图3-105 规定HLPFULL键字当按下帮助键并且光标位于第4行的第10列到第29列之间，则LIBA/PNL1的帮助模块NAMETAG1用全屏方式显示。如果在光标位于其它位置时按下帮助键，则LIBA/PNL1的帮助模块GENERAL以全屏方式显示。3.3.65 HLPID（帮助标识）用这个常数字段层键字为字段层帮助中的常数定义一个标识符。所定义的标识符可用在HLPARA键字上来联结帮助正文和这个常数字段。 HLPID（帮助标

25、识）帮助标识参数是必需的并且只能是1到999之间的一个数字。这个数字在你所定义的记录中必须是唯一的。图3-106给出如何规定HLPID键字 A R RECORD HELP A HLPRCD（HLPCNST1 LIB1/FILE1） A H HLPARA（*CNST 2） A HLPRCD（HLPCNST2 LIB1/FILE1） A 2 4Constant field 1 A 4 4Constant field 2 HLPID（2）图3-106 规定HLPID键字在这个例子中，如果光标位于显示中正文“Constan field 1”中并按下了帮助键，库LIB1的文件FILE1中的记录HLPCNST1作为帮助正文显示。如果光标位于“Constent field 2”中且按下了帮助键，则库LIB1的文