| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <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> </p> |
| </li> |
| <li> |
| <p><a href="#prerequisites">Pre-requisites</a> </p> |
| </li> |
| <li> |
| <p><a href="#download">Downloading the Scripting Framework</a> </p> |
| </li> |
| <li> |
| <p><a href="#install">Installing the Scripting Framework</a></p> |
| </li> |
| <li><a href="#Installing_the_Scripting_Framework_in_a_">Installing |
| the Scripting Framework in a Network Installation of |
| OpenOffice.org</a></li> |
| </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 </p> |
| </li> |
| <li> |
| <p>OpenOffice.org users who wish to execute Office scripts via |
| menu, key and event bindings in OpenOffice.org </p> |
| </li> |
| </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> |
| <li>This release of the Scripting Framework runs on <a |
| href="http://www.openoffice.org/dev_docs/source/1.1rc/index.html"> <b>OpenOffice.org |
| 1.1 rc</b></a> and above. </li> |
| <li>The Scripting Framework is currently available in English only. </li> |
| </ul> |
| The table below shows the JDK and memory requirements for running the |
| Office Scripting Framework. |
| <p> </p> |
| <center> |
| <table colspan="4" cellpadding="5" border="1"> |
| <tbody> |
| <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.4.0_02</td> |
| <td>256MB</td> |
| </tr> |
| <tr> |
| <td>Script Developer</td> |
| <td>NetBeans 3.4</td> |
| <td>1.4.0_02</td> |
| <td>512MB</td> |
| </tr> |
| </tbody> |
| </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> |
| <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> |
| <li><b>examples</b> - Example scripts written in Java, JavaScript |
| & BeanShell.</li> |
| <li><span style="font-weight: bold;">schema</span> - Contains the |
| registry schema file for the Scripting Framework data.<br> |
| </li> |
| <li><b>sframework</b></li> |
| <ul> |
| <li><b>ooscriptframe.zip</b> - A UNO package containing the |
| core Scripting Framework libraries & Jar files. This also contains |
| the Java script runtime.<br> |
| </li> |
| <li><b>bshruntime.zip</b> - A UNO package containing the BeanShell |
| script runtime.<br> |
| </li> |
| <li><b>jsruntime.zip</b> - A UNO package containing the JavaScript |
| script runtime.<br> |
| </li> |
| </ul> |
| <li><b>ide</b> - The Jar files for NetBeans integration. </li> |
| </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> |
| <span style="color: rgb(255, 0, 0);"><span style="font-weight: bold;">Note:</span> |
| <span style="color: rgb(51, 0, 0);">Unlike previous releases, release |
| 0.3 |
| must be installed by the same user who installed OpenOffice.org, ie. |
| the |
| Administrator in the case of a network installation. This requirement |
| is |
| due to the fact that release 0.3 contains a schema extension to the |
| OpenOffice.org registry which must be installed under </span></span><font |
| face="Courier, monospace" size="2"><Office Installation>/share.</font><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: </p> |
| <ul> |
| <li>Open a terminal (Linux/UNIX) or DOS Command Prompt (Windows) </li> |
| <li>Ensure that java is in your execution path </li> |
| <li>Run the command: <font face="Courier, monospace" size="2">java |
| -jar SFrameworkInstall.jar</font> </li> |
| </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> |
| <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> |
| <p> <font face="Courier, monospace" size="2"> java -jar |
| SFrameworkInstall.jar -office <Office Installation> -netbeans |
| <NetBeans Installation></font> </p> |
| <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.<br> |
| </p> |
| <h2><a name="Installing_the_Scripting_Framework_in_a_"></a>Installing |
| the Scripting Framework in a Network Installation of |
| OpenOffice.org</h2> |
| Installing the Scripting Framework into an OpenOffice.org network |
| installation can only be done via the command line. the installation |
| done as a two-part process.First (after installing the OpenOffice.org, |
| the <font face="Courier, monospace" size="2">setup -net</font> part) |
| install the components and shared scripts, macros |
| etc:<br> |
| <br> |
| <font face="Courier, monospace" size="2"> java -jar |
| SFrameworkInstall.jar -office <Shared Office Installation> -net<br> |
| <br> |
| </font>then as each user, once |
| the user has installed OpenOffice.org (<font face="Courier, monospace" |
| size="2">setup</font> from the shared installation), add the menu |
| bindings to the |
| Scripting Framework dialogs:<br> |
| <br> |
| <font face="Courier, monospace" size="2"> java -jar |
| SFrameworkInstall.jar -office <User </font><font |
| face="Courier, monospace" size="2">Office Installation> -bindings<br> |
| <br> |
| </font> |
| This is currently not working on Linux due to a bug in the Linux release of |
| OpenOffice.org1.1rc. It |
| is expected that this will be fixed by the next release. |
| <p> </p> |
| <p> <b>Update:</b> The network install in current download is broken, this will be fixed as soon as possible.</p> |
| <p> <a href="#top">Top</a> </p> |
| <hr> Last Modified: |
| Tue Sep 16 18:48:26 BST 2003 |
| </body> |
| </html> |
