home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / LISTV10.ZIP / RALISTER.DOC < prev    next >
Encoding:
Text File  |  1996-04-13  |  13.7 KB  |  334 lines
  1.                         · ∙ Imagine Productions ∙ · 
  2.                                   Presents  
  3.  
  4.                                  RA-Lister
  5.                                  ▀▀▀▀▀▀▀▀▀
  6.                                 Version 1.0
  7.                                                     
  8.                           (C) 1996 by Jason Raphael
  9.  
  10.    ─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-─-
  11.    
  12.                      ─═─ Welcome to RA-Lister v1.0! ─═─
  13.                        
  14.    RA-Lister v1.0 was programmed and designed by Jason Raphael, April 1996.
  15.                       Completed at 10:46am, 04-13-96.
  16.  
  17.                                     - 1 - 
  18.  
  19.  ──═════════════════════──
  20.      Table of Contents
  21.  ──═════════════════════──
  22.  
  23.     Table of Contents........1
  24.     Information..............2
  25.     Legal Information........3
  26.     Archive Contents.........4
  27.     Installation.............5
  28.     Program Usage............6
  29.     Editing BBS List.........7
  30.     RA-Lister Log............8
  31.     Registration.............9
  32.     Credits..................10
  33.     Support..................11
  34.     Other Fine RA Utils......12
  35.  
  36.                                     - 2 -
  37.  
  38.  ──═════════════════════──
  39.         Information
  40.  ──═════════════════════──
  41.  
  42.     RA-Lister is a RemoteAccess questionnaire (q-a) script.  This means that
  43.     it will load extremely fast from RA, and you can still see the RA status
  44.     bar and use all RA SysOp keys while in the program.  RA-Lister has many
  45.     features, including:
  46.  
  47.         - Ability for users to add their own entries..
  48.         - Full logging of all activity in RA-Lister to a separate log..
  49.         - Creates a very nice, professional looking listing..
  50.         - Will not allow a user to enter a listing without all necessary
  51.           information - If a field is left blank, the user is prompted to 
  52.           abort the entry..
  53.         - Easy to edit listing..
  54.         - ...And much more!
  55.  
  56.    - Notice on modifications of questionnaire:
  57.  
  58.      Although I don't see any reason to, you may modify the text in this 
  59.      questionnaire (such as the menus, etc).  I only have one small 
  60.      requirement about this: You must leave the blue status bar at the top 
  61.      of every screen (as it is now) with the program name on it, the exact 
  62.      way it is by default.
  63.  
  64.                                     - 3 -
  65.  
  66.  ──═════════════════════──
  67.      Legal Information
  68.  ──═════════════════════──
  69.     
  70.     Neither myself (Jason Raphael) nor Dream Scape BBS can be held 
  71.     responsible for any damage this program may cause on your system.  It
  72.     HAS been thoroughly tested on my system as well as other systems, and to 
  73.     the best of my knowledge works fine.  After all, it is only an RA 
  74.     questionnaire. <grin> :)  If you DO for some reason encounter any 
  75.     problems with it, however, neither of the above mentioned parties take 
  76.     any responsibility for it.
  77.  
  78.     You are encouraged to distribute RA-Lister, as long as it is in its
  79.     original archive with all files included and NOT modified in any way.
  80.     
  81.                                     - 4 -
  82.  
  83.  ──═════════════════════──
  84.      Archive Contents
  85.  ──═════════════════════──
  86.  
  87.     The RA-Lister archive (LISTV10.ZIP) should contain the following files:
  88.       DONATE.FRM     Donation form
  89.       FILE_ID.DIZ    Program identification
  90.       INSTALL.BAT    Installation program
  91.       LISTER.20X     Main Q-A file for RA v2.0x
  92.       LISTER.25X     Main Q-A file for RA v2.5x
  93.       LISTER.BAT     Batch file used by RA-Lister
  94.       RALISTER.DOC   RA-Lister documentation (you're reading it!)
  95.       README.1ST     Important installation information
  96.       
  97.     The following files will be created after RA-Lister is executed:
  98.       LISTER.ANS     BBS listing ANSI screen (in your textfiles dir)
  99.       LISTER.LOG     RA-Lister logfile (only with RA 2.5x) (in your RA dir)
  100.  
  101.                                     - 5 -
  102.     
  103.  ──═════════════════════── 
  104.        Installation
  105.  ──═════════════════════──
  106.  
  107.      For quick and simple installation, please run INSTALL.BAT (included with
  108.      RA-Lister).  This program will detect what version of RemoteAccess you 
  109.      are running, and copy all necessary files to their proper locations.  
  110.      All that you will need to do after running INSTALL is add the option
  111.      to run RA-Lister in the menu(s) you'd like.  
  112.  
  113.      INSTALL.BAT will do the following items for you:
  114.  
  115.      - Select the appropriate questionnaire for your system (based upon what
  116.        version of RemoteAccess you are using) and copy it to your 
  117.        RemoteAccess questionnaire directory.  (Due to certain options RA 
  118.        2.5x's questionnaire script has that RA 2.0x's does not, there are two 
  119.        Q-A files included with this program.  If you're running RemoteAccess 
  120.        v2.0x, LISTER.20X will be renamed to LISTER.Q-A.  If you're running 
  121.        RemoteAccess v2.5x, LISTER.25X will be renamed to LISTER.Q-A.  The 
  122.        main difference between the 2.0x enhanced version and the 2.5x 
  123.        enhanced version of RA-Lister is logging: Logging of activity within 
  124.        the program is only available within the 2.5x version.)
  125.      
  126.      - Copy LISTER.BAT to your RemoteAccess system directory for RA-Lister to
  127.        access.  If for some reason your RA system directory is not in your
  128.        PATH statement, you will need to move it to a directory that is (such
  129.        as C:\DOS).
  130.      
  131.      INSTALL needs only three pieces of information to properly run:
  132.      
  133.      - The TXTFILES environment variable must point to your RA textfiles 
  134.        directory (ex: SET TXTFILES=D:\TXTFILES).  RA-Lister requires that 
  135.        this variable be set for the program to operate.
  136.  
  137.      - The RA environment variable must point to your RemoteAccess system
  138.        directory (ex: SET RA=D:\RA).
  139.  
  140.      - The full path (including drive letter) to your RA questionnaire 
  141.        directory must be specified on the commandline WITHOUT A TRAILING
  142.        BACKSLASH (ex: INSTALL D:\RA\Q-A).
  143.  
  144.      Now, all that is left is to add the option in your menus:
  145.  
  146.     ∙ Setting up RA-Lister v1.0 in a RemoteAccess menu
  147.      
  148.      a) Enter RACONFIG -> Menu editor
  149.      b) Go to the menu(s) that you wish to have an option to run RA-Lister on.
  150.      c) Make a new menu entry as follows:
  151.  
  152.  Action   Execute a questionnaire (Type 12) 
  153.  Display  ;         <-- Your display may vary
  154.  OptData  LISTER    
  155.  HotKey   L         <-- Your hotkey may vary
  156.  AutoExec No
  157.  Colour   Colour example
  158.  
  159.  MinSec   0                  TimeUsed 0                  FlatCost 0
  160.  MaxSec   0                  TimeLeft 0                  TimeCost 0
  161.  A flags  --------           Age      0                  Terminal ANSI RIP
  162.  B flags  --------           MinSpeed 0                  Nodes
  163.  C flags  --------           MaxSpeed 0                  Groups
  164.  D flags  --------           Credit   0                  DayTimes
  165.  
  166.      You must have an ANSI driver loaded (such as ANSI.SYS) to use RA-Lister.
  167.  
  168.      At this point in time, RA-Lister does not support ASCII.  Make sure that
  169.      you set the terminal type to ANSI and RIP, since ASCII is not supported.
  170.  
  171.      If there is enough demand, RA-Lister could support ASCII in a future 
  172.      release.
  173.  
  174.      NOTE: If you're currently running RA v2.0x, and you upgrade to v2.5x 
  175.            at a later time, repeat these steps again to upgrade to the    
  176.            2.5x enhanced version of RA-Lister.                                     
  177.      
  178.                                     - 6 - 
  179.  
  180.  ──═════════════════════──
  181.        Program Usage
  182.  ──═════════════════════──   
  183.  
  184.     RA-Lister is very simple and easy to use.  Upon entering the program,
  185.     you are presented with the following menu:
  186.  
  187.                                 V) View BBS listing
  188.                                 A) Add BBS to listing
  189.                                 Q) Quit RA-Lister
  190.  
  191.     Selecting 'V' to view the BBS listing will, of course, display the BBS
  192.     listing database.  Option 'A' takes the user through a question process
  193.     to add a new BBS to the list, and obviously 'Q' exits the program and
  194.     returns to the BBS.
  195.  
  196.                                     - 7 - 
  197.  
  198.  ──═════════════════════──
  199.       Editing BBS List
  200.  ──═════════════════════──   
  201.  
  202.     Editing the BBS list that RA-Lister creates and uses is also quite simple
  203.     to do.  The BBS list is located in your RA textfiles directory with a
  204.     filename of LISTER.ANS.  Just load your favorite ANSI screen editor (such
  205.     as TheDraw), load LISTER.ANS, and make any changes/deletions you want to.
  206.  
  207.                                     - 8 - 
  208.  
  209.  ──═════════════════════──
  210.        RA-Lister Log
  211.  ──═════════════════════──   
  212.     
  213.     RA-Lister will create a logfile of all activity.  The time a user entered
  214.     the program will be logged, as well as any additions they make to the
  215.     BBS list.  Here is an example of how the logfile will look after someone
  216.     adds an entry:
  217.     
  218.     RA-Lister executed by Jason Raphael [Jammer] on node 2 (03-20-96, 20:11)
  219.     - Added BBS entry: Dream Scape BBS
  220.     - Exited RA-Lister (20:11)
  221.     
  222.     The RA-Lister logfile will be created in your RA system directory with 
  223.     the filename LISTER.LOG.
  224.  
  225.     NOTE: Due to to certain options RA 2.5x's questionnaire script has that 
  226.           RA 2.0x's does not, logging is only available in the 2.5x version
  227.           of RA-Lister (see Installation section of documentation for more
  228.           information).
  229.  
  230.                                     - 9 -
  231.  
  232.  ──═════════════════════──
  233.         Registration 
  234.  ──═════════════════════──    
  235.     
  236.     You are not required to pay any kind of fee to use this program.  I've
  237.     put a lot of my time into making RA-Lister look just right, fixing every 
  238.     little detail, etc.  There are no special features or extras you get for 
  239.     sending a donation, but I'm definitely more likely to release future 
  240.     versions and other q-a programs if I were to receive some donations.  I 
  241.     suggest a small donation of $5.  Please see DONATE.FRM for donation 
  242.     information.  
  243.     
  244.     Even if you choose not to donate, if you enjoy the program, I'd really 
  245.     appreciate receiving some kind of postcard or letter from you.  My 
  246.     mailing address is at the end of this document.
  247.  
  248.                                     - 10 -
  249.  
  250.  ──═════════════════════──    
  251.           Credits       
  252.  ──═════════════════════──    
  253.  
  254.     Although RA-Lister is a somewhat new project, a lot of work has been put
  255.     into it.  There are some people that I'd like to thank for their help, 
  256.     without which RA-Lister wouldn't be where it is today (in no particular 
  257.     order):
  258.          - Brad Meyer, Imagine Productions beta tester and internet 
  259.            distributor for his support, ideas, and testing of RA-Lister, as 
  260.            well as his distribution of Imagine Productions programs via the 
  261.            internet..
  262.          - Andrew Milner - If it weren't for him, RemoteAccess wouldn't be
  263.            here, and this program would be useless.
  264.  
  265.                                     - 11 -
  266.  
  267.  ──═════════════════════──    
  268.          Support
  269.  ──═════════════════════──    
  270.  
  271.     You can always obtain the latest version of RA-Lister by:
  272.      ∙ FREQing magicname RA-LISTER from Dream Scape BBS, 1:284/22, any time
  273.        but ZMH up to 28.8 bps..
  274.      ∙ Logging on to the Imagine Productions Support Site: 
  275.        Dream Scape BBS - 417-883-4035..
  276.      ∙ From the official Imagine Productions World Wide Web site:
  277.        http://www.cland.net/~dsbbs/imagine.html
  278.  
  279.     If you're having any problems with RA-Lister v1.0, if you have a 
  280.     suggestion for a future version, or need to contact me for some other
  281.     reason, there are several ways you can do so:
  282.  
  283.     - Send FidoNet netmail: 1:284/22
  284.     - Logon to Dream Scape BBS: (417) 883-4035
  285.     - Send internet e-mail: jason.raphael@c-matrix.springfield.mo.us
  286.                        -or- jammer@cmaster.com
  287.     - Post a message to me in the RA_UTIL FidoNet echo
  288.     - Send me mail via U.S. Postal service:
  289.                 Dream Scape BBS
  290.                 1730 East Republic Road A-123
  291.                 Springfield, MO  65804-7502
  292.  
  293.                                     - 12 -
  294.  
  295.  ──═════════════════════──    
  296.     Other Fine RA Utils
  297.  ──═════════════════════──    
  298.  
  299.     Be sure to check out these other fine RemoteAccess utilities by Imagine
  300.     Productions:
  301.  
  302.                 RA-Pager v1.55 - SysOp pager for         
  303.                 RemoteAccess v2.0x and v2.5x.           
  304.                 ----------------------------------------  
  305.                 Many improvements over RA's internal   
  306.                 pager.  Allows you to continue using   
  307.                 RA's SysOp chatter with a much         
  308.                 improved interface and many more       
  309.                 features such as:                      
  310.                 - Full logging of all activity/page    
  311.                 reasons to a separate log 
  312.                 - Full lightbar support of all prompts
  313.                 - Moving bars during paging
  314.                 - Page reason and leave message prompt,
  315.                   just like in registered RA
  316.                 ..And much more!        
  317.                 * Another fine RA Q-A program *         
  318.  
  319.  [FREQable from 1:284/22 as magicname: RA-PAGER]
  320.  
  321.  
  322.                            - RAPSA v1.0 -    
  323.    
  324.                 RAPSA is a simple batch file utility 
  325.                 to adjust the status of RemoteAccess 
  326.                 paging (on or off) from your DOS prompt.
  327.  
  328.  [Distributed with RA-Pager archive]
  329.  
  330.              - - - - - - - - - - - - - - - - - - - - - - - - - - - 
  331.              - Visit Imagine Productions on the World Wide Web!  -
  332.              -     http://www.cland.net/~dsbbs/imagine.html      -
  333.              - - - - - - - - - - - - - - - - - - - - - - - - - - - 
  334.