/*
README
The Frankie Library Tour Version 2.1
Compiled in CA-Clipper 5.2c and 5.01
*/

Table of Contents
-----------------
A. Disclaimer
B. License
C. Quick Start for Those Who Downloaded Frankie from CompuServe or a BBS.
D. Quick Start for Those Who Received Frankie in One Disk
E. Quick Start for Those Who Received Frankie in Two Disks
F. NOTE TO CLIPPER 5.01 USERS
G. Major Changes That May Require Some Source Rewrite (v2.0)
H. Major Changes That May Require Some Source Rewrite (v2.1)
I. Registration
J. Upgrading from Version 1
K. Where to Get the Latest Version
L. Acknowledgement


A. Disclaimer
-------------
THE PROGRAMMER'S DESK DISCLAIMS ALL WARRANTIES RELATING TO THIS SOFTWARE,
WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND ALL
SUCH WARRANTIES ARE EXPRESSLY AND SPECIFICALLY DISCLAIMED. NEITHER
THE PROGRAMMER'S DESK NOR ANYONE ELSE WHO HAD BEEN INVOLVED IN THE CREATION,
PRODUCTION, OR DELIVERY OF THIS SOFTWARE SHALL BE LIABLE FOR ANY INDIRECT,
CONSEQUENTIAL, OR INCIDENTAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO
USE SUCH SOFTWARE EVEN IF THE PROGRAMMER'S DESK HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES OR CLAIMS. IN NO EVENT SHALL THE PROGRAMMER'S
DESK'S LIABILITY FOR ANY DAMAGES EVER EXCEED THE PRICE PAID FOR THE LICENSE
TO USE THE SOFTWARE, REGARDLESS OF THE FORM OF CLAIM. THE PERSON USING THE
SOFTWARE BEARS ALL RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE.



B. License
----------
Frankie is copyrighted material (COPYRIGHT (c) 1992,1993 by Angelito Dizon,
All rights reserved.) Frankie is not public domain nor free software. The
registered version of Frankie may not be duplicated other than for backup
purposes. The same registered copy of Frankie may not be used in more than
one computer at the same time.



C. Quick Start for Those Who Downloaded Frankie from CompuServe or a BBS
------------------------------------------------------------------------
1. Unzip "FRANKN.ZIP." Will yield FRANKN.TXT, the Frankie Newsletter. It
contains the latest Frankie news, recently asked questions, etc.

2. Unzip "FRANKG.ZIP." Will yield FRANKI21.NG, the Norton Guides database.

3. Unzip "FRANKR.ZIP." Will yield REF.TXT, the documentation text.

4. Unzip "FRANK.ZIP." Will yield README and FRANKIE.EXE.

5. Read "README", this file, which was extracted from FRANK.ZIP.

6. Run the self-extracting file "FRANKIE.EXE," which was extracted from
FRANK.ZIP. The following files will be extracted into the current
directory:

FRANKIE.CH - the header file
FRANKIE.LIB - the library file
F2_501.CH - header file for Clipper 5.01 users
F2_501.LIB - extra library file for Clipper 5.01 users

OVERVIEW.F - overview of the Frankie library
OVERVIEW.SB - overview of the scroll bar engine
OVERVIEW.GM - overview of the boxed gets engine
OVERVIEW.HP - overview of the help facility
OVERVIEW.PB - overview of the push button engine
OVERVIEW.RB - overview of the radio button engine
OVERVIEW.DB - overview of the database browser engine
OVERVIEW.RD - overview of the get/read engine
OVERVIEW.VM - overview of the vertical menu engine
OVERVIEW.HM - overview of the horizontal menu engine
OVERVIEW.BM - overview of the dialog box engine
OVERVIEW.FV - overview of the file viewer engine

ENGINES.F - overview of the Frankie engines
FUNCLIST.F - a list of the Frankie non-engine functions
TECHSUPT.TXT- technical support info

F_TOUR.PRG - source code of the Frankie Tour program (main)
BM_TOUR.PRG - Dialog box
DB_TOUR.PRG - Dabase browser
FV_TOUR.PRG - File Viewer
HM_TOUR.PRG - Horizontal menu
HP_TOUR.PRG - Help facility
PB_TOUR.PRG - Push button
RB_TOUR.PRG - Radio buttons
RD_TOUR.PRG - Get/Read
SB_TOUR.PRG - Scroll bar
VM_TOUR.PRG - Vertical menu
MISC.PRG - Miscellaneous functions

