home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1993 #2 / Image.iso / gene / ne4paf60.zip / NE4PAF60.DOC next >
Text File  |  1993-07-05  |  20KB  |  530 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                           Name Editor
  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.             ║                                  ║
  55.             ║           Name Editor            ║
  56.             ║               for                ║
  57.             ║      Personal Ancestral File     ║
  58.             ║            (NE4PAF)              ║
  59.             ║               by                 ║
  60.             ║        Frank E. Hutchison        ║
  61.             ║                                  ║
  62.             ╚══════════════════════════════════╝
  63.  
  64.      In the course of acquiring over ten thousand ancestors and
  65. relatives, I discovered that not everyone followed the obvious
  66. rules of always identifying Switzerland as Switzerland or using
  67. the U.S. postal codes for states.  Instead I discovered that
  68. there were at least ten (10) ways of spelling the state of
  69. Connecticut and twelve (12) ways of identifying Switzerland, not
  70. to mention all the ways of mangling England.  Identifying these
  71. "mistakes" and correcting them one by one was tedious and
  72. time consuming.  There is also the "problem" with names typed in
  73. with all uppercase letters, although I wanted the state codes to
  74. be all uppercase.  I also wanted the first letter following the
  75. Mc and Mac, a space, a question mark or a comma to be uppercase. 
  76. Name Editor for Personal Ancestral File (NE4PAF) will make these
  77. changes wholesale.
  78.  
  79.      Name Editor for Personal Ancestral File (PAF) is a program
  80. that will allow you to edit the name file (NAME2.DAT) of Personal
  81. Ancestral File (tm), version 2.2.  It will automatically:
  82.  
  83.       Place all names in lowercase letters, except for
  84.       The first letter of the name, which will be capitalized if
  85.      the user desires
  86.       Capitalize the first letter to follow Mc, Mac, a space, or
  87.      the characters: (, ), [, ], /, the question mark, the comma,
  88.      the period, the minus sign, the quote (") or the apostrophe
  89.      ('), but
  90.       it will not capitalize the possessive "s".
  91.       All names which are not used in INDIV2.DAT and MARR2.DAT
  92.      will be removed from NAME2.DAT.
  93.  
  94. In addition:
  95.  
  96.       when individual names are changed, all related changes to
  97.      the individual (INDIV2.DAT) or marriage (MARR2.DAT) files will
  98.      be performed, as necessary.
  99.       You can also delete all references to a name.  This is
  100.      useful when someone has put USA in a database and you want the
  101.      USA removed.
  102.       You can specific exactly how you want any name capitalized
  103.      by use of a "dictionary" of names.  (This is useful for those
  104.      names that would or would not be capitalized following the
  105.      above rules.)
  106.  
  107.      There are many ways of data becoming corrupted.  NE4PAF has
  108. many safeguards.  However, BEFORE STARTING NE4PAF, BE SURE YOU
  109. HAVE MADE A BACK-UP OF YOUR PAF DATA.  NE4PAF will save the old
  110. copies of the INDIV2.DAT, MARR2.DAT, and NAME2.DAT files as
  111. INDIV2.OLD, MARR2.OLD, and NAME2.OLD.  However, the only way to be
  112. sure you never lose any data is to keep current back-ups.  You
  113. should be doing this as a regular course of action anyway.  In
  114. addition, run the PAF Family Records Check (FRCHK) program after
  115. using NE4PAF to insure that all records are okay.  There is a
  116. reminder at the conclusion of NE4PAF of this information.
  117.  
  118.      To use NE4PAF, you must know where the PAF database is
  119. located (C:\PAF\DATA, B:, etc.).  NE4PAF can be told the location
  120. in one of two ways:  On the command line or it will ask if no
  121. location is specified on the command line.
  122.  
  123.      To start NE4PAF, type at the prompt either
  124.  
  125.      C:\>NE4PAFxx
  126.  
  127. or
  128.  
  129.      C:\>NE4PAFxx [location]
  130.  
  131. where the xx indicates the version number and [location]
  132. indicates the location of the PAF data files, which is optional.
  133.  
  134.      The first screen to appear is a warning screen that asks if
  135. you have made a back-up or are using a copy.  Pushing the <F1>
  136. will continue the program.  Any other key will abort the program.
  137.  
  138.      Next, The title screen will appear.  If the [location] was
  139. not specified on the command line, then NE4PAF asks
  140.  
  141.                   Where is the PAF database located?
  142.  
  143.                   1.  A:
  144.                   2.  B:
  145.                   3.  C:\PAF\DATA
  146.                   4.  Other
  147.                   5.  Return to System
  148.  
  149. Menu selection is made by selecting the menu number or using the
  150. up and down arrow keys and hitting the <Enter> key.
  151.  
  152.      The first three choices will encompass probably 90% of the
  153. locations of PAF databases.  If yours is not one of the first
  154. three choices, then select option 4.  Just below the above menu
  155. will be displayed:
  156.  
  157.                   Location of PAF database: 
  158.  
  159. You can type in the path to the database.  If it is wrong, an error
  160. message will be displayed and you will be able to try again. 
  161. Option 5 will quit the program.
  162.  
  163.      NE4PAF allows you to determine if you always want the first
  164. letter of each name capitialized or to allow the first letter to
  165. remain whatever case it was.  NE4PAF will ask:
  166.  
  167.      Should the first letter of each name be capitalized?
  168.  
  169.                     1.  Yes, always
  170.                     2.  No, leave the case as is
  171.                     3.  This choice not used
  172.                     4.  Change the directory
  173.                     0.  Return to System
  174.  
  175. If you want the first letter of all names capitalized, choose
  176. option 1.  If not, choose option 2.  Option 3 is not used at
  177. present.  Option 4 will return you to the previous menu to choose
  178. the directory to use, and option 5 will quit the program.
  179.  
  180.      NE4PAF will next display the notices:
  181.  
  182.           Gathering Information
  183.           Search each individual and count the names
  184.           Search the marriages and count the names
  185.           Alphabetizing the names
  186.  
  187. Progress bars will show how far along you are when gathering
  188. information or counting names.
  189.  
  190. USE OF THE NAME DICTIONARY
  191. --------------------------
  192.  
  193.      NE4PAF will now look in the directory you specified for a file
  194. named NE4PAF.DCT.  NE4PAF.DCT MUST be an ASCII file, also called a
  195. DOS text or a non-document file.  This file may contain names that
  196. you want capitalized in a special way.  For example, I have the two
  197. following names in my personal PAF database:
  198.  
  199.           CAPT NOAA (Ret.)  (Captain National Oceanic and
  200.                              Atmospheric Administration, Retired)
  201.           CDR, USN          (Commander, U. S. Navy)
  202.  
  203. NE4PAF would have them as
  204.  
  205.           Capt Noaa (Ret.)
  206.           Cdr, Usn
  207.  
  208. The first set is the "correct" set, according to the usage of the
  209. organizations represented.  Without the NE4PAF.DCT file, I have to
  210. change the above names every time I use NE4PAF.      Create the NE4PAF.DCT file by using any text editor or the
  211. non-document mode if you use a word processor.  Place one name on
  212. each line exactly as you want it in NAME2.DAT.  For the above
  213. example, the file could look like
  214.  
  215.           CAPT NOAA (Ret.)
  216.           CDR, USN
  217.           Ann(e)
  218.  
  219. Of course, the names should be up against the left side margin. 
  220. (No spaces in front of the name unless you want them there!)  And
  221. the spelling must be the SAME as the name is currently in
  222. NAME2.DAT.  You must create a separate NE4PAF.DCT for each PAF
  223. database you have, or you need to copy the dictionary to each
  224. directory.  Names in NE4PAF.DCT but not in NAME2.DAT have no
  225. effect.
  226.  
  227. VIEWING NAMES
  228. -------------
  229.      Directly following the alphabetizing of the names, the first
  230. eighty (80) names in alphabetical order will be displayed along
  231. with the number of times each name was found in the individual
  232. and marriage files.  To see the next "page" of names, hit the
  233. <Page Down> key and the next eighty (80) names in alphabetical
  234. order will appear.  Hitting <Page Up> will take you to the
  235. previous "page" of names.  Hitting the <Home> key will return you
  236. to the beginning of the alphabetical list while <End> will take
  237. you to the end.
  238.  
  239. EDITING A NAME
  240. --------------
  241.      To edit a name, use the arrow keys to highlight the desired
  242. name and hit the <Enter> key.  This will cause a window to appear
  243. on top of the screen which shows the present spelling of the
  244. name, the count found for that name and a space for the new
  245. spelling to be entered.  If the new spelling is unique, then it
  246. will replace the old spelling in the NAME2.DAT file and be used
  247. every place where the old spelling was used.  If the new spelling
  248. matches an existing name, then the old spelling will remain in
  249. the NAME2.DAT file, the count will become negative, but the
  250. matching name will replace the old spelling in the individual and
  251. marriage files.
  252.      If you decide you don't want to edit a name once you have hit
  253. the <Enter> key, just hit the <Enter> key again before you enter
  254. any other character.  You will be returned to the list of names.
  255.  
  256. DELETING A NAME
  257. ---------------
  258.      You have the additional capability to delete all references to
  259. a specific name.  The command for doing this is the combination
  260. <Ctrl>-<F10> (Hold down the <Ctrl> key and, WHILE STILL HOLDING THE
  261. <Ctrl> KEY DOWN, press the <F10> key).  The window will appear with
  262. the name, the words "Deleting name" in blinking letters, and a
  263. count of then number of times the name appears in the database. 
  264. There is no verification step (i.e., "Do you REALLY want to delete
  265. this name?") because the key combination requires a conscious
  266. effort to make.  The key combination was chosen for this very
  267. reason.  No one should be able to do <Ctrl>-<F10> "accidently." 
  268. For those with very fast computers, the screen may blink and return
  269. to the list of names without you being able to see the "Deleting
  270. name" message.
  271.  
  272. EXAMPLES
  273. --------
  274.  
  275.      To illustrate what happens, consider the following NAME2.DAT
  276. file of three (3) names:
  277.  
  278.           California   45
  279.           Switz.   34
  280.           Switzerland   78
  281.  
  282. To convert the complete state name to the postal codes, highlight
  283. California and hit the <Enter> key.  The window appears and shows
  284. California as the old name, its count (45), and space for the new
  285. spelling.  You enter CA and hit the <Enter> key to signify that
  286. you are done entering the new spelling.  Since CA is not in the
  287. file, CA will replace California:
  288.  
  289.           CA           45
  290.           Switz.       34
  291.           Switzerland  78
  292.           USA           5
  293.  
  294.      Next, to change the abbreviation for Switzerland, highlight
  295. Switz., hit <Enter>, and type in Switzerland for the new
  296. spelling.  Switzerland is also in the NAME2.DAT file, therefore,
  297. it's a matched name.  NE4PAF will display
  298.  
  299.           Switz.      -34      (Note the minus sign!)
  300.  
  301. indicating that Switz. has been selected for replacement or
  302. elimination.
  303.      Finally, we select USA and press <Ctrl>-<F10>.  NE4PAF
  304. displays
  305.  
  306.           USA          -5      (Note the minus sign!)
  307.  
  308.      All the changes are stored in a file called CHANGES.LST in the
  309. same directory as the NAME2.DAT file.  All the changes will be made
  310. later.
  311.  
  312. FINISH EDITING
  313. --------------
  314.  
  315.      When you are finished editing the names hit <Esc> to
  316. continue with the program. CHANGING YOUR MIND (THE "OOPS" LIST)
  317. ------------------------------------
  318.  
  319.      NE4PAF allows you to change your mind about the changes you
  320. have selected which involve changes other than simple changes.  A
  321. simple change is when the spelling or capitalization of a name is
  322. changed but there is no substitution of one name on the list for
  323. another name on the list.  The "oops" list, each change, in the
  324. order it was made, will be displayed with a total of 20 changes
  325. displayed at a time.  Editing of these changes is the same as for
  326. editing names, except that you can ONLY cancel a change, not modify
  327. it.  Using the example above, NE4PAF will now display
  328.  
  329.           Switz. will be replaced by Switzerland
  330.           USA will be deleted
  331.  
  332. Let's assume that you deleting USA was a mistake.  You select "USA
  333. will be deleted", press <Delete>, "USA will be deleted" is replaced
  334. with "This change deleted" and the deletion will not take place.
  335.  
  336.      While viewing the "oops" list, you will have the option to
  337. cancel everything by pressing <Ctrl>-<F10>.  This will cancel ALL
  338. the work that has been done and return everything to its original
  339. condition, then exit the program.
  340.  
  341.      When you are finished with the editing of the changes, press
  342. <Esc> to continue.
  343.  
  344. CREATING NEW FILES
  345. ------------------
  346.  
  347.      NE4PAF will now go though the individual (INDIV2.DAT) and
  348. marriage (MARR2.DAT) files and build new copies of these files as
  349. INDIV2.NEW and MARR2.NEW by replacing Switz. with Switzerland, as
  350. well as all the other replacements and eliminations you selected. 
  351. (This is where the changes recorded in CHANGES.LST are used.)
  352.  
  353. The Phantom EMPTY
  354. -----------------
  355.      In the latest version of PAF 2.2 (August 1991), you can
  356. search, using the Focus Reports, for fields which are empty by
  357. entering EMPTY in the field desired.  However, if a cursor has
  358. passed through a date field, PAF puts a flag there.  The presence
  359. of this flag prevents the Focus Report from finding the date field
  360. empty even though the date field appears empty to you.  Therefore,
  361. NE4PAF examines each date field.  If there is an entry, that entry
  362. will be transferred to the new record.  However, in those date
  363. fields which are suppose to be empty, NE4PAF will check for a flag
  364. which tells whether or not a cursor has passed through the field. 
  365. If this flag is present, NE4PAF will replace the apparently blank
  366. entry with a true blank entry. CREATING THE NEW NAME2.DAT FILE
  367. -------------------------------
  368.  
  369.      Following the re-alphabetization of the names, NE4PAF will
  370. establish the tree of names and create the NAME2.NEW file.  NE4PAF
  371. will check if NAME2.OLD, INDIV2.OLD and MARR2.OLD exist, delete
  372. them if they do, rename NAME2.DAT, INDIV2.DAT and MARR2.DAT to the
  373. .OLD ending, rename NAME2.NEW, INDIV2.NEW and MARR2.NEW to the .DAT
  374. ending, remove any temporary files, print the reminder, and end.
  375.  
  376. Some thoughts on using NE4PAF:
  377.  
  378.      This is just a few thoughts that you should think about BEFORE
  379. you change the spelling of a name and some facts about the use of
  380. NE4PAF:
  381.  
  382.      1.   There are some names which are used for both states,
  383.           counties, and even persons.  Virginia is a good example. 
  384.           I have ancestors which were named Virginia.  Do I want to
  385.           replace all Virginias with the postal abbreviation?  At
  386.           present, there is no way that NE4PAF will distinguish
  387.           between a Virginia in a person's name and a Virginia in
  388.           a place name.  Utah can be a state or a county in the
  389.           same state.  So think very carefully before you change a
  390.           state name to its abbreviation.
  391.  
  392.  
  393.      2.   NE4PAF rebuilds the tree within the NAME2.DAT file.  As
  394.           a result, there will usually be a new tree which has
  395.           fewer levels as measured by FRCHK.  This will cause PAF
  396.           to be a little more efficient when searching for names. 
  397.           The reason for the difference is that PAF adds names to
  398.           the tree as they are added to the database.  It is
  399.           possible that using this method, the tree could have a
  400.           many levels as there are names. VERSIONS
  401. --------
  402. Version A (NE4PAF1A and NE4PAF2A): The original released version 
  403.                                    (14 Dec 1992).
  404.  
  405. Version B (NE4PAF1B and NE4PAF2B): Corrects a bug in version A,
  406.                                    released 30 Dec 1992.
  407.  
  408. Version 3.0 (NE4PAF3A and NE4PAF3B): Improves the speed of oper-
  409.                ation for editing large databases.  Also, the
  410.                capitalization rules have been improved.  Changed
  411.                version numbering system.  Released 21 Jan 1993.
  412.  
  413. Version 4.0 (NE4PAF4A and NE4PAF4B): Added more rules for capital-
  414.                ization.  Added capability to delete references to
  415.                a specific name.  Cleaned up the video display
  416.                routines.  Released 6 Feb 1993.
  417.  
  418. Version 4.1 (NE4PAF4A and NE4PAF4B): Eliminated a minor bug when a
  419.                name has a trailing space in the NAME2.DAT file. 
  420.                Released 6 Mar 1993.
  421.  
  422. Version 5.0 (NE4PAF5A and NE4PAF5B): Improves the speed of
  423.                operation.  Works with monochrome monitors (earlier
  424.                versions didn't).  Mouse capability in the menus
  425.                was removed.  Performs the actions on INDIV2.DAT
  426.                and MARR2.DAT  after all the changes have been
  427.                identified.  Released 17 April 1993.
  428.  
  429. Version 5.1 (NE4PAF5A and NE4PAF5B): Corrects errors in handling
  430.                name changes that go to the beginning or end of the
  431.                alphabetized list.  Also error in name order
  432.                corrected.
  433.  
  434. Version 6.0:    All names which are not used are removed from
  435.                NAME2.DAT.
  436.                 You can specific exactly how you want any name
  437.                capitalized by use of a "dictionary" of names.
  438.                 There is no longer a "A" and "B" version.  One
  439.                size fits all.
  440.                 Allows the user to review the proposed changes
  441.                (the oops list) before proceeding.
  442.                 Allows the user to stop the program at the oops
  443.                listing.
  444.                 Saves the old NAME2.DAT, INDIV2.DAT, and MARR2.DAT
  445.                files with the extant .OLD.
  446.                 Posts a reminder at the end of the program to run
  447.                FRCHK and that the old files were saved as .OLD.
  448.                 Improved error checking and speed.
  449.                 Released 1 July 1993 REGISTRATION
  450. ------------
  451.      If you use Name Editor for Personal Ancestral File (NE4PAF)
  452. you are asked to register with me.  The cost is ten dollars
  453. ($10.00).  This will (1) increase my high regard for you, (2)
  454. encourage me to improve the program, (3) allow me to inform you
  455. of improvements, (4) allow me to notify you in the event that a
  456. serious problem with NE4PAF is discovered, and (5) convince my
  457. wife that I'm not just playing with the computer.
  458.  
  459. Personal Ancestral File and PAF are registered trademarks of the
  460. Corporation of the President of The Church of Jesus Christ of
  461. Latter-Day Saints.
  462.  
  463. All rights to NE4PAF and its accompanying files are reserved. 
  464. NE4PAF may be distributed and used only in accordance with the
  465. provisions contained herein.  Comments, problem reports, 
  466. suggestions for improvements and registration are welcomed and
  467. may be sent to:
  468.  
  469. Address:       Frank E. Hutchison
  470.                Qtrs D, Mason Row
  471.                Yorktown, VA 23690
  472.  
  473. Phone:         (804)887-0290 between 6:00 and 9:00 pm Eastern
  474.  
  475. I also monitor the GENSOFT echo on the Fidonet for messages to
  476. Frank Hutchison.  (Please note the spelling.)
  477. ╔══════════════════════════════════╗
  478. ║                                  ║
  479. ║           Name Editor            ║
  480. ║               for                ║
  481. ║      Personal Ancestral File     ║
  482. ║            (NE4PAF)              ║
  483. ║               by                 ║
  484. ║        Frank E. Hutchison        ║
  485. ║                                  ║
  486. ╚══════════════════════════════════╝
  487.  
  488.  
  489. REGISTRATION FORM
  490.  
  491.  
  492. Surname: _____________________      Given1: _____________________
  493.  
  494. Given2: ______________________      Given3: _____________________
  495.  
  496. Address1: __________________________________________
  497.  
  498. Address2: __________________________________________
  499.  
  500. City:  _____________________________________________
  501.  
  502. State:  __________                  Zip Code: ________________
  503.  
  504. Phone: (_____) ________--_______________
  505.  
  506. How did you find out about NE4PAF?
  507.  
  508.  
  509.  
  510. Comments/Suggestions/Problem Report:
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526. Mail to:            Frank E. Hutchison
  527.                     Qtrs D, Mason Row
  528.                     Yorktown, VA 23690
  529.  
  530.