home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / comm / misc / 032 / rahelp.doc < prev    next >
Encoding:
Text File  |  1993-05-31  |  6.8 KB  |  159 lines
  1. RAHelp v1.10
  2. Help/TextFile Full-Screen Driver
  3. Written by Ken Reily and Chris Bongaarts
  4.  
  5. Gotta get this outta the way...
  6.  
  7. If any computer related component blows up, it's not my fault.
  8.  
  9. Ok, now to the fun stuff...
  10.  
  11. What is it: It's a program!
  12.  
  13. Besides that: It's a full-screen text(help) file driver for RA or
  14. QuickBBS. It was intended for scrolling through help files, but it can
  15. be used for just about anything.
  16.  
  17. Installation...
  18.  
  19. Ok, here's basically how it works. UnZIP this archive into a separate directory
  20. on your HD. Put the RAHELP.CFG file in the path that RAHELP will be called from
  21. (usually the RA system directory or, if using a type 15 exit, wherever you
  22. decide to CD to in your batch file.) You should call this from a type 7 menu
  23. item in RA (Or type 15 for patient people). Since this program is not exactly
  24. memory efficient, we strongly suggest you use the swap to disk function. Call
  25. RAHELP from your menu item's
  26.  
  27. Optional Data line like this:
  28.  
  29.    <path>RAHELP.EXE*M <FILENAME> <DATAFILENAME>.DAT [DEBUG]
  30.  
  31. Where: RAHELP.EXE is the program.
  32.  
  33.        <FILENAME> is the file name to display before the
  34.                   main menu. This is usually the help file for the
  35.                   current area the user is in. This file need not be
  36.                   in the RAHELP.DAT file.
  37.  
  38.    <DATAFILENAME> When it is started up, RAHelp searches the command
  39.                   line for a filename with the .DAT extension. If found,
  40.                   RAHelp will use this data(menu) file instead of the
  41.                   default RAHELP.DAT. This will allow you to call RAHelp
  42.                   with many different menus. This option is not
  43.                   required, if ommitted RAHelp will use the default RAHELP.DAT
  44.                   filename.
  45.  
  46.        [DEBUG]    is a parameter that will cause the program to stop
  47.                   and display all system variables. Use this if you
  48.                   think that something is not being read correctly
  49.                   from the config file. This was put in mainly for my
  50.                   purposes, but you can use it if you like...
  51.  
  52.                   *M, of course, indicates the Swap function.
  53.  
  54. The two Data files you will need are RAHELP.CFG, the configuration file, and
  55. RAHELP.DAT, the file containing the files to be displayed and their
  56. descriptions. Let's go through RAHELP.CFG.
  57.  
  58. RAHELP.CFG is the configuration file. This must be placed in the
  59. directory that RAHelp is called from. This is the first file RAHelp will
  60. read, and contains all the names of operating directories that will be
  61. used in the course of the programs operation. Please refer to
  62. instructions placed inside the config file. Only the first 11 lines are
  63. read, anything after that is used for comments.
  64.  
  65. The RAHELP.DAT file is basically your menu file. It is entered as an ASCII text
  66. file in the following format:
  67.  
  68. Column 1        Column 15
  69. MSGHELP         Help Entering Messages
  70. FILEHELP        Help with File XFers
  71. DISCLAIM.TXT    Disclaimer! Read this!
  72. *FILES          Files Help Menu
  73.  
  74. The file to display, extension or no extension, should begin on column one(1).
  75. The description (What actually appears on the main menu) should start at column
  76. 15 and go through column 72. Any ASCII text can be entered for either of these.
  77. If there is no extension specified, then .ASC or .ANS is used depending on the
  78. status of the users ANSI bit. You may have up to 100 help files in RAHELP.DAT
  79. as of this writing. Future versions may include formatting of menus, thus
  80. shortening the description length;  you should plan your descriptions
  81. accordingly.
  82.  
  83. Adding a * in front of the file name denotes a MENU file. This is
  84. another file with the same format as the RAHELP.DAT file. The .DAT
  85. extension is implied. For instance, *FILES would indicate the fact that
  86. the program will use the FILES.DAT file for the menu. Be sure to include
  87. a path back to the main menu in your new menu file. Just add the line...
  88.  
  89. [Column 1]    [Column 15]
  90. *RAHELP       Main RAHelp Menu
  91.  
  92. ...to the end of the file.
  93.  
  94. RAHelp has been successfully tested on a 80386sx-16, a 4.77Mhz PC, and a
  95. 80386dx-40. If you expierience problems with your machine, or if you
  96. find the speed of the program(over the modem) unsatisfactory, please let
  97. us know on the comment line of your registration form.
  98.  
  99. In some cases, the screen you as a sysop see will not be the same as the
  100. screen that the user sees. Please remember that RAHelp reads the user's
  101. Screen Length from the EXITINFO.BBS file and uses it to size it's
  102. displays. If the display the user has is longer than the display you
  103. have, things will look like they are scrolling by on the local side,
  104. when in actuality the user sees everything just fine. Just don't panic,
  105. we plan to address this problem in the future, probably by adding VGA
  106. support for 43/50 line mode if necessary.
  107.  
  108. Please make sure that all your ANSI screens are saved without screen
  109. mode manipulation commands. Commands that clear the screen and move the
  110. cursor around tend to make RAHelp lose its place. We would put in a
  111. filter for these characters, but then that causes the display to lose
  112. alot of speed. If you are expieriencing problems with these, take out
  113. those codes. Also be sure and save all ANSI screens with NO maximum line
  114. length, this causes a great speed increase in RAHelp.
  115.  
  116. Another suggestion for a speed increase. Before the program is run,
  117. execute the command SET OUTBUFF=ON. This will cause outbound buffering
  118. and allow for a great speed increase. Set this to off after you are
  119. finished.
  120.  
  121. Registration of this program as of v1.0 costs only $5. Future versions
  122. may have increased registration fees, so getting your registration
  123. number now insures minnimum investment. Your registration number will be
  124. good for all future versions of RAHelp. Send $5 check or money order
  125. with the registration form to:
  126.  
  127.         Ken Reily
  128.         8432 Virginia Rd.
  129.         Bloomington, MN  55438
  130.  
  131. A thousand thanks to:
  132.  
  133. John Parlin (Author of JPDoor) for his perserverence in answering my
  134.    stupid questions, and for making this program so much easier to
  135.    bring to you
  136.  
  137. John Jacobs for being a great guy, and lending a routine or two
  138.  
  139. All the users of "The Game Center BBS" for helping me during the
  140.    seemingly endless period of testing and re-working
  141.  
  142. Michael Bolton, Amy Grant, Steven Spielberg, and Hans Zimmer
  143.    for providing the entertainment that keeps me out of the
  144.    nuthouse while working on this...
  145.  
  146. Greg Jansen of Mudday Waters BBS for keeping me REALLY busy on his many
  147.    suggestions for this, some of which have not been implemented as of
  148.    this version.
  149.  
  150. For more info, comments, suggestions, a good
  151. conversation, and a great time, call
  152.  
  153. The Game Center BBS   (612) 942-7531
  154. 9600 baud -- 24 hours
  155.  
  156. FidoNet                 1:282/54
  157. MetroNet                200:5005/13
  158. InterNet E-Mail         divebomb@tdkt.kksys.com
  159.