home *** CD-ROM | disk | FTP | other *** search
/ Shareware 1 2 the Maxx / sw_1.zip / sw_1 / GENEFILE / DESCEN21.ZIP / DESCEND.DOC next >
Text File  |  1990-12-10  |  15KB  |  281 lines

  1.  
  2.  
  3.  
  4.         
  5.         
  6.         
  7.         
  8.         
  9.         
  10.         
  11.         
  12.         
  13.         
  14.         
  15.         
  16.         
  17.         
  18.         
  19.         
  20.         
  21.         
  22.         
  23.         
  24.         
  25.         
  26.         
  27.                  DESCEND - An Expanded Descendant Chart for PAF
  28.         
  29.                                 by John C. Barron
  30.                                510 E. Braker Lane
  31.                                 Austin, TX 78753
  32.         
  33.                                    22 Nov 1990
  34.         
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.                                     Abstract 
  42.              This program reads Personal Ancestral File (PAF) 2.x data 
  43.         files and produces an expanded descendant chart.  The chart can 
  44.         have up to 16 generations, any person can have up to 5 marriages, 
  45.         and any couple can have up to 20 children.  An individual entry 
  46.         consists of a descendant with birth, death, and (optionally) 
  47.         notes followed by a spouse with birth, marriage, death, and 
  48.         notes.  This pattern is then repeated for their children.  An 
  49.         index is generated after the chart.  The chart can be routed to 
  50.         three output sources:  printer, screen, or disk file.  For di-
  51.         rectly printed charts, the printer instructions are EPSON stand-
  52.         ard and include compressed mode (17 cpi) and eight lines per inch 
  53.         vertically.  If your printer does not accept these commands then 
  54.         use the disk output mode and edit the resulting file with a word 
  55.         processor before printing.
  56.         
  57.                                   Introduction
  58.              The Personal Ancestral File Genealogy System produced and 
  59.         sold by the Church of the Latter Day Saints (LDS) is an extremely 
  60.         good, inexpensive way for genealogists to organize their data.  
  61.         For storage and searches it is hard to beat, but its output is 
  62.         very generic and is often not optimal for certain uses.
  63.              Along with the usual pedigree charts and family group 
  64.         sheets, PAF produces a descendant chart.  It is limited in nature 
  65.         and outputs just the generation number, name, date of birth, and 
  66.         RIN of the descendants.  You can route it to screen, disk, or 
  67.         printer but you have no control over the contents.
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.                                Development History
  75.              The program was begun in Mar 1988, but little progress was 
  76.         made until the end of the year when Bourland Corp. released Turbo 
  77.         Pascal 5.0 and its interactive debugger.  By the use of this 
  78.         powerful product, I was able to solve some very tricky problems 
  79.         and complete the project.  The following table lists the released 
  80.         versions of the program and the principle modifications of each.
  81.         
  82.              Vs.  Modification                         Date
  83.         
  84.              1.0  Completed using Turbo DeBug.       20 Jan 1989 
  85.              1.1  Added search window.               11 Feb 1989 
  86.              1.2  Fixed dual date problem.           10 Mar 1989 
  87.              1.3  Used paf unit for path.            18 Mar 1989 
  88.              1.4  Limit no. generations.              4 Aug 1989 
  89.              1.5  Increase no. persons input.        13 Sep 1989 
  90.              1.6  Fix LF on null note problem.        7 Oct 1989 
  91.              1.7  Fix note line length overflow.     24 Nov 1989 
  92.              1.8  Use christening & burial if        18 Jan 1990 
  93.                        birth or death dates missing.
  94.              1.9  Set maximum marriages to 5000.     23 Feb 1990 
  95.              2.0  Revised marriage array, added      10 Oct 1990 
  96.                        PAF name/address to output,
  97.                        added command line path input,
  98.                        more bullet proof input, 
  99.                        revised mar array, 
  100.                        indicate spouse with sp-, 
  101.                        added option for printing notes, 
  102.                        add name & rin of selected person,
  103.                        added chart title option,
  104.                        checked index memory usage.
  105.              2.1  Fixed bug with MaxSpo, fixed       22 Nov 1990
  106.                        problem when person had blank surname,
  107.                        fixed problem with it not running in 
  108.                        current directory.
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.                                       Usage
  116.              The program can be started in two ways from the DOS prompt:  
  117.         1) by entering the name (DESCEND), or 2) by entering the name and 
  118.         a path to the directory where the PAF files are located.  The 
  119.         following examples illustrate the methods:
  120.         
  121.                   D:\>DESCEND
  122.                   D:\>DESCEND D:\PAF\
  123.         
  124.              If a valid path to the PAF files is given, DESCEND goes 
  125.         directly into operation.  If no path is given and if no PAF.CFG 
  126.         file is present (more on this later), an introductory screen 
  127.         describing the program is shown followed by another screen re-
  128.         questing the path.  If the PAF data files are in the current 
  129.         directory, DESCEND begins running.  If you are confused about 
  130.         directories and paths to them, then it would be advisable to read 
  131.         your DOS manual, especially the chapter about tree-structured 
  132.         directories.
  133.              If no path to PAF files is given on startup, DESCEND prompts 
  134.         the user for this information with the path screen.  At this 
  135.         point, and at almost any other input option, the user can halt 
  136.         the program.  If the user chooses, however, a path can be given 
  137.         and the program will continue to cycle in this screen until a 
  138.         valid path is input or until the user decides to quit.
  139.              Once a valid path to PAF files is given, DESCEND prompts the 
  140.         user for some additional information.  At this point you can 
  141.         still (Q)uit, or you can (C)hange the path once more, or you can 
  142.         (S)ave the path in the PAF.CFG file for later usage, or you can 
  143.         (U)se the path.  If you save it, it automatically uses it too.  
  144.         The file PAF.CFG is written on the current directory when you 
  145.         save it and is also used the next time DESCEND is started.  It is 
  146.         simply an ASCII file containing the path to PAF files.
  147.              Using the path gets you started with the rest of the pro-
  148.         gram.  The next step prompts the user to enter the number of 
  149.         generations desired.  The maximum number of generations that 
  150.         DESCEND can process is 16.  Entering 2 generations would produce 
  151.         a chart similar to a family group sheet.  Entering a zero for the 
  152.         number of generations will abort the program and stop the run.  
  153.         If the number of generations desired is exceeded during the 
  154.         process of producing a chart, DESCEND ignores them and prints a 
  155.         message indicating that more information is available.
  156.              At this point, you are ready to tell the program which 
  157.         persons to include in the descendant chart.  You can enter up to 
  158.         10 individuals for a run, all of whom will be included in the 
  159.         order given and separated by a message indicating the beginning 
  160.         each new line.  At the prompt, you can either enter a RIN if you 
  161.         know it, search for a particular person, or, as usual, quit.
  162.              If you enter a RIN number, DESCEND accesses the PAF files 
  163.         and displays the person, along with parents and spouse.  The user 
  164.         is then asked to verify the selection and a message asks if this 
  165.         is the correct person.  The user can answer (Y)es, (N)o continue 
  166.         search, or (Q)uit search.  Quitting returns to the enter RIN 
  167.         prompt as does selecting no.  Choosing yes selects the displayed 
  168.         individual as part of the descendant chart run.  The name of this 
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.         selected person replaces the enter RIN prompt line and the proc-
  176.         ess is repeated.
  177.              Most of the time RINs are not remembered and you will need 
  178.         to choose the search selection at the enter RIN prompt.  You can 
  179.         search for as many as three names to attempt to find a person.  
  180.         If fewer than three names are input, you must still press the 
  181.         enter key for each of the name fields on the screen.  If the 
  182.         search finds no such combination of names, it will inform you and 
  183.         return to the current enter RIN prompt.  If the search finds an 
  184.         individual with the entered combination of names, it will display 
  185.         the person along with parents and spouse.  Once more it will ask 
  186.         if this is the correct person.  If you select no, the program 
  187.         will continue to search for additional persons of the entered 
  188.         name combination.  Quitting, of course, returns you to the cur-
  189.         rent enter RIN prompt and choosing yes selects the displayed 
  190.         person for the descendant chart.
  191.              You can continue the selection of RINs for inclusion in the 
  192.         chart until reaching the limit of 10 or stop at any amount fewer.  
  193.         This limit is imposed at this time as a safety feature to try to 
  194.         prevent the overflow of index entries which are presently kept in 
  195.         memory as a linked list.  If a memory overflow occurs, the index 
  196.         cannot be completed and the program will halt and ask the user 
  197.         whether to continue.  At the end of the run the memory used by 
  198.         the index is reported.  Hopefully, future releases of DESCEND can 
  199.         be designed to include a larger number of selections.
  200.              After selecting the persons to be included in the chart, 
  201.         DESCEND prompts the user for the desired output destination.  The 
  202.         selections are (S)creen, (P)rint, (F)ile, or (Q)uit.  Quitting 
  203.         stops the run without further action.  Selecting screen output 
  204.         directs the chart to the terminal.  This may be the best selec-
  205.         tion for checking a new run to make sure it is what is wanted.  
  206.         You can stop the screen output at any page break by the control-
  207.         break key combination.
  208.              Print output selection, of course, sends the chart to the 
  209.         printer attached to the LPT1 print device.  Printer control codes 
  210.         are EPSON (c) standard for dot matrix output.  No other printers 
  211.         are, at present, supported.  Printer controls will be the object 
  212.         of future releases of the program.  It is anticipated that more 
  213.         printers (especially laser printers) will be supported directly 
  214.         and that the user can also enter whatever codes are needed for 
  215.         others.  The PAF.CFG file may be used to retain these codes.  
  216.         Printed output is condensed pitch (17 characters per inch hori-
  217.         zontally) and 8 lines per inch vertically.
  218.              If your printer does not work properly with the print selec-
  219.         tion, then you should use the file selection to send the output 
  220.         to a disk file.  The resulting file is named DESCEND.TXT and is 
  221.         written to the current directory.  The names of the individuals 
  222.         in the chart are listed and scroll by to merely show the user 
  223.         that something is taking place.  Birth and death dates, notes, 
  224.         etc., do not appear on the screen, but are actually in the file.  
  225.         You should rename this file if you wish to keep it permanently; 
  226.         otherwise it will be overwritten the next time you choose this 
  227.         selection.  You can edit this file with a word processor and make 
  228.         whatever changes are desired.  Care should be taken, however, not 
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.         to make changes that affect the page numbers or else the index 
  236.         will no longer be correct.  You should be able to print this file 
  237.         either with your word processor or with the PRINT command from 
  238.         the DOS prompt.  This is done as follows:
  239.                   >PRINT DESCEND.TXT
  240.              You can personalize the output by using the next option 
  241.         which asks if the user desires a title for the chart.  If you 
  242.         select yes, then an input area is opened which will allow you to 
  243.         enter a 55-character chart title which will be printed at the top 
  244.         of each page.  If no special title is requested, then the name 
  245.         and version of the program is used in its place.  I recommend 
  246.         that you use a chart title listing the first person in the chart.
  247.              The next option for the chart concerns the listing of RINs 
  248.         and MRINs in the output.  The user is asked if these reference 
  249.         numbers are desired.  If the chart is to be sent to others, these 
  250.         numbers make no sense to them and should be left off.  On the 
  251.         other hand if the chart is for your own use as a reference for 
  252.         additional work, you can nearly always find good use for the RIN 
  253.         and MRIN numbers.  The MRINs are shown in parentheses after the 
  254.         RIN of a spouse entry.
  255.              The last option for the chart asks the user if notes from 
  256.         the PAF files are desired.  If yes is selected then the PAF notes 
  257.         are included along with birth, marriage, and death entries.  Only 
  258.         regular notes created by PAF are included; those created by a 
  259.         word processor and linked to a PAF entry are not included.  
  260.         Perhaps inclusion of these notes can be implemented by a future 
  261.         update of DESCEND.
  262.         
  263.                                    Discussion
  264.              Future updates to DESCEND include more printer support as 
  265.         described above.  I also want to make better use of colors and 
  266.         will do so if I ever decide to get a color graphics terminal.  I 
  267.         would appreciate any suggestions from users and will try to meet 
  268.         them.
  269.              Well, that's about it.  The program is pretty simple and 
  270.         hopefully user friendly.  I have been pleased and surprised by 
  271.         the reception of it by PAF users in many parts of the country.  
  272.         Users of the NGC echo have been especially helpful in giving me 
  273.         suggestions for improvements as well as pointing out bugs and 
  274.         shortcomings.  Thank you all and keep the comments coming.
  275.              I hereby release the program into the public domain for the 
  276.         free use of anyone.  You may distribute it in any manner except 
  277.         for sale either by itself or as a package.
  278.          
  279.  
  280.  
  281.