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