Shareware Overload/ShartewareOverload.cdr/database/dedit100.zip/DEDIT.DOC

Text File | 1991-11-18 | 11KB | 267 lines

                  ╔═══════╗
                  ║       ╚═══╗
                  ║           ║
                  ║           ║
                  ║           ║  ╔════╕  ╔════╗    ╥  ╒═══╦═══╕
                  ║           ║  ║       ║    ╚═╗  ║      ║
                  ║           ║  ╠═══    ║      ║  ║      ║
                  ║       ╔═══╝  ║       ║    ╔═╝  ║      ║
                  ╚═══════╝      ╚════╛  ╚════╝    ╨      ╨

   ╔═══════════════════════════════════════════════════════════════════╗
   ║           Dedit Database Structure Editor, Version 1.00           ║
   ╚═══════════════════════════════════════════════════════════════════╝

                     Copyright 1991, Maurice Soulliere

                            All Rights Reserved




    First off, I don't warrantee this program in any shape or fashion.
Use this program at your own risk.  As a safety measure, always make
backup copies of your databases before editing them.  If you do happen
to come across any errors or mischievious happenings, please let me
know.  I will be sure to correct them for the next release.

    Secondly, this program is distributed through the shareware system.
This means you are free to use this program and to copy it, in the
original archive, to anybody else.  If you like it, all I ask is that
you register the program.  Checks or money orders for $20.00 can be made
out to:


                           Maurice Soulliere
                            88 First Avenue
                            Sudbury, Ontario
                                P3B 3L1


    Registration gives you free support, as well as advance warning of
the arrival of a new version.  I can be reached either at [phone]
by voice, or on the Crystal Cavern BBS [phone].  You can also
write to me if you so choose.  Please make sure you send me your
complete address and a number where you can be reached when you register
the program.

    Now that that's out of the way, let's get to the program.



    WHO TO

    This program was written for Clipper programmers who do not have an
easy way of editing database structures and records.  I've looked at the
other so called database editors, but they were lacking in the most
fundamental of all areas, that of changing the structure or creating a
new database.  This program does that in an extremely friendly, natural
way.  It also allows you to edit the records, create new indexes, and
pack the database.  A couple of reports have been added to aid you in
your software development.



    INSTALLATION

    Installation is simple.  Put the DEDIT.EXE file in a directory that
is in your path statement.  That's it.  Of course, you can print out
this document, but that's neither here nor there.



    THE OPTIONS

    Okay, now that the installation has been completed, we can down to
explaining what the options are.

    First off, when you initially run the program, you will be
confronted by the initial welcome screen.  There will be a delay and
then just press any key to resume operation.  Please read this screen.
Upon resuming, you will see the main menu.



    MODIFY STRUCTURE

    The first menu option allows you to modify the database structure of
any dBase compatible database.  Once you have selected this option, you
will be given a list of available databases to open. Pressing <Esc> in
the database selection window will cancel that operation and bring you
back to the main menu. After selecting the database you wish to modify
the program will continue to the Modify Structure screen.

    A list of commands is provided for you on the right side of the
screen.  There are a few things about this procedure which you should be
aware of.

    1.  The <esc> key has several functions.  One of the functions is
        to get you out of the Modify Structure procedure and return you
        to the main menu.  If any changes were made, you will be
        prompted to say Yes or No to save changes.

        The other function is while editing a field.  Pressing <esc>
        will cancel any changes to that field.  Pressing any other key
        will save the changes.

    2.  Beware when changing field names.  All information that exists
        in that field will be removed if you decide to save the changes.
        I am working on a solution that will allow you to keep the
        information, but for now you will have to be careful.

    3.  I have attempted to make changing the field type as painless as
        possible.  A few rules have been incorporated for keeping
        information.  However, some sorts of field type changes are just
        not compatible.  For those that are nowhere near each other, a
        default value will be applied to the new field type.  Logicals
        will be filled with false values, dates with blank date formats,
        numerics with zeros, and characters with null strings.  Changes
        to a memo type will always result in a new, blank memo field.

        A special note here.  The larger the database, the longer it
        will take to save if you decide to change a field type.  So ask
        yourself if that field really needs to have its type changed.
        Especially if you have a database that is over 300k. I am
        currently working on a solution to this problem, and hope to
        have a solution in the near future.



    CREATE STRUCTURE

    The second main menu option will allow you to create a new database.
