Lotus 1-2-3 ADK - INSTALL.TXT

This file includes information about:
- how the 1-2-3 ADK is installed.
- how to get the 1-2-3 ADK to work on non-default installations.

================================================================================
The 123 LSX samples can be built using the LSX Toolkit version 2.0 and later.  

The LSX toolkit is dependent only on Lotus Script - it has no application specifics in it.  Application specific functionality can be accessed through the application's interface with LotusScript (i.e. by passing application objects to you LSX functions), or by certain other application specific methods.

Methods to give access to 1-2-3 data are implemented in the LSX123Base class.  Most of these methods provide a wrapper for the LotusScript API to make your code easier to develop and more readable.  All of the defines necessary to use these methods are included in the ADK.

This release of the ADK includes the LSX Toolkit Version 2.2 The latest version of the LSX toolkit is available at the Lotus dev.net site (see toolbox section) at http://www.lotus-dev.net or at the Lotus Developer Central Web Site (see downloads section) at http://www.lotus.com/developers 	(you'll need to register with the sites).

================================================================================
Installation Instructions

1). The Setup program provides three options for the installation:

a). Install LSX Toolkit.
	
You should choose this option if you have not previously installed the LSX Toolkit or you have a previous version of the LSX Toolkit and want to upgrade it to the latest version. 

b). Install the 1-2-3 LSX Toolkit add-in files.

You should select this option to install the additional 1-2-3 specific LSX Toolkit Files.

You should choose this option if you have an existing LSX Toolkit setup that you do not    want overwritten. You must have an LSX Toolkit in the destination directory if you choose this option.

c). Install just the 1-2-3 LSX Sample files.

This option installs the 1-2-3 Sample files complete with all source code and documentation. It does not install any 1-2-3 Toolkit Components. The sample C++ source code is included in the relevant directory off the \SRC directory along with the .123 files for 1-2-3. The actual sample Dll's are included in the \BIN\W32 Directory. The samples are ready to run by loading the relevant .123 sample file into Lotus 1-2-3.


2. LSX Development setup

Once the install program has copied the LSX files to your hard drive, you will need to set up the development environment for the LSX Toolkit.  LSX Toolkit 2.x provides two batch files to assist with setting up the development environment for the LSX toolkit.

Lsxflex.bat is designed to work on a variety of platforms and compilers.  It takes two parameters to specify platform and compiler.

Lsxtriv.bat is specific to Windows 32 bit platform; this will be adequate for most 123 LSX development.

You should edit these files to make sure that the directories for your LSX Toolkit are correct.  You can also add the directory of your compiler so that this can be added to the path as well.

Before you run lsxtriv.bat or lsxflex.bat you should make sure your environment variables are set for your compiler.
For example, if you are using Visual C++ there will be a VCVARS32.BAT file in the \BIN Directory of your MSVC installation.
You should run this file to set up your compiler environment variables. - See LSXTRIV.BAT for a more detailed explaination. We recommend you add this to your AUTOEXEC.BAT file so the environment variables are always set up correctly.

Once you have set up your environment variables and modified lsxtriv.bat or lsxflex.bat, you are ready to integrate these into your setup. You should set up a shortcut in Windows to create a Command window with a larger than usual environment space. To do this, create a shortcut to a command window as usual, then select the properties of the shortcut and set the Initial environment space to 1024 or more.

You should then use this shortcut to open the command window for development. Whenever you open the command window, run lsxtriv or lsxflex from the \lsx directory as appropriate to set up the environment for that session. 


3. Building

Once the necessary environment variables are set, any directory off \lsx\src can be built by going to that directory and running DO_IT.  This applies to the LSX Toolkit samples, the 1-2-3 ADK samples and any other LSXs that you've created using the LSX Wizard.  One can also set up development projects, and some of the 1-2-3 ADK samples come with project files for the Visual C++ compiler.  Generally this simply involves adding the source code to the project - remembering also to add the common source code and to make sure that the correct .def file is used.


4. LSX Wizard

The LSX Toolkit provides the LSX Wizard Notes database that sets up all of the boilerplate structure that Script requires of an LSX.  The files that it generates are basic LSXs that don't inherit from the LSX123Base class.  To setup the LSX wizard it's necessary to enter the directory of the LSX Toolkit on your machine.

The Wizard itself uses an LSX (LSXWIZRD.DLL) to provide functionality. This LSX is registered automatically by the install program when you install the LSX Toolkit Files. 

If you do not use the install program and simply copy the files manually, you will need to register this LSX Manually. This can be done simply by running the LotusScript code toolsreg.lss in the lsx directory.


5. Installing 1-2-3 specific samples

The installation program supplied with the 1-2-3 ADK will copy all appropriate files to the correct places to work with the LSX Toolkit.  The locations of these files are detailed in the file readme.txt included with the ADK.  All the samples have been designed to be built by running the batch file, do_it.bat and pre-built versions are provided.  The installation process will register the sample LSXs so that they can be run immediately.  There is a .123 file in each of the sample directories which demonstrates the functionality of the particular sample.
