home *** CD-ROM | disk | FTP | other *** search
/ Groovy Bytes: Behind the Moon / groovybytes.iso / GROOVY / SND_TOOL / WM10.ZIP / DOC.DAT / help.txt < prev    next >
Encoding:
Text File  |  1995-08-30  |  9.1 KB  |  201 lines
  1.  Help on WM Help                  The only way round is through. - Robert Frost
  2.  ───────────────                    
  3.  
  4.  Welcome to Help on WM Help!
  5.  
  6.  First of all, some basic text scrolling commands (keys):
  7.  
  8.                        ■ Up arrow    (scroll up one line)
  9.                        ■ Down arrow  (scroll down one line)
  10.                        ■ PgUp        (scroll up 24 lines)
  11.                        ■ PgDn        (scroll down 24 lines)
  12.                        ■ Home        (go to first screen)       
  13.                        ■ End         (go to last screen)
  14.   
  15.  You can also use the mouse. The red portion of the bottom bar lists all the 
  16.  commands above (and more - we'll come to that). Position the mouse cursor on 
  17.  the command you wish to execute and hit Enter or click the Left mouse button.
  18.  
  19.  
  20. ─── WM Help basics ─────────────────────────────────────────────────────────────
  21.  
  22.  WM Help is a simple hypertext browser. Help files are text files which may 
  23.  be created with any ASCII editor, e.g. DOS Edit (this makes it easy for you 
  24.  to modify existing help entries or to add your own). The program is usually 
  25.  called with a filename parameter, as in "Help ReadDir". If no filename is 
  26.  specified, Help displays the default file Start.TXT (residing in WAVmaker's 
  27.  DOC\ subdirectory). If the file can not be found, WM Help is aborted.
  28.  
  29.  Text appearing within curly brackets is displayed in red. It constitutes a 
  30.  hypertext link, i.e. a reference to a location either in the document being 
  31.  viewed or in a different document. Positioning your mouse cursor on the link
  32.  and hitting the Right arrow key ("forward" reading direction), the Enter key,
  33.  or the Left mouse button (the one you always use to execute commands in 
  34.  WAVmaker) causes a jump to the referenced material.
  35.  
  36.  WM Help keeps track of your jumps. Hitting the Left arrow key ("backward"
  37.  reading direction) or the Right mouse button (used to exit WAVmaker programs) 
  38.  returns you to the previous document (the one you last jumped from). This is 
  39.  known as backtracking.
  40.  
  41.  Backtracking from the top level document, the one displayed when you first
  42.  entered WM Help, terminates the program. You can also leave WM Help at any 
  43.  time by hitting the Esc key.
  44.  
  45.  In summary, to execute a hypertext jump
  46.  
  47.                  (1) Position the mouse cursor on the link
  48.                  
  49.                  (2) ■ Click the Left ("execute") mouse button, or
  50.                      ■ Hit the Enter ("execute") or the Right arrow 
  51.                        ("forward") key
  52.  
  53.  To backtrack,    ■ Click the Right ("exit") mouse button, or 
  54.                   ■ Hit the Left arrow ("backward") key
  55.  
  56.  To exit,         ■ Hit the Esc key.
  57.  
  58.  An example: click the Left mouse button on the following link to jump to the 
  59.  top of the present document, then click the Right mouse button to backtrack.
  60.  
  61.                                    {Help 1}
  62.  
  63.  Finding text
  64.  ────────────
  65.  
  66.  WM Help offers a simple text search feature. To invoke it,
  67.  
  68.                        ■ Press Alt-F, or
  69.                        ■ Choose Find from the bottom bar
  70.  
  71.  You will be prompted for the string to look for. Type it in using standard 
  72.  line edit commands (Left/Right arrow, Ins, Backspace and Del). You can abort
  73.  by hitting Esc or by clicking the Right mouse button; if you terminate with
  74.  Enter or by clicking the Left mouse button, the file is scanned for the next 
  75.  occurrence of the search string. 
  76.  
  77.  The search starts either at the first currently displayed line or, if the
  78.  previous search was for the same string, at the position immediately 
  79.  following its latest found occurrence.
  80.  
  81.  Repeated searches are quite easy, since WM Help remembers the search string.
  82.  Once you've typed it in, just position the mouse cursor on the Find command 
  83.  (bottom bar) and keep clicking!
  84.  
  85.  
  86.  Printing text
  87.  ─────────────
  88.  
  89.  Do not forget your PrtSc key! If you only want to print out a screenful of
  90.  text, this is the quickest way.
  91.  
  92.  It is also possible to send selected portions of a help file to the 
  93.  standard DOS printer/spooler for background printing. In order to do so,
  94.  
  95.      (0) Hit the - (Minus) key a couple of times (a preparatory action
  96.          to remove any previously set markers).
  97.      
  98.      (1) Position the mouse cursor at the beginning (first character) 
  99.          of the block to be printed out.
  100.      
  101.      (2) Hit the + (Plus) key. This sets the start marker (you won't see 
  102.          anything happening on the screen at this time).
  103.      
  104.      (3) Position the mouse cursor at the end (last character) of the 
  105.          block to be printed out.
  106.      
  107.      (4) Hit the + (Plus) key again. This sets the end marker. The 
  108.          (visible portion of the) selected range should now be 
  109.          highlighted (cyan background).
  110.  
  111.  You won't get a selected range if you set the end marker to a position
  112.  preceding that of the start marker! If you want to change your marker 
  113.  assignments, use the - (Minus) key. This key removes the end mark first 
  114.  (if it's set), so you can hit it just once to remove the end marker but not
  115.  the start marker, or twice to remove both markers and start all over again.
  116.  
  117.  Anyway, provided that you have selected a range (it does not need to be on 
  118.  screen, you are free to scroll around any way you like) you are all set for 
  119.  step
  120.  
  121.                    (5) To print the selected range, 
  122.          
  123.                        ■ Press Alt-P, or
  124.                        ■ Choose Print from the bottom bar
  125.  
  126.  WM Help will now invoke HARDCOPY.BAT, which in turn calls the DOS PRINT 
  127.  utility. If you want to use a different printer/spooler, edit HARDCOPY.BAT.
  128.  
  129.  Technical Note: 
  130.  
  131.  HARDCOPY.BAT sends all PRINT screen output to the NUL device. This is done 
  132.  to keep the WM Help screen intact. The resident part of PRINT is installed 
  133.  by WM.BAT when WAVmaker is first started up. If PRINT has not already been 
  134.  installed when WM Help invokes it, it will try to ask the usual question 
  135.  (device name), but since its output is being redirected to the NUL device, 
  136.  you won't see this, and the system will appear to have locked up. Hitting 
  137.  Enter will clear things up, but the morale is the usual one: use WM.BAT to 
  138.  start up WAVmaker, do not modify it unless you know what you are doing (or 
  139.  at least not without having backed it up first!), and do not run WAVmaker's 
  140.  user interface programs (WMmain, WMmenu, WM DOSbox, WM WAView, WM Read, 
  141.  WM Help and WM PRGed) in standalone mode!
  142.  
  143.  
  144.  Getting Help on WM Help
  145.  ───────────────────────
  146.  
  147.  In order to jump to this file from within WM Help
  148.  
  149.                        ■ Press Alt-H, or
  150.                        ■ Choose Help from the bottom bar
  151.  
  152.  
  153. ─── Link format ────────────────────────────────────────────────────────────────
  154.  
  155.  [This section contains technical information. You don't need to read it unless
  156.  you plan to modify/extend the help system.]
  157.  
  158.  The WM Help link format is quite straightforward:
  159.  
  160.  First comes the name of the desired text file. Files are assumed to reside in 
  161.  WAVmaker's DOC\ subdirectory. If no extension is provided, the default TXT is 
  162.  used. In the above example, WM Help goes looking for the file DOC\HELP.TXT 
  163.  (since DOS is not case sensitive, WM Help isn't either - Help, HELP and hElP 
  164.  are all the same to it).
  165.  
  166.  After the file name there may be an optional line number. The default line 
  167.  number is 1 (top of file), so there was no real need for it in the above 
  168.  example (we could just have written {Help}).
  169.  
  170.  
  171.  Shelling to DOS
  172.  ───────────────
  173.  
  174.  There is a special case. A link starting with the separate word DOS is NOT a 
  175.  help text reference; it's a DOS shell command. All remaining text in the link 
  176.  is a standard DOS command line. If you execute such a "jump", WM Help will 
  177.  unload almost all of itself from base memory, leaving only a small stub 
  178.  resident (a few kB - the exact size depends on memory fragmentation at run 
  179.  time). The rest of program and data is swapped to XMS memory, EMS memory, or 
  180.  disk, in that order of preference. Thereafter, the command line is executed. 
  181.  When the child process terminates, WM Help loads itself back into base memory.
  182.  
  183.  Try it! Clicking on the following links should cause imgView (residing in 
  184.  WAVmaker's EXE\ subdirectory) to display the files Lips.GIF, Frog.GIF and 
  185.  Fly.GIF (residing in the Doc\ subdirectory; you'll need a SVGA for this to 
  186.  work) - exit the usual way, hit Esc or click the Right mouse button: 
  187.  
  188.                          {DOS EXE\imgView Doc\Lips}
  189.                          {DOS EXE\imgView Doc\Frog}
  190.                          {DOS EXE\imgView Doc\Fly}
  191.  
  192.  By the way, click here for the imgView documentation: {imgView}.
  193.  
  194.  The DOS shell conventions are the same throughout WAVmaker. Redirection is 
  195.  supported. If the command to be executed is a BAT file, WM Help uses the 
  196.  COMSPEC environment variable to locate the command processor, and inserts any 
  197.  parameters present on the COMSPEC line into the parameter string. In order to
  198.  execute internal commands (commands which are part of COMMAND.COM) you must
  199.  invoke the command processor explicitly with the /C switch, as in 
  200.  "COMMAND /C DIR".
  201.