home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / pcab300.zip / PCAB.DOC < prev    next >
Text File  |  1991-04-28  |  21KB  |  539 lines

  1.  
  2.  
  3.                                  PCAB V3.00(c)
  4.  
  5.                                 P J Tewkesbury*
  6.  
  7.                                  Feb 17th 1991
  8.  
  9.  
  10.                          This is a SHAREWARE Program.
  11.  
  12.          * Thanks to S Harrison and A Ibrahim for there assistance
  13.          with the checking and debugging of this program.
  14.  
  15.          Shareware.
  16.  
  17.          This application package, which includes files contained in
  18.          the PCAB.ZIP file are copyright of P J Tewkesbury. However,
  19.          you may use the software for upto 30 days. After which time
  20.          if you decide to continue to use the package, you should
  21.          register with the author. Otherwise you should erase the
  22.          package from all your discs. This package may be copied and
  23.          distributed freely, so long as the files are not changed in
  24.          any way, by any means.
  25.  
  26.          Restrictions.
  27.  
  28.          This package, as it stands is a fully working program, but it
  29.          has one limitation, That is it will only allow you to store a
  30.          maximum of 30 records in any one database. There is also a
  31.          popup reminder which will appear from time to time to remind
  32.          you that that copy is un-registered.
  33.  
  34.          If you would like the full package, which can handle upto
  35.          1000 records per database, you will have to register with the
  36.          author.
  37.  
  38.          Registering.
  39.  
  40.          To register, send £20 to the author. In return, you will
  41.          receive a fill working copy of PCAB V3.00 which can cope with
  42.          1000 records per database. You will also receive a typeset
  43.          manual for PCAB. You should find an file called ORDER.TXT,
  44.          print this file and then fill it in and return to the address
  45.          on the order form.
  46.  
  47.          -------------------------------------------------------------
  48.  
  49.          1. Program Requirements.
  50.  
  51.          This program requires the following to operate correctly.
  52.  
  53.          A. IBM PC or 100% compatible computer.
  54.          B. MSDOS 3.2 or latter.
  55.          C. Printer Optional.
  56.          D. Mouse Optional.
  57.          E. 512K Memory ( For 1000 record capcaity.)
  58.  
  59.          2. Introduction.
  60.  
  61.          What is PCAB?
  62.  
  63.          Well PCAB is a fast, and easy to use data base for keeping
  64.          names, addresses, telephone numbers, birthdays, & wedding
  65.          anniversary dates. PCAB is quick to load up, can be used to
  66.          print an envelope label, or to just check a telephone number.
  67.          But you can also export a file of names and addresses in one
  68.          of 3 different formats for your word processor to use as
  69.          input for a mail merge. Pcab is easy use, and the information
  70.          that you have entered can be displayed in one of 4 different
  71.          formats. The formats are:- (i) Name & Telephone number, (ii)
  72.          Name & Birth/wedding dates, (iii) Address Labels, & (iv)
  73.          Total information. These formats have been included so that
  74.          you can find that date or telephone number as easily as
  75.          possible.
  76.  
  77.          3. Program Features.
  78.  
  79.          PCAB supports the following features:-
  80.  
  81.          A. 4 different display formats.
  82.          B. Fully menu driven, and hot keys.
  83.          C. Two field sort routine.
  84.          D. Search routine.
  85.          E. Export routine in either ASCII C, ASCII L, or PCFILE+ 3.0
  86.             formats.
  87.          F. Output records to file or printer.
  88.          G. PCFILE+ 3.0 Compatible output data files.
  89.          H. REMINDER. A program to inform you 2 weeks in advance of
  90.             peoples birthdays \ wedding anniversaries, using
  91.             information previously stored in the database.
  92.          I. Full Online Help.
  93.          J. MS compatible mouse supported.
  94.          K. All text screens supported. (Color or Mono.)
  95.  
  96.          4. Display Formats
  97.  
  98.          PCAB can display the above information in 1 of 4 different
  99.          ways.
  100.  
  101.          They are:-
  102.  
  103.          A. Name & Telephone Number.
  104.          B. Name & Dates. (Birthday & Wedding Anniversary dates.)
  105.          C. Name & Address. (For printing onto envelopes.)
  106.          D. Total Information. (All information is displayed.)
  107.  
  108.          5. General Use.
  109.  
  110.          Once PCAB has been loaded and run, PCAB will display a title
  111.          screen and wait for the return key to be pressed. After that,
  112.          the screen will clear, and PCAB will load the database into
  113.          memory.
  114.  
  115.          You will see that the top line of the screen is a status line
  116.          containing the number of records in the database, the number
  117.          of tagged records, ( See section 5.1 ) the amount of free
  118.          memory, and the time. In the main window on the screen you
  119.          can see the information held in the data base, and the top
  120.          record will be highlighted. To move the highlight bar, you
  121.          can use the up\down arrow keys, Home\End or the PGUP\PGDN
  122.          keys. The left\right arrow keys will allow you to change the
  123.          display format.
  124.  
  125.          5.1 Help.
  126.  
  127.          Help can be obtained at all times by pressing the F1 key, and
  128.          a help window will appear. Onec you have read the help, press
  129.          the ESC key to remove the help window.
  130.  
  131.          5.2 Tagging/Untagging Records.
  132.  
  133.          For some operations like Exporting, Printing, or Deleting,
  134.          you may require PCAB to perform the operation on only some of
  135.          the records. Therefore, PCAB will allow you to TAG any or all
  136.          of the records that are held in the database.
  137.  
  138.          To tag a record you can use :- T,t or F7.
  139.  
  140.          To untag a record, you can use :- U, u, of F8.
  141.  
  142.          Tagged records are marked by a star '*' on the top left hand
  143.          corner of the record.
  144.  
  145.          To tag or untag all the records in the database you can use
  146.          the ALT T, or ALT U respectively.
  147.  
  148.          5.3 Menus.
  149.  
  150.          Once a menu has been displayed, you can use the arrow keys to
  151.          move the highlight bar up and down. Return will select an
  152.          option, and ESC will exit you from the current menu to the
  153.          previous one.
  154.  
  155.          5.4 Dates.
  156.  
  157.          PCAB will, at some point, ask you to enter a date.
  158.  
  159.          Dates can be entered in the form of DD/MM/YY, where DD = Day;
  160.          MM = Month; YY = Year.
  161.  
  162.          Eg:-
  163.  
  164.          12 March 1967 would be entered as:- 12/03/67
  165.  
  166.          PCAB also allows you to miss the year if it is unknown.
  167.  
  168.          6. Main Menu. (F2)
  169.  
  170.          From the main menu you can select all of the following
  171.          operations. To display the main menu use the F2 key.
  172.  
  173.          6.1 Edit Menu. (F9, ALT E)
  174.  
  175.          From this menu, you can select any of the following options:-
  176.  
  177.          A) Add. (F3, ALT A)
  178.  
  179.          ADD will allow you to add a new record after the current
  180.          record. A window with a blank record will be displayed. You
  181.          can then type in the required information. Use the arrow keys
  182.          to move from field to field, F10 to store the information,
  183.          and ESC to abort the option. You can also use ALT D to erase
  184.          the current field, or ALT E to erase the current record.
  185.  
  186.          B) Modify. (F4, ALT M)
  187.  
  188.          Modify will allow you to modify the information in any
  189.          record. A window will be displayed with the current record
  190.          information, and you will be able to modify the information
  191.          in the same way as with the ADD record option.
  192.  
  193.          C) Delete. (F5, ALT D)
  194.  
  195.          If ALT D is pressed, then the current record that is
  196.          highlighted will be deleted from the database.
  197.  
  198.          If F5 is used, then a menu will appear. From this meun you
  199.          can select to delete All, the Tagged, or the current
  200.          record(s).
  201.  
  202.          If you delete all the records in a database,  or you create a
  203.          new  database by entering a new database name when  you  load
  204.          PCAB,  (See section 7.  Command line options.)  PCAB will not
  205.          allow you to use the DELETE, TAG, UNTAG, PRINT, SORT, SEARCH,
  206.          or  EXPORT  functions  until you have entered  at  least  one
  207.          record.
  208.  
  209.          D) Tag. (F7, T, t)
  210.  
  211.          See section 5.1 above for more information.
  212.  
  213.          E) Untag. (F8, U, u)
  214.  
  215.          See section 5.1 above for more information.
  216.  
  217.          6.2 Print Menu. (F6)
  218.  
  219.          From the Print Menu, you can select to print All, the Tagged,
  220.          or the current record(s). You can use ALT P to print the
  221.          currently highlighted record to the printer.
  222.  
  223.          Once you have selected which records to print, you will be
  224.          asked if you wish to create a Print File, or to print the
  225.          records directly to the printer.
  226.  
  227.          If you select to create a print file, then you will be asked
  228.          to enter a filename of the print file. The file will then be
  229.          created, and filled with the records selected.
  230.  
  231.          6.3Sort Menu. (ALT O)
  232.  
  233.          Sorting can be made on the name, reference code, birthday, or
  234.          wedding anniversary fields.
  235.  
  236.          The sort option will also allow you to sort in acceding or
  237.          descending order for each sort field.
  238.  
  239.          To sort the records, first select the FIELD 1 option from the
  240.          SORT menu, and then you can select the field to sort by, and
  241.          weather to sort in acceding or descending order.
  242.  
  243.          The RESET option of the FIELD 1 menu will set the sort field
  244.          to NAME, and the sort order to acceding.
  245.  
  246.          You can do the same with FIELD 2 option of the SORT menu, but
  247.          you also have a NONE sort field in case you only wish to sort
  248.          by one field. The RESET option of the FIELD 2 option will set
  249.          the sort field to NONE, and the sort order to ASCENDING.
  250.  
  251.          Once this is done, you can select SORT DATABASE from the SORT
  252.          menu. PCAB will then sort the database.
  253.  
  254.          Once you exit the menu, the screen will be updated. The
  255.          window will show the top record.
  256.  
  257.          6.4 Search Menu. (ALT S)
  258.  
  259.          The search option will allow you to search the database, and
  260.          tag any records which match the search pattern.
  261.  
  262.          To search the database, first pull down the SEARCH menu. Then
  263.          you can select the field to search by. This is done by
  264.          selecting the SEARCH FIELD option, then select the search
  265.          field option.
  266.  
  267.          Next you have to select the SEARCH STRING from the SEARCH
  268.          menu. You will be asked to input either a string, a number of
  269.          a pair of dates depending on which field you have selected.
  270.  
  271.          Once you have input the search string, you can then select DO
  272.          SEARCH from the SEARCH menu. PCAB will then perform the
  273.          search, and tag all the matching records. Once you exit from
  274.          the search menu, the screen will be updated.
  275.  
  276.          NB. If you selected to search either the birthdate/wedding
  277.          anniversary fields, then you can enter the following:-
  278.  
  279.          1. If you only enter the top date in full (DD/MM/YY), then
  280.          the search routine will search for that date only.
  281.  
  282.          2. If you only enter the top date (DD/MM), then the search
  283.          routine will search, and tag all record with the DD/MM
  284.          matching the inputed date.
  285.  
  286.          3. If you enter both dates in full (DD/MM/YY), then the
  287.          search routine will search, and tag all records which have a
  288.          date in the range from the top date to the bottom date.
  289.  
  290.          4. If you enter both dates (DD/MM), then the search routine
  291.          will search and tag all records which have the DD/MM in the
  292.          range of the dates entered.
  293.  
  294.          6.5 Export Menu. (ALT X)
  295.  
  296.          The Export menu will allow you to export all or only the
  297.          tagged record to a file in one of three formats. This new
  298.          file can then be used a the input to another application
  299.          package. EG Word Processor. PCTYPE II for a mail merge.
  300.  
  301.          To export data from PCAB, first select the EXPORT menu, then
  302.          you can select to DATA option. You can then select to export
  303.          either ALL of the records, or only the TAGGED records.
  304.  
  305.          Next you can select the FILE FORMAT option from the EXPORT
  306.          menu. You can then decide on which file format to save the
  307.          information as. You can select ASCII C, ASCII L, or
  308.          PCFILE+3.0. (Format details can be found latter.)
  309.  
  310.          Once this has been selected, select the EXPORT DATA option
  311.          from the EXPORT menu. You will be asked for a filename, and
  312.          once you have entered the filename, the information will be
  313.          saved to the file.
  314.  
  315.          6.6 Backup Database. (ALT B)
  316.  
  317.          This option allow you to save the database to disc. If you do
  318.          not backup the database, you will lose all the changes that
  319.          you have made to the database.
  320.  
  321.          6.7 Configuration Page. (ALT C)
  322.  
  323.          This option will allow you to change upto 4 parameters that
  324.          PCAB uses. Once this option is selected, a window will be
  325.          displayed. PCAB will allow you change any of the 4 fields.
  326.          They are:- Database Path, Database Name, Color/Mono screen,
  327.          and the default display format.
  328.  
  329.          You can use the arrow keys to change the current field, F10
  330.          will store the data in the config file. ESC will abort the
  331.          changes made.
  332.  
  333.          Once the changes have been made, and saved, then the new
  334.          parameters will be used. That is, if you change the database
  335.          name, and backup the database, it will be saved using the new
  336.          name. That is you can create a new database under a new name,
  337.          and path.
  338.  
  339.          The old database can still be loaded by using the command
  340.          line parameters.
  341.  
  342.          6.8 Quit. (F10, ALT Q)
  343.  
  344.          This option allows you to exit from PCAB back to your command
  345.          shell ( MSDOS ), but it will also ask you if you which to
  346.          backup the database to disc.
  347.  
  348.          IF YOU DO NOT BACKUP THE DATABASE, YOU WILL LOSE ALL CHANGES
  349.          MADE TO THE DATABASE.
  350.  
  351.          7. Operational Keys
  352.  
  353.          In Table 2 you can see a list of all the keys that can be
  354.          used to access the many functions of PCAB v3.00
  355.  
  356.          F2          : Main menu.
  357.          F3, ALT A   : Add record.
  358.          F4, ALT M   : Modify current record.
  359.          F5, ALT D   : Delete current record.
  360.          F6          : Print Menu
  361.          F7, t, T    : Tag current record.
  362.          F8, u, U    : Untag current record.
  363.          F9, ALT E   : Edit menu.
  364.          F10, ALT Q  : Quit program.
  365.          Arrows Up   : Up
  366.          Arrow Down  : Down
  367.          Arrow Left  : Left
  368.          Arrow Right : Right
  369.          Home        : Top of file.
  370.          End         : End of file.
  371.          PGUP        : Page up.
  372.          PGDN        : Page down.
  373.          ALT C       : Configuration.
  374.          ALT B       : Backup data file.
  375.          ALT O       : Sort menu.
  376.          ALT P       : Print Current Record.
  377.          ALT S       : Search menu.
  378.          ALT T       : Tag all records.
  379.          ALT U       : Untag all records.
  380.          ALT X       : Export menu.
  381.  
  382.          Table 1. Command Keys for PCAB V3.00
  383.  
  384.          8. Command line options.
  385.  
  386.          PCAB has 4 command line parameters that can be used when the
  387.          program is run.
  388.  
  389.          8.1 /P:[pathname] : Path name for the database.
  390.  
  391.          Defines a new path name for the database. The length of the
  392.          path can be a maximum of 40 characters long, and all the
  393.          characters must be valid of a directory path.
  394.  
  395.          8.2 /N:[name] : Database name.
  396.  
  397.          Defines a new database name. The name can be a maximum of 8
  398.          characters long, and it must use valid characters for a
  399.          filename.
  400.  
  401.          Using these above command line parameters, it is possible to
  402.          load up one of a number of databases held on disc.
  403.  
  404.          8.3 /M : Mono screen - Selects mono screen colors.
  405.  
  406.          8.4 /C : Color screen - Selects color screen colors.
  407.  
  408.          9. REMINDER.
  409.  
  410.          9.1 Introduction.
  411.  
  412.          This program will, when run, check the dates in every record,
  413.          and if any of the dates are in the next 2 weeks, then a
  414.          message is displayed on the screen.
  415.  
  416.          9.2 Installation.
  417.  
  418.          This program should be run every time the computer is booted.
  419.          If you wish this program to be run, then just add the
  420.          following line to your AUTOEXEC.BAT file:-
  421.  
  422.          [drive]:\PCAB\REMINDER /P:????? /N:????
  423.  
  424.          You must remember to include the drive letter in the command
  425.          line above where PCAB has been installed. You must also
  426.          include the path name of where the database can be found for
  427.          the /P option, and the database name for the /N option. If
  428.          the last two options are omitted then the REMINDER program
  429.          will not be able to find the database files, and it will
  430.          return to MSDOS.
  431.  
  432.          9.3 Command Line Options.
  433.  
  434.          Also supported by REMINDER.EXE are 2 command line options
  435.          which will specify the Name and Path of the database. The
  436.          parameters are the same as seen in Section 8. To include the
  437.          command line parameters, simply add the options to the new
  438.          command line above which is placed in the AUTOEXEC.BAT file.
  439.  
  440.          Example :-
  441.  
  442.          C:\PCAB\REMINDER /P:C:\PCAB\DB /N:MYFILE
  443.  
  444.          9.4 Use.
  445.  
  446.          Once you have updated your AUTOEXEC.BAT file, the reminder
  447.          program will automatically run, and check you database. If
  448.          there are any birthdays/wedding anniversary in the next 2
  449.          weeks, a message will be displayed.
  450.  
  451.          10. PCAB Files.
  452.  
  453.          In Table 3 there is a list of all the files that PCAB uses,
  454.          and what they are used for.
  455.  
  456.          PCAB.EXE     : Main PCAB execution file.
  457.          PCAB.DOC     : This manual.
  458.          KEYCARD.TXT  : List of Hot Keys for all options.
  459.          PCAB.CFG     : Configuration file.
  460.          REMINDER.EXE : Main REMINDER execution file.
  461.          PCAB.DTA     : Main Data File.
  462.          PCAB.INX     : Main Index File.
  463.          PCAB.HDR     : Main Header File.
  464.  
  465.          Table 2 : PCAB Files.
  466.  
  467.          11. Export File Formats.
  468.  
  469.          As stated in Section 5.9 the Export option of PCAB can
  470.          generate 3 different types of output file. Here, the file
  471.          formats are explained.
  472.  
  473.          11.1 ASCII C
  474.  
  475.          Each record will take one line, and each field is enclosed by
  476.          quotes, and each field is separated by a comma.
  477.  
  478.          11.2 ASCII L
  479.  
  480.          Each field is enclosed by quotes, and each record takes one
  481.          line, and each record is separated by one or more blank
  482.          lines.
  483.  
  484.          11.3 PC FILE+3.0
  485.  
  486.          PCAB uses PCFILE formats to save the database. This means
  487.          that if you have PCFILE+ V3.0, then you can use the PCAB
  488.          database on PCFILE+ V3.0
  489.  
  490.          PCFILE+ 3.0 has 3 files for each database, and they are
  491.  
  492.          11.3.1 DTA Files.
  493.  
  494.          These files hold all the information for the database. Each
  495.          record is of a fixed length (The sum of all the fields), and
  496.          the record end is marked by a carriage return. (Hex 0D). Each
  497.          field is of a fixed length, and if needed, the field is
  498.          padded to the right with spaces.
  499.  
  500.          If the first character of the record is a '/' character, then
  501.          that record has been deleted, and if the first character is a
  502.          '\' then this marks the end of the database.
  503.  
  504.          When PCFILE+ adds a new record, PCFILE+ first replaces the
  505.          records which have been deleted, and if there are no deleted
  506.          records, then PCFILE+ adds the records to the end of the
  507.          file.
  508.  
  509.          11.3.2 INX Files.
  510.  
  511.          This file contains the information about the order of the
  512.          file. IE Which record is 1st, 2nd, 3rd etc. (This also
  513.          includes deleted records.)
  514.  
  515.          Each index record is made up of the first 2 characters of
  516.          each field, followed by a 2 byte binary pointer to the
  517.          relative record number of the record in the DTA file.
  518.  
  519.          11.3.3 HDR Files.
  520.  
  521.          The HDR files contains information only required by PCFILE+
  522.          V3.0. If you are using PCFILE+ see the documentation files
  523.          for more information on the HDR file format.
  524.  
  525.          12. Questions.
  526.  
  527.          If you have any questions, or suggestions for PCAB, please
  528.          send then to the author, with a SAE for your reply. NB. If
  529.          there is no SAE, there will be no reply.
  530.  
  531.          Author:-
  532.  
  533.          Mr P J Tewkesbury,
  534.          26 Garthorp Road,
  535.          Northern Moor,
  536.          Manchester,
  537.          M23 OAS,
  538.          England.
  539.