home *** CD-ROM | disk | FTP | other *** search
/ Groovy Bytes: Behind the Moon / groovybytes.iso / GROOVY / SND_TOOL / WM10.ZIP / DOC.DAT / read.txt < prev    next >
Encoding:
Text File  |  1995-08-30  |  9.0 KB  |  197 lines
  1.  WM Read
  2.  ───────
  3.  
  4.  WM Read is a simple text browser. If you can use the WM Help browser, you
  5.  can use (most of) WM Read. Hypertext jumps are not supported, however, while
  6.  there are a couple of additional commands related to Function keys F1-F10.
  7.  
  8.  There is another important difference: WM Read MUST be called with the name
  9.  of a text file to browse. Leaving out the file extension is OK (the default
  10.  TXT is then used), but you must provide a filename, as in "Read DOC\HELP".
  11.  Failing to do so will cause WM Read to abort execution at startup.
  12.  
  13.  This Help file can be called up from within Read by pressing Alt-H or by
  14.  selecting the Help command from the bottom bar (point with the mouse cursor
  15.  and click the Left button).
  16.  
  17.  
  18.  Contents:   ■ Leaving WM Read         {Read  25}
  19.  ─────────   ■ Scrolling               {Read  31}
  20.              ■ Searching               {Read  44}
  21.              ■ Printing                {Read  70}
  22.              ■ Function key operations {Read 127}
  23.  
  24.  
  25. ─── Leaving WM Read (Esc) ──────────────────────────────────────────────────────
  26.  
  27.  To leave Read,        ■ Hit the Esc key, or                      
  28.                        ■ Click the Right mouse button
  29.  
  30.  
  31. ─── Scrolling ──────────────────────────────────────────────────────────────────
  32.  
  33.  Basic text scrolling commands (also available from the bottom row; point
  34.  with the mouse cursor and hit Enter or click the Left button):
  35.  
  36.                        ■ Home        (go to first screen)       
  37.                        ■ End         (go to last screen)
  38.                        ■ PgUp        (scroll up 24 lines)
  39.                        ■ PgDn        (scroll down 24 lines)
  40.                        ■ Up arrow    (scroll up one line)
  41.                        ■ Down arrow  (scroll down one line)
  42.  
  43.  
  44. ─── Searching (Alt-F) ──────────────────────────────────────────────────────────
  45.  
  46.  To find a text string,
  47.  
  48.                        ■ Press Alt-F, or
  49.                        ■ Choose Find from the bottom bar
  50.  
  51.  You will be prompted for the string to look for. Type it in using standard 
  52.  line editing commands (Left/Right arrow, Ins, Backspace and Del). You can 
  53.  abort by hitting Esc or by pressing the Right mouse button; if you terminate 
  54.  with Enter or Left mouse button, the file is scanned for the next occurrence 
  55.  of the search string. 
  56.  
  57.  There is a difference compared to WM Help: hitting F1 to F10 while entering 
  58.  the search string will write the current value of the Function key (see 
  59.  {Read 127}) to the edit line.
  60.  
  61.  The search starts either at the first currently displayed line or, if the
  62.  previous search was for the same string, at the position immediately 
  63.  following its latest found occurrence.
  64.  
  65.  Repeated searches are quite easy, since WM Help remembers the search string.
  66.  Once you've typed it in, just position the mouse cursor on the Find command 
  67.  (bottom bar) and keep clicking!
  68.  
  69.  
  70. ─── Printing ───────────────────────────────────────────────────────────────────
  71.  
  72.  To print out the current screen, hit PrtSc.
  73.  ────────────────────────────────
  74.  
  75.  To print out a selected portion of the file being viewed,
  76.  ───────────────────────────────────────────────────────── 
  77.  
  78.      (0) Hit the - (Minus) key a couple of times (a preparatory action
  79.          to remove any previously set markers).
  80.      
  81.      (1) Position the mouse cursor at the beginning (first character) 
  82.          of the block to be printed out.
  83.      
  84.      (2) Hit the + (Plus) key. This sets the start marker (you won't
  85.          see anything happening on the screen at this time).
  86.      
  87.      (3) Position the mouse cursor at the end (last character) of the 
  88.          block to be printed out.
  89.      
  90.      (4) Hit the + (Plus) key again. This sets the end marker. The 
  91.          (visible portion of the) selected range should now be 
  92.          highlighted (cyan background).
  93.  
  94.  You won't get a selected range if you set the end marker to a position
  95.  preceding that of the start marker! If you want to change your marker 
  96.  assignments, use the - (Minus) key. This key removes the end mark first 
  97.  (if it's set), so you can hit it just once to remove the end marker but not
  98.  the start marker, or twice to remove both markers and start all over again.
  99.  
  100.  Anyway, provided that you have selected a range (it does not need to be on 
  101.  screen, you are free to scroll around any way you like) you are all set for 
  102.  step
  103.  
  104.                    (5) To print the selected range, 
  105.          
  106.                        ■ Press Alt-P, or
  107.                        ■ Choose Print from the bottom bar
  108.  
  109.  WM Read will now invoke HARDCOPY.BAT, which in turn calls the DOS PRINT 
  110.  utility. If you want to use a different printer/spooler, edit HARDCOPY.BAT.
  111.  
  112.  Technical Note: 
  113.  
  114.  HARDCOPY.BAT sends all PRINT screen output to the NUL device. This is done 
  115.  to keep the WM Help screen intact. The resident part of PRINT is installed 
  116.  by WM.BAT when WAVmaker is first started up. If PRINT has not already been 
  117.  installed when WM Read invokes it, it will try to ask the usual question 
  118.  (device name), but since its output is being redirected to the NUL device, 
  119.  you won't see this, and the system will appear to have locked up. Hitting 
  120.  Enter will clear things up, but the morale is the usual one: use WM.BAT to 
  121.  start up WAVmaker, do not modify it unless you know what you are doing (or 
  122.  at least not without having backed it up first!), and do not run WAVmaker's 
  123.  user interface programs (WMmain, WMmenu, WM DOSbox, WM WAView, WM Read, 
  124.  WM Help and WM PRGed) in standalone mode!
  125.  
  126.  
  127. ─── Function key operations ────────────────────────────────────────────────────
  128.  
  129.  While in WM Read, you have ten programmable Function keys (F1 to F10) at your
  130.  disposal. Each one is assigned a title and a value. Titles and values can be
  131.  up to 15 characters long (reflecting the size of the default DOS keyboard 
  132.  buffer).
  133.  
  134.  At startup, WM Read inherits Function key titles and values from the calling
  135.  program (the gory details of this process are described in {FnKeys}). If 
  136.  there is nothing to inherit, titles and values default to empty strings.
  137.  
  138.  To call up a window showing all Function key titles and values, press Alt and
  139.  a Function key between F1 and F10.
  140.  
  141.  To make the Function key window go away, either
  142.  
  143.                         ■ Press Alt and F1-F10 again, or
  144.                         ■ Hit the Esc key, or
  145.                         ■ Click the Right mouse button, or
  146.                         ■ Scroll the text file
  147.  
  148.  You can also view the contents of a single Function key by hitting it at any
  149.  time (almost - see exceptions below). Title and value will be written to the 
  150.  screen's upper right corner. They will disappear the next time you execute a 
  151.  Find or a scroll command, close the Function key window, or hit another 
  152.  Function key. 
  153.  
  154.  Now for the two exceptions: 
  155.  
  156.     ■ Hitting a Function key when entering a search string with the Find 
  157.       command causes the current value of the Function key to be written 
  158.       to the edit line. 
  159.     
  160.     ■ Hitting a Function key while a word is selected assigns the selected 
  161.       word to the Function key value and causes the NEW value to be 
  162.       displayed in the screen's upper right corner (see below).
  163.  
  164.  A word in the text file is selected by positioning the mouse cursor on it and 
  165.  hitting Enter or the Left mouse button. This causes the word to be highlighted 
  166.  (light cyan on blue background). Hitting Enter or the Left mouse button again 
  167.  undoes the selection. The selected word need NOT be on screen to be assigned 
  168.  to a Function key.
  169.  
  170.  The main purpose of programmable Function keys in WM Read is to allow data to
  171.  be exported to other WAVmaker applications, including the menu programs. When
  172.  WM Read is terminated, it makes Function key assignments available to other
  173.  programs through the standard mechanism described in {FnKeys}. The menu 
  174.  programs WMmain and WMmenu can be instructed to inherit the exported values of
  175.  Function keys with matching titles (only titles matter, not key numbers: if 
  176.  an application assigns a title:value pair "File #1":"Read.TXT" to Function 
  177.  key F8, and the Function keys F1 and F9 both have been assigned a title "File 
  178.  #1" in the calling menu, they will both inherit the new value "Read.TXT"). 
  179.  Since WM Read inherits both titles and values from the caller, ALL titles 
  180.  will match, so you can reprogram all Function keys of the calling menu from 
  181.  within WM Read.
  182.  
  183.  Confused? Don't be. It's all very simple. 
  184.  
  185.  An example: 
  186.  ───────────
  187.  
  188.  In WAVmaker, WM Read is used to browse directory listings {ReadDir}. While 
  189.  doing this, you can select a filename and assign it to the Function key 
  190.  entitled "File #1". Upon return to the calling menu, hitting the Function key 
  191.  entitled "File #1" (provided that the menu in question has one) will cause 
  192.  the filename to be written to the command line, avoiding you the hassle of 
  193.  having to remember it (and of having to type it in correctly!) when entering 
  194.  the next command.
  195.  
  196.  Handy, isn't it?
  197.