home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / bblist3a.zip / MANUAL.DOC < prev    next >
Text File  |  1995-10-03  |  9KB  |  192 lines
  1.                                   INSTALLATION
  2.  
  3.     Installation of BBS Lister is simple: create a subdirectory called DOOR
  4. of your main Maximus directory, and create a subdirectory of DOOR called
  5. BLIST. Extract all the files into the DOOR\BLIST directory.
  6.  
  7.  
  8.                                  CONFIGURATION
  9.  
  10.     BBS Lister uses one configuration file, called LIST.CFG. This name is
  11. hard-coded into the program, as are the names and locations of the display
  12. files. There are 5 display files, with a different last letter for each
  13. main display file.
  14.  
  15.  
  16.  
  17.     BBS Lister uses one configuration file, called LIST.CFG. This name is
  18. hard-coded into the program, as are the names and locations of the display
  19. files. There are 5 display files, with a different last letter for each main
  20. display type. The names of the display files for callers with ANSI or AVATAR
  21. graphics end with the letter "a", and names of the display files for callers
  22. using TTY mode end with the letter "t". The 5 main display files and their base
  23. names are:
  24.  
  25.  
  26.         BMENU       Main door menu
  27.         EDMENU      Menu for editing bbs information
  28.         BBSVIEW     Display screen for list of each bbs
  29.         INSTRUC     Instructions for users (BBS callers)
  30.         WELCOME     Initial display screen
  31.  
  32.  
  33.     The SysOp can configure all aspects of the program. The security level that
  34. is required to add to the list, view the list, edit already-existing entries,
  35. and download the bbs list can be altered through the configuration file. Enter
  36. the security level required to view the bbs list on line 1; enter the security
  37. level required to add to the bbs list on line 2; enter the security level
  38. required to enter the security level required to download the bbs list on Line
  39. 3, enter the security level required to edit bbs entries that are already
  40. in the database on line 4 and enter the security level required to delete bbs entries
  41. from the database on Line 5.
  42.     The display files can be customized in the same way all display files are
  43. customized in Maximus. To get you started, a MEC version of each of the files
  44. is included in the distribution package.
  45.  
  46.  
  47.                                    OPERATION
  48.  
  49.     The program starts by displaying to the caller the initial welcome screen.
  50. Then it shows the main door menu, and requests input from the user. The options
  51. on the main menu are: Add to List, View List, Change graphics mode, Show
  52. instructions, Download list, Quit the door, and log off the BBS from the door.
  53.  
  54.  
  55.                                ADDING A BBS ENTRY
  56.  
  57.     If the user chooses to add a bbs to the list, the program will check in the
  58. configuration file to see if their access level is at least the level entered
  59. on line 2. If they pass the access test, they will be prompted for data for
  60. each of the 9 fields that are stored for each event. These fields are:
  61.  
  62.         Date            The date of the event;
  63.         Begin Time      The time at which the event starts;
  64.         End Time        The time at which the event ends (if any);
  65.         Location        Where the event will take place;
  66.         Contact         The name of a person to contact for more information;
  67.         Telephone       The phone number of the person to contact;
  68.         descr1          Line 1 of the description of the event;
  69.         descr2          Line 2 of the description of the event;
  70.         Sponsor         The group or individual that is holding the event;
  71.  
  72.     The name of the user who entered the information is stored as the last
  73. item of information about the bbs. That person is the only one who can edit or
  74. delete the event (features planned for a future version of BBS Lister).
  75. The information entered by users is stored in a text file called BBS.LST. This
  76. file can be edited by the SysOp using any text editor.
  77.  
  78.     Once the user has entered all the information for a bbs, that information
  79. will be displayed on the screen, and the user will be given the opportunity to
  80. edit any of the fields (except the user field).
  81.  
  82.  
  83.                                 VIEWING THE LIST
  84.  
  85.     If the user chooses to view the bbs list, the program will check in the
  86. configuration file to see if their access level is at least the level entered
  87. on line 1. If they pass the access test, they will be shown each bbs entry.
  88. They will be asked to press enter to continue after the data for each bbs is
  89. displayed, until they reach the end of the list.
  90.     Once they reach the end of the list file, they will be returned to the
  91. main menu.
  92.  
  93.  
  94.                               EDITING A BBS ENTRY
  95.  
  96.     If the user chooses to edit the record for a bbs that is already in the
  97. list, the program will check in the configuration file to see if their access
  98. level is at least the level entered on line 4. If they pass the access test,
  99. AND if they are the user that originally entered the data, they will go through
  100. the process described below. If neither condition is true, they will be sent
  101. back to the program's main menu.
  102.      Whenever a BBS is found that matches the two criteria above, that entry
  103. will be displayed, and they will be asked if that is the BBS they want to edit.
  104. If they answer YES, they will be shown a menu that allows them to choose a
  105. field to edit. They will then be asked for information, and the edit menu will
  106. be repeatedly presented until they choose to quit.
  107.  
  108.  
  109.  
  110.                               DELETING A BBS ENTRY
  111.  
  112.     If the user chooses to delete a bbs that is in the list, the program will
  113. check in the configuration file to see if their access level is at least the
  114. level entered on line 5. If they pass the access test, AND if they are the user
  115. that originally entered the data, they will go through the process described
  116. below. If neither condition is true, they will be sent back to the main menu.
  117.      Whenever a BBS is found that matches the two criteria above, that entry
  118. will be displayed, and they will be asked if that is the BBS they want to
  119. delete. If they answer YES, that entry will be deleted, the subsequent entries
  120. will be moved up in the file, and the file will be truncated to accommodate the
  121. new size.
  122.  
  123.  
  124.                               CHANGE GRAPHICS MODE
  125.  
  126.     If the user chooses this option, they will be presented with the Maximus
  127. Chg_Video menu command. If they choose to change video modes, the change will
  128. be carried over to the BBS.
  129.  
  130.  
  131.                                SHOW INSTRUCTIONS
  132.  
  133.     This option will display the file INSTRUC?, which contains brief
  134. descriptions of the purpose of each command.
  135.  
  136.  
  137.                                DOWNLOAD BBS LIST
  138.  
  139.     This option allows the caller to download the text file that contains the
  140. information about all the bbses that have been entered by users or by the
  141. SysOp. The program will check to ensure that the caller's access level is at
  142. least equal to the access level entered in line 3 of the configuration file.
  143. The data file MUST be present in the MAX\DOOR\BLIST directory; this path is
  144. hard-coded in the program.
  145.  
  146.  
  147.                                 QUIT THE DOOR
  148.     This option allows the caller to exit the BBS Lister and return to
  149. the BBS.
  150.  
  151.  
  152.                                   GOODBYE BBS
  153.  
  154.     This option allows the caller to exit the door and hangup, without
  155. returning to the BBS.
  156.  
  157.  
  158.                                   REGISTRATION
  159.     THERE IS NO COST TO REGISTER THIS PROGRAM, OR, FOR THAT MATTER, ANY
  160. REGISTRATION PROCEDURE. This program is NOT crippled, and there are NO NAGS
  161. to encourage you to register. However, at the time of this writing, (September
  162. 4, 1995) I have no job, so I am asking anyone who finds this program useful
  163. to donate $5. Any donations can be sent to:
  164.  
  165.  
  166.                     James McCarte
  167.                     5715 St. Jacques, #3
  168.                     Montreal, QC
  169.                     H4A 2E7
  170.  
  171.  
  172.                               FUTURE IMPROVEMENTS
  173.  
  174.         - Allow ANSI ads as part of a BBS record, to be shown when
  175.           browsing the list
  176.         - Allow RIP ads as part of a BBS record, to be shown when
  177.           browsing the list
  178.         - Support for RIP graphics
  179.         - Allow callers to upload a text file to be imported into the
  180.           bbs list description field
  181.         - Search capability
  182.  
  183.  
  184.     If you have any suggestions on improvements to make to the program, or
  185. reports of bugs, you can contact the author, James McCarte, by the following
  186. methods:
  187.  
  188.  
  189.         - call MindSeed BBS at (514) 489-3212;
  190.         - email/netnail a message to James McCarte at IBMNet node 40:6499/115;
  191.         - write a letter to the address above.
  192.