Select this command and you will be confronted with a prompt to enter a
file name.  Just enter the first eight characters.  The extension will
be added later on.  After entering the filename, you will once again be
looking at the Modify Structure screen.  From here onwards is identical
to the Modify Structure procedure.  If you select No to the save changes
prompt, everything will be discarded.



    EDIT DATABASE

    Not much needs to be said about this option.  After selecting it
from the menu, select the database from the popup screen.  If there are
any indexes in the same directory, a popup list of index files will be
displayed.  Select one or a group of indexes by pressing the <enter> key
or the space bar.  A character will be displayed next to the file name
to indicate that this file has been selected.  To de-select a file,
point to it and press the <enter> key or space bar again.  When you
select an index file, it will intially look to see if the file is a
valid index for the current database.  If not, then it will just ignore
that selection.  You can open up to seven indexes (of course) at a time.
When you are happy with the selected databases, press <esc> to continue
this procedure.

    The browse screen that appears comes from the Clipper sample program
supplied with Clipper Summer '87.  (Why re-invent the wheel?)  There
have been a few modifications to improve upon the basic design.

    Remember that the only chance you have of abandoning a change to a
field is when editing that field.  Once the change has been made, it is
permanent.  Pressing <esc> to return to the main menu will just return
to the main menu.  You will not be asked to save the changes.



    BUILD INDEX

    This option will, as you have probably guessed by now, build a new
index file.  First off, if there are any databases in this directory,
you will see a popup list of them.  Select the database you want to
index by pointing to it and pressing <enter>.  Pressing <esc> will
abandon this procedure.

    Once you have selected a database, you will have the opportunity to
select the fields upon which to build the index.  To select a field,
point to it and press <enter>.  It will be displayed in the box on the
right hand side of the screen.  To remove a field from the list, point
to it and press <del>.  I have limited the number of fields you can
select at one time to eighteen.  I can not foresee needing an index that
would be greater than that.

    Once you are content with the selection with your selections, press
<esc>.  You will be asked for the name of the index file.  Be careful at
this part.  If you enter a name that already exists, the old file will
be replaced by the new one.



    RE_INDEX DATABASE

    A fairly straight forward option.  Select the database and the list
of indexes.  Press <esc> and the re-indexing will commence.



    PACK DATABASE

    This is the nuker.  Select the database and the list of indexes.
Answer Yes at the "are you sure?" prompt and say good-bye to those nasty
and difficult records which nobody really wanted anyway.  Use this
option with caution, as you know there is no return from the land of
lost bits.



    PRINT STRUCTURE

    dBase has a very nice "Display Structure" feature.  I attempted to
duplicate it here with a few exceptions and add-ons.  Once this option
has been selected, select the database you would like to list.  Then
select the destination for the report, Screen, Printer, or Abort.

    NOTE:   Make sure the printer is ready as this option does not first
            check for that.



    PRINT DBF STATS

    I often find it hand to just have an alphabetical listing of
fieldnames, minus all the other junk, on one page.  This report has a
few other statistics thrown in for good measure, but its main purpose is
to list all the fields, in alphabetical order, on one page.  Works
exactly as the previous report.  Select a database, then a destination.

    NOTE:   Make sure the printer is ready as this option does not first
            check for that.



    QUIT TO DOS

    It, uhm, quits to DOS.



    CONCLUSION

    Well, there you have it, the program in a nutshell.  Undoubtedly I
probably forgot to put something in this document file.  My apologies.
If you do find something, please let me know.


    ACKNOWLEDGEMENTS

    Many thanks go to Dave Cushing of Ringworld Software Solutions, who
has done much Beta testing on this program.  He has seems to have a
knack for crashing my programs.

    Also, thanks go to my brother, Terry Soulliere, who helped solve
some fairly key problems.


    I hope you find this program of great use to you in your endeavours
and feel obligated to register your copy.

"Help keep the dream of shareware alive" and me in coffee.

Bye for now.