home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 8 / CDASC08.ISO / VRAC / CALCAT41.ZIP / CALCAT.DOC < prev    next >
Text File  |  1993-08-18  |  24KB  |  587 lines
  1.                            
  2.                            
  3.                            
  4.                            
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                            
  12.                            
  13.  
  14.  
  15.                            CalCat! Ver 4.0ß
  16.                            By Bart Flentje
  17.                            August 16, 1993
  18.  
  19.  
  20.        
  21.        
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.        Legal                                                            
  33.        
  34.        CalCat! is provided "AS IS" without any warranty of any kind,
  35.        either expressed or implied as to the merchantability or fitness
  36.        of purpose.  The risk as to the quality and performance of the
  37.        software is the end user's.  The Author shall have no liability
  38.        or responsibility to the user with respect to the liability, loss
  39.        or damage caused or alleged to be caused by this software,
  40.        including, but not limited to, any interruption of service, loss
  41.        of business or anticipatory profits or consequential damages
  42.        resulting from the use of, or the inability to use the software.
  43.  
  44.        The information in this document is subject to change without
  45.        notice and does not represent a commitment on the part of the
  46.        Author.
  47.      
  48.        
  49.        
  50.       
  51.        
  52.        
  53.        
  54.        
  55.        
  56.        
  57.        
  58.        
  59.        
  60.        
  61.        
  62.        
  63.        Copying and Distribution:
  64.  
  65.        CalCat! is (c) copyrighted 1992,1993 by Bart Flentje.  It is also
  66.        registered with United States Library of Congress as such.  That
  67.        means registered versions of CalCat! cannot be copied and/or
  68.        distributed without the express written consent of the author. 
  69.        However, CalCat! can be copied and distributed so long as it is an
  70.        unregistered version and is accompanied with the appropriate key 
  71.        designating it as SHAREWARE.  No  changes or modifications may be 
  72.        made without the authors approval.  It is also a violation to use 
  73.        CalCat!  past an authorized date unless a new key has been issued 
  74.        and released by the author.  IT IS a violation of Federal COPYRIGHT
  75.        Laws to distribute registered versions of this software whether it 
  76.        be the software itself or a registration key.
  77.      
  78.       
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.        Registration:
  92.  
  93.        CalCat! is NOT  public domain, it is SHAREWARE.  That means that 
  94.        you have to  pay registration fees ($10.00)  if you use CalCat! in  
  95.        any way or form.  The registration cost is minimal and considered 
  96.        to be below market standards. Registration fee will allow the author 
  97.        to  write new  and improved versions of CalCat!.  Registering your 
  98.        software will give you limited rights of use with no expiration.  
  99.        Registering your software also supports all new updates that may 
  100.        be developed.
  101.  
  102.         
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.          Description of files:
  116.  
  117.          - CALCAT.DOC    (This documentation)
  118.          - CONFIG40.EXE  (Database management utility)
  119.          - CALCAT40.EXE  (The CalCat! program file to be run as event)
  120.          - CALCAT.BAT    (Sample batch file to start CalCat! event)
  121.          - CALCAT.INI    (.INI configuration support file)
  122.          - CALCAT.DAT    (Holiday data file.  Back this up!)
  123.          - SWAP.DAT      (Swap screen data support file)
  124.          - RELEASE.DOC   (Version release information and history)
  125.          - HOLISCRN.ZIP  (Archive file containing 242 holiday screens)
  126.          - REGISTER.DOC  (This registers your SHAREWARE!!)
  127.  
  128.       
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.        What is CalCat! ?
  142.  
  143.  
  144.        CalCat! is a utility that was originally written for my BBS to  
  145.        automatically swap in a new HELLOX. screen on holidays, thus
  146.        saving me a lot of work.  It started out with just half dozen or
  147.        so major holidays and has progressed since.  Right now, CalCat!
  148.        is supplied with a data file that will check for over two hundred
  149.        holidays.  This data file has the necessary data to place your
  150.        holiday screens where you want them regardless of the year.  No
  151.        more monkeying with date shifting.  (e.g. President's Day is the
  152.        3rd Monday in February)  CalCat! does it for you.  Beyond that, 
  153.        CalCat! also allows you to randomly or sequentially swap in other 
  154.        screens on non-holiday days!  CalCat! is easy to setup and should 
  155.        be run as an event (preferred) or as postcall.bat by Wildcat!. 
  156.       
  157.  
  158.  
  159.  
  160.  
  161.  
  162.        How do I install CalCat! ?
  163.  
  164.        
  165.        There are four basic steps to setup CalCat!
  166.  
  167.        I.  Set up your new event directory.
  168.       II.  Customize your information and database files.
  169.      III.  Set up your event in Wildcat!
  170.     
  171.     
  172.      BEFORE YOU START!!!!!
  173.  
  174.      Delete any previous version of CalCat! from your directory for the
  175.      new version will use a NEW configuration for data!!
  176.      
  177.  
  178. I.
  179.     A. Create a new directory for CalCat!  For better organization,
  180.        I create a directory for each event that I run.  My CalCat!
  181.        event path looks like this:  C:\WC30\EVENT3
  182.     
  183.     
  184.     B. Copy all CalCat! files into your new event directory.  That will
  185.        include CALCAT40.EXE, CALCAT.INI, CALCAT.DAT, CONFIG40.EXE, SWAP.DAT,
  186.        and HOLISCRN.ZIP.  (the whole works)
  187.  
  188.     
  189.     C. Inside my event directory, I have created a sub directory for all 
  190.        of the holiday screens.  This is for purely organizational purposes. 
  191.        That path looks like such;  C:\WC30\EVENT3\SCREENS.  Here is where 
  192.        you have the new option.  You can either copy HOLISCRN.ZIP into
  193.        this sub directory or you can unzip the contents of HOLISCRN.ZIP
  194.        into the sub directory.  Which ever way you decide to go, you will
  195.        determine the setting when setting up the .INI file.
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.        
  204.        Here is an EXAMPLE of how my directory looks...         
  205.        _______________________________________________            
  206.                 Volume in drive C is MAX1!                   
  207.                 Volume Serial Number is 18DB-9CAD            
  208.                 Directory of C:\WC30\EVENT3                  
  209.                                                              
  210.                 .            <DIR>     08-28-93   2:07p      
  211.                 ..           <DIR>     08-28-93   2:07p      
  212.                 CALCAT   DAT      6756 10-31-93  12:01a     
  213.                 CONFIG40 EXE     64232 10-18-93  12:00a      
  214.                 CALCAT   INI        93 10-31-93   3:00p       
  215.                 CALCAT40 EXE     76162 10-31-93   3:00p
  216.                 CALCAT   BAT        12 10-31-93   3:00p
  217.                 CALCAT   DOC      8138 10-31-93   3:00p
  218.                 SWAP     DAT     56124 05-01-93  12:00a
  219.                 SCREENS      <DIR>     10-31-93   3:00p <- Screens go here.
  220.                     11 file(s)     151459 bytes
  221.                                1817217536 bytes free
  222.        _______________________________________________
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230. II.  Make sure you are now in your new event directory.  We'll modify your 
  231.      database files to suit your individual needs.  Run CONFIG40.EXE which 
  232.      is the database management utility.  
  233.  
  234.      First we need to modify personal details.  So choose option one (1)
  235.      from the menu which allows you to set up CalCat! for you and your
  236.      computer.  Edit CALCAT.INI menu option looks something like this:
  237.  
  238.  
  239.    SYSOP Name: Bart Flentje              <--- Sysops first and last name
  240.    BBS Name: Eagan Wildcat! BBS          <--- Name of your BBS
  241.    User Key: 0000000                     <--- Your user key here
  242.    SourcePath: C:\WC30\EVENT1\SCREENS\   <--- Path of Source Holiday Screens
  243.    TargetPath: C:\WC30\DISP\             <--- Path to Display Screens
  244.    Archive File: HOLISCRN.ZIP            <--- Name of ZIP file
  245.    ASCII Screen: BBS                     <--- ASCII file identifier
  246.    ANSI Screen: SCR                      <--- ANSI file identifier
  247.    Graphic Screen: RIP                   <--- Graphic file identifier
  248.    Graphic Support: No (Registered Only) <--- Toggles graphic support on/off
  249.  
  250.  
  251.    The following data will help explain the information needed in the  
  252.    .INI file.  Use the arrow keys or mouse to choose which field you need  
  253.    to modify.  The following list helps explain the contents of this menu.
  254.    
  255.        1. Sysop Name:  This is the first and last name of sysop.
  256.        
  257.        2. BBS Name:    The name of your BBS.
  258.        
  259.        3. User Key:    This is the key registered in your name, or an official     
  260.                        SHAREWARE key issued by the author.
  261.        
  262.        4. SourcePath:  This is the path where CalCat! will find your holiday
  263.                        screens.  If a holiday file does not exist at this
  264.                        path, CalCat! will abort it's operation.  CalCat! is
  265.                        NOT sensitive to backslash at the end of the path.
  266.  
  267.        5. TargetPath:  This is the path where CalCat! will write your holiday
  268.                        screen to.  This line is more important to your BBS
  269.                        that it is for CalCat!'s operation, because this is
  270.                        the path where your BBS should be able to find your
  271.                        display screens.  Again, CalCat! is NOT sensitive to
  272.                        the backslash at the end of the path.
  273.                          
  274.        
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.        6. Archive:     This is where you specify whether you would like to
  282.                        store the holiday screens in ZIP archive form or not.
  283.                        This new line must exist.  If you WOULD like to store
  284.                        holiday screens in archive form, put the name of the
  285.                        archive file here.  The screens included in SHAREWARE
  286.                        version have been preZipped, so I would recommend that
  287.                        you just leave the screens as is and put HOLISCRN.ZIP
  288.                        in this field.  If you choose to store the holiday 
  289.                        screens in the extracted form, this line MUST exist but
  290.                        leave the field blank.
  291.        
  292.        7. ASCII Screen:  Most BBS packages produced today allow you to use 
  293.                          two sets of screens.  These two screens types are 
  294.                          usually ANSI and ASCII, one set allowing for advanced 
  295.                          colors and animation, and the other allows color or 
  296.                          black and white, respectively.  CalCat! is now setup 
  297.                          to go beyond Wildcat!'s .BBS and .SCR making CalCat! 
  298.                          compatible with several other packages on the market.  
  299.                          In this field, simply put the ASCII screen identifier 
  300.                          used by your BBS package here.  Again, this line is 
  301.                          more important to your BBS than for the operation of 
  302.                          CalCat!.  An identifier that is wrong will cause your 
  303.                          BBS to not find your holiday file.
  304.  
  305.        8. ANSI Screen:   As in above, simply put the ANSI identifier used by 
  306.                          your BBS package here.  It is not case sensitive.
  307.  
  308.        9. Graphic Screen: As in above, simply put the graphic screen 
  309.                           identifier used by your BBS package here. It is not 
  310.                           case sensitive.
  311.  
  312.        10. Graphic Support:  This will toggle graphic support on or off.  This
  313.                              option is NOT available to unregistered users of
  314.                              CalCat!  This allows for the copying of graphic
  315.                              screens along with ANSI or ASCII screens.
  316.  
  317.      That should do it for personal data, that didn't seem too bad, did it?
  318.  
  319.  
  320. III. Next step is to modify your swap data to meet the needs of your BBS.
  321.      To do this, you need to step back to the main menu of CONFIG40.EXE and
  322.      select option 2, modify SWAP.DAT.
  323.  
  324.      CalCat! now has the ability to swap screens into 10 different locations.
  325.      As you can see from the list, these will be referred to as target files,
  326.      and they can be any display file within Wildcat! so long as the actual
  327.      display file can be found in the "Target Path" as defined in the edit
  328.      CALCAT.INI menu.  (such as HELLO1, PRELOG, GOODBYE etc.)  You will find
  329.      that you have the option of using any amount of these target files up to
  330.      the allowed limit of 10 and must use at least one for CalCat! to operate.
  331.      
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.      Choose one of these target files using the arrow keys or mouse and we 
  339.      will modify one to show you how it's done.
  340.  
  341.        I will choose to modify TargetFile #1, submenu for TargetFile #1 now
  342.        comes up looking like such:
  343.  
  344.          
  345.          Target File Name: HELLO1      <--- Name of target file.
  346.          On/Off Switch: On             <--- Used to turn target file on/off
  347.          Flagged for Holiday: On       <--- toggles holiday swaps on/off
  348.          Sequence Type: Random         <--- toggles swap type on non-holiday
  349.          Last Copied: 2                <--- Last screen swapped.  Internal
  350.          Swap Screens:  <list button>  <--- Hit enter to list swap screens
  351.  
  352.          The following is detailed information of each option.
  353.  
  354.          1. Target File Name:  This is the name of the display file you want
  355.                                to assign to this particular target file.  This
  356.                                display file must be able to be found by WC         
  357.                                in the target path as assigned by you in the
  358.                                edit CALCAT.INI menu.  Notice that there is no
  359.                                dot (.) or a screen type identifier... this IS
  360.                                the correct syntax, for CalCat! will determine
  361.                                the screen identifier by the holiday database.
  362.          
  363.          2. On/Off Switch:  This toggles the target file on or off.  You must
  364.                             have at least one target file turned on for the
  365.                             CalCat! program to work.  Any number of these
  366.                             target files can be turned on or off and will
  367.                             operate so long as target file name is assigned
  368.                             and there exists screens in the swap list.
  369.                             See #6
  370.  
  371.          3. Flagged for Holiday:  This option allows you to control the 
  372.                                   holiday swaps of each individual target
  373.                                   file.  Any number of target files can be
  374.                                   toggled as flagged for holiday.
  375.  
  376.             "On" | Holiday "Flagged" | Actual Holidays | Copied | Swaps
  377.             -----------------------------------------------------------
  378.               8  |       4           |        2        |   2    |  6
  379.               3  |       2           |        3        |   2    |  1
  380.               1  |       0           |        1        |   0    |  1
  381.               1  |       1           |        1        |   1    |  0
  382.  
  383.                                Get the picture?
  384.  
  385.          4. Sequence Type:  This can be toggled as random or sequential.
  386.                             this function determines the swap technique
  387.                             used when there are no holidays or when the
  388.                             holiday flag has been turned off.
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.          5. Last Done:  This was the last screen copied from the swap list.
  397.                         This is written internally and cannot be modified.
  398.  
  399.          6. Swap List:  Choose this option to add display screens to the swap
  400.                         list.  These are the screens to be swapped when:
  401.                            - Target file toggled for holiday and there is
  402.                              no damn holiday.
  403.                            - Target file is not toggled for holiday.
  404.                         If you add screens to this swap list, YOU MUST
  405.                         REMEMBER to ADD your new screens to HOLISCRN.ZIP or
  406.                         they will NOT be swapped.  You have the ability to
  407.                         add up to 20 display screens for EACH target file.
  408.                         This means if you use CalCat! to it's full potential,
  409.                         you can swap up to 200 display screens.  Duh!
  410.  
  411.          
  412.          
  413.          This should do it for the swap data.  Remember, if you have troubles
  414.          to use your common sense.  The information to be edited is very
  415.          straight forward.
  416.  
  417.  
  418.  
  419.  
  420. IV.  With CalCat's new database system, it is now easier for you to turn
  421.      holidays on and off, or add holidays to the database.  I won't go into
  422.      too much detail on how to modify the holiday database, because it is
  423.      very straight forward so long as you use the key options presented and
  424.      that you pay attention to the screen.
  425.       
  426.      To edit or add holidays to the holiday database, you first need to be
  427.      back at the main menu of CONFIG40.EXE and choose option 3.  Edit the
  428.      CALCAT.DAT database.
  429.  
  430.      The menu will look like this:
  431.  
  432.      Add New Holiday:   <--- Lets you add your own holidays to database
  433.      Edit Holiday:      <--- Allows you to edit holiday already in database
  434.      Delete Holiday:    <--- Allows you to delete a holiday from the database
  435.      List Holidays:     <--- Lists holidays for you.  Sorted or unsorted
  436.      Print Holidays:    <--- Prints list of holidays sorted or unsorted
  437.  
  438.  
  439.      Details of the above options are as follows:
  440.  
  441.      1. Add New Holiday:  This option lets you add your own date sensitive
  442.                           holiday to the database.  Remember, if you add a 
  443.                           holiday, make sure your new holiday display screen
  444.                           is put into HOLISCRN.ZIP or it will not be copied.
  445.      
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.      2. Edit Holiday:  This option allows you to edit any holiday that YOU 
  453.                        have added to the database.  Holidays provided by the
  454.                        author CANNOT be modified in any except for turning
  455.                        them on or off!
  456.  
  457.      3. Delete Holiday:  This option allows you to delete any holiday that 
  458.                          YOU have added to the database.  Holidays supplied
  459.                          by the author CANNOT be removed from the database or
  460.                          that is an infringment of your software license.
  461.  
  462.      4. List Holidays:  This allows you to easily view the list of holidays
  463.                         either sorted or unsorted.  Two different sorting
  464.                         options are by alphabetical or by date.
  465.  
  466.      5.  Print Holidays:  This allows you to easily print a list of holidays
  467.                           either sorted or unsorted.  Two different sorting
  468.                           options are by alphabetical or by date.
  469.  
  470.  
  471.          
  472.          Add New Holiday & Edit Holiday sub menus.
  473.  
  474.            - Holiday Name:  Name your holiday.  Easter, Birthday, etc.
  475.                             (max of 30 characters)
  476.            
  477.            - Holiday Code:  Name of your display screen that YOU WILL add
  478.                             to HOLISCRN.ZIP in order for it to work properly.
  479.                             (max of 12 characters in proper DOS syntax, also
  480.                              must have prefered identifier.  eg SCREEN1.BBS)
  481.            
  482.            - Author Lock:   This function is for me to lock and unlock author
  483.                             holidays for edit.  No sense in tampering with
  484.                             this option, it does not exist outside of my
  485.                             home.
  486.            
  487.            - On/Off Switch:  Allows you to toggle holidays on or off.  Easy
  488.                              enough, if you don't want it to show up, turn it
  489.                              off.
  490.            
  491.            - Holiday Type:  There are three holiday types: 1) Constant, which
  492.                             is a holiday such as Christmas which has the same
  493.                             date every year.  2) Variable, which is a holiday
  494.                             such as Memorial Day which is different every year.
  495.                             3) Internal, which is a holiday such as Easter
  496.                             which needs to be determined by special algorithm
  497.                             due to its uniqueness.  All internals are done by
  498.                             the author.
  499.            
  500.            - Month:  This obviously will be the month of holiday in question.
  501.            
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.            - Day:  This can have two meanings:  1) Constant holiday, this will
  510.                    be the day of month holiday falls.  2) Variable holiday,
  511.                    this will be the "day of week" the holiday falls.  eg Monday
  512.  
  513.            - Week:  This option is for Variable holidays only.  It is the
  514.                     week the holiday falls.  For example, Columbus Day is the
  515.                     2nd Monday in October, that means this would be set to 2
  516.                     and the day would be set to Monday. (above)
  517.  
  518.            - Shift:  This option is used for certain holidays that depend on
  519.                      another.  Such as, Ascension Day is 50 days after the
  520.                      Christmas, which could easily be calculated on your own.
  521.                      With this, you could set the holiday to Christmas' date
  522.                      with a shift of 50, and it will count the days for you
  523.                      while also accounting for leap year.
  524.  
  525.  
  526.  
  527.  
  528.      **  Well that should do it.  You know the basics for holiday house
  529.          keeping.
  530.  
  531.  
  532.  
  533. V.    Set up event in SYSOP menu area of Wildcat! BBS using the
  534.       CALCAT.BAT sample file.  Run once per day preferably at say
  535.       12:01 A.M.  Once installed properly, event only takes
  536.       approximately 7 seconds to run so will not interfere with incoming
  537.       calls.
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544. That should do it.  CalCat! is now ready to be run.  You can run it outside
  545. of Wildcat! obviously if you'd like to see it run.  Not much to see though
  546. until you log onto your BBS system.
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555. PLEASE PLEASE PLEASE REMEMBER................
  556.  
  557.    I have supplied ANSI and attribute screens for the 242+ holidays that
  558.    are already installed in the CALCAT.DAT file.  Please cut me some slack
  559.    on these screens.  Some of them are from other authors and some of them
  560.    are made by me.  Every attempt has been made to retain the original work
  561.    by other authors and by also leaving their mark, (name) on their work.  I
  562.    respect the hard work and creativity by these people, and I hope you also
  563.    appreciate them.  ANSI authors make your life easier!!
  564.  
  565.    ******  Read on....
  566.        And by all means I cannot and will not guarantee that any of these 
  567.        screens are setup with the proper amount of line lengths.  I tried
  568.        with the version 2 series and it turned out to be too much work for
  569.        one person to do. (Especially as a student.)  
  570.  
  571.        So, if you get a chance to get a nice set of custom holiday screens, 
  572.        please circulate them around the BBS world, especially at MSI HQS so I
  573.        can get a hold of them.
  574.  
  575.  
  576.  
  577. Enjoy CalCat! and if you have any problems or suggestions for improvements,
  578. please feel free to contact me, Bart Flentje, on the MSI HQS BBS or you can
  579. write to me at:                     or voice phoned at: 
  580.                  Bart Flentje                            612-686-6276
  581.                  1718 Hickory Hill
  582.                  Eagan, MN 55122       
  583.  
  584. Thanks for the support!
  585.  
  586.  
  587.