home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / CPM / DATABASE / TTGEN10C.LBR / TTGEN10.DZC / TTGEN10.DOC
Text File  |  2000-06-30  |  12KB  |  270 lines
  1.  
  2.  
  3.                +-------------------------------------------+
  4.                |                  "TTGEN"                  |
  5.                |  Tiny Tafel Generator and Editor Program  |
  6.                |  Written by Tom P. Douglas, March, 1987   |
  7.                +-------------------------------------------+
  8.  
  9.  
  10.         COPYRIGHT (c) 1987 BY TOM P. DOUGLAS, ALL RIGHTS RESERVED.
  11.  
  12.       PORTIONS COPYRIGHT (c) 1984, 85 & 86 BY BORLAND INTERNATIONAL.
  13.  
  14.  
  15. NOTICE:  Sale of this software beyond cost of media for any reason without
  16. prior written consent of the author is strictly prohibited.  This software
  17. is not to be used as an incentive toward any purchase of any product or
  18. service.  Free, non-commercial distribution of this software with this
  19. document file, all unaltered, is welcomed and encouraged.
  20.  
  21.  
  22. VERSION:       1.00 (beta test), released 22 March 1987.
  23.  
  24.  
  25. AUTHOR:        Tom P. Douglas
  26.                P. O. Box 9046
  27.                Colorado Springs, CO  80932
  28.                (303) 635-2061
  29.  
  30.                "Please forward any bug reports, comments and suggestions
  31.                regarding this software to the above address.  Thank you!"
  32.  
  33.  
  34. OBJECTIVE:     To provide a properly formatted, compact ASCII file that
  35.                describes a family database so that the information can be
  36.                scanned visually or by computer.
  37.  
  38.  
  39. ACKNOWLEDGEMENTS:
  40.                Thanks to Commsoft (2257 Old Middlefield Way, Mountain View,
  41.                CA 94903) for providing the text file, SPEC.TT (v 1.16)
  42.                which TTGEN is based on.  This file describes the Tiny Tafel
  43.                "based on an article titled Tiny-Tafel for Database Scope
  44.                Indexing by Paul Andereck in the April-May-June 1986 (vol 5,
  45.                number 4) issue of Genealogical Computing."  You may wish to
  46.                refer to this file for the full format description.
  47.  
  48.                And thanks to Mid Kolstad of Colorado Springs for loaning me
  49.                her books and (hopefully) getting me squared away on the
  50.                proper Soundex coding.
  51.  
  52.  
  53.  
  54.  
  55.                                BETA TESTING
  56.                               --------------
  57.  
  58. This version of TTGEN (1.00) is a "Beta Test" version.  This means that
  59. this software's developement is in the preliminary stages and is released
  60. to the public for evaluation.  Therefore this software should be used with
  61. caution, checking it's created or edited files for errors, and providing
  62. feedback (bug reports, suggestions, comments, etc.) to the author.
  63.  
  64. Should the program display an error and "Program Aborted" messages and
  65. return to your operating system's prompt, please write down the entire
  66. error message (error type, number and "PC=" code).  The software version
  67. number (found on the introduction screen) will be needed also.  A report of
  68. what you did just prior to the program abort would be helpful as well.
  69.  
  70. Any and all inputs are welcomed, encouraged and appreciated.  The author,
  71. Tom Douglas, can be best contacted via FidoMail (Node 128/15), FidoNet's
  72. National Genealogy Conference, or U.S. Mail (P.O. Box 9046, Colorado
  73. Springs, CO  80932).
  74.  
  75. It is inticapated that future versions of TTGEN will continue to be
  76. released as freeware to the public.
  77.  
  78.  
  79.  
  80.  
  81.                                 ABOUT TTGEN
  82.                                -------------
  83.  
  84. TTGEN was written on a CP/M machine, using Borland International's
  85. excellent Turbo Pascal.  TTGEN is designed to create and properly format a
  86. Tiny Tafel file quickly and easily.  The files created or edited are in
  87. ASCII form and are designed to be read visually or by computer.  Soundex
  88. Codes are automatically calculated for each surname in the files.
  89.  
  90. Since TTGEN and TGENINST is not entirely "idiot proof", you should take it
  91. easy and watch the prompts and instructions that appear on your screen. 
  92. You shouldn't have any problem with those as most (if not all) are at least
  93. fairly straight-forward.
  94.  
  95.  
  96.  
  97.  
  98.                              INSTALLING TTGEN
  99.                             ------------------
  100.  
  101. You should have a backup copy of TTGEN.ARC or TTGENCPM.LBR before you
  102. proceed beyond this point.  Installation is optional for MS-DOS machines.
  103.  
  104. TTGEN uses cursor positioning and screen clear commands which varies from
  105. computer to computer (CP/M).  Therefore you need to "install" TTGEN to
  106. operate properly on your particular screen (terminal).  TGENINST.COM,
  107. TGENINST.DTA, and TGENINST.MSG are required to make the installation.  Once
  108. TTGEN is installed and you are satisfied with the installation, these 3
  109. TGENINST.* files may be purged from your work disk.
  110.  
  111. Type "TGENINST" (without the quotes, of course) and depress the Carriage
  112. Return or Enter key (noted hereon as [CR]).  At the first prompt, enter "S"
  113. to enter the terminal installation procedure.  If your terminal is listed,
  114. select it by number and [CR].  You'll then be asked if you want to modify
  115. your terminal parameters.  Chances are, you don't need to modify it.  Hit
  116. "N" to bypass the modify option.
  117.  
  118. If your terminal is not listed, select the number for "Terminal Not
  119. Listed".  You will need to refer to your system users manual for Screen
  120. Sequence Commands.  You will then receive a series of prompts for the
  121. command information.  Only the clear screen and cursor positioning sequence
  122. commands are required to run TTGEN; the remainder of the prompts may be
  123. answered just by a [CR].
  124.  
  125. The next prompt is for your computer's clock speed.  This information is
  126. used for timing applications within programs which are not used in TTGEN. 
  127. With that, just press [CR].
  128.  
  129. The last option is to install again or to quit.  Hit "Q" to exit the
  130. installation utility.
  131.  
  132.  
  133.  
  134.  
  135.                                 USING TTGEN
  136.                                -------------
  137.  
  138. Type "TTGEN" and a [CR].  The title screen will come up momentarily, along
  139. with a date prompt.  Enter the day's date as mmddyy (2 numeric digits for
  140. the month, 2 for date, and last 2 of year).
  141.  
  142. The next prompt you'll see is for a file name.  Specify the name of your
  143. Tiny Tafel (TT) file as you would name any file, and hit [CR].  If no
  144. extention is specified, ".TT" is used.  If you are in doubt about file
  145. names, go to your system users manual.  If the named file is found on disk,
  146. it is read into memory.  Otherwise you'll be queried rather if you want to
  147. create a new file or not.  If you choose not to create one, you'll have
  148. another chance at naming your file.  A [CR] without any entry at the file
  149. name prompt will send out on the way out of TTGEN.  Confirm that you do
  150. want to get "dumped" out of the program and into the operating system.
  151.  
  152. Going on in TTGEN, the first screen contains the header data about the
  153. person having custody of the family information.  If you have just created
  154. the TT file, you'll already be in the "edit mode".  Otherwise you'll see an
  155. "Information okay?" prompt.  Hit "N" to go into the edit mode.  In the edit
  156. node, a note between the 2 rows of "="'s will give you more specific
  157. instructions and formatting information to "jog your memory".  Enter each
  158. line in full to make the entry.  Simply hit [CR] to default the line as is.
  159. Or enter a space and [CR] to null the line.
  160.  
  161. The Header Data screen entries are as follows:
  162.  
  163. NAME:  This entry is manditory!  This is the name of the person having
  164. custody of the family data.  You will not be able to exit the current
  165. screen without this entry!
  166.  
  167. ADDRESS #:  5 lines of the person's address are available.  Although
  168. optional, it would be a wise idea to input that information.  That makes it
  169. alot easier for follow researchers to contact the named custodian (unless
  170. he or she is renouned throughout the world, of course).
  171.  
  172. TELEPHONE:  Optional; just don't forget to include the area code.
  173.  
  174. INFO COMM:  Optional; communication service used for research or contact,
  175. with telephone number and area code if applicable.
  176. Entry format: service/telephone
  177. Use MCI, ITT, ONT, RCA, ESL, CIS, SOU, etc.  (e.g., CIS/77123,512).
  178.  
  179. BBS INFO:  Optional; custodian's Bulletin Board System (BBS) name and
  180. telephone number with area code.
  181. Entry format: BBS/telephone
  182.  
  183. BBS CONFIG:  Optional; communications configuration of above BBS.
  184. Entry format: nnnn/X/P
  185. where  nnnn = maximum baud rate
  186.           X = O(riginate only), A(nswer only), B(oth)
  187.           P = Protocol (Xmodem, Kermit, etc.)
  188.  
  189. DISK FORMAT:  Optional; diskette format used by custodian.
  190. Entry format: d/f/c
  191. where  d = disk diameter (3, 5, 8)
  192.        f = disk format MS-DOS, Apple II, etc.
  193.        c = disk capacity in KB or MB (specify which)
  194.  
  195. FILE FORMAT:  Optional; data file format, or simply put, database software
  196. used (Roots II, Roots/M, PAF Version 1, etc.).  Free form entry.
  197.  
  198. REMARKS:  Optional; free form entry.
  199.  
  200. After going through the inputs, you'll be queried if these inputs are
  201. alright.  Hit "N" and you'll repeat the above inputs again.  Otherwise
  202. TTGEN will proceed to the next phase, the genealogical data entries.  This
  203. is where the family information goes.  Select:
  204.  
  205. "N" to make a new entry;
  206.  
  207. "F" to display the next entry;
  208.  
  209. "B" to display the previous entry;
  210.  
  211. "E" to edit an existing entry currently on display (watch for instructions
  212.     between the 2 rows of "="'s);
  213.  
  214. "D" to delete an existing entry currently on display;
  215.  
  216. "L" to look at all of the entries in memory so far;
  217.  
  218. "S" to save the TT to a disk file and prompt for another file name;
  219.  
  220. "A" to abort the work file (return to header information or name another
  221.     work file).
  222.  
  223. Each entry has the following entries:
  224.  
  225. SURNAME:  Manditory; surname being researched.  Up to 5 seperate spellings
  226. are permitted to be used.  If using more than 1 name, seperate the names by
  227. a "," (comma) delimiter.
  228.  
  229. ANCESTOR'S BIRTH YEAR:  Manditory; earliest known birth year of ancestor.
  230.  
  231. ANCESTOR'S BIRTH PLACE:  Optional; birth place of ancestor if known.
  232.  
  233. ANCESTOR INTEREST:  Interest level of the researcher for additional
  234. ancestor information if found.  Non-entry assumes the lowest interest
  235. level.  Interest levels are defined as:
  236.      0 = No interest
  237.      1 = Low interest
  238.      2 = Moderate interest
  239.      3 = Highest interest
  240.  
  241. DECENDENT'S BIRTH YEAR:  Latest decendent's birth year known.  Non-entry
  242. defaults to Ancestor's Birth Year.
  243.  
  244. DECENDENT'S BIRTH PLACE:  Optional; above decendent's birth place if known.
  245.  
  246. DECENDENT INTEREST:  Interest level of the researcher for additional
  247. decendent information if found.  Non-entry assumes the lowest interest
  248. level.  Interest levels are defined above.
  249.  
  250. Select "S" to save the TT to a disk file.  The family information lines are
  251. sorted by surname and a Soundex Code is automatically assigned to each
  252. entry as the file is saved.  "M" and "P" switches are used to enable the
  253. use of up to 5 surname spellings (Soundex Coding is based on first surname
  254. only) and the use of place names (see SPEC.TT for details).
  255.  
  256. Or select "A" to exit the genealogical entry screen.  If you don't wish to
  257. abort the current work file completely, the Header Data information screen
  258. will be returned to.  Otherwise you'll receive another prompt for another
  259. file name, thus loosing your current work file in memory.  A [CR] at the
  260. file name prompt will exit TTGEN.
  261.  
  262.  
  263.                       ==============================
  264.  
  265.  
  266. REMINDER:  This version of TTGEN is under a Beta Test and should be used
  267. with caution.  Bug reports, comments, ideas, etc. would be very much
  268. appreciated.  Enjoy using TTGEN!
  269. st and should be used
  270. with caution.  Bug