05/23/94 HINTS.DOC: Data Structure of HINTS.TXT and How to Modify it for Custom Use =========================================================== PROCOMM PLUS for Windows version 2.00 includes a handy hints script (HINTS.WAX) which displays text in a dialog window on program startup. You can modify its source file, HINTS.TXT, to suit your needs. This can be especially useful to corporate or MIS managers who want to create a set of hints appropriate to specific tasks. When modifying or creating your own HINTS.TXT file, keep the following constraints in mind: 1. The data file must be named HINTS.TXT. 2. HINTS.TXT must be located in the directory containing your ASPECT files. Normally this will be \prowin2\aspect. 3. Unless it already exists, HINTS.WAX builds a file called HINTS.INI. Do not attempt to edit HINTS.INI directly. All customization you wish to do to HINTS can be done by editing the HINTS.TXT file. The HINTS script is normally executed automatically on startup by the STARTUP.WAX script. If you delete STARTUP.WAX, then run HINTS from the scripts box, it will create a new STARTUP.WAS and compile it. If you edit or create a new STARTUP.WAS and compile it, HINTS will not run automatically. You can start HINTS by selecting it from the script selection drop list at any time. The following simple example STARTUP.WAS restores your hints on program startup: ;******************************************************** ;* STARTUP.WAS ;* Simple example startup script. Add your own ;* startup defaults between 'proc main' and 'endproc' ;******************************************************** proc main chdir $WINPATH profilerd "PW2.INI" "startup script" "Run Hints" i0 if i0 == 1 chdir $ASPECTPATH execute "hints.wax" endif endproc Data Structure of HINTS.TXT HINTS.TXT consists of one optional and two required sections. Each section consists of one or more lines of information, each terminated by a carriage return, occurring under a descriptive header between square brackets. * Icon Files -- this optional section tells HINTS.WAX where to find icons to be displayed in the dialog box with each hint. The format is [Icon Files] IconLabel=\filename Example: Camera=c:\windows\camera.ico You can use any text string for the label. The path should be a fully qualified path to any .ICO file or .DLL containing icons. * Category List -- this required section links "category" headers which appear over each hint with header text to be displayed in the dialog box and the source and index of the icon to be displayed. The format is: [Category List] $_HeaderText,This is text to be displayed,nn, where nn is an offset into the icon file. This should be 0 for .ico files. Example: $_ScreenSnap,Capture a screen to your Clipboard,0,Camera The optional "Camera" at the end of this line, of course, refers to the label defined under Icon Files. If you don't define an icon label, HINTS will display an icon from NPW.DLL by default. * Hints Text -- This section contains the information you want to display in the HINTS dialog box. Text must be unformatted ASCII with carriage returns only where you want paragraph breaks. All text must be imbedded between two special character lines ending with carriage returns: Category header: $_HeaderText and End of text marker: #_ NOTE: the distributed HINTS.TXT includes numbers after the End of text markers. These numbers are offsets into the PW help file. Leaving these numbers off simply grays out the "More Info" button on the dialog box. Example: $_Support Remember that help is available in the DATASTORM Forum on CompuServe seven days a week. #_ (Note: this example includes carriage returns after each line for ease of readability. Actual hint text will contain carriage return/line feeds only at the end of the text paragraph, just before the end of text marker.)