home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / p / pafutil.zip / DESCEND.DOC < prev    next >
Text File  |  1992-04-23  |  26KB  |  542 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.                  DESCEND - An Expanded Descendant Chart for PAF
  27.         
  28.                                 by John C. Barron
  29.                                510 E. Braker Lane
  30.                                 Austin, TX 78753
  31.         
  32.                                    Version 2.3
  33.                                    23 Apr 1992
  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.                                     Abstract 
  61.         
  62.              This program reads Personal Ancestral File (PAF) 2.x data 
  63.         files and produces an expanded descendant chart.  The chart can 
  64.         include up to 16 generations, any person can have up to 5 mar-
  65.         riages, and any couple can have up to 20 children.  There is a 
  66.         limit of 5,000 selected marriages.  An individual entry consists 
  67.         of a descendant with birth, death, and (optional) notes followed 
  68.         by a spouse with birth, marriage, death, (optional) parent data, 
  69.         and notes.  This pattern is then repeated for their children.  An 
  70.         index is generated after the chart.  Up to 5,200 index entries 
  71.         can be expected and the user is warned if the index cannot be 
  72.         completed.  The chart can be routed to three output sources:  
  73.         printer, screen, or disk file.  Printer drivers for about 40 
  74.         printers can be selected and drivers can also constructed for a 
  75.         specific printer.  DESCEND require a 16 pitch font to operate 
  76.         correctly since it indents for each generation.  Several new 
  77.         options are supplied with this version.  
  78.         
  79.         
  80.         
  81.         
  82.         
  83.                                   Introduction
  84.         
  85.              The Personal Ancestral File Genealogy System produced and 
  86.         sold by the Church of the Latter Day Saints (LDS) is an extremely 
  87.         good, inexpensive way for genealogists to organize their data.  
  88.         For storage and searches it is hard to beat, but its output is 
  89.         very generic and is often not optimal for certain uses.
  90.         
  91.              Along with the usual pedigree charts and family group 
  92.         sheets, PAF produces a descendant chart.  It is limited in nature 
  93.         and outputs just the generation number, name, date of birth, and 
  94.         RIN of the descendants.  You can route it to screen, disk, or 
  95.         printer but you have no control over the contents.
  96.         
  97.         
  98.         
  99.         
  100.                                Development History
  101.         
  102.              The program was begun in March, 1988, but little progress 
  103.         was made until the end of the year when Bourland Corp. released 
  104.         Turbo Pascal 5.0 and its interactive debugger.  By the use of 
  105.         this powerful product, I was able to solve some very tricky 
  106.         problems and complete the project.  The following table lists the 
  107.         released versions of the program and the principle modifications 
  108.         of each.
  109.         
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.         
  117.             Vs.     Date        Modification
  118.         
  119.             1.0  20 Jan 1989    Completed using Turbo Debug.
  120.             1.1  11 Feb 1989    Added search window.
  121.             1.2  10 Mar 1989    Fixed dual date problem.
  122.             1.3  18 Mar 1989    Used paf unit for path.
  123.             1.4   4 Aug 1989    Limit no. generations.
  124.             1.5  13 Sep 1989    Increase no. persons input.
  125.             1.6   7 Oct 1989    Fix LF on null note problem.
  126.             1.7  24 Nov 1989    Fix note line length overflow.
  127.             1.8  18 Jan 1990    Use christening & burial if birth or 
  128.                                 death dates missing.
  129.             1.9  23 Feb 1990    Set maximum marriages to 5000.
  130.             2.0  10 Oct 1990    Revised marriage array, added PAF
  131.                                 name/address to output, added command
  132.                                 line path input, more bullet proof input,
  133.                                 revised mar array, indicate spouse with
  134.                                 sp-, added option for printing notes, add
  135.                                 name & rin of selected person, added 
  136.                                 chart title option, checked index memory 
  137.                                 usage.
  138.             2.1  22 Nov 1990    Fixed bug with MaxSpo, fixed problem when
  139.                                 person had blank surname, fixed problem
  140.                                 with it not running in current directory.
  141.             2.1a 11 Mar 1991    Released as shareware version.
  142.             2.1b 24 Mar 1991    Increased marriage arrays back from 1,000
  143.                                 to 5,000.
  144.             2.1c  5 Apr 1991    Fixed problem with note printing.
  145.             2.1d 31 May 1991    Revised final page output.
  146.             2.2   4 Jan 1992    Isolated output, added options screen,
  147.                                 added margin, printer options screen,
  148.                                 added config file, overlayed files, fixed
  149.                                 note overflow, added burial usage, tagged
  150.                                 note option, uppercase surname option,
  151.                                 spouse's parents, select up to 30 RINS.
  152.             2.3  23 Apr 1992    increased mrin display length, restore
  153.                                 orig. video settings, replaced all 
  154.                                 integer type with word, added pafhalt
  155.                                 standard procedure, fixed spouse parent
  156.                                 addition bug.
  157.         
  158.         
  159.         
  160.         
  161.         
  162.         
  163.         
  164.         
  165.         
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.                                       Usage
  173.         
  174.              The program can be started in two ways from the DOS prompt:  
  175.         1) by entering the name (DESCEND), or 2) by entering the name and 
  176.         a path to the directory where the PAF files are located.  The 
  177.         following examples illustrate the methods:
  178.         
  179.                   D:\>DESCEND
  180.                   D:\>DESCEND D:\PAF\
  181.         
  182.              If a valid path to the PAF files is given, DESCEND goes 
  183.         directly into operation.  If no path is given and if no PAF.CFG 
  184.         file is present (more on this later), an introductory screen 
  185.         describing the program is shown followed by another screen re-
  186.         questing the path.  If the PAF data files are in the current 
  187.         directory, DESCEND begins running.  If you are confused about 
  188.         directories and paths to them, then it would be advisable to read 
  189.         your DOS manual, especially the chapter about tree-structured 
  190.         directories.
  191.         
  192.              If no path to PAF files is given on startup, DESCEND prompts 
  193.         the user for this information with the path screen.  At this 
  194.         point, and at almost any other input option, the user can halt 
  195.         the program.  If the user chooses, however, a path can be given 
  196.         and the program will continue to cycle in this screen until a 
  197.         valid path is input or until the user decides to quit.
  198.         
  199.              Once a valid path to PAF files is given, DESCEND prompts the 
  200.         user for some additional information.  At this point you can 
  201.         still (Q)uit, or you can (C)hange the path once more, or you can 
  202.         (S)ave the path in the PAF.CFG file for later usage, or you can 
  203.         (U)se the path.  If you save it, it automatically uses it too.  
  204.         The file PAF.CFG is written on the current directory when you 
  205.         save it and is also used the next time DESCEND is started.  It is 
  206.         simply an ASCII file containing the path to PAF files.
  207.         
  208.              Using the path gets you started with the rest of the pro-
  209.         gram.  The next step displays a window which gives the user a 
  210.         number of options which can be selected by the user to customize 
  211.         the chart as desired.  The options available at this point are as 
  212.         follows:
  213.         
  214.         A.  How many descendant generations do you want? (maximum is 16)
  215.         B.  How many spaces on the left margin? (maximum is 20)
  216.         C.  What output mode do you want? (Screen/Print/File)
  217.         D.  Do you want printer commands in file output? (Y/N)
  218.         E.  Do you want to change the default chart title? (Y/N)
  219.             DESCENDANT CHART - Version 2.2
  220.         F.  Do you want to include RINs & MRINs in the chart? (Y/N)
  221.         G.  What notes do you want to include? (All/Tagged/None)
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.         H.  What tag do you use in your notes?
  229.         I.  Do you want the make surnames upper case? (Y/N)
  230.         J.  Do you want "son/dau of" in spouse data? (Y/N)
  231.         S.  Do you want to save these settings for future charts? (Y/N)
  232.         
  233.              Option A - Prompts the user to enter the number of genera-
  234.         tions to use in the chart.  The maximum (and default) number of 
  235.         generations that DESCEND can process is 16.  Entering 2 genera-
  236.         tions would produce a chart similar to a family group sheet.  If 
  237.         the number of generations desired is exceeded during the process 
  238.         of producing a chart, DESCEND ignores them and prints a message 
  239.         indicating that more information is available.
  240.         
  241.              Option B - Allows the user to set the number of spaces on 
  242.         the left hand margin of the chart.  This has no affect for charts 
  243.         sent to the screen however.  The default margin is 0 (none).
  244.         
  245.              Option C - Concerns the output destination for the chart.  
  246.         Three modes are available:  screen, print, or file.  Screen 
  247.         output shows the chart to the user on the terminal and does not 
  248.         produce printed output.  This is recommended for checking a chart 
  249.         before printing a lot of pages.  The default is to send the 
  250.         output to the printer.  The third option is to send the output to 
  251.         a disk file named DESCEND.TXT which you can edit and print with a 
  252.         word processor or print with the DOS print command, PRINT.COM.
  253.         
  254.              Option D - This options allows the user to insert printer 
  255.         control (escape sequence) codes into the optional DESCEND disk 
  256.         file.  These are normally wanted to print the file with the DOS 
  257.         print command, but not wanted for a file that will be subsequent-
  258.         ly edited before printing.
  259.         
  260.              Option E - Here you can personalize the output by using the 
  261.         next option which asks if the user desires a title for the chart.  
  262.         If you select yes, then an input area is opened which will allow 
  263.         you to enter a 55-character chart title which will be printed at 
  264.         the top of each page.  If no special title is requested, then the 
  265.         name and version of the program is used in its place.  I recom-
  266.         mend that you use a chart title listing the first person in the 
  267.         chart.
  268.         
  269.              Option F - The next option for the chart concerns the list-
  270.         ing of RINs and MRINs in the output.  The user is asked if these 
  271.         reference numbers are desired.  If the chart is to be sent to 
  272.         others, these numbers make no sense to them and should be left 
  273.         off which is the chart default.  On the other hand if the chart 
  274.         is for your own use as a reference for additional work, you can 
  275.         nearly always find good use for the RIN and MRIN numbers.  The 
  276.         MRINs are shown in parentheses after the RIN of a spouse entry.
  277.         
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.              Option G - This option asks the user about including notes 
  285.         from the PAF files in the chart.  Three options are available:  
  286.         all notes, tagged notes, or no notes.  If "all" notes (the de-
  287.         fault) is selected then the PAF notes are included along with the 
  288.         birth, marriage, and death entries.  Only regular notes created 
  289.         by PAF are included; those created by a word processor and linked 
  290.         to a PAF entry are not included.  Perhaps inclusion of these 
  291.         notes can be implemented by a future update of DESCEND.  If the 
  292.         "tagged" notes option is selected then only those note entries 
  293.         starting with your personal tag are included.  Obviously, the 
  294.         "none" selection will include no notes in the output.
  295.         
  296.              Option H - This option allows you to enter your own personal 
  297.         one-character tag.  The default is ! which is what is recommended 
  298.         by PAF.
  299.         
  300.              Option I - With this option the user can instruct DESCEND to 
  301.         make all surnames uppercase regardless of how they were recorded 
  302.         in the PAF database files.  The default is no which will use the 
  303.         names as they are in the database.
  304.         
  305.              Option J - The is a much requested new option which allows 
  306.         the user to include information about a spouse's parents in a 
  307.         chart entry, provided, of course, they are in the PAF file.  If 
  308.         the default value (yes) is selected, then male spouses will have 
  309.         "son of" [his parents names] included before his notes section 
  310.         while for a female spouse "dau of" will appear.  These parent 
  311.         names are also included in the index and I recommend that the 
  312.         option be used for a more complete chart.  Additionally, its use 
  313.         also shows the user where "holes" exist in a PAF database.
  314.         
  315.              Option S - This option allows the user to save most of the 
  316.         above selected options in a disk file named DESCEND.CFG which is 
  317.         saved in the default directory.  This provides a way to customize 
  318.         and optimize your chart settings for future use without resetting 
  319.         the options every time.  You can use this to your advantage by 
  320.         setting the no saving switch when you make a special chart having 
  321.         options for a specific reason.  The default is to save the se-
  322.         lected option settings.
  323.         
  324.              If the chart is to be sent to the printer, then additional 
  325.         options can be set.  These printer options are displayed by an 
  326.         additional menu which looks something like the following.
  327.         
  328.         
  329.         
  330.         
  331.         
  332.         
  333.         
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.         ======================== Printer Setup Screen ===================
  341.         Printer Selected                      1..Select Another Printer
  342.                                               2..Show Code Details     
  343.                                               3..Change Printer Codes  
  344.         Initialization Code                   4..Abort This Chart      
  345.                                                                         
  346.                                               0..Continue With Chart   
  347.         Pitch Code                                                     
  348.                                               Enter choice -           
  349.         
  350.         8 Lines/Inch Code (blank for 6 l/i)                                 
  351.                                                                        
  352.                                                                        
  353.         Port                                                           
  354.         ================================================================
  355.              The options addressed in the printer menu work as follows:  
  356.         1) select your specific printer from a list of some 40 provided 
  357.         in the program, 2) show the details of the escape codes of your 
  358.         selected printer, 3) change or customize your printer codes to 
  359.         what better suits your needs, 4) abort or abandon the chart, and 
  360.         finally, 0) continue with creating your chart.
  361.         
  362.          1..AT&T (DM)         17..HP Deskjet          33..Qume Sprint        
  363.          2..AT&T 457/458      18..HP LaserJet         34..Silver Reed
  364.          3..AT&T 473/474      19..IBM ProPrint. (New) 35..Star                
  365.          4..Brothers (DM)     20..IBM ProPrint. (Old) 36..Star NX-1000        
  366.          5..Brothers (DW)     21..IBM Quietwriter III 37..Tandy DMP          
  367.          6..C-Itoh F10-40/55  22..Juki 6100/6300      38..TI 855
  368.          7..C-Itoh Prowriter  23..Microline IDS       39..TI 865               
  369.          8..Citizen           24..MPI 50 G         40..Toshiba P351/P1340 
  370.          9..DEC LA 50/100     25..NEC 8000            41..Transtar           
  371.         10..Diablo 1620/30    26..NEC Spinwriter      42..Default Printer    
  372.         11..Diablo 620/30     27..Okidata             43..Other              
  373.         12..DOS Text Printer  28..Okidata (Epson)                            
  374.         13..Epson EX/LQ       29..Okidata (IBM Comp.)                        
  375.         14..Epson FX/LX/RX    30..Oliveti Ink Jet                            
  376.         15..Epson MX          31..Olympia Compact                            
  377.         16..Gemini            32..Panasonic                                  
  378.         
  379.              The above printers are currently supported.  For the most 
  380.         part, these are the printers supported by the 2.2 version of PAF.  
  381.         If you have a dot matrix printer that is not listed, try using 
  382.         the 1st menu option and selecting either the default printer 
  383.         (#42) or the Epson FX/LX/RX (#14).  If you have a laser printer 
  384.         that is not listed, try selection 18, the HP LaserJet.
  385.         
  386.              If your printer still doesn't work properly, then you may 
  387.         have to build your own printer driver.  To do this select printer 
  388.         menu option 2 (Show Code Details).  You will see a screen that 
  389.         shows the presently selected codes for printer initialization, 
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.         pitch, and lines per inch.  The table looks as follows:
  397.         
  398.         ================================================================
  399.         
  400.          Printer Name: HP Deskjet     Port: LPT1: LPT2: COM1: COM2: COM3:     
  401.                                                                                       
  402.          Initialization:   ^E                                           
  403.           27  69 ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___
  404.          Pitch:            ^(s16H                                      
  405.           27  40 115  49  54  72 ___ ___ ___ ___ ___ ___ ___ ___ ___ ___
  406.          8 Lines per Inch: ^&l8D                                       
  407.           27  38 108  56  68 ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ 
  408.         
  409.         ================================================================
  410.         
  411.              After viewing the selections, return to the printer menu and 
  412.         select option 3 (Change Printer Codes).  The numbers shown are 
  413.         the decimal equivalents of the escape sequences of the selected 
  414.         printer.  For instance to initialize an HP Deskjet printer, you 
  415.         send an escape E sequence while escape @ initializes Epson com-
  416.         patibles.  Check your printer manual for your particular initial-
  417.         ization code.
  418.         
  419.              The pitch code is special for DESCEND.  Your printer must be 
  420.         set to a non-proportional, compressed pitch of 17 characters per 
  421.         inch or more.  Since each generation of a chart is indented 4 
  422.         spaces, without a compressed pitch or font you will quickly have 
  423.         lines longer than can be properly printed.  This will usually 
  424.         result in a margin overflow situation and some of the line will 
  425.         be printed along the left margin jumbling the indentation.
  426.         
  427.              The next thing that can be addressed in the print change 
  428.         menu is the 8 lines per inch (lpi) vertical option.  The standard 
  429.         printer setting is to print 6 lines per inch and DESCEND comes 
  430.         equipped to do this.  However, more information can be presented 
  431.         by using 8 lpi and most printers can do this.  If your selected 
  432.         printer does not show a code in this slot, check your manual and 
  433.         change the settings.
  434.         
  435.              The default output port is set to LPT1:, but with the print-
  436.         er change menu this too can be changed to whatever parallel or 
  437.         serial port you use.  If your printer doesn't work with the 
  438.         default, keep changing the port until you select the right one.
  439.         
  440.              If your printer still does not work properly with the print-
  441.         er selected, then you should set the file output mode to send the 
  442.         output to a disk file.  The resulting file is named DESCEND.TXT 
  443.         and is written to the current directory.  The names of the indi-
  444.         viduals in the chart are listed and scroll by to merely show the 
  445.         user that something is taking place.  Birth and death dates, 
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.         notes, etc., do not appear on the screen, but are actually in the 
  453.         file.
  454.         
  455.              You should rename the disk file if you wish to keep it 
  456.         permanently; otherwise, it will be overwritten the next time you 
  457.         choose this selection.  You can edit this file with a word pro-
  458.         cessor and make whatever changes are desired.  Care should be 
  459.         taken, however, not to make changes that affect the page numbers 
  460.         or else the index will no longer be correct.  You should be able 
  461.         to print the file either with your word processor or with the 
  462.         PRINT command from the DOS prompt.  This is done as follows:
  463.         
  464.                   >PRINT DESCEND.TXT
  465.         
  466.         
  467.              At this point, you are ready to tell the program which 
  468.         persons to include in the descendant chart.  You can enter up to 
  469.         30 individuals for a run, all of whom will be included in the 
  470.         order given and separated by a message indicating the beginning 
  471.         each new line.  Only a very small amount of information will be 
  472.         duplicated in a chart with common lines.  At the prompt, you can 
  473.         either enter a RIN if you know it, search for a particular per-
  474.         son, or, as usual, quit.
  475.         
  476.              If you enter a RIN number, DESCEND accesses the PAF files 
  477.         and displays the person, along with parents and spouse.  The user 
  478.         is then asked to verify the selection and a message asks if this 
  479.         is the correct person.  The user can answer (Y)es, (N)o continue 
  480.         search, or (Q)uit search.  Quitting returns to the enter RIN 
  481.         prompt as does selecting no.  Choosing yes selects the displayed 
  482.         individual as part of the descendant chart run.  The name of this 
  483.         selected person replaces the enter RIN prompt line and the pro-
  484.         cess is repeated.
  485.         
  486.              Most of the time RINs are not remembered and you will need 
  487.         to choose the search selection at the enter RIN prompt.  You can 
  488.         search for as many as three names of a person's names.  If fewer 
  489.         than three names are input, you must still press the enter key 
  490.         for each of the name fields on the screen.  If the search finds 
  491.         no such combination of names, it will inform you and return to 
  492.         the current enter RIN prompt.  If the search finds an individual 
  493.         with the entered combination of names, it will display the person 
  494.         along with parents and spouse.  Once more it will ask if this is 
  495.         the correct person.  If you select no, the program will continue 
  496.         to search for additional persons of the entered name combination.  
  497.         Quitting, of course, returns you to the current enter RIN prompt 
  498.         and choosing yes selects the displayed person for the descendant 
  499.         chart.
  500.         
  501.              You can continue the selection of RINs for inclusion in the 
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.         chart until reaching the limit of 30 or stop at any amount fewer.  
  509.         This limit is imposed at this time as a safety feature to try to 
  510.         prevent the overflow of index entries which are presently kept in 
  511.         memory as a linked list.  If a memory overflow occurs, the index 
  512.         cannot be completed and the program will halt and ask the user 
  513.         whether to continue.  At the end of the run the memory used by 
  514.         the index is reported.
  515.         
  516.         
  517.         
  518.         
  519.                                    Discussion
  520.         
  521.              Well, that's about it.  The program is pretty simple and 
  522.         hopefully user friendly.  I have been pleased and surprised by 
  523.         the reception it has received by PAF users in many parts of the 
  524.         country.  Users of the NGC echo have been especially helpful in 
  525.         giving me suggestions for improvements as well as pointing out 
  526.         bugs and shortcomings.  Thank you all and keep the comments 
  527.         coming.
  528.         
  529.              I release the program under the shareware concept which 
  530.         essentially provides you a trial use period.  Try the program 
  531.         out; check all the options.  If you find it helps you in your 
  532.         research, please fill out the included registration form and send 
  533.         me a fee of $20.00 toward its future development.  You may enthu-
  534.         siastically provide copies to your friends and acquaintances for 
  535.         their use, upload it to your local computer bulletin boards, and 
  536.         call it to the attention of your computer and genealogical 
  537.         groups.  You may pass it around and distribute it in any manner 
  538.         except for sale.  Thank you, John.
  539.  
  540.  
  541.  
  542.