home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / REMIND12.ZIP / REMINDME.DOC < prev    next >
Encoding:
Text File  |  1992-08-30  |  14.4 KB  |  333 lines

  1.  
  2.                                REMIND ME !
  3.  
  4.                                   v1.2
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    The REMIND ME! Door allows your callers to enter REMINDERS to themselves.
  21.    They can be reminded daily, on a specific date, a day of the week or on 
  22.    a paricular date of the month. Reminders are displayed to the caller when
  23.    they open the Door or automatically if you make it an Auto Login Door. 
  24.    
  25.    SYSOP can leave reminders to ALL, specific Security levels or to
  26.    SPECIFIC USERS!!!!
  27.  
  28.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  29.          created in the directory you run the door from.
  30.  
  31.  
  32.  
  33.                               INSTALLATION
  34.                               ____________
  35.  
  36.  
  37.    Installation is fairly easy and straight-forward. The following steps and
  38.    examples should have you up and running in a very short period of time.
  39.    It is assumed that you are familiar with setting up DOORS on your system.
  40.    To this end, only examples of the configuration file and Door batch file
  41.    are described.
  42.  
  43.       1) Create a directory to hold all REMINDME files
  44.  
  45.       2) Unzip REMINDxx.ZIP into the the above directory
  46.  
  47.          NOTE: BRUN45.EXE is not included but is required !!!
  48.  
  49.       3) Create a configuration file, with a name of your choice, or
  50.          modify the supplied REMINDME.CFG file. A description follows:
  51.  
  52.             **                       Location of system file (See Below)
  53.             SUNRISE-80 BBS           Your BBS Name
  54.             Al                       Sysop's First nameAP
  55.  
  56.             Lawrence                 Sysop's Last Name
  57. |-----------------------------------------------------------------------------|
  58. | READ!     1                        CommPort  \ These 2 lines are required   |
  59. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  60. |-----------------------------------------------------------------------------|
  61.  
  62.             00000000                 Registration Number
  63.  
  64.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  65.                                      2 = Display ADOPT-A-DOOR message
  66.  
  67.             2                        Keyboard timeout value in Minutes
  68.  
  69.  
  70.             N                        Y =  Use European Date Format (DDMMYY)
  71.                                      N =  Use Regular  Date Format (MMDDYY)
  72.  
  73.            365                       Maximum # of days caller can enter in
  74.                                      response to the number of warning days.
  75.                                      This number will be used to determine how
  76.                                      many days prior to the due to start
  77.                                      displaying the Reminder. (0-365).
  78.                                      0 = No warning days
  79.  
  80.            365                       Maximum # of days caller can enter in
  81.                                      in response to how long the reminder
  82.                                      will remain active (1-365)
  83.  
  84.               0                       Additional Security level that will be
  85.                                       allowed to leave Reminders as if they
  86.                                       were the Sysop (Co-Sysop as an example)
  87.                                       Note: They will NOT be able to Delete or
  88.                                             Modify or Review messages they 
  89.                                             entered to a Specific caller or to
  90.                                             All Callers.
  91.               ** = Replace with ONE of the following:
  92.  
  93. C:\BBS\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  94. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  95. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  96.                                    (Note:DOOR.SYS must be in SAME directory)
  97. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  98. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  99. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  100. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  101. C:\BBS\GTUSER.BBS               <- For GT Power 
  102.                                    * if using this option you must put the
  103.                                      ComPort # on line 5 and the Node # on
  104.                                      line 6 of the configuration file
  105.  
  106.  
  107.  
  108.            # = Requires registration to change to a different value.
  109.  
  110.                NOTE: There are NO Blank Lines in the Config File!!
  111.  
  112.  
  113.  
  114.  
  115.       4) Create a batch file or modify the REMINDME file supplied. A
  116.          description of this file follows:
  117.  
  118.             ECHO off
  119.             cd\BBS\DOORS\REMINDME     Location of REMINDME files
  120.             REMINDME REMINDME.CFG     EXE filename and CFG filename (Name
  121.                                       used in creating file in #3 above)
  122.             CD\BBS
  123.             BOARD
  124.  
  125.  
  126.        5) When running in more than one node, be sure to supply a
  127.           different configuration name for each node (your choice of name).
  128.  
  129.  
  130.  
  131.                       AUTO LOGIN OPTION (Registered Version Only)
  132.                       -------------------------------------------
  133.  
  134.       Should you want to take your callers to the REMIND ME Door automatically
  135.       at logon I would suggest that you set up 2 batch files. 
  136.  
  137.       One batch file would take the caller to the Door if they selected it off
  138.       your Door Menu. They would be presented with any Reminders that have 
  139.       come due AND they will be able to use all the functions of the Door.
  140.       See #4 above for example.
  141.  
  142.       The second batch file would take your caller to the Door, present the
  143.       caller with any Reminders that have come due and immediately return to
  144.       the BBS. If REMIND ME finds a file called BACK2BBS.TXT, it will display
  145.       that file while the system is returning to the BBS. All that would be 
  146.       required would be to create another batch file as in #4 above, give it
  147.       another name (I use REMLOGIN, but you do what you have to depending on
  148.       your BBS software) and ADD   $BYPASS$   to the END of the Command line.
  149.  
  150.           Example: REMINDME REMINDME.CFG $BYPASS$
  151.              Note: $BYPASS$ must be the last parameter on the line
  152.                    Everything else in the batch file is the same as #4 above
  153.  
  154.  
  155.                         NON-STANDARD COM SUPPORT
  156.                         ________________________
  157.  
  158.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  159.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  160.       number after the configuration filename. Let's assume your Door is
  161.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  162.       passed to your Door would be:
  163.  
  164.                             FOOBAR FOOBAR.CFG /5
  165.  
  166.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  167.       normally used with COM1. No /x parameter is needed for the standard
  168.       IRQ's.
  169.  
  170.       As an alternative, you may use an environmental variable on the command
  171.       line. To use the variable (following the example above), place a 
  172.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  173.       different IRQ number for each node). The command line would now look 
  174.       like this: 
  175.  
  176.                           FOOBAR FOOBAR.CFG /%IRQ%
  177.       
  178.       This, in combination with the use of the environmental variables 
  179.       described in the MULTI-NODE SETUP section will allow you to use one 
  180.       batch file and one config file to run this door on all nodes.
  181.  
  182.  
  183.  
  184.  
  185.                            MULTI-NODE SETUP
  186.                            ________________
  187.  
  188.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  189.       ability to access a configuration file which will have its own system 
  190.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  191.       line. There are 2 ways to accomplish this:
  192.  
  193.       (1) Create a separate configuration file for each node. The only 
  194.           difference between each file would be the location of the system 
  195.           file for that particular node. For example, on my system there are 2
  196.           nodes and the first line of the config files would look like this:
  197.  
  198.                         NODE1:  H:\PCB1\DOOR.SYS
  199.                         NODE2:  H:\PCB2\DOOR.SYS
  200.  
  201.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  202.  
  203.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  204.           the following PCBoard environmental variables:
  205.  
  206.                  PCBDIR    (Directory containing the System file)
  207.                  PCBDRIVE  (Drive containing the System file)
  208.  
  209.           Thus, the first line of the SINGLE configuration file, for this Door
  210.           would look like this:
  211.  
  212.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  213.  
  214.       NOTE: This option, as described, assumes that you are running PCBoard 
  215.             14.5a software. The environmental variables are automatically 
  216.             created by the software for each node.
  217.  
  218.             HOWEVER, if you are running other BBS software you should be able
  219.             to set the variables EXACTLY as described below, for EACH node 
  220.             (more than likely in each batch file you use to bring up EACH node):
  221.  
  222.                             PCBDRIVE=C:
  223.                             ^^^^^^^^^
  224.                             PCBDIR=\NODE2
  225.                             ^^^^^^^^
  226.             
  227.             Info with a carat (^) under it, MUST be typed as is. The rest 
  228.             depends on your naming conventions. 
  229.  
  230.             This, in combination with the use of the optional environmental
  231.             variable described in the NON-STANDARD COM SUPPORT section, will
  232.             allow you to use one batch file and one config file to run this 
  233.             door on all nodes.
  234.  
  235.  
  236.  
  237.                                ADOPT-A-DOOR
  238.                                ____________
  239.  
  240.     Having been a Sysop for a number of years, I have had my share of problems
  241.     and frustrations getting financial support for my board's upkeep. A fellow
  242.     Sysop left a message on my board, not long ago, about a concept that was
  243.     being used by several boards around the country.
  244.  
  245.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  246.     would be the same as sending in a donation, only this way it is earmarked
  247.     for registering a particular door. In a way, the user feels he/she is
  248.     "getting something in return". As a Door author I have decided to build
  249.     this concept into each of my Door programs. The concept replaces the
  250.     usual message "tell the Sysop to register this Door" we find in most
  251.     doors.
  252.  
  253.     If the Door is unregisterd then a message appears on the opening screen
  254.     to that effect. After finishing or suspending a game, a message screen
  255.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  256.     caller to contact the Sysop to find out if there is any further details
  257.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  258.     time, etc to callers that ADOPT-A-DOOR.
  259.  
  260.     If the Door has been registered, either by the Sysop or other callers,
  261.     the names of those contributors will be displayed in the closing screen.
  262.  
  263.     NOTE: If you want to display the names of the callers that contributed
  264.           to registering the Door, you must create an ASCII file called
  265.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  266.           the name(s) of the contributors (one on each line, maximum of 5
  267.           entries, each a maximum of 30 characters long). This file must be
  268.           saved, in ASCII format, and placed in the Door directory.
  269.  
  270.  
  271.  
  272.                               LEGALITIES
  273.                               __________
  274.  
  275.  
  276.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  277.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  278.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  279.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  280.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  281.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  282.       OR BREACH OF ANY WARRANTY.
  283.  
  284.  
  285.  
  286.  
  287.  
  288.                              DISTRIBUTION
  289.                              ____________
  290.  
  291.    You may make this file available for downloading from your BBS or you may
  292.    upload it to any BBS of your choice, provided that you do not make any
  293.    changes to the contents of the archive (ZIP file). The archive and its
  294.    individual contents may not be used by any service that charges any money
  295.    whatsoever, without the written permission of the author.
  296.  
  297.  
  298.  
  299.  
  300.  
  301.                              REGISTRATION
  302.                              ____________
  303.  
  304.    Registration and the subsequent insertion of the registration number into
  305.    your configuation file, allows for the display of your BBS name on the
  306.    opening and closing screen as well as the reduction of a delay built into
  307.    the opening screen display along with the ability to change certain
  308.    values in the configuration file.
  309.  
  310.    To register your copy of REMINDME, please fill out the registration form
  311.    (REGISTER.FRM) and mail it along with the appropriate registration fee to
  312.    the name and address on the form.
  313.  
  314.    Be sure to use the proper upper/lower case when filling in your name and
  315.    BBS name, as they MUST match the way you entered them in the configuration
  316.    file.             ^^^^
  317.  
  318.    Based upon information supplied on the registration form, I will pre-
  319.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  320.    up your registration number.
  321.  
  322.  
  323.  
  324.                                  MISC
  325.                                  ____
  326.  
  327.    The latest version of REMIND  ME! and other fine SUNRISE DOOR programs
  328.    are always available for download from SUNRISE-80 BBS.
  329.  
  330.    Remember, should you have any problems, questions or suggestions, be sure
  331.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  332.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.
  333.