6.4.11. FORMAT OF ON-LINE HELP FILES

next, previous Section / Table of Contents / Index The format of on-line help files is of interest only for those who want to modify the default help file provided with the software for customization or translation purposes. Running BALSAC and using on-line help for option menus requires a help file with its name provided on the command line or defaulted to 'balsac2.hlp', see Sec. 6.1. This file is loaded at the beginning of each session or with the basic parameter option and contains all help text in ASCII format. This file can, therefore, be easily customized by the user. (Do NOT overwrite the original file provided with the software.) On-line help files are defined by 2 Cards given as follows: Card 1. (70X,I5,I3) LINES,NOPT LINES := Total number of lines in the help file, 1176 at present. NOPT := Total number of option key menus, 85 at present. Card 2. (A70,I5,I3) HTEXT,IOPT,ISUBO HTEXT := Help text line (up to 70 characters) IOPT := Code number of the option key menu. These numbers are shown by BALSAC if the index flag is set to "on" (with the control parameter option) - in most option menus (DOS/VGA and Unix/X.11 Windows, see Sec. 6.2.15) which finish with a line ============================================= IOPT == at the bottom. - at the bottom of any menu window (Unix/X.11 Windows only, see Sec. 3.3.8) reading __ |__| ?: LATTICE Menu No. IOPT | or __ |__| ?: CLUSTER Menu No. IOPT | - after help is requested (DOS/VGA and Unix/X.11 Windows, see Sec. 3.3.3) and BALSAC asks for the next option by IOPT> Select options from [ABC...,?] : ISUBO := Sequence number of the specific option in the menu. The sequence of options is shown by BALSAC after help is requested (DOS/VGA and Unix/X.11 Windows, see Sec. 3.3.3) and BALSAC asks for the next option by IOPT> Select options from [ABC...,?] : Here the character string in square brackets "[ABC...,?]" lists option sequence by the respective key codes (ISUBO=1 for option "A", ISUBO=2 for option "B", etc.). Help text for a given option key can extend over several lines. In this case the lines must appear in correct order in the file with each line having the same values for IOPT,ISUBO. As an example Sec. 6.4.11.1 lists the content of the default help file provided with the BALSAC package. next, previous Section / Table of Contents / Index