home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Editor / FREDV19A.LHA / FrexxEd / fpl / SimpleHelp.FPL.README < prev    next >
Encoding:
Text File  |  1995-07-19  |  1.7 KB  |  54 lines
  1. ############################################
  2. File: SimpleHelp.FPL
  3. Author: Kjell Ericson
  4. Email: kjer@pki.philips.se, FidoNet 2:201/328
  5. Short description: A simple interface to AmigaGuide
  6. Version: 1.2
  7. Date: 219.11.94
  8. Local settings:
  9. Global settings:
  10. Keysequence: 'Help' and "Amiga Shift 'Help'"
  11. Type: function
  12. Prereq: run grep as explained.
  13. ############################################
  14.  
  15. BEFORE
  16.   Before using SimpleHelp() you have to execute the command...
  17.  
  18. grep -$ -n @node #?.guide >Guide:AllNodes
  19.  
  20.  ...standing in your guide directory.  You can append other guide files
  21. to the 'Guide:AllNodes'.
  22.  
  23. An alternative is to use the FrexxUtil 'AGgrep' which is designed only to
  24. extract nodes from amiga guide files.  Usage:
  25.  
  26. AGgrep #?.guide >Guide:AllNodes
  27.  
  28.  ...which will give the same result.
  29.  
  30.  
  31. FUNCTION
  32.   SimpleHelp() is assigned to the 'Help' key.  When you press it, the word
  33. currently under the cursor will be passed to SimpleHelp().
  34.   SimpleHelp() will try to find that word in the 'Guide:AllNodes' file.  If
  35. a match is made, it will start 'AmigaGuide' with the correct parameters to
  36. get your help.
  37.  
  38.   The first try of SimpleHelp() is to find a match to the word surrunded with
  39. '"', ie '"NodeName"'.  If that match fails, a try is made to the word with a
  40. space attached to the beginning and end, ie ' NodeName '.  If that match fails, 
  41. a last try is made to see if the word exists (a word only search).
  42.  
  43.   When a match is found, SimpleHelp() expect the node name to start at
  44. position 6 (it is important that the '-n' flag is given to 'grep').
  45.  
  46.   If it fails to find a match, FrexxEd.guide will be shown.
  47.  
  48. The "Amiga Shift 'Help'" key will prompt for a string to match.
  49.  
  50.  
  51. NOTE
  52.   'grep' is a utility that is copyright by SAS Institute, Inc., Cary, NC
  53.  
  54.