home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / tools / kingfisher / readme < prev   
Encoding:
Text File  |  1994-04-16  |  7.6 KB  |  198 lines
  1. Editor's Note:
  2.  
  3. This version of KingFisher is provided in the hope that you may find it
  4. useful, however because it is a beta test version, and because there was no
  5. significant time for testing (it was literally included on the CD-ROM on
  6. the same day the ISO-9660 master tape was made), it is almost certain that
  7. by the time you see this CD-ROM, many improvements will have been made.
  8.  
  9. I STRONGLY urge you to register with Udo for the latest supported version.
  10. Not only will you get an improved version of KingFisher and the
  11. accompanying databases, but you will get many other benefits as well.
  12.  
  13. I would like to express my deep appreciation to Udo for his work on writing
  14. the specification for the "product info" files and for this rewrite of
  15. KingFisher.  Please help support this work by registering KingFisher.
  16.  
  17. -Fred Fish
  18.  16-Apr-94
  19.  
  20. ===========================================================================
  21.  
  22. This is the "BETA 9" release of KingFisher 2.0.  This KingFisher is
  23. provided to you without any warrantees, either expressed or implied.  This
  24. software is a preliminary release of a package under development and may
  25. exhibit erroneous behavior, even result in crashes.  It is not a finished
  26. product by any means.
  27.  
  28. For more detailed information on the program, please read the documentation
  29. in the KingFisher.DOC file.
  30.  
  31. KingFisher 2.0 is lacking the following features of Release 1:
  32.  
  33.   · AmigaGuide® Help,
  34.   · Skipping forward/backward by version and disk number,
  35.   · Printing and exporting data,
  36.   · Add Fish that recognizes the "original" listing format,
  37.   · Deleting fish from the database,
  38.   · Reindexing the database,
  39.   · Iconifying,
  40.   · Custom screen support.
  41.  
  42. I hope that for the moment you can live without these features.  Release
  43. 2.0 offers a lot, however, that Release 1 did not:
  44.  
  45.  
  46.  
  47. FEATURES OF RELEASE 2.0
  48.  
  49.   · Connects to a currently running KingFisher 2.0 Database Server,
  50.  
  51.   · Starts up the KingFisher 2.0 Database Server if not currently running;
  52.     the KFServer must reside in the same directory as KingFisher 2.0 for
  53.     this feature to be functional.  Alternatively, the tooltype or config
  54.     entry "SERVERNAME=volume:path/KFServer" may specify an alternate path
  55.     AND filename for the KingFisher 2.0 Database Server.
  56.  
  57.   · Allows selecting a database other than the default database,
  58.  
  59.   · Resizable GadTools interface, sensitive to proportional fonts, even
  60.     with a word-wrapping and proportional font sensitive ListView,
  61.  
  62.   · Display format is sensitive to database contents and will omit the
  63.     display of fields that do not exist (or are empty,)
  64.  
  65.   · Forward and backward motion through the database, one fish at a time,
  66.  
  67.   · Offers logical search expressions of the form
  68.                    fieldname comparison constantvalue
  69.     combined with boolean operators & (AND), | (OR), and ^ (XOR), as well
  70.     as ! or ~ (NOT) for negating an expression.  Expressions can be grouped
  71.     into more complex ones with the use of parentheses.  Errors in the
  72.     expression are diagnosed with a small set of error messages.
  73.          Comparison operators are the common < <= > >= = (==) and != (<>)
  74.     In addition, the $ is also used to be read as "contains," i.e.
  75.                    name$kingfisher
  76.     means "field name contains the string 'kingfisher'."  Constant values
  77.     must be quoted with "" or '' if they contain any special symbol such as
  78.     & | ^ a blank space or closing parenthesis.
  79.  
  80.   · A meta-field '*' may be used to signify ALL fields.  Thus, the
  81.     expression "*$fish" searches for the substring "fish" in all fields.
  82.     This is what KingFisher Release 1 did with the expression "fish"; old
  83.     expressions may thus be translated by preceding all keywords with the
  84.     characters "*$" to denote substring searches in all fields.
  85.  
  86.     This has not been found to be functional as of the BETA 6 release
  87.     and not been sufficiently tested as of BETA 9; my apologies!
  88.  
  89.   · Scans a single file and allows addition of its contents to the current
  90.     database,
  91.  
  92.   · Handles both a KingFisher Release 1 and the new Release 2 database
  93.     format with equal grace.  KingFisher Release 1 index files will be
  94.     converted to Release 2 format index files; this causes the files to be
  95.     unusable with KingFisher Release 1; use backup copies of the index file
  96.     to be able to go back to the old release.
  97.  
  98.  
  99. BUGS
  100.  
  101.   · Loses about 4272 bytes of memory each time invoked,
  102.  
  103.   · Sometimes crashes with a privilige violation (8000 0008) gury; This one
  104.     hasn't bitten me in a while, but I haven't found a spot in the code
  105.     which was definitely responsible for the problem, so I suspect it's
  106.     only gone into hiding for the moment.
  107.  
  108.   · Is not always graceful or overly informative when the server is not
  109.     responsive, or when some other problem exists with the connection to
  110.     the server; I hope to clean that up a bit and make things more
  111.     explicit,
  112.  
  113.  
  114. VERY NEAR FUTURE (By second week? of April 1994)
  115.  
  116.   · Recursively scanning a directory tree for .Product-Info, Product-Info,
  117.     or #?.pi files to be added to database; the current version of this
  118.     command is not functional; it stops after the first file,
  119.  
  120.   · Following existing version links (currently only part of KingFisher
  121.     Release 1 indexed databases),
  122.  
  123.   · Skipping forward and backward to disk boundaries (currently implemented
  124.     only as part of KingFisher Release 1 indexed databases),
  125.  
  126.  
  127. NEAR FUTURE (Most likely late April or May)
  128.  
  129.   · Quick Index based on a field in the database (usually the name) which
  130.     is used automatically if a search involves only a field so indexed,
  131.  
  132.   · Saving a history of search expressions to take the place of and expand
  133.     upon the 6 fields that KingFisher Release 1 used; these will be
  134.     selectable from a ListView,
  135.  
  136.   · Saving current positions in each used database so that skipping back
  137.     and forth between databases does no reset to the first fish,
  138.  
  139.   · Saving position and size of (all?) windows that KingFisher opens,
  140.  
  141.   · Modifying and examining flags associated with each fish,
  142.  
  143.   · Assigning and modifying disk numbers to ranges of fish,
  144.  
  145.   · Printing and Exporting
  146.  
  147.   · User-defined display, print, and export formatting with the same power
  148.     as the built-in contents senstive display,
  149.  
  150.   · Full localization,
  151.  
  152.  
  153. FURTHER FUTURE (Maybe implemented during the Summer 94)
  154.  
  155.   · Defining new databases interactively (i.e. where files are, how they
  156.     are split up, index file names, etc)
  157.  
  158.   · Automatic printing, exporting, assigning of new flags, etc during a
  159.     search,
  160.  
  161.   · Clipboard support,
  162.  
  163.   · Searching within a range of fish,
  164.  
  165.   · Reindexing a database (rebuilding a damaged index,)
  166.  
  167.   · Status display (i.e. similar to what "KFSERVER STATUS" prints out,)
  168.  
  169.   · AmigaGuide® Help just as in KingFisher Release 1,
  170.  
  171.   · Viewing search results as if they were a subset of the full database,
  172.     rather than viewing matches as they occur and proceeding from there
  173.     (which is how KingFisher Release 1 does it,)
  174.  
  175.   · Starting a second KingFisher client from with KingFisher to allow easy
  176.     background searches or simultaneous, side-by-side access to multiple
  177.     databases,
  178.  
  179.   · Sensitivity to display aspect ratio.  At this time, KingFisher 2.0 uses
  180.     a 1:1 aspect ratio for its gadgets; it will become sensitive to this in
  181.     the future and adopt a more pleasing imagery for older systems,
  182.  
  183.   · Delete fish from the database that have a DELETE flag set,
  184.  
  185.   · Use of a custom screen instead of only Public (or Workbench) screens,
  186.  
  187.   · Iconification to the Workbench,
  188.  
  189.   · Maintain multiple Search Sets (even saved on disk) to which one can
  190.     return at any time,
  191.  
  192.   · User-selectable display font for the interface, rather than the use of
  193.     the default system font.
  194.  
  195.  
  196.  ._.  Udo Schuermann
  197.  ( )  walrus@wam.umd.edu
  198.