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