home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / games / logg141.zip / LOGGER.DOC < prev    next >
Text File  |  1987-12-04  |  25KB  |  595 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.             
  8.             
  9.             
  10.             
  11.             
  12.             
  13.             
  14.             
  15.             
  16.             
  17.             
  18.                                   The KD2MT Logger
  19.                                     Version 1.41
  20.                                   Public Domain by
  21.                                     David Myers
  22.                                       Box 9861
  23.                                     Duke Station
  24.                                  Durham, NC  27706
  25.             
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.                               --- The KD2MT Logger ---
  71.  
  72.  
  73.                                     INTRODUCTION
  74.             
  75.                  Being a  ham, and  having a  computer,  I  thought  I'd
  76.             computerize my  QSO logging.   This  is  not  a  contester's
  77.             logger, although  it can  be used as one.  This is a general
  78.             purpose computerized  implementation  of  a  standard  ham's
  79.             logbook, based  on the  ARRL logbook.    Although  there  is
  80.             something nice  about a handwritten log, if your handwriting
  81.             is like  mine, you'll  appreciate having your printer do the
  82.             writing.  You don't have to have a printer, though.
  83.                  I decided  to make the Logger store its data on a disk,
  84.             rather than  in memory,  like most  database programs.  This
  85.             would allow  a very  large log, and some ham friends of mine
  86.             have logs  of 4000+  Q's.   A log  that size  could run into
  87.             storage problems  if it  were kept  in memory.   This  means
  88.             access to  large amounts  of contacts  is slower on a floppy
  89.             disk based  system. I  have a  hard disk, but have tried the
  90.             program on  a PC  with  floppy  disks  and  found  that  the
  91.             performance is not too bad.
  92.                  I've tested  the Logger  with over 10,000 QSO's logged.
  93.             That's a data file over 1 megabyte in size.
  94.                  An option  for using  the program on a floppy system or
  95.             hard disk  system is  to store  the Logger's  data in  a RAM
  96.             disk, which gives very fast performance.  I highly recommend
  97.             that you  use a  RAM disk  if you have a floppy disk system.
  98.             More on that later.
  99.                  If you  have any  comments about  the Logger,  you  can
  100.             write to  me at the above address.  Don't send any money, as
  101.             I am  just releasing  this for  fun, and  not for  any other
  102.             reason.
  103.             
  104.             
  105.                                    CONFIGURATION
  106.             
  107.                  The Logger  disk or  ARChive, whichever  you  received,
  108.             includes   a    file   called   LOGGER.CNF,   the   Logger's
  109.             configuration file.   This  is a  text file  containing  the
  110.             following:
  111.             
  112.             "KD2MT","",""
  113.             "Your callsign","Path to LOGGER.DAT","Path to temporary
  114.             storage"
  115.             
  116.                  Using an  ASCII editor such as EDLIN, replace the first
  117.             string in  quotes with  your callsign,  so it will appear on
  118.             the title  screen and  on printed copies of your log.   (The
  119.             information in  LOGGER.CNF must  appear on the first line of
  120.             the file,  in quotes,  separated by commas.  The second line
  121.             is there as a reminder, and the Logger ignores it.)
  122.                  Fill the  second set  of quotes  with the path name for
  123.             the file LOGGER.DAT, the Logger's data file.
  124.             
  125.  
  126.  
  127.  
  128.  
  129.  
  130.                                  ----- page  2 -----
  131.  
  132.  
  133.  
  134.  
  135.  
  136.                               --- The KD2MT Logger ---
  137.  
  138.  
  139.             ____________________________________________________________
  140.             NOTE:   LOGGER.DAT is  the file  that contains  your logbook
  141.             entries.   It is  created by the Logger after you've entered
  142.             your first  entries and  used the  save file command.  It is
  143.             not included in the ARChive or on the disk.
  144.             ____________________________________________________________
  145.             
  146.                  Empty quotes  mean that  the file  is  in  the  default
  147.             directory.  Example entries are:
  148.             
  149.                          "B:"
  150.                          "C:\LOGGER\DATA\"
  151.                          "D:\"
  152.             
  153.                  The string  in the third set of quotes tells the Logger
  154.             where to  write the  file LOGGER.TMP.   The Logger uses this
  155.             temporary file  when it  makes changes  or additions  to the
  156.             log.   This file  is copied  to LOGGER.DAT  when you use the
  157.             SAVE DATA FILE command.
  158.                  Also, the  LOGGER tries  to back  up LOGGER.TMP  when a
  159.             sort  is  performed.    It  tries  to  use  the  same  drive
  160.             LOGGER.TMP is  on.   If there  is not  enough space, you can
  161.             still sort,  but you  might want to keep this extra space in
  162.             mind.
  163.                  This allows  you to  have LOGGER.EXE,  LOGGER.DAT,  and
  164.             LOGGER.TMP in different directories, or on different drives.
  165.             (LOGGER.EXE and  LOGGER.CNF must  be in the same directory.)
  166.             Better yet,  it allows  you to  tell the  Logger to  put the
  167.             temporary file  in a  RAM disk.   The path name entry should
  168.             contain the  drive letter  of the  RAM disk  (followed by  a
  169.             colon, of  course).  This will provide the fastest access to
  170.             the data.
  171.                  If you  use a RAM disk, it must be large enough to hold
  172.             a file  the size  of LOGGER.DAT  (107 bytes  per log entry).
  173.             Three times this size would be best.
  174.                  The file  LOGGER.TMP  is  erased  when  the  Logger  is
  175.             terminated.
  176.             
  177.             ____________________________________________________________
  178.             NOTE:    Refer to your DOS manual for information on setting
  179.             up a  RAM disk.   On many systems, it will consist of adding
  180.             the line:
  181.             
  182.                          DEVICE = \pathname\VDISK.SYS size
  183.             
  184.             to the  file CONFIG.SYS, which resides in the root directory
  185.             of the  disk you boot your computer from.  The "pathname" is
  186.             the  path   to  the  file  VDISK.SYS  (RAMDISK.SYS  on  some
  187.             systems), and  "size"  is  the  size  of  the  RAM  disk  in
  188.             kilobytes.  100 might be a good value for "size".  After you
  189.             have added  this line  to CONFIG.SYS, you'll have to re-boot
  190.             your machine for the RAM disk to be set up.
  191.  
  192.  
  193.  
  194.  
  195.  
  196.                                  ----- page  3 -----
  197.  
  198.  
  199.  
  200.  
  201.  
  202.                               --- The KD2MT Logger ---
  203.  
  204.  
  205.             ____________________________________________________________
  206.             NOTE FOR  MONOCHROME MONITOR  USERS:    The Logger uses many
  207.             windows with  various background  colors.   These might  not
  208.             look so good on your monitor, especially if you have a color
  209.             card, but  a monochrome  monitor. If  this is  the case, the
  210.             first thing  you should  do when  you start the Logger is to
  211.             hold down  the Alt  key and type C.  This toggles on and off
  212.             the background  colors, and changes some of the other colors
  213.             around to  make the  Logger function  better  on  monochrome
  214.             systems.
  215.             ____________________________________________________________
  216.             
  217.                  To set up the Logger to work with your printer, run the
  218.             included program  LOGPRT.   Choose the printer that operates
  219.             closest to yours.  Hopefully, one will work.  There aren't a
  220.             heck of  a lot  yet, but  it's growing.  You can keep trying
  221.             other printers by re-running LOGPRT.
  222.                  LOGPRT creates  the file LOGGER.PRT, which contains the
  223.             printer codes  the Logger needs to send its output correctly
  224.             to a printer.  LOGGER.PRT, like LOGGER.CNF, should reside in
  225.             the same  directory as  LOGGER.EXE.   Once you are done with
  226.             LOGPRT, you can move it to another disk.
  227.             
  228.             
  229.                                LOGGING YOUR CONTACTS
  230.             
  231.                  For each  "record", or  entry, in  your log, the Logger
  232.             stores 12  "fields", or  items.   They are  adapted from the
  233.             standard ARRL  log, and  their  maximum  lengths  have  been
  234.             chosen to  allow each  entry to fit on a single (compressed)
  235.             line when the log is
  236.             printed.
  237.                  The items are:
  238.             
  239.               o  The callsign of the station worked (max 6 characters)
  240.               o  The date of the contact in the form MM-DD-YY (8)   
  241.               o  The frequency of the contact (8)
  242.               o  The mode of the contact (3)
  243.               o  The RST report you sent to the other station (5)
  244.               o  The RST report sent to you by the other station (5)
  245.               o  The starting time of the contact in the form HH:MM (5)
  246.               o  The CHECK  of the  contact, which  is either the ending
  247.                       time of  the contact,  or a contest serial number,
  248.                       or some other special exchange (5)
  249.               o  The name of the operator worked (10)
  250.               o  The QTH of the station worked (20)
  251.               o  A comment field, for anything you like (30)
  252.               o  QSL status: The suggested use of this field would be to
  253.                       enter an  "S" if  you  have  sent  a  QSL  to  the
  254.                       station, an  "R" if  you have  received a QSL from
  255.                       the station, or an "SR" for both (2)
  256.                  
  257.             
  258.  
  259.  
  260.  
  261.  
  262.                                  ----- page  4 -----
  263.  
  264.  
  265.  
  266.  
  267.  
  268.                               --- The KD2MT Logger ---
  269.  
  270.  
  271.                  In addition,  each contact  is given  a number used for
  272.             referring to  the contact  in the  log, but  this number  is
  273.             assigned by  the program,  and does  not appear  on the  log
  274.             printout.
  275.             
  276.             
  277.                                   USING THE LOGGER
  278.             
  279.                  ... is easy.  The ten function keys initiate all of the
  280.             functions you use to maintain your log.
  281.                  The options are:
  282.             
  283.             
  284.                            F1 ... Add new log entries
  285.                            F2 ... Edit a past entry
  286.                            F3 ... Search for an entry
  287.                            F4 ... Print log
  288.                            F5 ... List entries by number
  289.                            F6 ... Delete an entry
  290.                            F7 ... Data file status
  291.                            F8 ... Sort entries
  292.                            F9 ... Save data file
  293.                            F10 .. Terminate program
  294.             
  295.             
  296.                  These are pretty self explanatory.  Some embellishment:
  297.             
  298.             F1 (Add  New Entries)  - The  names of the 12 fields appear,
  299.                  and prompts at the bottom of the window remind you what
  300.                  to enter.  The input routine limits how long each entry
  301.                  can be in accordance with the maximum character lengths
  302.                  of each field given above.  Some fields provide default
  303.                  values, which  you can  easily type  over if  you don't
  304.                  want them  (for example, "59" automatically appears for
  305.                  RST SENT).   If  you wish  to replicate the information
  306.                  you entered  in that  field for  the previous entry you
  307.                  made, type ^R (type R while holding down the Ctrl key).
  308.                       You can  use the  arrow keys  to get  around while
  309.                  entering data.   When  you get  to the  bottom  of  the
  310.                  entries, or  hit ESCape,  you are  prompted for  one of
  311.                  four actions.   Hitting  return adds  the entry  to the
  312.                  log, and  begins entry  of another  contact.   "L", for
  313.                  "last", adds  the entry  to the  log and terminates the
  314.                  Add New  Entry window.   "R",  for "re-enter", lets you
  315.                  re-enter the contact before you save it, in case you've
  316.                  made a  mistake.   Hitting ESCape  does  not  save  the
  317.                  entry, and cancels the Add New Entry window.
  318.             
  319.             F2 (Edit)  - Given  an entry number, displays and allows you
  320.                  to change  the data  for that contact.  Works very much
  321.                  like F1  (Add New  Entries).   Hitting <Page Down> will
  322.                  jump to  the next  entry in  the log without saving the
  323.                  current one.  Similarly, <Page Up> jumps backwards.
  324.             
  325.  
  326.  
  327.  
  328.                                  ----- page  5 -----
  329.  
  330.  
  331.  
  332.  
  333.  
  334.                               --- The KD2MT Logger ---
  335.  
  336.  
  337.             F3 (Search)  - Given  a callsign, the search pulls up all of
  338.                  the QSO's  with that  station.  Or, given a date, pulls
  339.                  up all  QSO's on that date.  Remember to enter the date
  340.                  in the  form MM-DD-YY.   You  can use  F2 (Edit) to see
  341.                  more information on the individual contacts.
  342.             
  343.             F4 (Print)  - You  can output  a listing  of your log either
  344.                  directly to  the printer,  or to  the file  LOGGER.LOG.
  345.                  You are given the choice when you hit F4.  You are then
  346.                  also asked which page the printing is to begin on.
  347.                       The use  of printing  the log to a file is that if
  348.                  it is  long, you  can print it later, perhaps using the
  349.                  DOS print  spooler  PRINT.COM.    Note  that  the  file
  350.                  contains the  necessary   printer codes the Logger uses
  351.                  to toggle  printer effects.   You  could also  send the
  352.                  file  to   the  printer   by  using  the  command  COPY
  353.                  LOGGER.LOG PRN.
  354.                       The file is created on the same drive or directory
  355.                  from which  the Logger was started (the default).  Make
  356.                  sure there  is enough  space, as the file can get quite
  357.                  big.
  358.             
  359.             F5 (List  by Number) - Each contact entered into your log is
  360.                  assigned a  sequential entry  number.   This provides a
  361.                  quick way  to access a specific entry in the log.  List
  362.                  by Numbers  shows you  sequentially all of the contacts
  363.                  in the  log, but  shows you  only the entry number, the
  364.                  callsign, and  the date of the contact.  This gives you
  365.                  a quick  review of the log, and by using F2 (Edit), you
  366.                  can see the complete entry for a given contact number.
  367.                       Note that  the numbers are always sequential, from
  368.                  1 to  the number of entries in the log.  The number for
  369.                  a given  entry may  change after  sorting the  log,  or
  370.                  after deleting an entry with a lower number.
  371.             
  372.             F7 (Data  File Status)  - Quickly shows you how many entries
  373.                  there  are   in  your  log,    the  size  of  the  file
  374.                  LOGGER.TMP, and  the amount  of space free on the drive
  375.                  where LOGGER.TMP  is located.   This is handy to see if
  376.                  you are filling up your disk as you add entries.
  377.             
  378.                  Typing a  "?" at  the main menu gives you (very) simple
  379.             help screens.  Typing Alt-S at the main menu puts you in DOS
  380.             until you  use the DOS "EXIT" command.  Typing Alt-C toggles
  381.             the background  colors on  and off  for  monochrome  monitor
  382.             users.
  383.             
  384.             ____________________________________________________________
  385.             NOTE: In  order for  the Shell  To DOS  to  work,  the  file
  386.             COMMAND.COM must be available.
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.                                  ----- page  6 -----
  395.  
  396.  
  397.  
  398.  
  399.  
  400.                               --- The KD2MT Logger ---
  401.  
  402.  
  403.             ____________________________________________________________
  404.             *** Remember  to use  the F9  SAVE DATA  FILE command if you
  405.             make any  changes to  the log  which you would like to keep.
  406.             By the same token, you can mess around with your log as much
  407.             as you want without worrying about messing it up permanently
  408.             as long as you don't use F9. ***
  409.             ____________________________________________________________
  410.             
  411.                  Also, the ESCAPE key is always available to get you out
  412.             of any function.
  413.             
  414.             
  415.                                       SORTING
  416.             
  417.                  The Logger  is intended  to store  your log  entries in
  418.             chronological order.   Under  most circumstances,  you won't
  419.             use the  F3 Sort command, which sorts your entries into that
  420.             order.   You just  put your entries in as you work stations,
  421.             and you end up with a log in chronological order, just as it
  422.             should be.   However,  you may end up with a few entries out
  423.             of order.   You  could have  put them in wrong, or forgotten
  424.             one, or  you might just want to convert your paper logs over
  425.             to the  computer a few months at a time, going back in time.
  426.             For these reasons, the Logger can sort the data file.
  427.                  In order  for the  sort to  be done correctly, you must
  428.             have all  TIME entries  in the  form  HH:MM,  and  all  DATE
  429.             entries in the form MM-DD-YY.  The input routines prompt you
  430.             to enter  the information  in these  formats, so  you  won't
  431.             forget.
  432.                  The sort  routine needs  some extra  disk space  on the
  433.             path where  LOGGER.TMP has  been stored.   Given  these, the
  434.             sort is  pretty efficient.  The more entries that are out of
  435.             order, the  quicker it  gets.    You  can sort  up  to  8000
  436.             entries.
  437.                  If either not enough memory or disk space is available,
  438.             the Logger cannot sort.
  439.             
  440.             ____________________________________________________________
  441.             *** Remember, the results of sorting are not permanent until
  442.             you use F9. ***
  443.             ____________________________________________________________
  444.             
  445.             
  446.                                    POP-UP WINDOWS
  447.             
  448.                  My thanks  to Dave  Evers for  making some great pop-up
  449.             window routines public domain.
  450.                  You'll find  in many  cases that  by hitting successive
  451.             function keys,  you can have windows pop up over each other.
  452.             This is  especially useful  if you  are paging  through  the
  453.             numbered listing  of your entries, and you want to examine a
  454.             particular entry in more detail without losing your place in
  455.             the listing.  Just hit F2 (Edit) from within the F5 (List by
  456.             Numbers) routine,  and the  EDIT ENTRY window pops right up.
  457.  
  458.  
  459.  
  460.                                  ----- page  7 -----
  461.  
  462.  
  463.  
  464.  
  465.  
  466.                               --- The KD2MT Logger ---
  467.  
  468.  
  469.             When you exit the EDIT function, you are back where you came
  470.             from.
  471.             
  472.                  Exceptions:  No windows will pop over EDIT ENTRY or ADD
  473.             NEW ENTRY (except TERMINATE, F10).  Also, no window will pop
  474.             up over another window that is waiting for input.
  475.             
  476.             
  477.                                       HAVE FUN
  478.             
  479.                  The best way to learn the Logger is to play around with
  480.             it.   I hope  somebody finds a real use for it (besides me).
  481.             Please write to me with your comments on the program.
  482.             
  483.             
  484.                                                               73,
  485.                                                               Dave
  486.                                                               KD2MT
  487.             
  488.             ____________________________________________________________
  489.             
  490.                                LOGGER VERSION HISTORY
  491.                       (For those interested in such things...)
  492.             
  493.             
  494.                  I have  been working on the Logger in various forms for
  495.             about two  and a  half years.  It started out in interpreted
  496.             BASIC, and  has since  become much more powerful.  I reached
  497.             version 5.00  when I  decided to  release the  Logger to the
  498.             public domain.   For  release, I  started the numbering over
  499.             with 1.00.
  500.             
  501.                  Version 1.00 released in June of 1987.
  502.             
  503.                  Version 1.10  released in  July of 1987.  Window colors
  504.             altered,  and   windows  cleaned   up.      Major   internal
  505.             restructuring caused  1.10 to  be smaller than 1.00.  Little
  506.             fixes here and there.  Use of Up and Down keys added to EDIT
  507.             and ADD routines.
  508.             
  509.                  Version 1.11  released 10  days  after  1.10.    I  had
  510.             disabled error  trapping while developing 1.10, and I forgot
  511.             to re-enable it when I finally compiled it!  What a dummy!
  512.             
  513.                  Version 1.20  released in  August of 1987.  A new sort!
  514.             Previously, only a disk-based sort was implemented.  After a
  515.             good book  on the  Quicksort algorithm, this new routine was
  516.             added.  Also, the status routine now also displays available
  517.             disk space  on the path for LOGGER.TMP.  Use of the Home and
  518.             End keys added to input routine.  Monochrome monitor support
  519.             added.  Fixed bug in print routine prompt.  Support for over
  520.             10,000 QSO's added (previous limit was 9999).
  521.             
  522.  
  523.  
  524.  
  525.  
  526.                                  ----- page  8 -----
  527.  
  528.  
  529.  
  530.  
  531.  
  532.                               --- The KD2MT Logger ---
  533.  
  534.  
  535.                  Version 1.30  released in  October of  1987.  Who was I
  536.             kidding with  the disk-based sort?  It really was only there
  537.             because it  worked fine  on  my  original  versions  of  the
  538.             Logger, which  all used a RAM disk.  In this version, I have
  539.             removed it  completely.   The sorting  limit is  set at 8000
  540.             entries, due to my stingy compiler.  Also, a few little bugs
  541.             are worked out.
  542.                  Multiple printer  support added.  Previous versions did
  543.             not use  the file  LOGGER.PRT.   Also, ability to print to a
  544.             file added.
  545.             
  546.                  Version 1.40  released in  November of  1987.   Limited
  547.             release.   Performance enhancements.   Screen writes greatly
  548.             speeded up.   Windows snap up faster.  The sorted file write
  549.             after sorting is also about twice as fast.
  550.                  Also, you  no longer  need COMMAND.COM on the disk with
  551.             LOGGER.EXE.   It was  necessary before,  although  I  didn't
  552.             realize it.   You do need COMMAND if you shell out, and when
  553.             you terminate  the Logger.   And  the backup and save of the
  554.             data file will be faster if COMMAND is present.
  555.                  Automatic detection  of mono card implemented.  Page Up
  556.             and Page  Down keys  added to  edit routine.  Search by date
  557.             added.  There was a little bug where if you hit ESCape after
  558.             entering information  into a  box, it would be treated as if
  559.             you hit enter.  Fixed.
  560.                  Use of  Ins and Del keys added to input routine.  Added
  561.             the introductory screen.
  562.             
  563.                  Version 1.41  released in  December of 1987.  The first
  564.             window in  the logbook  printing routine  was unreadable  on
  565.             some monochrome monitors.  It should be OK now.
  566.                  WB8VGE wrote  in with  suggestions, and  a couple  have
  567.             been added.   If  you enter  a character  in  the  frequency
  568.             field, rather  than only  digits and  a decimal  point,  the
  569.             Logger will  "blip" at  you as  a warning.  The data will be
  570.             accepted if you leave it that way, though.  This only occurs
  571.             in Add  New Entries.   Also, the ^R key was added to the Add
  572.             New Entries routine.
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.                                  ----- page  9 -----
  593.  
  594.  
  595.