CBFRANK.BAT - batch file to compile/link (Blinker) the tour program
CBRRANK.BAT - batch file to compile/link (RTlink) the tour program
F_TOUR.LNK - Blinker link file
F_TOURR.LNK - RTlink link file

F_TOUR.HLP - Help file of the tour program
F_TOUR.HLX -

CUSTOMER.DBF- demo datafiles used by the tour program
CUSTOMER.NTX-
DEMO.DBF -
DEMO.DBT -
EMPLOYEE.DBF-
EMP_NAME.NTX-
EMP_NUM.NTX -
HARDWARE.DBF-
HARDWARE.NTX-
SOFTWARE.DBF-
SOFTWARE.NTX-

REGISTER.FRM- registration form
UPGRADE.FRM - form for upgrading from v1 to v2.1
USERS.TXT - What users say about Frankie.

In addition, two sub-directories will be created: SAMPLE and NEWDEMO
which will be filled with a number of demo programs. The demos in
NEWDEMO are new in version 2.1.

7. Compile and link the ??_TOUR.PRGs using CRFRANK.BAT if you use Rtlink,
or CBFRANK.BAT if you use Blinker. This will create F_TOUR.EXE.
Run it to "tour" the various features of the Frankie mouseable user
interfaces. Be sure that the environmental variables LIB and INCLUDE
are properly set.

NOTE: If you are using CLIPPER 5.01, you will need to make a minor
change in the F_TOUR.LNK and F_TOURR.LNK files. The change
is explained in the .LNK files themselves.

8. To run the demo programs in the SAMPLE or NEWDEMO directory, go to that
directory, then compile/link each demo program using the Blinker
and RTlink batch files, CB.BAT and CR.BAT.

NOTE: If you are using CLIPPER 5.01, you will need to make a
minor change in these batch files. The change is explained
in the .BAT files themselves.

NOTE: The resulting .EXE is named TEST.EXE for all PRGs.

10. To find out what the changes are from Frankie 1.0x to Frankie 2.0,
and from 2.0 to 2.1, run the Norton Guides and select "New" from the
menu. Moreover, FRANKN.TXT lists the new and modified features in
version 2.1


D. Quick Start for Those Who Received Frankie in One Disk
---------------------------------------------------------
All these files are in the diskette:

README
FRANKIE.EXE
FRANKG.ZIP
FRANKR.ZIP
FRANKN.ZIP

Follow the steps in "C", but skip step #4.


E. Quick Start for Those Who Received Frankie in Two Disks
----------------------------------------------------------
These files are in Disk #1

README
FRANKIE.EXE

These files are in Disk #2

FRANKG.ZIP
FRANKR.ZIP
FRANKN.ZIP

Follow the steps in "C", but skip step #4.


F. NOTE TO CLIPPER 5.01 USERS
-----------------------------
If you are using Clipper 5.01, #include F2_501.CH in your programs.
Its correct placement is "before" FRANKIE.CH, like this:

#include F2_501.CH
#include FRANKIE.CH

If you do not properly #include F2_501.CH, the mouse will not work
properly with ADread(), which is the Frankie replacement of the
GetSys.Prg.

Also link F2_501.LIB, together with, but ahead of FRANKIE.LIB.
Your link command may thus look like this:

blinker file MYFILE lib F2_501, FRANKIE

or:

rtlink file MYFILE lib F2_501, FRANKIE

If you do not properly link F2_501.LIB, you may get "undefine symbols"
warnings during linking, and the resulting .exe file may not work
properly. However, if "CLIPPER520" is the only undefined symbol
encountered, you need not worry about it.

See F_TOUR.CH, F_TOUR.LNK, and F_TOURR.LNK for examples.


G. Major Changes That May Require Some Source Rewrite (v2.0)
-----------------------------------------------------------
1. The ADMEMO extention of ADGET is no longer supported in this version.
Refer to the ADread() documentation for instructions on how to modify
existing code. Basically, it is simply a change from:

