INSTALLATION NOTES

From binary tar archive
=======================

We have build a quick-and-dirty binary distribution for all platforms 
available at the download page.

- Preparation

    * Download the tarball.
    * Un-tar it (for example into /home/user1).
    * To tell the bean the locations of the the OpenOffice executable 
      and the native library, create a new file 'openofficebean.properties' 
      in your home directory. On a Windows machine this is usually 
      'c:\Documents and Settings\<login name>\'. Add the two properties 
      'org.openoffice.path' and 'org.openoffice.libpath' to the file. 
      For example if you are running a linux machine with a OpenOffice 
      installed in /usr/local/openoffice:
      
      org.openoffice.path=/usr/local/openoffice/program
      org.openoffice.libpath=/home/user1/openofficebean-0.1.0_bin/lib/linux_i386
      
      (Windows user: use windows like path names, for example 
      c:\openoffice\program).
      
    * Replace the toolkit library in the OpenOffice installation 
      with the patched version (backup the original version first). 
      The patched library resides in the sub-directory patched_libs of 
      this binary distribution and is named:
      
          * libtk614li.so (for Linux Intel)
          * libtk614ss.so (for Solaris Sparc)
          * tk614mi.dll ( for Windows)

- Run the sample application

      java -classpath classes/openofficebean.jar org.openoffice.Demo
      
      (Windows user: make sure that jawt.dll is included in your PATH environment variable).

- Use it in the beanbox

    * copy the file openoffice.jar into the 'jars' directory of the BDK.
    * Start the bean box, two new beans should apear in the Toolbox: 
      'OpenOffice Bean' and 'OpenOffice Writer'.
    * Drag the 'OpenOffice Bean' into the BeanBox window - the Bean will 
      show only a image at this time.
    * Enter a valid URL in the 'DocumentURL' property field and wait some 
      seconds for the startup of OpenOffice. Besides common file or http 
      URLs you can use following URLs to open an empty document:
      
          * private:factory/swriter
          * private:factory/scalc
          * private:factory/simpress
          * private:factory/sdraw
          * private:factory/smath

- Use it in a Java IDE

We have tested the bean in NetBeans IDE 3.1beta without any problems.
Please refer to the documentation of your IDE how to integrate beans.

- Use it in a Browser

You can embed the bean in a applet and run it with the JRE 1.3 plugin 
from SUN in every browser - we have tested it only in Mozilla 0.7 under 
Linux. Because the bean uses several security relevant features like 
setting system properties, native code, executing processes on the local 
machine, you have to grant all this permissions to your applet.
The easy way is to create a file .java.policy in your home directory 
and add an entry like

grant codeBase "<URL to my applet code>" { 
   permission java.security.AllPermission; 
};


From source
===========

The project itself is independent from the OpenOffice build environment 
and works with make & configure on Unix systems and nmake on a Windows 
system. That means you don't need the OO-solenv tree. Unfortunately you 
need the whole OO-solver tree, because the the Java-UNO runtime classes 
and the Java bindings of the StarOffice API are not part of the binary 
distribution of OpenOffice, yet. I hope, this will change soon. Right 
now you have to download the OO-614-solver tree.

- Preparation

    * Download the 614-solver tree and un-tar it (for example into 
      $HOME/oo_614)
    * Get the source code of this project
      
          * either from CVS (OpenOffice CVS infos). The module name is 
            'whiteboard/OOBean' or
          * Or you can download a tarball of the source.
    * Replace the toolkit library in the OpenOffice installation with 
      the patched version (backup the original version first). The patched 
      library resides in the sub-directory patched_libs of the binary 
      distribution and is named:
      
          * libtk614li.so (for Linux Intel)
          * libtk614ss.so (for Solaris Sparc)
          * tk614mi.dll ( for Windows)
      
      Or you can download it separately from our download page

- Build it on Linux or Solaris

    * Set your JAVA_HOME and ANT_HOME environment variables.
    * Go to the root of the project and type 
      ./autogen.sh --with-oopath=$HOME/oo_614.
    * then type make (make install will not do any reasonable action)
    * The jar file which contains the bean will be stored in the classes 
      directory, the native library in src/native/unix/.libs.
    * Refer to the above description how to run the example, use the bean 
      in the beanbox or use it in a Java IDE.

- Build it on Windows

    * Execute the VCVARS32.BAT from the Microsoft Visual C++ compiler 
      to adjust the path settings.
    * Set your JAVA_HOME and ANT_HOME environment variables.
    * Set the OO_PATH environment variable to your OpenOffice source directory.
    * Go to the root of the project and type nmake -f makefile.win.
    * The jar file which contains the bean will be stored in the classes
      directory, the native library in src\native\win32\.libs.
    * Refer to the above description how to run the example, use the bean 
      in the beanbox or use it in a Java IDE.
