home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1993 #2 / Image.iso / gene / insr3a.zip / README.TXT < prev    next >
Text File  |  1993-06-30  |  9KB  |  203 lines
  1. Welcome to InstaRel!  To get more documentation after reading
  2. this, run InstaRel and then press the F1 key.
  3.  
  4. Version 1.03 changes:  6/30/93
  5.  
  6. There was a potential of a memory problem upon exiting the program.
  7. This was never reported, but it was fixed.
  8.  
  9. Version 1.02 changes:  6/11/93
  10.  
  11. Fixed a speed problem.  There is a file included with InstaRel
  12. that determines what records are inserted into the database.
  13. This file is called HR.GRM.  It may be OK not to read in so
  14. much information for each individual.  So to speed up the
  15. program, I made some changes to HR.GRM.  If you want to use
  16. InstaRel to load in all the fields that it is capable of,
  17. copy HR.SLO to HR.GRM.
  18.  
  19. Fixed a memory problem.  InstaRel was trying to read in all the
  20. CONT tags that were children of SOUR tags.  If a GEDCOM file had
  21. a lot of these in one record, there was not enough memory to read
  22. it in.
  23.  
  24. Version 1.01 changes:   4/30/93
  25.  
  26. Fixed a bug that made large databases to crash
  27.  
  28. Fixed up the rule file.  I'm still working on the threshhold value
  29. and scores that are assigned if there is a match.
  30.  
  31. Added a better status screen while the database is being updated.
  32.  
  33. Version 1.00:
  34.  
  35. Howdy, Cousin!                                     April 27, 1993
  36.  
  37. In about a half hour I'll be ready to upload InstaRel version 1.0
  38. to Compuserve and some other bulletin boards for the first time.
  39. This is kind of exciting, 'cause I've been working on this program
  40. (off and on) since about 1984, not long after the GEDCOM standard
  41. was established.  (I'm probably off on the 1984 date a little).
  42.  
  43. THANKS
  44.  
  45. A special THANKS goes to Michael Wise (who designed the first
  46. Personal Computer) who wrote the Daitch-Mokotoff Soundex algorithm
  47. for me.  He also helped with the code that processes the rules
  48. file.
  49.  
  50. HOW IT WORKS
  51.  
  52. About a year ago I developed a the prototype to InstaRel. The
  53. minute I finished writing the program I used it on two people that
  54. I had been working with at the Family History Department.  They
  55. both became my instant relatives!  I also extended my lines
  56. back further.
  57.  
  58. The program works by taking two or more GEDCOM files (your
  59. genealogy program should be able to make you a GEDCOM file) and
  60. comparing them. It is very sophisticated.  It looks to see if given
  61. names of children are the same as the parents or grandparents.  It
  62. compares dates of birth or christening dates.  It looks at marriage
  63. dates.    You can change the program so that it will report "maybe"
  64. matches or "for-sure" matches. I could go on, but you get the
  65. picture.
  66.  
  67. THE MATCH REPORT
  68.  
  69. Following is a sample match report:
  70.  
  71.                           HOW ARE WE RELATED?
  72.                                Created By
  73.                           INSTANT RELATIVES (r)
  74.                                22 MAY 1993
  75.  
  76.            |   GIVEN|            |               |               ─┐   This
  77.     SURNAME|    NAME|  BIRTH DATE|    BIRTH PLACE|  DEATH DATE    ├─┐ top line
  78. -----------------------------------------------------------------─┘-│-----
  79. MOTHER'S| MOMS'S MOM                                                │
  80.  SURNAME|    SURNAME|SPOUSE SURNAME|  SP GVN| RFN NO|SUBMITTER      │
  81. --------------------------------------------------------------------│-----
  82.                *************** (Score: 52) ***************          │ 
  83.       Nurse|   Sarah| 14 NOV 1722| Salem,Essex,MA|     ─────────────┤ Describes 
  84.         |           |        Putnam|  Samuel|  I2195|       29      │ the top
  85.                                                                     │ lines in
  86.                                                                     │ these 2
  87.       Nurse|   Sarah| 14 NOV 1722|               |     ─────────────┘ matches
  88. Mitchell|           |        Putnam|  Samuel|   R968|       45
  89.  
  90.                *************** (Score: 56) *************** 
  91.   DAVENPORT|  Thomas|        1682|Cold Springs,We| 30 DEC 1759
  92. HITCHCOC|           |       LEGGETT|   Sarah|  I1200|        2
  93.  
  94.  
  95.   Davenport|  Thomas|        1682|               | 30 DEC 1759
  96.         |           |       Leggett|   Sarah|   I292|       31
  97.                *************** (Score: 74) ***************
  98.      HORTON|    John|  6 JUN 1672|Milton,Norfolk,| 15 OCT 1742
  99.         |           |       GARNSEY|Mehitabl|  I1354|        2  ──┐
  100.                                                                   │
  101.                This submitter number matches record in SUBMIT file│
  102. 0 @S2@ SUBM  ─────────────────────────────────────────────────────┘
  103. 1 NAME Larry Allen Maddocks
  104. 1 ADDR 935 Best Ave.
  105. 2 CONT Salt Lake City, Utah 84106
  106. 1 PHON 801 484 6958
  107. 1 COMM To be used with howrel.exe
  108.  
  109.                  Score, Threshhold, and the Rules File
  110.  
  111. Following are a few lines taken from the Rules file:
  112.  
  113. 5: A.surname B.surname s=
  114. /The following is the threshold for changing match sensitivity
  115. threshhold 50
  116. /end
  117.  
  118. The first line tells Instant Relatives to add 5 to the total score if the soundex
  119. of database A (Your database) and database B match.  Line two is a comment. Put
  120. a "/" in front of a line to designate comments.  Line three tells instant
  121. relatives to not declare a match until the total score is at least 50.  You can
  122. change this to a lower amount to get matches that are more "iffy."  The "s=" in
  123. line one means to perform a soundex match.  Leaving the "s" off means perform an
  124. exact match.  That's it for documentation for the RULES file.  These rules can be
  125. changed.  I'll provide more documentation for this if there is a big enough
  126. demand.
  127.  
  128. SEND ME YOUR GEDCOM
  129.  
  130. Get the full benefits of InstaRel by registering your copy with me.
  131. Your benefits include having us compare your GEDCOM file with the
  132. huge database of GEDCOM files that we have.  You will get a report
  133. showing all those who are working on your lines, and how they are
  134. related to you.   You will also meet new friends and start getting
  135. letters from others when we compare their GEDCOM files with yours.
  136.  
  137. Another benefit you get by registering InstaRel is support. 
  138. You also will get the next upgrade of the software.
  139.  
  140. HOW TO REGISTER InstaRel
  141.  
  142. Register InstaRel by sending $30, $15 or whatever you can afford.
  143. I can accept checks, VISA or Mastercard.  This
  144. support from you will allow  me to continue to enhance your program
  145. and write new genealogy utilities.
  146.  
  147. I'll include a file that you can use to register your product, or
  148. you can call my BBS (and leave me a message with your VISA number
  149. and expiration date) at (801)466-5374, or leave a message at (801)
  150. 575-1910 or call my home at (801) 484-6958.  My address:
  151.  
  152. Larry Maddocks, Manager
  153. Knowledge Software Systems, L.C.
  154. 935 Best Ave.
  155. Salt Lake City, Utah 84106
  156.  
  157. FUTURE VERSIONS
  158.  
  159. There are times when nothing seems to be happening in InstaRel. 
  160. The program is not hung, but it does need more status messages.
  161.  
  162. It would be nice to change the threshold from the program, save the
  163. configurations, have InstaRel generate letters to your new-found
  164. cousins, to have a better looking match report.
  165.  
  166. NOTE:
  167.  
  168. With this first version, exit the program before running the next
  169. comparison and backup the file (called out.std) which contains the
  170. match report.  The 2nd output report does not get a header on it,
  171. and it overwrites the last output report.
  172.  
  173. FILES
  174.  
  175. RULES               This contains the rules that InstaRel uses to
  176.                     determine matches.  This file can be changed
  177.                     by the user, but there is no documentation or
  178.                     support for doing so.  This file also contains
  179.                     a line for changing the threshold.  See the
  180.                     on-line documentation for details.  To get to
  181.                     the on-line doc's, get into InstaRel and press
  182.                     the F1 key.
  183. SUBMIT              Keeps a record of submitters of GEDCOM files.
  184. INSTAREL EXE        Instant Relatives(tm), the executable program.
  185. HR       GRM        A grammar file that is used by InstaRel to
  186.                     store the database.
  187. HR       SLO        Slow version of HR.GRM
  188. INSTAREL HLP        The on-line help file.
  189. YOURDB   HSH        Created by InstaRel.  Gets deleted when you
  190.                     want to start a new database.
  191. YOURDB   SRT        ditto
  192. THEIRDB  HSH        ditto
  193. THEIRDB  SRT        ditto
  194. YOURDB   STD        ditto
  195. THEIRDB  STD        ditto
  196. OUT      STD        Contains the match report.  You may wish to
  197.                     print this out.  I'll see if I can make a
  198.                     print option in a next version.
  199. ORDER    TXT        Order form
  200. WARRANTY TXT        Our warranty.
  201. FILE_ID  DIZ        Description of this product
  202. README   TXT        This file
  203.