home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / misc3 / tracer22.lzh / TRACER.DOC < prev    next >
Text File  |  1986-01-06  |  21KB  |  396 lines

  1.                       TRACER       version 2.2
  2.  
  3.                * * * * * "DOCUMENTATION" * * * * *
  4.  
  5. Tracer is a PAF file-compatible system for people who want
  6. to use the LDS PAF system, but have only one drive, or can't stand how
  7. slow it is.  If you want to know the details of how it works, refer to
  8. your original PAF documentation.  Several new features have been added
  9. to enhance you work environment.
  10.  
  11. To run this program, you must have certain equipment:
  12.  
  13.   A: An IBM PC or compatible machine.
  14.  
  15.   B: at least 256K of memory
  16.  
  17.   C: At least one disk, hard or floppy, upon which reside the program files.
  18.      Once you have reached the MAIN MENU, there is no further reason to have
  19.      the program disk in the system (if you are using floppies) so the
  20.      history notes diskette can go in one drive and the data diskette in
  21.      another, if you have more than one.  The entire program is memory-
  22.      resident.
  23.  
  24.   D: A place to put the data files, such as the same hard disk, or a few
  25.      more floppies.
  26.  
  27.   E: An optional printer for the optional printed reports.
  28.  
  29.   F: All the program files.  Here's the list you should have:
  30.        TRACER.COM
  31.        TRACER.OVL
  32.        TRACER.CNS
  33.        IDXEDIT.COM
  34.  
  35. =============================================================================
  36.  
  37.                              GETTING STARTED
  38.  
  39.     If you are using TRACER on a floppy diskette system, you probably
  40. already have the program files (F, above) on a floppy disk and are ready to
  41. go.  If you are running TRACER on a hard disk, then you might want to
  42. stop and think for a moment.  Even if you have a version of TRACER earlier
  43. than 2.2 and are upgrading, you will want to stop and think about this.
  44. Version 2.2 has a built-in system for handling data files on hard disks
  45. that you might want to take advantage of.
  46.     Previously, since Tracer was only able to locate files by disk drive
  47. if you wanted to work on more than one genealogy on a hard disk, you would
  48. have to create a directory for that family, put a copy of TRACER in it and
  49. run it from that directory.  Three families, three directories, three copies
  50. of TRACER taking up room on your system.  Phooey!
  51.     Option #3 in the System Utilities menu is called "Initialize Hard Disk
  52. System" ("Reconfigure System" has been moved to number 4).  If you select
  53. this option, the system will ask for a family name.  After you enter the
  54. family name, it will attempt to open a subdirectory for that family.  If it
  55. doesn't find one, it will create one and initialize new files in that
  56. directory just as it would in options 1 and 2 for diskette systems.  If it
  57. finds that directory already exists, then it will return to the menu, and
  58. you are now IN THAT DIRECTORY.  You may return to the main menu and begin
  59. processing the data for that family.
  60.     What does this all mean?
  61.     This means that you want to create one directory on your system and
  62. put TRACER in it.  You can call the directory anything you want, but if
  63. you call it "TRACER" you'll find it's a nice name and it will be easy to
  64. remember whats in it.  You don't HAVE to create a directory--TRACER can
  65. run from the main directory just as easily, but it keeps your main directory
  66. from becoming cluttered.
  67.     If you're upgrading from an earlier version of TRACER or converting from
  68. PAF, then you will want to create subdirectories with the first eight
  69. characters of the family name.  Then copy your data files into their
  70. respective family subdirectories.
  71.     Logically, it looks something like this:
  72.  
  73.                    Subdir: \TRACER
  74.                      Files: TRACER.COM
  75.                             TRACER.CNS
  76.                             TRACER.OVL
  77.                             TRACER.CFG (will be created by the system)
  78.                             |
  79.         ===========================================================
  80. Subdir: \TRACER\SMITH       \TRACER\JONES             \TRACER\BROWN
  81. Files:    NAMES.DAT           NAMES.DAT                  NAMES.DAT
  82.           INDIV.DAT           INDIV.DAT                  INDIV.DAT
  83.           HISTSTK.DAT         HISTSTK.DAT                HISTSTK.DAT
  84. etc.         ...                 ...                       ...
  85.  
  86.     The advantages of this are that your files are kept separate by
  87. the system, and only one copy of the program is required on your disk.
  88. Also, you can switch from family to family at any time without bringing
  89. down TRACER as the diskette people have to.
  90.  
  91.     DISKETTE USERS!
  92.  
  93.     If you just skipped the above, you should read it anyway, since,
  94. if you are dealing with small families, you can still use the system
  95. on a floppy diskette.  The only requirement is that the data files
  96. and the history files MUST BE ON THE SAME DISKETTE.  If you need to
  97. keep data files on one diskette and History files on another, you
  98. must use options 1 and 2 on the Utilities menu to initialize the
  99. diskettes and run it as a floppy system.
  100.  
  101.     Fine.  So you, the diskette user, have inserted the diskette with
  102. the TRACER programs files on it into the default drive and you, the
  103. hard disk user, have created a directory with TRACER in it and are now
  104. in that directory.  Type "TRACER" at the system prompt.
  105.     If you've never run it before, after the copyright screen you will
  106. be sent to the System Configuration screen to define your system.
  107. You will need to specify which drives the system will put the files in.
  108. If you have a printer, you will need to specify the control character
  109. sequences that put your printer in compressed print and normal print and
  110. how many characters the printer puts on a line in these modes.  You may
  111. have more than one "normal" print to select from.  You will see a place
  112. to enter the number of lines on your video screen.  It should be set to
  113. 25 when you start.  Leave it that way unless you want to be funny.
  114. There is also a place to tell the system whether or not your hardware
  115. allows for direct screen memory menagement.  Most systems do.  Set this
  116. to "Y" (it starts at "N") for a much faster system.  If your system runs
  117. wierd after that, set it back to "N".  It will be slower at "N", but
  118. you'll see everything.
  119.  
  120.    VERY IMPORTANT!
  121.  
  122.     If you are on a diskette system, it is not smart to remove the
  123. data diskettes when you're not told to.  Files can be left open and
  124. directories left unposted.  This can, in turn, be very confusing to the
  125. system.  Make backups religiously.  If you need to change data disks,
  126. terminate the program and restart it with the new data disk.  History/Research
  127. diskettes can be changed whenever the system requests the switch.
  128.     Option 3 on the System Utilities menu can also be used to safely
  129. change from one family to another without bringing the system down.
  130. Keep in mind how it works, as I described earlier.
  131.  
  132.     Oh, yes.  I left you configuring the system.  After you press F1 to
  133. write the configuration to the disk or diskette, you can use option 3 or
  134. options 1 and 2 to initialize your data files and the press 7 to go to
  135. the Main Menu and you are on your way.
  136.  
  137. ---------------------------------------------------------------------------
  138.  
  139. Here's a few other things you should know.
  140.  
  141.   1.  At the month field of any date you can enter a number from 1 to 12,
  142.       or a month name, or the first three letters of the month, or another
  143.       useful word, like ABOUT (ABT), BEFORE (BEF), AFTER (AFT), INFANT (INF),
  144.       STILLBORN (STI), SUBMITTED (SUB), CLEARED (CLE), UNCLEARED (UNC),
  145.       COMPLETED (COM), CANCELLED (CAN), BIC, DNS or DNS/CAN.  In some
  146.       places, some of these words make no sense at all.  I'm not as picky
  147.       as PAF about that.  If you want to stick meaningless things in your
  148.       files, thats your problem.  If you want these abbreviations to mean
  149.       something different to you, that's your privilege.  It's a free
  150.       country (they say).
  151.  
  152.   2.  History notes are faster and easier to edit on this.  The system accepts
  153.       the use of HOME, PG UP, PG DN, END, all four arrow keys, as well as
  154.       CNTL-P to erase to end of line.  The INS key toggles the insert/over-
  155.       write switch and DEL deletes the character under the cursor.
  156.       See the notes on things new to version 2.2 for more information.
  157.       When Insert is ON, backspace is destructive; when overwrite is on,
  158.       backspace is non-destructive.  I regret that at the moment, when
  159.       inserting, characters disappear off the end of lines and do not
  160.       wrap down to the next line.  Maybe next version.
  161.  
  162.   3.  A word on general name and place display logic.  The system, when
  163.       required to display a name or a place in a limited area, will
  164.       display as much as it can.  It selects which elements of the name
  165.       or place based on a built-in priority system, as follows:
  166.           DATA FIELD      PRIORITY
  167.       Names: Surname        1
  168.              Given1         1
  169.              Given2         2
  170.              Given3         3
  171.       Places:Level1         1
  172.              Level2         3
  173.              Level3         2
  174.              Level4         4
  175.       Fields with a priority of 1 will appear in the name regardless of
  176.       whether there is enough room for them.  If there is not enough
  177.       room the extra characters are truncated (see the examples below
  178.       where display size is only 10 characters large).  The lower priority
  179.       elements are added in toto if room is available.
  180.       This sort of thing is particularly important when using the
  181.       List/Dump feature where you can select your field sizes.  The net
  182.       effects are as shown below:
  183.  
  184.       Example 1: Name: Joseph Philip Harrison Cornwell
  185.                               0--------1---------2---------3---------4---
  186.             Field size: 10    Joseph Cor
  187.                         20    Joseph Cornwell
  188.                         30    Joseph Philip Cornwell
  189.                         40    Joseph Philip Harrison Cornwell
  190.       Example 2: Place: Groton,Middlesex,Mass.,U.S.A.
  191.                               0--------1---------2---------3---------4---
  192.             Field size: 10    Groton,Mas
  193.                         20    Groton,Mass.,U.S.A.
  194.                         30    Groton,Middlesex,Mass.,U.S.A.
  195.       {NOTE: in the above example, field size of 20 causes "U.S.A." to be
  196.        included in the descript even though it has a lower priority than
  197.        "Middlesex".  This is because there was not enough room to include
  198.        the Level2 name, but there was enough room for the Level4 name.}
  199.  
  200.   4.  You may experience error 243 during a file opening that crashes the
  201.       program.  This is caused by a system that is not configured with
  202.       enough buffers to fill the requirements of the program.  The DOS
  203.       system defaults to 10 files, I think.  You can include the FILES= state-
  204.       ment in the CONFIG.SYS file to increase the number of buffers.  The
  205.       exact number you need will vary according to your particular system.
  206.       I have the statement "FILES=18" in mine, but this is more than you
  207.       should need.  I like a few extra.
  208.         If you don't have a CONFIG.SYS file already, load your boot disk in
  209.       the default drive and type "copy con: config.sys" at the system prompt.
  210.       The cursor will move to the left, down one line and wait.
  211.       Type "FILES=18" or whatever you chose.  Hit <return> and hold the
  212.       CTRL key down and simultaneously press "Z".  Hit <return> again and
  213.       your CONFIG.SYS file will be created.
  214.         See your DOS reference manual for the particulars on this.
  215.  
  216.   5.  I recommend you use a print spooler.  It will speed up the printing
  217.       immensely.  There are freeware print spoolers available on most
  218.       BBS's.
  219.  
  220.   6.  My address is:
  221.         Wayne R. Shepard
  222.         2339 45th Ave.
  223.         San Francisco, CA 94116
  224.       If you have money to send in gratitude for this valuable contribution
  225.       to your research environment, you may send it to that address secure
  226.       in the knowledge that I will find it.  $35 is far below the suggested
  227.       retail value, but is sufficient for you to be considered morally upright,
  228.       politically correct and in good taste.  Only heathen scum send nothing.
  229.  
  230.   7.  If you have problems, you may write me at that address, or you may
  231.       embarrass me in public by leaving a message for me on the ROOTS-BBS
  232.       (415) 584-0697.
  233.  
  234. NEW IN VERSION 2.0:
  235.  
  236.   1.  Effective in ver. 2.0 is the new List/Dump facility.  This will
  237.       EXTRACT individuals from the file by whatever criteria you specify
  238.       (see note 4 below), SORT them by whatever sort order you specify,
  239.       and DISPLAY, PRINT, or WRITE to disk with or without page headings
  240.       and including whatever information you specify.  You'll have to
  241.       play with it to really appreciate it.  Again, the general rule of
  242.       thumb is the more work you want it to do for you, the longer you
  243.       have to wait.  If you don't specify a sort, the output will be printed
  244.       as it is extracted.  The sorts themselves are very fast, though, and
  245.       a large sort will not burden your time.  For large sorts, however,
  246.       the system may need to put workfiles on disk during the sort, so it
  247.       is handy to have a moderately empty disk in the default drive.  As
  248.       a benchmark for your own purposes, try extracting your entire file
  249.       (enter no extract parameters), sort it by surname and given names,
  250.       and print a list of whatever you want from them.
  251.  
  252.   2.  The search routine is new.  When you do a search, a blank individual
  253.       worksheet is presented to you.  Simply enter the values for the
  254.       search in any fields you want used as search criteria.  Leave the
  255.       rest blank.  This method is also used for the extract parameters in
  256.       the List/Dump utility.
  257.  
  258.   3.  The Search/Extract will perform a Soundex search on any field that
  259.       accepts an alphabetic entry.  To call for a Soundex search, preceed
  260.       the name entry with the left-bracket character "[".  The system will
  261.       convert the name to it's Soundex code and display it back for you.
  262.       Soundex searches are slower as more disk i/o is required to handle
  263.       the name compares.  Be forwarned and take the good with the bad.
  264.  
  265.   4.  It is now possible to view the family and individual records while
  266.       in the Lineage-Linked search mode.  You can even do quickee editing
  267.       on the individual record if you so desire.  Just follow the Function
  268.       key guide at the bottom of the screen.
  269.  
  270.   5.  PRINTER CONFIGURATION:  You now can do it.  During system configuration,
  271.       where you select which drives you want to put your files on, you also
  272.       may select the control codes to select standard and compressed print
  273.       on your printer and inform the system of the maximum line line during
  274.       each.  For control code entry, you can
  275.       enter the basic CHR$ value or the control designation with the
  276.       "carrot" (^) or a alpha character sequence in double quotes ("M").
  277.       It may require some experimentation to get it right.
  278.       If more than one character is needed (as in an escape sequence) use
  279.       commas to separate the character values.  Example:  I have an Epson
  280.       FX80.  It offers three different print densities--80,96,and 132 columns
  281.       per line.  A 15 (^O) selects compressed print and an 18 (^R) returns
  282.       it to normal, whatever normal is.  It defaults to 80 when you turn it
  283.       on, but I prefer 96.  96 character lines are selected by the ESC-M
  284.       sequence.  But the compressed print command won't work in 96 character
  285.       mode, so the ^[,"P" sequence must preceed the ^R compressed-print
  286.       command.  So to configure this, I entered ^[,"P",15 on the
  287.       compressed-print selection line and I entered 18,^[,"M" on the
  288.       Standard Print selection line.  An escape char is designated by
  289.       the number 27 or the character expression ^[.
  290.                     27,80,15  = ^[,"M",^O
  291.       Whatever you choose to enter, the system will display back the
  292.       numeric format.
  293.         In short, if you have an Epson FX-80 printer like I do, then
  294.       if you want 80 column print as a standard, make these entries:
  295.  
  296.               Standard --- 18
  297.               Compressed --- 15
  298.  
  299.       but if you want 96 column print as a standard, make these entries:
  300.  
  301.               Standard --- 18,27,"M"
  302.               Compressed --- 27,"P",15
  303.  
  304.       If you don't have an FX-80, good luck, you're on your own.  I hope
  305.       this isn't too confusing.  I tried to make it so that pretty much
  306.       any sequence required by any printer could be set up in any designation
  307.       any printer manual might use.  Let me know if I missed any.
  308.  
  309. NEW IN VERSION 2.1:
  310.  
  311.   1.  Printer control now extends to the FGS and Lineage reports solving
  312.       problems of line wrap for users with maximum printlines of less than
  313.       132.
  314.  
  315.   2.  The MARK LIST has been added.  At any information screen you may hit
  316.       F10 and the record number you are examining will be added to the
  317.       mark list.  If you are at an individual's record, the RIN will be
  318.       put on the list.  If you are at a marriage record or displaying the
  319.       family structure, the Marriage RIN will be added to the list.
  320.       When you do a FIND BY RIN or a FIND BY MRIN, the mark list will be
  321.       displayed for you.  This is handy for keeping track of people you
  322.       need to get back to later.  Marriages will be displayed with an
  323.       asterisk ("*") next to the names to distinguish them from individual's
  324.       records.  If you hit F10 while looking at the mark list, you can
  325.       delete an item from the list.  On all information screens, marked
  326.       numbers will be displayed with the asterisk to indicate that they
  327.       are on the mark list already.  At the lineage-linked display screen,
  328.       hitting F10 will mark the individual at the root of the display.
  329.       NOTE: There isn't always enough room on the screen to document this
  330.       fact at runtime, so I have taken the liberty to not document it at all
  331.       on the screen.  Also, the Mark list is not currently active on the
  332.       history notes screen.
  333.  
  334.   3.  The CLEAR function in List/Dump parameters section has been moved to
  335.       F9.  It formerly used F10, and conflicted with the mark list.
  336.  
  337.   4.  Up to 10 control characters can be entered for each control function
  338.       in the printer configuration.
  339.  
  340. NEW IN VERSION 2.2:
  341.  
  342.   1.  A glitch in the List/Dump facility is corrected.
  343.  
  344.   2.  Further enhancements to the History note section.  The limit to
  345.       the number of records has been increased.  Memory-permitting, it
  346.       should set itself to about 490 lines.  If there is not enough
  347.       memory, it should adjust itself accordingly.
  348.  
  349.         The controls also have been modified.  In addition to the
  350.       function keys (whose use is described on the bottomline of the
  351.       screen) the keypad controls also perform the following functions:
  352.  
  353.       HOME: sends the cursor to the beginning of the current line.
  354.       UP ARROW: goes to the next line above the current line.
  355.       PG UP: Displays the previous page, beginning 15 lines above the
  356.              current top line of the window.
  357.       LEFT ARROW: Moves the cursor to the left one character.
  358.       RIGHT ARROW: Moves the cursor to the right one character.
  359.       END:  Moves the cursor to the end of the current line.
  360.       DOWN ARROW: Moves to the line which follows the current line if
  361.            there is one.
  362.       PG DN:  Displays the next 16 lines beginning with the bottom line
  363.            of the current page.
  364.  
  365.         When the CTRL key is held down, certain keys have other functions:
  366.  
  367.       CNTL-HOME: Goes to the beginning of the notes.
  368.       CNTL-PG UP: Goes to the beginning of the previous note type.
  369.       CNTL-LEFT ARROW: Goes to the beginning of the previous word.
  370.       CNTL-RIGHT ARROW: Goes to the beginning of the next word.
  371.       CNTL-END: Goes to the end of the notes and is ready to add a new line.
  372.       CNTL-PG DN: Goes to the beginning of the next note type if there is
  373.            one.
  374.  
  375.     4.     Also included for the first time in this release is a little
  376.       utility program called IDXEDIT.  One purpose of genealogical BBS's is
  377.       to help each perticipant find out who might know something about
  378.       people he or she is working on.  One way we do this is by indexing
  379.       our data files and uploading the indexes to our favorite BBS for
  380.       public perusal.  IDXEDIT makes this job easy.  TRACER does the first
  381.       part of the job, IDXEDIT does the middle part.  It's up to you to
  382.       upload it (the last part).
  383.            IDXEDIT runs with command line parameters.  If you run it without
  384.       the command line parameters, it will politely give you instructions
  385.       on how to create the BBS-compatible index for your files.
  386.            Now you have no excuses.
  387.  
  388.       Hard disk users:
  389.  
  390.            IDXEDIT will not find files in subdirectories, but TRACER will
  391.       put the files in subdirectories.  IDXEDIT should be run from your
  392.       "path" while you are in the appropriate family's subdirectory.
  393.  
  394. Explore.
  395.  
  396.                   copyright 1986 by Wayne R. Shepard