home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 4 / CDPD_IV.bin / fish / fisher / sysop.doc < prev   
Text File  |  1994-03-27  |  8KB  |  247 lines
  1.  ---------------------------------------------------------------------------
  2.  
  3.                                 Fisher.rexx
  4.               ARexx/DLG Front End for the KingFisher Database.
  5.                       Copyright © 1994 Keith R. Burby
  6.                            [Sysop Documentation]
  7.  
  8.  ---------------------------------------------------------------------------
  9.  
  10.  
  11. Legal Stuff
  12. ¯¯¯¯¯¯¯¯¯¯¯
  13. The Fisher.rexx script and the documentation are copyrighted by the author.
  14. Feel free to make changes, to this program,to suit your needs, however, I
  15. ask two things:  1) If you feel that the changes you've made, to this
  16. program, are improvements or bug fixes, please send me a copy of the updated
  17. script with some notes regarding the changes you made.  2) Do not alter the
  18. program's title, in particular, the two lines which give credit to both
  19. myself and Mr. Shuermann.
  20.  
  21. The author accepts no responsibility for any damage to the system of anyone
  22. who uses this program.
  23. USE THIS PROGRAM AT YOUR OWN RISK.
  24.  
  25.  
  26. Features
  27. ¯¯¯¯¯¯¯¯
  28. Fisher.rexx is an ARexx/DLG BBS front end to Udo Schuermann's famous
  29. KingFisher database program, allowing users to now view, select, and request
  30. titles from the Fred Fish collection online.
  31.  
  32. Some of the features included are:
  33.  
  34. - The ability to step to the next or previous selection, version of the
  35.   current selection, or disk in the database.
  36.  
  37. - The ability to jump to the first entry of a specific disk, or even a
  38.   specific entry itself, with commands to jump to the first and last entries
  39.   without a hassle.
  40.  
  41. - The ability to conduct a search of either the titles or descriptions,
  42.   forwards or backwards, with the full pattern matching capabilities of
  43.   KingFisher available.
  44.  
  45. - The ability to optionally allow the user to send an E-Mail request, to the
  46.   sysop, for a specific title or disk.
  47.  
  48. In fact, most of the features that are available in KingFisher have been
  49. implemented in this script.
  50.  
  51.  
  52. Requirements
  53. ¯¯¯¯¯¯¯¯¯¯¯¯
  54. The following items are included in this archive:
  55.  
  56.   Fisher.rexx     (Script)
  57.   Fisher.doc      (User documentation)
  58.   Sysop.doc       (Sysop documentation [what you're reading])
  59.   KingFisher.cfg  (Blank configuration file)
  60.  
  61. The following items must be installed on your system, in order for
  62. Fisher.rexx to work:
  63.  
  64.   ARexx
  65.   DLG BBS/OS
  66.   KingFisher v1.40
  67.  
  68.  
  69. Installation
  70. ¯¯¯¯¯¯¯¯¯¯¯¯
  71. Just drop Fisher.rexx and KingFisher.cfg in the appropriate directory(ies).
  72.  
  73.  
  74. Setting Up
  75. ¯¯¯¯¯¯¯¯¯¯
  76. Both Fisher.rexx and KingFisher.cfg will need to be configured for your
  77. system's setup.
  78.  
  79.  
  80.   Fisher.rexx
  81.   ¯¯¯¯¯¯¯¯¯¯¯
  82.   The following variables will need to be changed to suit your setup.
  83.  
  84.     KingFisher.Path  = "DH1:Database/KingFisher"
  85.     KingFisher.Prefs = "DOORS:Fisher/KingFisher.cfg"
  86.     KingFisher.Port  = "KINGFISHER1"
  87.     KingFisher.Quit  = TRUE
  88.  
  89.     Sysop = "Keith_Burby"
  90.  
  91.     RightMargin = 77
  92.  
  93.   The variabes are:
  94.  
  95.     .Path       -- The complete path/filename of the KingFisher program.
  96.     .Prefs      -- The complete path/filename of the configuration file.
  97.     .Port       -- The name of the ARexx port to access (UPPER CASE).
  98.     .Quit       -- Whether or not to quit KingFisher upon exit of the script.
  99.  
  100.     Sysop       -- Sysop's name, with spaces changed to underscores.
  101.     RightMargin -- Right margin for text formatting.
  102.  
  103.   NOTE:  Two constants, TRUE and FALSE, have been defined for use with the
  104.          .Quit variable.  Use either these names, or 1 and 0.  Any other
  105.          value assigned to .Quit will not be accepted.
  106.  
  107.   NOTE:  The Sysop variable is used for sending requests to the sysop via
  108.          E-mail.  If this variable is set to an empty string (""), the
  109.          request option will be disabled.
  110.  
  111.  
  112.   KingFisher.cfg
  113.   ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  114.   The following lines will need to be changed to suit you setup.
  115.  
  116.     # Datafile partitioning information
  117.     # Format:  begin-entry,end-entry,volume-name
  118.     FishData=0001,0500,
  119.     FishData=0501,1100,
  120.     FishData=1101,1700,
  121.     FishData=1701,2300,
  122.     FishData=2301,2900,
  123.     FishData=2901,3500,
  124.  
  125.     # Datafiles appended by KingFisher to appropriate paths
  126.     # Should contain TWO `%d' symbols (for first and last entry)
  127.     FishFileNames=DH1:Database/Fish-%04d-%04d
  128.  
  129.     # Unsplittable datafiles (path plus filename)
  130.     FishIndexFile=DH1:Database/Fish.Index
  131.     NameIndexFile=DH1:Database/Name.Index
  132.  
  133.   The variables are:
  134.  
  135.     FishData      -- These should have any path info removed.
  136.     FishFileNames -- Complete path/filename of KingFisher database.
  137.     FishIndexFile -- Complete path/filename of index file.
  138.     NameIndexFile -- Complete path/filename of name file.
  139.  
  140.   NOTE:  For further information, regarding KingFisher's configuration file,
  141.          please refer to the comments in the file and to KingFisher's
  142.          documentation.
  143.  
  144.   NOTE:  Experience has shown me that when using a custom setup that uses
  145.          CG/Outline fonts, KingFisher's load time will double, which I
  146.          consider unacceptable when going though a script, especially since
  147.          that pretty font can't be be seen anyhow.  Therefore, I've included
  148.          a "blank" configuration file, to be used with the script.  However,
  149.          usage of this configuration file is optional.  If you feel that
  150.          your configuration loads fast enough and you have complete paths
  151.          specified in the three lines mentioned, then feel free to use your
  152.          configuration and throw this one away.
  153.  
  154.  
  155. BBS Setup
  156. ¯¯¯¯¯¯¯¯¯
  157. Now all that's left is assigning a menu entry for the puppy.  Best place for
  158. the entry would be the files base.  Here's what the entry should look like:
  159.  
  160.   [ 1] Letter:                   !
  161.   [ 2] Executable: (path/name)   Rx DOORS:Fisher/Fisher %ANSI %USER
  162.   [ 4] Description:              Fisher - KingFisher database
  163.   [ 5] Type:                     Executable
  164.   [ 6] Help File:                FILE_MAIN/!
  165.   [ 7] Lower level:              1
  166.   [ 8] Upper level:              255
  167.   [ 9] Hidden:                   NO
  168.   [10] Load type:                OVERLAY
  169.   [11] Ask user if sure:         NO
  170.   [12] Pend messages:            YES
  171.   [13] Cli mode:                 YES
  172.   [14] Pause on completion:      NO
  173.   [15] Log value:                None
  174.   [16] Activity string:          Gone fishing!
  175.   [17] Priority:                 DEFAULT
  176.   [18] Edit help file
  177.  
  178. After that, select entry #18, and upload the Fisher.doc (user documentation)
  179. to the help file.
  180.  
  181. NOTE:  The reason the type is an executable instead of ARexx macro is
  182.        because the only way to pass arguments, namely the user's name, via
  183.        the command line is by calling the script with Rx.
  184.  
  185. And on that note, you're good to go!
  186.  
  187.  
  188. Thanks!
  189. ¯¯¯¯¯¯¯
  190. A great deal of thanks goes to my good friend Dave Birdsong, current
  191. president of the Wateford Amiga Users Group and sysop of Midiland BBS
  192. (810/887-HELP).  Without his suggestion and allowing me access to his BBS
  193. this script wouldn't have been written, and without his constant pushing and
  194. nagging (and I'll get you for that :>) this script would have never left the
  195. Highland area.
  196.  
  197. Also, some recognition is due for Mr. Schuermann for his reliable and easy
  198. to use database program, THAT HAS AN AREXX PORT, without which, this script
  199. would pretty much be useless.  :>
  200.  
  201.  
  202. Future
  203. ¯¯¯¯¯¯
  204. Although the script is complete, it's far from done.  Currently in the
  205. planning stages are (from most important to least important):  Adding an
  206. option to export a range of entries to the user's private file area,
  207. Reorganizing the code to make it easier to modify for use with other Amiga
  208. based BBSes, and make the script interact with KingFisher in a more friendly
  209. manner.
  210.  
  211.  
  212. How to Contact Me
  213. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  214. If you have any comments, suggestions, or questions, regarding Fisher.rexx,
  215. please feel free to contact me.  I can be reached at:
  216.  
  217.   E-Mail
  218.   ¯¯¯¯¯¯
  219.   kb0s2113@sycom.mi.org
  220.   Arcane@lppl.mi.org
  221.   an989@freenet.buffalo.edu
  222.  
  223.   Support BBS
  224.   ¯¯¯¯¯¯¯¯¯¯¯
  225.   Midiland BBS 810/887-HELP
  226.                       (4357)
  227.   Snail Mail
  228.   ¯¯¯¯¯¯¯¯¯¯
  229.   Keith R. Burby
  230.   3800 Teeple Lake Road
  231.   White Lake, MI  48383
  232.   USA
  233.  
  234.  
  235. Finally
  236. ¯¯¯¯¯¯¯
  237. The script is free for your use and abuse, and while I'm not asking for any
  238. money, if you feel compelled to send some my way, I won't be ashamed to
  239. accept it. :>
  240.  
  241. Here's to hoping that you'll find my little diddy here a useful addition
  242. to your BBS.
  243.  
  244. As always.
  245.                                                   K/B
  246.                                                   ~~~
  247.