@ .. SAY .. ADMEMO ..

to:

@ .. SAY .. ADGET .. MEMO

2. If you used the ADsbx_.. and the ADsby.. functions, you will have to
rewrite the source portions that call them. Please refer to the documentaion
of the Horizontal Scroll Bar Engine and the Vertical Scroll Bar Engine. If
you used them only in implementing scoll bars in the database browsers, then
you only need to remove all the ADsby.. and ADsbx.. lines and configure
the browser with the ADdb_horsbar() and ADdb_versbar() APIs. Refer to
the Database Browser Engine documentation.

3. The default location of a vertical menu has been changed from the
top/left corner of the screen to the center of the screen. Thus if you have
an ADvermenu() call like this:

ADvermenu( ,, aMenu )

the menu will now be centered, instead of being placed at the top left
corner. If you want to preserve the location of "default" menus in existing
applications, modify these menu calls to :

ADvermenu( 0,0, aMenu )

4. In Frankie 1, the menu wraps from the first to the last option when the up
arrow is pressed, and vice-versa. In Frankie 2, this wrap behaviour has to
be explicitly configured in one-page menus, otherwise, no such wrapping
occurs. The rewrite may take this form:

Original: ADvermenu( ,, aMenu )
Rewrite: ADvermenu( ,, aMenu,,, {|| ADvm_wrap(.t.)} )

In multi-page picklists, ADvermenu() always wraps.


5. In Frankie 1, ADbm_exit() was used to abort ADboxmenu(). In Frankie 2
ADbm_exit() no longer exists. It has been replaced with ADbm_abort().


H. Major Changes That May Require Some Source Rewrite (v2.1)
------------------------------------------------------------
Changed ADr_tbpopup() syntax:
from ADr_tbpopup( nRow, nCol, aOrder, aForce, bConfig )
to ADr_tbpopup( aCoords, xDummy, aOrder, aForce, bConfig )

The first two params are now aCoords and xDummy instead of nRow
and nCol. In this new syntax, it is possible to specify all four
coordinates. The second parameter, xDummy is no longer used. If
aCoords is not passed, the function works the same way as when you
do not pass nRow and nCol in the old syntax.

You should change your existing code like this:

1. Old: ADr_tbpopup( NIL, NIL, .. )
New: No change

2. Old: ADr_tbpopup( nRow, nCol, .. )
New: ADr_tbpopup( { nRow, nCol, Nil, NIL }, NIL, .. )

3. Old: ADr_tbpopup( nRow, NIL, .. )
New: ADr_tbpopup( { nRow, NIL, Nil, NIL }, NIL, .. )

4. Old: ADr_tbpopup( NIL, nCol, .. )
New: ADr_tbpopup( { NIL, nCol, Nil, NIL }, NIL, .. )


I. Registration
---------------
Print and fill out REGISTER.FRM, then follow instructions therein. Or fill
out a registration form via the F_TOUR program.


J. Upgrading from Version 1
---------------------------
Print and fill out UPGRADE.FRM, then follow instructions therein. Or fill
out a registration form via the F_TOUR program.


K. Where to Get the Latest Version
----------------------------------
Enhancement work on Frankie is a continuous effort in The Programmer's Desk
office. Announcements are accordingly published in an electronic newsletter.
If you are wondering whether you have the latest version, download the file
FRANKN.ZIP from either the Clipper Forum, Lib 7 in Compuserve, or from the RRR
Bulletin Board at (301)464-1372.


L. Acknowledgement
------------------
My heartfelt gratitude to the following:

1. Those who registered their Frankie version 1.
2. Those who reported problems.
3. Those who requested for new APIs and engines which for the most part
resulted in version 2.

Special thanks to Mark Lussier of Pinnacle Publishing for featuring Frankie 1
in the July, 1993 issue of Reference (Clipper).

Special thanks also to Steven Gibb for extending to me special upload
privileges in his excellently managed BBS.

Foremost of all, to my good friend from Germany, George Lorrig and to his
wife Esther.

Then of course to the wonderful members of my family who deserve more quality
time and attention from me than what they have been getting lately: Thelma,
Frances and Catherine (who also acted my special secretary in more ways than
one).

Lito Dizon
The Programmer's Desk
Compuserve 71165,1023