Installation Guide for the Early Developer Release (Version 0.1)
This document tells you how to download and install the Early Developer
Release of the Office Scripting Framework.
Contents
Who Should Read This Document
This document should be read by:
Application Developers who wish to enhance OpenOffice.org
functionality without needing to develop UNO components or to connect to
OpenOffice.org from a remote JVM
OpenOffice.org users who wish to execute Office scripts written
in Java via menu and key bindings in OpenOffice.org
Top
Pre-requisites
- This is an Early Developer Release of the Office Scripting Framework
provided for users and developers of OpenOffice.org to try out and provide
feedback. Future releases of the Framework may change.
- This release of the Scripting Framework runs
only on OpenOffice.org 643C
- The Scripting Framework is currently available in English only.
The table below shows the JDK and memory requirements for running the
Office Scripting Framework on OpenOffice.org 643C.
User | IDE | JDK required | Memory required |
Script User | - | 1.3 | 256MB |
Script Developer | NetBeans 3.4 | 1.3 | 512MB |
Script Developer | jEdit 4.0.3 | 1.4 | 512MB |
Top
Downloading the Scripting Framework
The Scripting Framework is available for download in the form of a Jar
file which can be obtained from here.
The contents of the Jar file are as follows:
- installer - A platform-independent installer for the Scripting
Framework written in Java.
- bindingdialog - A collection of StarBasic dialogs
to enable the user to assign (bind) scripts written in Java to menu and
key items. This directory also contains the necessary XML files
for the menu items that invoke these StarBasic dialogs.
- examples - Two example scripts written in Java.
- sframework - A UNO package containing
the Scripting Framework libraries, Jar files and types.
Additionally, a resource file for a security-related dialog.
- ide - The Jar files for NetBeans and jEdit integration.
- (platform dirs) - These contain the platform dependent
regsingleton
tool used to add singleton entries in the OpenOffice.org services datatbase.
Top
Installing the Scripting Framework
Before you begin installation, you need to ensure all Office processes
have terminated and on Windows and Linux, that the QuickStarter
has been closed.
To install the Scripting Framework:
- Open a terminal (Linux/UNIX) or DOS Command Prompt (Windows)
- Ensure that java is in your execution path
- Copy the Scripting Framework Jar file you downloaded into the program
directory of the OpenOffice.org installation into which you
wish to install the Framework.
- Switch to the <Office Installation>/program directory
- Run the command:
java -jar SFrameworkInstaller.jar
This will cause the Scripting Framework to be installed in the
<Office Installation>/user/uno_packages directory of your Office
installation. If the installer detects an installation of either
NetBeans 3.4 or
jEdit 4.0.3
you will be asked whether you wish to install the Scripting Framework
add-ins for these IDEs. These add-ins provide support for developing
and deploying Office Scripts in Java.
Note: The installer detects IDE installations by looking for
session related files in the home directory of the user running the install,
so in order for your IDE to be detected you will need to have run it at
least once.
Note: If you are installing the Scripting Framework into a network
installed OpenOffice.org, the Framework install will need to be run as
the same user who did the initial network install. This is because one of
the files (ProtocolHandler.xcu) that needs to be modified during the
Framework install is in the <Office Installation>/share directory,
Top
Uninstalling the Scripting Framework
Currently there is no automated process for uninstalling the Scripting
Framework, so uninstalling must be done manually (the process will be
automated in a future release).
To remove the Scripting Framework:
- Delete the file <Office Installation>/user/uno_packages/ooscriptframe.zip
- Switch to the <Office Installation>/program directory and run the command: pkgchk
If you wish to remove any scripts from your installation they are stored in the directories:
- <Office Installation>/user/Scripts
- <Office Installation>/share/Scripts
You can use the Tools/Configure dialog to remove any menu or key bindings
that you have setup for Office scripts.
If you have installed Office Scripting support into a NetBeans installation
you can remove it by deleting:
- <NetBeans Installation>/modules/office.jar
If you have installed Office Scripting support into a jEdit installation
you can remove it by deleting:
- <jEdit Installation>/jars/OfficeScripting.jar
- <jEdit Installation>/jars/idesupport.jar
Top
Last Modified: Fri Nov 29 14:19:53 GMT 2002