home *** CD-ROM | disk | FTP | other *** search
/ Mega CD-ROM 1 / megacd_rom_1.zip / megacd_rom_1 / DBASE / DEDIT100.ZIP / DEDIT.DOC next >
Text File  |  1991-11-18  |  11KB  |  267 lines
  1.  
  2.  
  3.                   ╔═══════╗
  4.                   ║       ╚═══╗
  5.                   ║           ║
  6.                   ║           ║
  7.                   ║           ║  ╔════╕  ╔════╗    ╥  ╒═══╦═══╕
  8.                   ║           ║  ║       ║    ╚═╗  ║      ║
  9.                   ║           ║  ╠═══    ║      ║  ║      ║
  10.                   ║       ╔═══╝  ║       ║    ╔═╝  ║      ║
  11.                   ╚═══════╝      ╚════╛  ╚════╝    ╨      ╨
  12.  
  13.    ╔═══════════════════════════════════════════════════════════════════╗
  14.    ║           Dedit Database Structure Editor, Version 1.00           ║
  15.    ╚═══════════════════════════════════════════════════════════════════╝
  16.  
  17.                      Copyright 1991, Maurice Soulliere
  18.  
  19.                             All Rights Reserved
  20.  
  21.  
  22.  
  23.  
  24.     First off, I don't warrantee this program in any shape or fashion.
  25. Use this program at your own risk.  As a safety measure, always make
  26. backup copies of your databases before editing them.  If you do happen
  27. to come across any errors or mischievious happenings, please let me
  28. know.  I will be sure to correct them for the next release.
  29.  
  30.     Secondly, this program is distributed through the shareware system.
  31. This means you are free to use this program and to copy it, in the
  32. original archive, to anybody else.  If you like it, all I ask is that
  33. you register the program.  Checks or money orders for $20.00 can be made
  34. out to:
  35.  
  36.  
  37.                            Maurice Soulliere
  38.                             88 First Avenue
  39.                             Sudbury, Ontario
  40.                                 P3B 3L1
  41.  
  42.  
  43.     Registration gives you free support, as well as advance warning of
  44. the arrival of a new version.  I can be reached either at (705) 560-8027
  45. by voice, or on the Crystal Cavern BBS (705) 566-7530.  You can also
  46. write to me if you so choose.  Please make sure you send me your
  47. complete address and a number where you can be reached when you register
  48. the program.
  49.  
  50.     Now that that's out of the way, let's get to the program.
  51.  
  52.  
  53.  
  54.     WHO TO
  55.  
  56.     This program was written for Clipper programmers who do not have an
  57. easy way of editing database structures and records.  I've looked at the
  58. other so called database editors, but they were lacking in the most
  59. fundamental of all areas, that of changing the structure or creating a
  60. new database.  This program does that in an extremely friendly, natural
  61. way.  It also allows you to edit the records, create new indexes, and
  62. pack the database.  A couple of reports have been added to aid you in
  63. your software development.
  64.  
  65.  
  66.  
  67.     INSTALLATION
  68.  
  69.     Installation is simple.  Put the DEDIT.EXE file in a directory that
  70. is in your path statement.  That's it.  Of course, you can print out
  71. this document, but that's neither here nor there.
  72.  
  73.  
  74.  
  75.     THE OPTIONS
  76.  
  77.     Okay, now that the installation has been completed, we can down to
  78. explaining what the options are.
  79.  
  80.     First off, when you initially run the program, you will be
  81. confronted by the initial welcome screen.  There will be a delay and
  82. then just press any key to resume operation.  Please read this screen.
  83. Upon resuming, you will see the main menu.
  84.  
  85.  
  86.  
  87.     MODIFY STRUCTURE
  88.  
  89.     The first menu option allows you to modify the database structure of
  90. any dBase compatible database.  Once you have selected this option, you
  91. will be given a list of available databases to open. Pressing <Esc> in
  92. the database selection window will cancel that operation and bring you
  93. back to the main menu. After selecting the database you wish to modify
  94. the program will continue to the Modify Structure screen.
  95.  
  96.     A list of commands is provided for you on the right side of the
  97. screen.  There are a few things about this procedure which you should be
  98. aware of.
  99.  
  100.     1.  The <esc> key has several functions.  One of the functions is
  101.         to get you out of the Modify Structure procedure and return you
  102.         to the main menu.  If any changes were made, you will be
  103.         prompted to say Yes or No to save changes.
  104.  
  105.         The other function is while editing a field.  Pressing <esc>
  106.         will cancel any changes to that field.  Pressing any other key
  107.         will save the changes.
  108.  
  109.     2.  Beware when changing field names.  All information that exists
  110.         in that field will be removed if you decide to save the changes.
  111.         I am working on a solution that will allow you to keep the
  112.         information, but for now you will have to be careful.
  113.  
  114.     3.  I have attempted to make changing the field type as painless as
  115.         possible.  A few rules have been incorporated for keeping
  116.         information.  However, some sorts of field type changes are just
  117.         not compatible.  For those that are nowhere near each other, a
  118.         default value will be applied to the new field type.  Logicals
  119.         will be filled with false values, dates with blank date formats,
  120.         numerics with zeros, and characters with null strings.  Changes
  121.         to a memo type will always result in a new, blank memo field.
  122.  
  123.         A special note here.  The larger the database, the longer it
  124.         will take to save if you decide to change a field type.  So ask
  125.         yourself if that field really needs to have its type changed.
  126.         Especially if you have a database that is over 300k. I am
  127.         currently working on a solution to this problem, and hope to
  128.         have a solution in the near future.
  129.  
  130.  
  131.  
  132.     CREATE STRUCTURE
  133.  
  134.     The second main menu option will allow you to create a new database.
  135. Select this command and you will be confronted with a prompt to enter a
  136. file name.  Just enter the first eight characters.  The extension will
  137. be added later on.  After entering the filename, you will once again be
  138. looking at the Modify Structure screen.  From here onwards is identical
  139. to the Modify Structure procedure.  If you select No to the save changes
  140. prompt, everything will be discarded.
  141.  
  142.  
  143.  
  144.     EDIT DATABASE
  145.  
  146.     Not much needs to be said about this option.  After selecting it
  147. from the menu, select the database from the popup screen.  If there are
  148. any indexes in the same directory, a popup list of index files will be
  149. displayed.  Select one or a group of indexes by pressing the <enter> key
  150. or the space bar.  A character will be displayed next to the file name
  151. to indicate that this file has been selected.  To de-select a file,
  152. point to it and press the <enter> key or space bar again.  When you
  153. select an index file, it will intially look to see if the file is a
  154. valid index for the current database.  If not, then it will just ignore
  155. that selection.  You can open up to seven indexes (of course) at a time.
  156. When you are happy with the selected databases, press <esc> to continue
  157. this procedure.
  158.  
  159.     The browse screen that appears comes from the Clipper sample program
  160. supplied with Clipper Summer '87.  (Why re-invent the wheel?)  There
  161. have been a few modifications to improve upon the basic design.
  162.  
  163.     Remember that the only chance you have of abandoning a change to a
  164. field is when editing that field.  Once the change has been made, it is
  165. permanent.  Pressing <esc> to return to the main menu will just return
  166. to the main menu.  You will not be asked to save the changes.
  167.  
  168.  
  169.  
  170.     BUILD INDEX
  171.  
  172.     This option will, as you have probably guessed by now, build a new
  173. index file.  First off, if there are any databases in this directory,
  174. you will see a popup list of them.  Select the database you want to
  175. index by pointing to it and pressing <enter>.  Pressing <esc> will
  176. abandon this procedure.
  177.  
  178.     Once you have selected a database, you will have the opportunity to
  179. select the fields upon which to build the index.  To select a field,
  180. point to it and press <enter>.  It will be displayed in the box on the
  181. right hand side of the screen.  To remove a field from the list, point
  182. to it and press <del>.  I have limited the number of fields you can
  183. select at one time to eighteen.  I can not foresee needing an index that
  184. would be greater than that.
  185.  
  186.     Once you are content with the selection with your selections, press
  187. <esc>.  You will be asked for the name of the index file.  Be careful at
  188. this part.  If you enter a name that already exists, the old file will
  189. be replaced by the new one.
  190.  
  191.  
  192.  
  193.     RE_INDEX DATABASE
  194.  
  195.     A fairly straight forward option.  Select the database and the list
  196. of indexes.  Press <esc> and the re-indexing will commence.
  197.  
  198.  
  199.  
  200.     PACK DATABASE
  201.  
  202.     This is the nuker.  Select the database and the list of indexes.
  203. Answer Yes at the "are you sure?" prompt and say good-bye to those nasty
  204. and difficult records which nobody really wanted anyway.  Use this
  205. option with caution, as you know there is no return from the land of
  206. lost bits.
  207.  
  208.  
  209.  
  210.     PRINT STRUCTURE
  211.  
  212.     dBase has a very nice "Display Structure" feature.  I attempted to
  213. duplicate it here with a few exceptions and add-ons.  Once this option
  214. has been selected, select the database you would like to list.  Then
  215. select the destination for the report, Screen, Printer, or Abort.
  216.  
  217.     NOTE:   Make sure the printer is ready as this option does not first
  218.             check for that.
  219.  
  220.  
  221.  
  222.     PRINT DBF STATS
  223.  
  224.     I often find it hand to just have an alphabetical listing of
  225. fieldnames, minus all the other junk, on one page.  This report has a
  226. few other statistics thrown in for good measure, but its main purpose is
  227. to list all the fields, in alphabetical order, on one page.  Works
  228. exactly as the previous report.  Select a database, then a destination.
  229.  
  230.     NOTE:   Make sure the printer is ready as this option does not first
  231.             check for that.
  232.  
  233.  
  234.  
  235.     QUIT TO DOS
  236.  
  237.     It, uhm, quits to DOS.
  238.  
  239.  
  240.  
  241.     CONCLUSION
  242.  
  243.     Well, there you have it, the program in a nutshell.  Undoubtedly I
  244. probably forgot to put something in this document file.  My apologies.
  245. If you do find something, please let me know.
  246.  
  247.  
  248.     ACKNOWLEDGEMENTS
  249.  
  250.     Many thanks go to Dave Cushing of Ringworld Software Solutions, who
  251. has done much Beta testing on this program.  He has seems to have a
  252. knack for crashing my programs.
  253.  
  254.     Also, thanks go to my brother, Terry Soulliere, who helped solve
  255. some fairly key problems.
  256.  
  257.  
  258.     I hope you find this program of great use to you in your endeavours
  259. and feel obligated to register your copy.
  260.  
  261. "Help keep the dream of shareware alive" and me in coffee.
  262.  
  263. Bye for now.
  264.  
  265.  
  266.  
  267.