home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1993 #2 / Image.iso / gene / ws4paf22.zip / WS4PAF22.DOC next >
Text File  |  1993-07-07  |  23KB  |  634 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                      Work Sheet Generator
  18.  
  19.                               for
  20.  
  21.                  Personal Ancestral File (tm)
  22.  
  23.                               by
  24.  
  25.                       Frank E. Hutchison
  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. Personal Ancestral File and PAF are registered trademarks of the
  51. Corporation of the President of The Church of Jesus Christ of
  52. Latter-Day Saints.               ╔═════════════════════════════════════╗
  53.               ║                                     ║
  54.               ║         Worksheet Generator         ║
  55.               ║                for                  ║
  56.               ║       Personal Ancestral File       ║
  57.               ║               (PAF)                 ║
  58.               ║                 by                  ║
  59.               ║         Frank E. Hutchison          ║
  60.               ║                                     ║
  61.               ╚═════════════════════════════════════╝
  62.  
  63.      Worksheet Generator for Personal Ancestral File (PAF) is a
  64. program that will create a worksheet for an individual which
  65. contains the information found in a PAF database that relates to
  66. that person.  The person's parents, spouse(s), children, their
  67. spouse(s), and grandchild are also shown on the screen, printer, or
  68. a user-designated file.  Worksheet Generator works only with PAF
  69. databases containing INDIV2.DAT, MARR2.DAT, NAME2.DAT and
  70. NOTES2.DAT.  Other files of PAF are not used nor are GEDCOM files.
  71.      Using WS4PAF is a three-part process:
  72.  
  73.      1) Tell the program where the PAF database is located,
  74.      2) Tell the program where the output is to go, and
  75.      3) Tell the program who the worksheet(s) is about.
  76.  
  77. STARTING WS4PAF
  78. ---------------
  79.  
  80.      To start WS4PAF, type at the prompt either
  81.  
  82.      C:\>WS4PAFxx
  83.  
  84. or
  85.  
  86.      C:\>WS4PAFxx [location]
  87.  
  88. where the xx indicates the version number and [location]
  89. indicates the location of the PAF data files, which is optional.
  90.  
  91.      The title screen will appear.  If the [location] was not
  92. specified on the command line, then WS4PAF asks
  93.  
  94.                   Where is the PAF database located?
  95.  
  96.                   1.  A:
  97.                   2.  B:
  98.                   3.  C:\PAF\DATA
  99.                   4.  Other
  100.                   5.  Return to System
  101.  
  102. Menu selection is made by selecting the menu number or using the
  103. up and down arrow keys and hitting the <Enter> key.
  104.  
  105.      The first three choices will encompass probably 90% of the
  106. locations of PAF databases.  If yours is not one of the first
  107. three choices, then select option 4.  Just below the above menu
  108. will be displayed:
  109.  
  110.                   Location of PAF database: 
  111.  
  112. You can type in the path to the database.  If it is wrong, an error
  113. message will be displayed and you will be able to try again. 
  114. Option 5 will quit the program.
  115.  
  116. OUTPUT SELECTION
  117. ----------------
  118.  
  119. Now the second menu appears and asks:
  120.  
  121.           What is the location of the output?
  122.  
  123.                1.  Screen
  124.                2.  Printer
  125.                3.  File
  126.                4.  Change directory
  127.                0.  Return to System
  128.  
  129. 1.  Screen
  130. ----------
  131. Option #1 results in the worksheet being displayed on the screen. 
  132. This is best used to see the output BEFORE printing or creating a
  133. file.
  134.  
  135. 2.  Printer
  136. -----------
  137. Option #2 results in the worksheet being sent to the printer.  The
  138. default printer is assumed to be Epson compatible, however, the
  139. only special control sent to the printer is the command for
  140. compressed print on and off (normally 17 Characters Per Inch
  141. (CPI)).
  142.      If you select option #2, then another menu will appear.  This
  143. menu allows you to change the way the work sheet will be printed
  144. and adjust the codes for compressed printing if your printer is not
  145. Epson compatible.  This menu looks like:
  146.  
  147.      Output to the printer will be:
  148.  
  149.      0.  Proceed to print
  150.      1.  Compressed (toggle)                  Not compressed
  151.      2.  Compressed ON printer code           \015
  152.      3.  Compressed OFF printer code          \018
  153.      4.  Top margin                             6 lines
  154.      5.  Bottom margin                          6 lines
  155.      6.  Left margin                            0 spaces
  156.      7.  Right margin                           0 spaces
  157.      8.  Paper height                          66 lines
  158.      9.  Paper width                           80 spaces
  159.      P.  Print notes (toggle)                  Print notes
  160.      S.  Save configuration
  161.  
  162. See Appendix I for details about changing the values shown and
  163. creating new default values.  For now, choose the first option,
  164. zero (0), as it should work with a majority of printers.
  165.  
  166. 3.  File
  167. --------
  168. Option #3 will result in the creation of a file containing the
  169. worksheet.  If you select this option, you will be asked:
  170.  
  171.                Location and name of file:
  172.  
  173. WS4PAF does check what it is given for a file name and path.  If
  174. the file already exists, you will be asked if you want to over
  175. write it.  If you do not enter a file name (just hit the Return or
  176. Enter key, without entering any name), then the file will be named
  177. PRINT.DAT and placed in the same directory or subdirectory as
  178. WS4PAF.
  179.  
  180. 4.  Change directory
  181. --------------------
  182. Option #4 allows you to return to the previous menu to change the
  183. directory.
  184.  
  185. 0.  Return to System
  186. --------------------
  187. The fifth option, zero (0), will end the program and return you to
  188. the system prompt.
  189.  
  190. This choice will determine of compressed print (17 characters per
  191. inch) is used with printed output.  The option without compressed
  192. print will cause the place for each event to be printed on a
  193. separate line.
  194.  
  195. IDENTIFY STARTING INDIVIDUAL
  196. ----------------------------
  197.  
  198. The third menu asks:
  199.  
  200.                   Identify Starting Individual
  201.  
  202.                   1.  Know RIN
  203.                   2.  Do not know RIN
  204.                   3.  Input File
  205.                   4.  Change Output
  206.                   0.  Return to System
  207.  
  208. 1.  Know RIN
  209. ------------
  210. Option 1 will ask: Which RIN?  Type in the RIN.  The RIN you have
  211. entered will be checked, the individual information displayed, and
  212. you will be asked if it's the correct individual.  If it is the
  213. correct individual, then WS4PAF will proceed to generate the
  214. worksheet.
  215.  
  216. 2.  Do not know RIN
  217. -------------------
  218. Option 2 allows you to find an individual's RIN by entering
  219. information about the individual and then searching the PAF
  220. database for that individual.  This is similar to the way PAF finds
  221. an individual when the "Match names and positions during individual
  222. search" option in CONFIG is chosen.  Option 2 will display the
  223. following
  224.  
  225.                               Individual Search
  226. =================================================================
  227. Surname:                   Given1:                   Sex:
  228. Given2:                    Given3:                   Title:
  229. -----------------------------------------------------------------
  230. Birth date:
  231. Place1:                            Place2:
  232. Place3:                            Place4:
  233. -----------------------------------------------------------------
  234. Christening date:
  235. Place1:                            Place2:
  236. Place3:                            Place4:
  237. -----------------------------------------------------------------
  238. Death date:
  239. Place1:                            Place2:
  240. Place3:                            Place4:
  241. -----------------------------------------------------------------
  242. Burial date:
  243. Place1:                            Place2:
  244. Place3:                            Place4:
  245. =================================================================
  246.  
  247. You can enter as much or as little information you wish.  You can
  248. move around the screen using the Enter, Tab, Shift-Tab, Up and Down
  249. Arrows and end the input by pushing the F1 key to start the search
  250. or the F2 key to quit.  This is the same as PAF.  Names are checked
  251. when you enter them to insure they are in the NAME2.DAT file.
  252.  
  253. 3.  Input File
  254. --------------
  255. Option #3 allows you to access a ASCII file, also called a DOS text
  256. file or a non-document file.  WS4PAF will expect one RIN to be on
  257. each line of the file.  This RIN will be read and acted upon as if
  258. you typed it in.  This is useful when you have a lot of individuals
  259. you want work sheets for.  An example of such a file would look
  260. like with three RINs:
  261.  
  262.        516
  263.        14
  264.        5
  265.        ^
  266.        This is column 1
  267.  
  268. 4.  Change Output
  269. -----------------
  270. Option #4 returns you to the previous menu that determined what
  271. mode of output the program would generate.
  272.  
  273. 0.  Return to System
  274. --------------------
  275. The fifth option, which is zero (0), will end the program and
  276. return you to the system prompt.
  277.  
  278. CREATION OF THE WORKSHEET
  279. -------------------------
  280.  
  281. Now WS4PAF creates the worksheet.  An sample is show below.  Due to
  282. the limit of 80 columns for a computer screen, some of the lines
  283. have been split.  Where the line was split is indicated by the
  284. double asterisks (**).  When the printer output (Option #2) is
  285. selected with compressed print, everything from Christening: to the
  286. end of the worksheet is printed in compressed print (17 CPI) as
  287. well as the Birth line.  Output to the screen (Option #1) will wrap
  288. the output as necessary.
  289.  
  290. Sometimes, a line of characters will be too long for your printer
  291. to print on one line.  You will notice this when the line is
  292. partially moved to the next line.
  293.  
  294. TROUBLESHOOTING
  295. ---------------
  296.  
  297. WS4PAF does not have a lot of error trapping built into itself.  If
  298. you have a problem with WS4PAF, please try the following
  299. suggestions to solve the problem:
  300. 1.   Is the printer on?  Does it have paper?  (WS4PAF should tell
  301.      you if these are problems.)
  302. 2.   Is the directory identified for the PAF database correct?
  303. 3.   If you are sending a file to disk, is there enough disk space?
  304.  
  305. If none of the above solves your problem, then please contact the
  306. author (address on the last page) with the following information:
  307. 1.   Where in the program the problem occurs.
  308. 2.   A copy of any print out available.
  309. 3.   A copy of the screen dump (press the Print Screen button with
  310.      the printer on).
  311. 4.   A description of your computer (PC, XT, AT, 386, 486, etc.),
  312.      amount of memory, monitor, and video, as well as, your printer
  313.      type.
  314.  
  315. WS4PAF only READS and does not write to PAF files.  There should be
  316. no disruption of your PAF data files by WS4PAF.  However, it is
  317. good practice to ALWAYS have a back-up of your data whenever you
  318. use a new program and especially after you have added to or changed
  319. any information in your database.                         Worksheet for John HUTCHISON
  320. RIN: 267           Sex: M                              ID: 4G91-L8 
  321. Birth: 16 Nov 1840 at ____________, Trigg, KY, ____________
  322.  
  323. Father: William T. HUTCHISON
  324.  
  325. Mother: Mary Clay DAWSON
  326.  
  327. Christening: ___ ____ _____ at _______, _______, ________, ________
  328. Death: 12 Jul 1913 at Ochelata, Washington, OK, ____________
  329. Burial: ___ ____ _____ at _______, ________, ________, _________
  330.  
  331. Spouse: Sarah Ellen WALLACE (**) 
  332.  marriage date: 5 Oct 1868 at Independence, Jackson, Mo, _________
  333.  Child: (M) William HUTCHISON ___ ____ 1870 Independence, (**)
  334.    Jackson,  Mo,_________
  335.   No marriage
  336.  Child: (M) Warner HUTCHISON 11 Nov 1872 Independence, (**)
  337.    Jackson, Mo, __________
  338.   wife: Gertrude PECK  (**)
  339.    marriage date: 30 Jul 1900 at __________, __________, (**)
  340.     __________, __________
  341.    grandchild: (**)
  342.    (M) John E. HUTCHISON  27 Nov 1901 at Stow, __________, (**)
  343.     OH, ____________
  344.    grandchild: (**)
  345.    (M) Wallace I. HUTCHISON  24 Jan 1905 at Chicago, Cook, (**)
  346.     IL, ____________
  347.  Child: (F) Marietta HUTCHISON 20 Oct 1873 Independence, (**)
  348.     Jackson, Mo, _________
  349.   husband: Charles FISHER  (**)
  350.   marriage date: ___ ____ _____ at __________, __________, (**)
  351.      _________, _________
  352.  
  353. Spouse: Molly ERBY (**)
  354.  marriage date: ___ ____ _____ at _________, _________, (**)
  355.    _________, __________
  356.  Child: (**)
  357.  (M) Ralph HUTCHISON ___ ____ _____ at _________, (**)
  358.    _________, ________, ________
  359.   No marriage
  360.  
  361. NOTES:
  362.  
  363. !Descendent chart by Lawrence Hutchison notes U. S. Indian
  364. Marshall, Pahuska, Oklahoma Territory, 1896-1901                            APPENDIX I
  365.                     How to "Configure" WS4PAF
  366.  
  367.      The menu, shown below, that appears whenever output to the
  368. printer is selected, along with the current values of each
  369. parameter, allows the user to change those parameters which affect
  370. how the printout will look on paper.  The menu is:
  371.  
  372.    Output to the printer will be:
  373.  
  374.    0.  Proceed to print
  375.    1.  Compressed (toggle)           Not compressed
  376.    2.  Compressed ON printer code    \015
  377.    3.  Compressed OFF printer code   \018
  378.    4.  Top margin                      6 lines
  379.    5.  Bottom margin                   6 lines
  380.    6.  Left margin                     0 spaces    Not Used Yet!
  381.    7.  Right margin                    0 spaces
  382.    8.  Paper height                   66 lines
  383.    9.  Paper width                    80 spaces
  384.    P.  Print notes (toggle)          Print notes
  385.    S.  Save configuration
  386.  
  387. Your printer manual should have an explanation of normal values for
  388. your printer.  An explanation of each option on the menu follows:
  389.  
  390. 0.  Proceed to print
  391. --------------------
  392.      This option tells WS4PAF that you are satisfied with the
  393. current values and to proceed to the next menu, the  "Identifying
  394. Starting Individual" menu.
  395.  
  396. 1.  Compressed (toggle)
  397. -----------------------
  398.      This option is a toggle.  Selection of this option will change
  399. from "Compressed" to "Not compressed" and vice versa.
  400.  
  401. 2.  Compressed ON printer code
  402. ------------------------------
  403.      This option allows you to change the codes used by WS4PAF to
  404. start compressed printing.  The codes are displayed as their ASCII
  405. equivalents.  For example, the ASCII equivalent of the Escape code
  406. (the Esc key on your keyboard) is 27.
  407.      You can enter up to five individual codes.  When this option
  408. is selected, you will be prompted for each individual code
  409. separately, i.e.
  410.  
  411.           First printer code:
  412.  
  413. For Epson compatible printers, the code for compressed print is 15. 
  414. Therefore, you would enter 1 and 5 followed by <Enter>.  Then, you
  415. would be prompted for the second printer code:
  416.  
  417.           Second printer code:
  418.  
  419. If there was a second code, you would enter it just like you did
  420. for the first printer code.  In this case, since there isn't one,
  421. you just hit the <Enter> key, the codes you have entered will be
  422. displayed, and you can make another selection.
  423.  
  424. 3.  Compressed OFF printer code
  425. -------------------------------
  426.      This option operates exactly like the Compressed ON printer
  427. code, except the codes entered are for turning compressed printing
  428. off.
  429.  
  430. 4.  Top margin
  431. --------------
  432.      This option allows you to change how many blank lines will be
  433. put at the top of each page.  Selection of this option will result
  434. in the prompt:
  435.  
  436.           Number of lines for top margin: 
  437.  
  438. Just enter the number of blank lines you want.  Usually 6 lines
  439. equal one inch.
  440.  
  441. 5.  Bottom margin
  442. -----------------
  443.      This option is the same as the Top margin except it's for the
  444. bottom margin.
  445.  
  446. 6.  Left margin
  447. ---------------
  448.      This option allows you to change how many blank spaces will be
  449. put at the left of each line.  Selection of this option will result
  450. in the prompt:
  451.  
  452.           Number of spaces for left margin: 
  453.  
  454. Just enter the number of spaces you desire.
  455.      PLEASE NOTE THAT THIS FEATURE IS NOT YET IMPLEMENTED BECAUSE
  456. IT COULD CAUSE RAGGED EDGES ON THE LEFT SIDE OF THE WORKSHEET.
  457.  
  458. 7.  Right margin
  459. ----------------
  460.      This option is the same as the Left margin except it's for the
  461. right margin.  THIS OPTION IS IMPLEMENTED.
  462.  
  463. 8.  Paper height
  464. ----------------
  465.      This option allows the user to tell WS4PAF how many lines per
  466. page there are so that WS4PAF will know when to apply the top and
  467. bottom margins.  You will be prompted with:
  468.  
  469.           Number of lines for paper height:
  470.  
  471. Usually there are 66 lines to a page with normal print.
  472. 9.  Paper width
  473. ---------------
  474.      This option allows the user to tell WS4PAF how many spaces per
  475. line there are so that WS4PAF will know where to apply the right 
  476. margin.  You will be prompted with:
  477.  
  478.           Number of spaces for paper width:
  479.  
  480. Usually there are 80 spaces to a line with normal (pica) print, 96
  481. with elite print, and 136 spaces with compressed print on a eight
  482. inch wide paper.
  483.  
  484. P.  Print notes (toggle)
  485. ------------------------
  486.      This option is a toggle.  Selection of this option will change
  487. from "Print Notes" to "Notes not printed" and vice versa.
  488.  
  489. S.  Save configuration
  490. ----------------------
  491.      This option will save all the values displayed in a file named
  492. WS4PAF.CFG in the PAF directory that is currently selected. 
  493. WS4PAF.CFG is an ASCII file that can be edited using any text
  494. editor or word processor in non-document mode, however, using
  495. WS4PAF will be the easiest way of modifying WS4PAF.CFG.
  496.      WS4PAF will look for WS4PAF.CFG once the PAF directory has
  497. been identified.  If WS4PAF.CFG is present, then the values will be
  498. read in and replace the default values in WS4PAF.                            APPENDIX II
  499.                        Versions of WS4PAF
  500.  
  501. Version 1.1 differences
  502. Thanks to Don Umberger, who:
  503.     -     Pointed out a bug in the search routine which has been
  504.           corrected.
  505.     -     Suggested the RIN be added to the worksheet.
  506.     -     Noted that the search option was similar to PAF ONLY if
  507.           the "Match names and positions during individual search"
  508.           CONFIG option was selected.
  509.     -     Suggested the option to print or not to print notes.
  510. Version 1.2 differences
  511. Thanks again to Don Umberger, who:
  512.     -     Pointed out a bug with the print to file which is
  513.           corrected.
  514.     -     Suggested that the user be notified if the print to file
  515.           filename already existed.
  516. Version 1.3 differences
  517. Thanks to Diane Hicks and Ruth Czigan, who:
  518.     -     Pointed out a bug that introduced a form feed where a
  519.           line feed was suppose to be.
  520. Version 1.4 differences
  521. Thanks to Ruth Czigan, who:
  522.     -     Pointed out that only the first marriage of the children
  523.           was shown in earlier versions.  All marriages are now
  524.           shown.
  525. Version 2.0 differences
  526.     -     This is almost an entire rewrite of the program.  In
  527.           particular, this version will:
  528.           o  Work with monochrome monitors (earlier version
  529.           didn't).
  530.           o  Allows the user to choose between using compressed
  531.           print or not.  This was requested by those who have a
  532.           hard time seeing the small print of 17 CPI.  If the
  533.           output is without compressed print, then the place of
  534.           each event is printed on a separate line.
  535.           o  Page breaks have been inserted in printer output.  At
  536.           least six lines will be placed at the top and bottom of
  537.           each page.
  538. Version 2.1 differences
  539. Thanks to Dewey Raymond Watkins, who:
  540.     -     Suggested that the title be displayed if it contains
  541.           something.
  542. In addition, version 2.1 has the following improvements:
  543.     -     Error handling routines for printer not on, out of paper,
  544.           etc.
  545.     -     If first given name is not present, ________________ is
  546.           displayed.
  547. Version 2.2 differences
  548.     -     Soundex code is added to the worksheet.
  549.     -     User control over formatting added.
  550.     -     RIN Input file added to identifying starting individual
  551.           menu Personal Ancestral File and PAF are registered trademarks of the
  552. Corporation of the President of The Church of Jesus Christ of
  553. Latter-Day Saints.
  554.  
  555. All rights to WS4PAF and its accompanying files are reserved. 
  556. WS4PAF may be distributed and used only in accordance with the
  557. provisions contained herein.  Comments, problem reports and
  558. suggestions for improvements are welcomed and may be sent to:
  559.  
  560. Address:       Frank E. Hutchison
  561.                Qtrs D, Mason Row
  562.                Yorktown, VA 23690
  563.  
  564. Phone:         (804)887-0290 between 6:00 and 9:00 pm Eastern
  565.  
  566. Anyone who first reports a problem or suggests an improvement will
  567. receive the first copy of the improved program free.
  568.  
  569. I also monitor the GENSOFT echo on the Fidonet for messages to
  570. Frank Hutchison.  Please note that I do not use my middle initial
  571. and that Hutchison is not HUTCHINSON.  Thank you.
  572.  
  573. REGISTRATION
  574. ------------
  575.      If you use Worksheet Generator for Personal Ancestral File
  576. (BA4PAF) you are asked to register with me.  The cost is FIVE
  577. dollars ($5.00).  This will (1) increase my high regard for you,
  578. (2) encourage me to improve the program, (3) allow me to inform you
  579. of improvements, (4) allow me to notify you in the event that a
  580. serious problem with WS4PAF is discovered, and (5) convince my wife
  581. that I'm not just playing with the computer.               ╔═════════════════════════════════════╗
  582.               ║                                     ║
  583.               ║         Worksheet Generator         ║
  584.               ║                for                  ║
  585.               ║       Personal Ancestral File       ║
  586.               ║               (PAF)                 ║
  587.               ║                 by                  ║
  588.               ║         Frank E. Hutchison          ║
  589.               ║                                     ║
  590.               ╚═════════════════════════════════════╝
  591.                                                     
  592.                        REGISTRATION FORM
  593.  
  594.  
  595. Surname: _____________________      Given1: _____________________
  596.  
  597. Given2: ______________________      Given3: _____________________
  598.  
  599. Address1: __________________________________________
  600.  
  601. Address2: __________________________________________
  602.  
  603. City:  _____________________________________________
  604.  
  605. State:  __________                  Zip Code: ________________
  606.  
  607. Phone: (_____) ________--_______________
  608.  
  609. How did you find out/acquire Worksheet Generator for Personal
  610. Ancestral File (WS4PAF)?
  611.  
  612. Comments/Suggestions/Problem Report:
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631. Mail to:            Frank E. Hutchison
  632.                     Qtrs D, Mason Row
  633.                     Yorktown, VA 23690
  634.