| <html> |
| <head> |
| <title>Installation and User Guide</title> |
| |
| <meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8"> |
| </head> |
| |
| <body> |
| <a name="top"></a> |
| |
| <h1>Installation Guide for the Office Scripting Framework</h1> |
| |
| <h2>Contents</h2> |
| |
| <ul> |
| <li><p><a href="#who">Who Should Read This Document</a> |
| <li><p><a href="#prerequisites">Pre-requisites</a> |
| <li><p><a href="#download">Downloading the Scripting Framework</a> |
| <li><p><a href="#install">Installing the Scripting Framework</a> |
| </ul> |
| |
| <a name="who"></a> |
| |
| <h2>Who Should Read This Document</h2> |
| |
| This document should be read by: |
| |
| <ul> |
| <li><p>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 |
| |
| <li><p>OpenOffice.org users who wish to execute Office scripts |
| via menu, key and event bindings in OpenOffice.org |
| </ul> |
| |
| <a href="#top">Top</a> |
| <a name="prerequisites"></a> |
| |
| <h2>Pre-requisites</h2> |
| |
| <ul> |
| <li>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. |
| <li>This release of the Scripting Framework runs on |
| <a href="http://www.openoffice.org/dev_docs/source/644/index.html"> |
| <b>OpenOffice.org 644</b></a> and above. |
| <li>The Scripting Framework is currently available in English only. |
| </ul> |
| |
| The table below shows the JDK and memory requirements for running the |
| Office Scripting Framework. |
| |
| <p> |
| <center> |
| <table colspan=4 cellpadding=5 border=1> |
| <tr> |
| <th>User</th><th>IDE</th><th>JDK required</th><th>Memory required</th> |
| </tr> |
| <tr> |
| <td>Script User</td><td>-</td><td>1.3</td><td>256MB</td> |
| </tr> |
| <tr> |
| <td>Script Developer</td><td>NetBeans 3.4</td><td>1.3</td><td>512MB</td> |
| </tr> |
| </table> |
| </center> |
| |
| <a href="#top">Top</a> |
| <a name="download"></a> |
| |
| <h2>Downloading the Scripting Framework</h2> |
| |
| The Scripting Framework is available for download in the form of a Jar |
| file which can be obtained from <a href="SFrameworkInstall.jar">here</a>. |
| The contents of the Jar file are as follows: |
| |
| <ul> |
| <li><b>installer</b> - A platform-independent installer for the Scripting |
| Framework written in Java. |
| |
| <li><b>bindingdialog</b> - A collection of StarBasic dialogs |
| to enable the user to assign (bind) scripts to menu and key items, |
| and to document and application events. This directory also contains |
| the necessary XML files for the menu items that invoke these StarBasic dialogs. |
| |
| <li><b>examples</b> - Example scripts written in Java and BeanShell. |
| |
| <li><b>sframework</b> - A UNO package <!--<sup>*</sup>--> containing |
| the Scripting Framework libraries, Jar files and types. |
| |
| <li><b>ide</b> - The Jar files for NetBeans integration. |
| |
| </ul> |
| |
| <!-- |
| <p> |
| <sup>*</sup>See <a href="http://api.openoffice.org/servlets/ProjectDownloadList?action=download&dlID=84"> |
| §4.7.1</a> of the |
| <a href="http://api.openoffice.org/DevelopersGuide/DevelopersGuide.html"> |
| Office Developers' Guide</a> for a description of the UNO packaging system. |
| <p> |
| --> |
| |
| <a href="#top">Top</a> |
| <a name="install"></a> |
| |
| <h2>Installing the Scripting Framework</h2> |
| |
| Before you begin installation, you need to ensure all Office processes |
| have terminated and on Windows and Linux, that the QuickStarter |
| has been closed. <br> |
| |
| <br> |
| <b>Note:</b> Before installing an updated version of the Scripting Framework, the previous version should be removed. (See the <a href="uninstall-guide.html">Guide for Uninstalling</a>) |
| |
| <p> |
| To install the Scripting Framework: |
| |
| <ul> |
| <li>Open a terminal (Linux/UNIX) or DOS Command Prompt (Windows) |
| <li>Ensure that java is in your execution path |
| <li>Run the command: |
| <font face="Courier, monospace" size="2">java -jar SFrameworkInstall.jar</font> |
| </ul> |
| |
| <p> |
| This will start the installer GUI, which you can use to select the Office |
| installation to which you want to install the Scripting Framework. The |
| framework is installed in the <Office Installation>/user/uno_packages |
| directory of the Office installation you choose. |
| |
| If the installer detects an installation of either |
| <a href="http://www.netbeans.org/devhome/docs/releases/builds_archive/release_archive.html"> NetBeans 3.4</a> |
| you will be asked whether you wish to install the IDE Add-ins. |
| These add-ins provide support for developing and deploying Office Scripts. |
| |
| <p> |
| <b>Note:</b> If you do not wish to use the GUI you can install the |
| Scripting Framework and the IDE Add-in via the command line using the command: |
| |
| <p> |
| <font face="Courier, monospace" size="2"> |
| java -jar SFrameworkInstall.jar -office <Office Installation> |
| -netbeans <NetBeans Installation></font> |
| |
| <p> |
| <b>Note:</b> 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. |
| |
| <p> |
| <a href="#top">Top</a> |
| |
| <hr> |
| Last Modified: Tue Mar 12 11:40:28 GMT 2003 |
| </body> |
| </html> |
