|
The Help System is a software component independent of CFS, which can also be integrated into other end-user systems.
The CFS user can at any stage enter '?', '?&', '??', '?CON' or '?par' to invoke the Help System. This will provide a detailed display of all the entries possible for that particular field. This is equally valid for screen masks, such as the SET and Job Report masks.
? All information relating to the marked field will be displayed.
?? A description of the Help System will be displayed.
?ALL | HELP The main menu of the Help System will be displayed, from which all available Help information can be reached.
?NEWS Display amendment history.
?CON All the Connection-related Help information will be displayed. This variant can be entered in Connections, in Line mode, or in the first field of a mask in Format mode.
?USER [, par] Display the menu and information from the CFSHELP.USER file. For further information, see page 24-.
?par All information relating to the par keyword is displayed, i.e. all parameters relating to the current input field.
Examples:
COMMAND : ?add
All information relating to the ADD command will be displayed.
FILENAME-SELECT : ?fstat
All information relating to the 'FSTAT' option in the FILENAME-SELECT field will be displayed.
HELP Information for multiple fields within a mask
Multiple fields within a mask can be marked with '?'. The relevant Help information will then be displayed in turn for each marked field.
Selection within the Help System
If the required Help information is very extensive, the individual chapters will be displayed in a menu. An individual menu point can be selected by marking it with any character.
An individual menu point can itself extend over multiple screens. In this case, a "Help continues" message will be displayed in the second last line.
If a submenu exists below a menu point, this will be indicated with the character "Ö" .
Normally, the menu points marked on a screen will be displayed immediately. If multiple menu points are to be collated and only displayed at the end, then the screens should be transmitted with the F1 key.
Assignment of the Data Transfer Keys
K1 Output of Help information is terminated at the current point. Output from the next menu point, or the next field to have been marked with "?" will be displayed. If the current Help screen is the last, then the HELP function will be terminated.
K3 Output of Help information is terminated at the current point. Output from the previous menu point is displayed. After displaying the first menu point, the display will switch to the higher level menu. The HELP function will be terminated when the first menu is reached.
F1 If a menu extends over several pages, any marked menu points will be displayed immediately if the screen is transmitted with DUE1. However, if the menu is transmitted with the F1 key, then the marked points will be collated and only displayed after the last page of the menu has been transmitted, or after the first time the DUE1 key is pressed.
F2 The F2 key has the same function as the MEN command, namely, branch to the higher level menu.
F3 The Help screen currently displayed will be captured to the CFS Hardcopy file. If multiple pages are to be saved to a file, this is better achieved by using the HC command (set Hardcopy mode).
Shift ENTER The command memory is activated. The command last entered in the Help mask will be displayed, or the specified character string will be sought, and its respective entry then displayed.
Examples of Help System Masks
Input: ?? (Information about Help System)
} dd.mm.yy hh:mm:ss H E L P - S Y S T E M TSN: .... {
} COMMAND : {
} INPUT : {
} Help System Description {
} {
} Mark the information required with an "x". {
} {
}. How can the Help System be reached ("?", "?all", "?operand", "??") {
}. Entries in "COMMAND" field (line 2 of this mask) {
}. Entries in "INPUT" field (line 3 of this mask) {
}. Assignment of the K1, F1, K3, F3 and DUE2 keys in the Help System {
} {
} {
} {
} {
} {
} {
} {
} {
} {
} {
} {
} {
} {
Input: help or ?all (Main Help System menu)
With a mouseclick you get a describtion of the screen item.
The "Ö" character indicates that this menu point has submenus associated with it.
Input: ?on (Information about Variable Actions)
} dd.mm.yy hh:mm:ss H E L P S Y S T E M TSN: .... {
} COMMAND : {
} INPUT : {
} ON Define Variable Actions {
} {
} This field is used to define actions with extensive parameters. {
} The action can be defined for all files (&) or only for those marked with "X" {
} {
} {
} Format: ONXvariable Action Action is only valid for marked files {
} ON&variable Action Action is valid for all files in the list {
} {
} {
} Please make your choice: {
} {
}xÖMenu of all Variable Actions {
}. Full description of the Variable Action process {
} {
} {
} {
} {
} {
} {
} {
} dd.mm.yy hh:mm:ss H E L P S Y S T E M TSN: .... {
} COMMAND : {
} INPUT : {
} Menu of all Variable Actions {
} {
}. / Execute BS2000 Command . REORG Reorganise library {
}.ÖADD Add to library . SEL Select from library {
}x ARCHIVE Save with Archive . SETUDAT Set USER date (PLAM) {
}. CONV Convert files . TSOSMT Save with TSOSMT {
}. COPY Copy {
}. DFLAM Decompress with FLAM {
}. DPF Generate file names {
}. FIND Find a character string {
}. FLAM Compress with FLAM {
}.ÖFT File Transfer with FT-BS2000 {
}. ICOPY Copy INF catalog {
}. LIST Create list {
}. LISTCAT List catalog entries {
}. MOVE Move to another volume {
}.ÖRDAC File Transfer with RDAC {
}. REN Rename {
} {
} {
} {
Options in the COMMAND field of a Help mask
} dd.mm.yy hh:mm:ss H E L P S Y S T E M TSN: .... {
} COMMAND : {
} INPUT : {
} ARCHIVE : Save with Archive {
} {
} ONXARCHIVE archive params {
} {
} A DO procedure for the save run will be created. The user {
} will be asked if this procedure should be started in {
} dialog mode, as an Enter job, or no action taken (only {
} generate the DO procedure). {
} If the save is to be done under dialog, a DO command will {
} will be issued, and CFS will terminate. {
} {
} {
} Examples: {
} {
} ONXARCHIVE E L=SYSOUT,TAPES=888888 {
} {
} ONXARCHIVE S NOW=NO,ER=YES,TAPES=123456 {
} {
} {
} {
} {
+ | - Page one screen forwards / backwards.
If nothing is entered in the Command field, this is the same as one screen forwards.
+n | -n n lines forwards / backwards (not allowed in menus).
++ | -- Move to the beginning / end of the current item (Field or menu point information - not allowed in a menu).
The full contents of the Help item currently being displayed will be written to a file with the specified name. If, for example, a user is currently displaying the CFS amendment history (?news command), the full text of the amendment history will be written to a file called CFS.NEWS if the command LIST CFS.NEWS is issued.
file Name of the output file. If no file name is specified, the standard file name of CFS.HELPLIST.tsn will be used.
If the file name is omitted for a later LIST command, the data will be appended to the List file last specified (i.e. the file will be opened in Extend mode).
E Append output file (Open=Extend).
O Create new output file (Open=Output). Existing file with the same name will be overwritten.
DKEY | NDKEY Display Keys. The ISAM key of the first record from the Help file will be displayed. This information is necessary for diagnostic purposes.
Standard: NDKEY
NF Next Field. Display information for the next field. This command is equivalent to pressing the K1 key.
LF Last Field. Display information for the previous field. This command is equivalent to pressing the K3 key.
MEN Display the previous menu. This command is equivalent to pressing the F2 key.
S&,.... Search for keywords in the HELP file.
Search the whole HELP file for the specified string (e.g. Reorganise). The result will be a list of all the menu points containing the search string.
For a full description of the Search command, see page 8-.
S,.... Search for the specified string from the current position to the end of the information relating to this field.
If the Search command is entered from a menu mask, then all menu points will be searched for the specified string. The menu points containing the string will be marked with an "S". If the menu point is another menu, it will always be marked with an "S", even thogh the submenu will not be searched. If a screen is transmitted with menu points thus marked, the resulting strings will be displayed, or the submenu will be searched.
S-,.... Search for the specified string in the direction of the beginning of the HELP information. This command is only permissable following a S,.....command.
E or END Terminate HELP function.
/cmd Execute BS2000 command.
/ Break. Branch to the BS2000 command mode.
=arith Arithmetic calculation, or hexadecimal <--> character conversion.
For a full description, see page 7-.
HC | NHC Set / reset the CFS Hardcopy function.
The HC command can be specified with any of the parameters detailed on page 15-1. The HC file,R command is of particular interest with the HELP system (see page 15-). The information appearing on the screen will be reproduced in the file in reduced form. The screen headers, footers and frames do not appear in the reduced format.
? Information on possible entries in the COMMAND field of the HELP mask.
?? General Information regarding the CFS Help System.
?ALL | ?& the main menu of the Help system will be displayed. The entire HELP system can be reached from this menu.
MES Write a message in the CFS Remark file. A mask will be displayed in which CFS errors, enhancement requests and other messages for the attention of OPG GmbH can be entered. This information is written in the file $TSOS.CFSCOM. The name of this file can be amended during installation by the system administrator. See the MES command on page 7- for further information on the format of the Remark mask.
Input Options in the INPUT Field of the Help Mask
INPUT : An entry in this field will be transferred to the field for which help was requested. This can be done at any time in the Help system, even over multiple screens and menus.
After terminating the Help information with the K1 key, or by entering the END Help command, the entry in the INPUT field will be transferred to be used as input in the field for which help was requested.
Calling a User Menu
Entering ?user [,name] in the CFS command field will result in a temporary switch from CFSHELP to a Help file created by the user.
Search Sequence for a User-specific Help File
CFS searches for the user-specific Help file according to the following rules:
1) The file was explicitly assigned with a file command (/FILE xxxx, LINK=HELPUSER)
2) A file exists with the name CFSHELP.jobname, or .acct if no job name was specified.
3) A file exists with the name CFSHELP.USER.
4) A file exists with the name $userid.CFSHELP.USER, where
userid is the userid under which CFS is cataloged.
Generating a Help File
The following statements are necessary to generate a Help file:
/FILE helpfile,LINK=HELPFILE
/EXEC (GENHELP,$CFS.CFSLIB)
DATA=lib(element-1)
DATA= ....
......
SOURCE=lib(element-x)
END
The elements marked element-n must exist as S-type elements in the PLAM library lib.
A DO procedure called J/GENHELP exists in the library CFS.S.LMSLIB.
Data Layout of a Help File
The most important syntax elements are:
:MEN: Menu statements define selection menus. Menus can be constructed to any number of hierarchical levels.
The beginning and end of selection menus in the SOURCE element is defined with Key and End records.
:COP: Cop statements results in the copy of information from a DATA element during the generation.
:DIR: Directory statement. All menu points contained in the Directory List can be displayed by entering the name directly, i.e. ?USER,name. Example: ?USER,EBCD.
Only one Directory block per Help file is allowed.
The elements S/CFSHELP.USER.MENUE and S/CFSHELP.HELPTABS in the CFS.S.LMSLIB library contain all the data necessary to generate a sample User Help File.