home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / TextEditors&Viewers / Texteditors / GoldED310.lha / Install / data / tools / Scanner / ReadMe < prev   
Encoding:
Text File  |  1995-05-01  |  1.5 KB  |  33 lines
  1. CONTENTS
  2.  
  3.  This is a collection of GoldED scan handlers.
  4.  
  5. INSTALLATION
  6.  
  7.  Select "Find functions/Show all"  from  GoldED's  FIND  menu:  the  QuickFunc
  8.  window appears. Now use the "mode" gadget to enter the QuickFunc setup. Add a
  9.  new handler ("add" gadget): The new handler is appended to the list. Activate
  10.  the  handler  (doubleclick  at its list entry) and leave the setup requester.
  11.  You should provide a default file  extension  for  the  new  handler  in  the
  12.  QuickFunc  window  if  you  want  to  make  GoldED  use the new handler while
  13.  creating a reference database: Scan handlers are used by  GoldED's  reference
  14.  system, too.
  15.  
  16. DESCRIPTION
  17.  
  18.  The "Guides" handler is able to scan AmigaGuide files for "nodes" (nodes  are
  19.  the  pages  of  AmigaGuide  documents).  Useful during guide development. The
  20.  "Defines" handler is able to scan C sources and C includes for  defines.  The
  21.  "ADoc"  handler  is  able  to  scan  AutoDoc-style  documents  for "sections"
  22.  (manuals of most shared libraries are provided as AutoDocs). This handler  is
  23.  considerably faster than GoldED's built-in AutoDoc scanner but can handle the
  24.  original Commodore AutoDoc format only (the built-in scanner  handles  slight
  25.  deviations, too).
  26.  
  27. EXAMPLE USAGE
  28.  
  29.  Load a text file after having added a  new  handler.  Select  "Functions/Show
  30.  all"  from  the FIND menu: a new window pops up with a list of all "elements"
  31.  found in the text  ("elements"  depends  on  the  scanner;  e.g.  a  list  of
  32.  functions). Click at an entry to move the cursor to the node definition.
  33.