-l flag used? +	parcel-descriptor.xml exists? +	result +
no +	no +	error message printed +
yes +	no +	parcel-descriptor.xml generated parcel.sxp generated +
no +	yes +	parcel-descriptor.xml not generated parcel.sxp generated +
yes +	yes +	if + language is different from parcel-descriptor.xml language, error + else + parcel-descriptor.xml regenerated + parcel.sxp generated +

; Fri, 25 Nov 2011 20:05:54 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r799253 [11/16] - in /websites/staging/ooo-site/trunk/content/framework: documentation/ documentation/devmanual/ documentation/filters/ documentation/filterui/ documentation/mimetypes/ documentation/others/ drafts/ proposals/ proposals/appl... Date: Fri, 25 Nov 2011 20:05:43 -0000 To: ooo-commits@incubator.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20111125200554.B09172388B75@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/commandline-devguide.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/commandline-devguide.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/commandline-devguide.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,256 @@ + + + + + + +Developing Scripts on the Command Line + + + + + + + + +

+ +

+ + + + + +

Developing Scripts on the Command Line

+ +For users who do not wish to develop their Office Scripts using an IDE there +is a simple command line interface built into the Office Scripting module +which can be used for the generation and deployment of Office Scripts. + +

+ +

Prerequisites +
The CommandLineTools class +
Examples +

+ + +

Prerequisites

+ +

The Scripting module office.jar file should be included in the +classpath. You can unpack this file from the Scripting Framework installer +SFrameworkInstall.jar +by running the following command: + +
+ +jar xf SFrameworkInstall.jar ide/office.jar + + +
The CommandLineTools class will only work if an XML parser (such as +Apache Xerces) +is available in the classpath. +

+ + +

The CommandLineTools class

+ +The CommandLineTools class takes the following options (Note: +Options in angle brackets "<>" are required, options in +square brackets "[]" are optional): + +

+ +-g [Path to Parcel directory] [options] + +
+Generates a Script Parcel for the given the parcel directory. The parcel +name will be the name of the parcel directory plus the .sxp extension. + +
+
If a parcel directory is not specified the current directory is used. +If the parcel directory does not contain a directory named Contents an error +message is printed. Otherwise a Script Parcel (.sxp) file is generated in +the parcel directory containing all of the files under the Contents +directory. + +The options that may be used with the -g option allow the user to specify +how the parcel-descriptor.xml file for the Script Parcel is generated +(see the Scripting Framework developer guide +for more information on the parcel-descriptor.xml file). The following options +are available: + +
+[-l language[=supported extension list]] + +
+Specifies which language attribute to use for the parcel element in the +parcel-descriptor.xml file. The supported extension list is ignored if the +language is Java. Otherwise all files that have one of the supported extensions +(the list should be separated by the platform specific path separator, +":" on Unix, ";" on Windows) will be added as script +entries to the parcel-descriptor.xml file. + +
+ +Alternatively the user can specify a list of names at the command line which +will be added as scripts and no search for script names will be performed. + +The following table shows the behaviour of CommandLineTools when the -l flag +is used: + +
+ + + + + + + + + + + + +
-l flag used? + parcel-descriptor.xml exists? + result +
no + no + error message printed +
yes + no + parcel-descriptor.xml generated
parcel.sxp generated +
no + yes + parcel-descriptor.xml not generated
parcel.sxp generated +
yes + yes + if +
language is different from parcel-descriptor.xml language, error +
else +
parcel-descriptor.xml regenerated +
parcel.sxp generated +
+ +
+[-p name=value] + +
+Specifies a name value pair to be added as a language dependent property in +the parcel-descriptor.xml file + +
+[-v] + +
+Specifies that verbose output should be displayed. +
+ +
+-d <Path to Script Parcel> <Target Directory|Document> + +
+Deploys the given Script Parcel to a directory or an OpenOffice.org document. +A directory will be created with the name of the Parcel and the contents of +the Parcel will be put into that directory. + +
+
If deploying to an OpenOffice.org installation the target directory should +be the <Office Installation>/user/Scripts or +<Office Installation>/share/Scripts directory. If the either the +Script Parcel or the target do not exist an error message is printed. +Otherwise the Script Parcel is deployed to the target. +
+

Top + + +

Examples

+ +

+java CommandLineTools -g myparceldir -l Java + + +
Generates a myparceldir.sxp file in myparceldir automatically exporting +all public Java methods which take XScriptContext as their first parameter as +Office scripts. + +
+java CommandLineTools -g -l BeanShell=.bsh + + +
Generates a script parcel file in the current directory +automatically exporting all files that end with the .bsh extension as +BeanShell scripts + +
+java CommandLineTools -g myparceldir -l BeanShell MyScript.bsh + + +
Generates a myparceldir.sxp file in myparceldir and exports MyScript.bsh +as an Office script. + +
+java CommandLineTools -g myparceldir -l Java -p classpath=dep1.jar:dep2.jar + + +
Generates a myparceldir.sxp file in myparceldir, automatically +searching for valid Office scripts, and adding the classpath property to +each Office script. + +
+java CommandLineTools -g myparceldir -l Java -p classpath=dep1.jar:dep2.jar -p secondprop=secondvalue + + +
Generates a myparceldir.sxp file in myparceldir, automatically +searching for valid Office scripts, and adding the classpath and the +secondprop properties to each Office script. + +
+java CommandLineTools -d myparceldir.sxp /export/home/MyOffice/user/Scripts + + +
Deploys the myparceldir.sxp Script Parcel to the specified office directory. +

+ +

Top +

+Last Modified: Tue Mar 12 11:40:28 GMT 2003 + + +

+ +

+ Apache "OpenOffice.org" is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. + Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and + decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is + not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has + yet to be fully endorsed by the ASF.

+ Contact Us | + Terms of Use +
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. +
OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. +
Other names appearing on the site may be trademarks of their respective owners. +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/developer-guide.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/developer-guide.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/developer-guide.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,338 @@ + + + + + + +Writing Scripts in BeanShell and Java + + + + + + + + +

+ +

+ + + + +

Writing Scripts in BeanShell and Java

+ + +

+ +

Hello World in BeanShell +
Trying out your BeanShell script +
Hello World in Java +
Writing Office Scripts and the XScriptContext type +
Tips on writing Office scripts +
Parcel Descriptor DTD and sample XML +

+ + +

Hello World in BeanShell

+ +Here's a BeanShell script that inserts Hello World at the start of an +OpenOffice.org Writer document: + +

+    import com.sun.star.frame.XModel;
+    import com.sun.star.text.*;
+    import com.sun.star.uno.UnoRuntime;
+    import drafts.com.sun.star.script.framework.XScriptContext;
+
+    model = context.getDocument(); 
+    textdoc = (XTextDocument)
+        UnoRuntime.queryInterface(XTextDocument.class, model);
+
+    oText = textdoc.getText(); 
+    oCursor = oText.createTextCursor(); 
+    oText.insertString(oCursor, "Hello World", false)
+

+Top + + +

Trying out your BeanShell script

+ +Trying out your Hello World BeanShell script is easy: + +

Start OpenOffice.org and open a new Writer document. +
Select the Tools/Scripting Add-on's/Interactive BeanShell Scripting... +menu item. +
Paste your Hello World code from above into the window that pops up and +click on the eval button. +
You should see Hello World appear at the start of the Writer document. +

+ +

+You can modify the code directly in the evaluation window and click eval again to test it. If you are new to the OpenOffice.org API this is a great way to experiment with it. + +

+Note: The Interactive BeanShell window does not report when an error occurs while evaluating your code, so it may fail silently. The best way to trace the execution of your code is to write debug statements into your document from your script, for example: + +

+model = context.getDocument();
+textdoc = (XTextDocument)UnoRuntime.queryInterface(XTextDocument.class, model);
+oText = textdoc.getText();
+oCursor = oText.createTextCursor();
+
+oText.insertString(oCursor, "DEBUG: start", false);
+
+// do something with the API
+
+oText.insertString(oCursor, "DEBUG: did something", false);
+

+ +

+When you are happy with your BeanShell script, you can create a Script Parcel +which can be deployed to OpenOffice.org installations or documents for use +by others. This can be done using NetBeans +or from the command line. + +

+Top + + +

Hello World in Java

+ +Here's the Hello World script in Java: + +

+ +

+    import com.sun.star.frame.XModel;
+    import com.sun.star.text.*;
+    import com.sun.star.uno.UnoRuntime;
+    import drafts.com.sun.star.script.framework.XScriptContext;
+
+    public class MyClass {
+
+        // The script method must be public
+        // It can either be static or non-static
+
+        public void showForm(XScriptContext xSc) {
+
+            // getting the text document object
+            XModel xmodel = xSc.getDocument();
+
+            XTextDocument xtextdoc = (XTextDocument)
+                UnoRuntime.queryInterface(XTextDocument.class, xmodel);
+            XText xtext = xtextdoc.getText();
+            XTextCursor xtextcursor = xtext.createTextCursor();
+
+            xtext.insertString(xtextcursor, "Hello World", false);
+        }
+    }
+

+ + +

+Office scripts in Java need to be compiled in order to execute them. +See the Developing Scripts in NetBeans and +Developing Scripts on the command line +guides for instructions on how to compile and deploy Office scripts in Java. + +

+Top + + +

Writing Office scripts and the XScriptContext type

+ +The XScriptContext type is used to obtain the the document context, +desktop and component factory from an Office script. Any public Java method +which accepts XScriptContext as it's first parameter can be executed as +an Office script. For BeanShell scripts, an instance of XScriptContext is +available in a global variable called "context" which can be +used by the script. + +

+The following accessor methods are available on the XScriptContext type: + +

Current document - access the document context against which +the script was invoked + +
+ +<XScriptContext Instance>.getDocument() +
returns +::com::sun::star::frame::XModel + +
Office Desktop - access the desktop of the running Office + +
+ +<XScriptContext Instance>.getDesktop() +
returns + +::com::sun::star::frame::XDesktop + +
Component Factory - access a ComponentContext factory to create +other UNO components as required + +
+ +<XScriptContext Instance>.getComponentContext() +
returns + +::com::sun::star::uno::XComponentContext +

+ +The Java or BeanShell script must import the XScriptContext interface, +using the following import directive: + + +

+    import drafts.com.sun.star.script.framework.XScriptContext;
+

+ + +

+Top + + +

Tips on writing Office scripts

+ +

Performance: Currently scripts are being loaded by the +Scripting Framework each time they are run. As such it is important to +keep the size of your scripts and any dependent jar files they are using +reasonably small. In future releases this script loading will be +optimised by changing the point at which the scripts are loaded +by OpenOffice.org and using various caching schemes once they are +loaded. However, the initial load will always be effected by the +script and it's dependent jar/class file sizes. + +
Threading: Scripts are run synchronously by the +Scripting Framework. If you wish to perform any background task or +provide some user interaction via a dialog for instance, then it is your +responsibility to spawn a thread in the running script which can +manage this process or interaction and let the script return promptly. +Within this running thread you should follow the normal +UNO component threading guidelines to ensure that they do not deadlock +OpenOffice.org through inappropriate use of the UNO API. +

+ +Top + + +

Parcel Descriptor DTD and sample XML

+Each script must contain a parcel-descriptor.xml file which provides all the necessary metadata for +the script. The DTD for the parcel-descriptor.xml follows +

+<?xml version="1.0" encoding="UTF-8"?>
+<!-- DTD for Parcel Meta data for use in the OpenOffice.org Scripting Framework Project -->
+<!ELEMENT logicalname EMPTY>
+<!ELEMENT description (#PCDATA)>
+<!ELEMENT displayname EMPTY>
+<!ELEMENT locale (displayname?, description?)>
+<!ELEMENT functionname EMPTY>
+<!ELEMENT prop EMPTY>
+<!ELEMENT languagedepprops (prop+)>
+<!ELEMENT file (prop*)>
+<!ELEMENT fileset (file+)>
+<!ELEMENT script (locale+, functionname, logicalname, languagedepprops*, fileset*)>
+<!ELEMENT parcel (script+)>
+<!ATTLIST logicalname
+	value CDATA #REQUIRED
+>
+<!ATTLIST displayname
+	value CDATA #REQUIRED
+>
+<!ATTLIST locale
+	lang CDATA #REQUIRED
+>
+<!ATTLIST functionname
+	value CDATA #REQUIRED
+>
+<!ATTLIST logicalname
+	value CDATA #REQUIRED
+>
+<!ATTLIST prop
+	name CDATA #REQUIRED
+	value CDATA #REQUIRED
+>
+<!ATTLIST file
+	name CDATA #REQUIRED
+>
+<!ATTLIST fileset
+	name CDATA #IMPLIED
+>
+<!ATTLIST script
+	language CDATA #REQUIRED
+>
+<!ATTLIST parcel
+	language CDATA #REQUIRED
+>
+

+The following is an example of a parcel-descriptor.xml file that defines a script, +implemented in Java. The languagedepprops element is used to extend the JVM's classpath. +

+<?xml version="1.0" encoding="UTF-8"?>
+<!--Sample Meta Data for use with the Scripting Framework Project in OpenOffice.org -->
+<!DOCTYPE parcel SYSTEM "parcel.dtd">
+<parcel language="Java">
+	<script language="Java">
+		<locale lang="english">
+			<displayname value="Memory.usage"/>
+			<description>
+				Displays the memory current memory usage
+			</description>
+		</locale>
+		<functionname value="memoryUtils.memoryUsage"/>
+		<logicalname value="MemoryUtils.MemUsage"/>
+		<languagedepprops>
+			<prop name="classpath" value="/opt/foo.jar:/usr/java/src.jar"/>
+		</languagedepprops>
+		<fileset>
+			<file name="mems.txt">
+				<prop name="type" value="resource"/>
+			</file>
+		</fileset>
+	</script>
+</parcel>
+

+Top + +

+Last Modified: Tue Mar 12 11:40:28 GMT 2003 + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/developer-release-features.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/developer-release-features.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/developer-release-features.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,153 @@ + + + + + + + Features for Early Developer Release + + + + + + + + +

+ +

+ + + + +

New Features in this Release

+ +

Additional language support + +
+Added support for BeanShell, a loosely typed Java based scripting language +supported by NetBeans. The Interactive BeanShell Scripting Window +available from Tools->Scripting Add-ons allows you to experiment +with Office scripting without needing to recompile your scripts. + +
+This is an example of the implementation of an additional script runtime, +in this case based on Java runtime (see +How to write a runtime for more information +on writing runtimes). + +
Security Enhancements + +
+Script execution by the scripting framework now honors the security +settings in Tools -> Options -> Security Settings. (ie. your existing +settings for StarBasic macros). + +
Support for storage of bindings in documents + +
+With this release script bindings can now also be stored in documents +as well as in your OpenOffice.org user directory (see the release notes for instructions). + +
Support for Event Bindings + +
+Assign dialogs have been enhanced to allow bindings to events as well +as to menu items and keys. +

+ +

Notes: + +

New binding assignments can be made without requiring a restart of +OpenOffice.org +
Scripts bindings are now fully resolved at binding +
Command line utilities have been added for packaging and deployment +(see +Developing Scripts without an IDE) +
Support for jEdit IDE has been discontinued +

+ +

Features of the Office Scripting Framework

+ +

Scripting Framework

+ +Enables Office scripting in a language of your choice through support for +different language Runtimes. The current release provides Java and +BeanShell Runtimes. The Scripting Framework is designed to allow Runtimes +for other languages (for which a UNO bridge exists) to be developed and +deployed easily. Runtimes for Java based languages use the Java UNO bridge. + +

Script Development and IDE support

+ +A NetBeans module is provided which can be used to create Office scripts. +Scripts can be deployed to a document or to an OpenOffice.org +installation (user or share area). By installing the ODK for +OpenOffice.org, the user has full access to online help and code +completion within any scripts they are writing. + +

+Debugging of scripts is possible in NetBeans for Java scripts. For +more information on setting up OpenOffice.org to enable debugging see + +Debugging Java components in NetBeans/Forte for Java + +

+Note: The BeanShell scripting language does not support source +level debugging it is not possible to debug Office scripts written +in BeanShell from NetBeans. It is recommended to use the Interactive +BeanShell Scripting Window when developing while BeanShell scripts. + +

Executing Scripts

+ +Scripts can be executed from key combinations, selecting menu item +or events (document or application). Assign dialogs (written in StarBasic) +allow the user to bind scripts available in document or OpenOffice.org +installation to key combination, menu items or events (document or +application). Bindings can be stored in documents or an OpenOffice.org +installation. + +

Security

+ +The security settings of the Scripting Framework honor the existing +StarBasic security settings available in Tools -> Options -> +Security Settings. + +
+

+Last Modified: Tue Mar 12 11:40:28 GMT 2003 + + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/faq.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/faq.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/faq.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,49 @@ + + + + + + + + + + + + +

+ +

+ + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/index.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/index.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/index.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,49 @@ + + + + + + + + + + + + +

+ +

+ + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/install-guide.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/install-guide.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/install-guide.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,204 @@ + + + + + + +Installation and User Guide + + + + + + + + +

+ +

+ + + + + +

Installation Guide for the Office Scripting Framework

+ +

Who Should Read This Document +
Pre-requisites +
Downloading the Scripting Framework +
Installing the Scripting Framework +

+ + + +

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 +via menu, key and event 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 on + +OpenOffice.org 644 and above. +
The Scripting Framework is currently available in English only. +

+ +The table below shows the JDK and memory requirements for running the +Office Scripting Framework. + +

+ + + + + + + + + + +

User	IDE	JDK required	Memory required
Script User	-	1.3	256MB
Script Developer	NetBeans 3.4	1.3	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 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. + +
examples - Example scripts written in Java and BeanShell. + +
sframework - A UNO package containing +the Scripting Framework libraries, Jar files and types. + +
ide - The Jar files for NetBeans integration. + +

+ + + +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.
+ +
+Note: Before installing an updated version of the Scripting Framework, the previous version should be removed. (See the Guide for Uninstalling) + +

+To install the Scripting Framework: + +

Open a terminal (Linux/UNIX) or DOS Command Prompt (Windows) +
Ensure that java is in your execution path +
Run the command: +java -jar SFrameworkInstall.jar +

+ +

+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 + NetBeans 3.4 +you will be asked whether you wish to install the IDE Add-ins. +These add-ins provide support for developing and deploying Office Scripts. + +

+Note: 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: + +

+ +java -jar SFrameworkInstall.jar -office <Office Installation> +-netbeans <NetBeans Installation> + +

+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. + +

+Top + +

+Last Modified: Tue Mar 12 11:40:28 GMT 2003 + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/javascript-devguide.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/javascript-devguide.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/javascript-devguide.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,196 @@ + + + + + + + + + Developing Scripts in JavaScript + + + + + + +

+ +

+ + + +

Writing Office Scripts in JavaScript

+ +A prototype Script Runtime has been developed for JavaScript using the +Rhino JavaScript +Interpreter from the Mozilla project. This Runtime allows JavaScript +scripts to be executed in OpenOffice.org. Unlike the BeanShell and Java +Runtimes the JavaScript Runtime is still in development and is not yet +fully functional, however it is suitable for experimenting with Office +scripting in JavaScript. + +

+Some known limitations of the JavaScript Runtime are: + +

Currently the JavaScript Runtime does support loading of Java classes that +are deployed with the JavaScript script. +
The JavaScript Runtime will not report any errors that occur during the +execution of the script. +
Currently there is no support for interactive development of +JavaScript scripts. +

+ +

Installation +
Hello World in JavaScript +
Invoking JavaScript in OpenOffice.org +
Issues +

+ +

Installation

+ +

Download the JavaScript Runtime UNO package +
If you have OpenOffice.org running you should close it. +
Switch to the directory named program under your OpenOffice.org installation +directory +

Run the command: +

+pkgchk <path to your downloaded jsruntime.zip>
++

+ +

Hello World in JavaScript

+ +Here's a JavaScript script that inserts Hello World at the start +of an OpenOffice.org Writer document: + +

+importClass(Packages.com.sun.star.uno.UnoRuntime);
+importClass(Packages.com.sun.star.text.XTextDocument);
+
+var oModel = ScriptContext.getDocument(); 
+var oTextdoc = UnoRuntime.queryInterface(XTextDocument, oModel);
+var oText = oTextdoc.getText(); 
+var oCursor = oText.createTextCursor(); 
+
+oText.insertString(oCursor, "Hello World", false);
+

+ +

+The ScriptContext variable above is a global instance of the XScriptContext type +which is available to all JavaScript scripts executed by the Scripting +Framework. See Writing Office Scripts +and the XScriptContext type for the methods available for the XScriptContext type. + +

Invoking a JavaScript script in OpenOffice.org

+ +You have two choices for making your Hello World script available for +execution within OpenOffice.org: + +

Using the command line tools + +
+You can use the CommandLineTools class available with the Scripting Framework +to generate and deploy a Script Parcel. To do this with the Hello World script: + +
+
- Create a directory called helloworld and create a file called helloworld.js +in that directory using the code above + +
- Setup the command line tools according to the instructions on the +Command Line Tools page + +
- To generate a script parcel run the command: +
  +
```
+java CommandLineTools -g -l Rhino=.js
+
```
  + +
- To deploy the generated .sxp file: +
  +
```
+java CommandLineTools -d <path to helloworld.sxp> <path to your OpenOffice.org>/user/Scripts
+
```
  +
+ +

Manually deploying your script + +

Create a directory called <path to your OpenOffice.org>/user/Scripts/rhino/helloworld +
Create a file helloworld.js in that directory with the Hello World code +

Create a file called parcel-descriptor.xml in that directory with the following contents: + +

+<?xml version="1.0" encoding="UTF-8"?>
+
+<parcel language="Rhino" xmlns:parcel="scripting.dtd">
+
+    <script language="Rhino">
+        <locale lang="en">
+            <displayname value="HelloWorld"/>
+            <description>Insert Hello World in a document</description>
+        </locale>
+        <functionname value="helloworld.js"/>
+        <logicalname value="HelloWorld.Rhino"/>
+    </script>
+</parcel>
+

+ +

+Once you have the JavaScript ScriptRuntime installed and the Hello World script +deployed restart OpenOffice.org. See the +Scripting Framework User Guide for instructions +on how to bind your script to a menu item, key binding or event. To see your +script set the Location to User and the Language to Rhino in the Assign +dialogs. + +

+If you want to change your Hello World script, just edit the helloworld.js file +in a text editor, save it and rerun the script using your menu, key or event +binding. You don't need to restart OpenOffice.org or rebind to the script +as the Scripting Framework reloads the script each time it runs it. + + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/jsruntime.zip ============================================================================== Binary file - no diff available. Propchange: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/jsruntime.zip ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/netbeans-devguide.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/netbeans-devguide.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/netbeans-devguide.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,288 @@ + + + + + + +Developing Scripts in NetBeans + + + + + + + + +

+ +

+ + + + + +

Developing Scripts in NetBeans

+ +This document describes how to set up NetBeans for Office Scripting +and how to write a simple script using NetBeans. You can download +the NetBeans IDE from the +NetBeans download page. + +

Pre-requisites

+ +

The Office Scripting module works with NetBeans 3.4 + +
You should have installed the Office Scripting module during the +installation process for the Scripting Framework. If you have not installed +it, see the Installation Guide for +instructions on how to install. + +
On Linux, you will need to ensure that your DISPLAY environment +variable is set to <your hostname>:0 in the shell from which you +start NetBeans to work around a problem with Java GUIs in Office. + +
Create a directory somewhere on your machine in which you will develop +your scripts. +

+ +Now start NetBeans and mount the directory you created using the +File/Mount Filesystem menu option. You also need to mount all of the jar +files in the <Office installation>/program/classes directory in +order to access the Office API from your scripts. +

+Top + +

+ +

Creating a Parcel Recipe

+ +Office scripts are delivered in Script Parcels. Like Office documents they +are zip files. Script Parcels have the .sxp extension. Script Parcels are +generated from Parcel Recipes where all of the files that are necessary +to create the parcel are put together. To create a new Parcel Recipe: + +

Right click on your mounted filesystem +
Select New/Office Scripting/Parcel Recipe +
In the New Wizard window that appears enter a name for your Parcel Recipe +
Select a language for your Parcel Recipe from the Initial Script +Language dropdown list. +
Click the Finish button to create your Parcel Recipe +

+ +This will create a new directory with the name you chose. In this directory +you will find a Contents directory where all of your files will +be placed. An empty stub file will have been placed in the +Contents directory and can be used as a starting point for your script. + +

+Note: To add further empty stub scripts to your Parcel Recipe, right +click on the Contents directory and use the New/Office Scripting/Empty Script +menu item. + +

+Top + +

+ +

Actions available for Parcel Recipe

+ +If the user right clicks on the parcel directory they should be +able to use the following actions: + +

Compile: Compiles all of the .java files in the Parcel Recipe + +
Build: Compiles all of the .java files in the Parcel Recipe. +It then searches for valid Office scripts in the language you selected +in the Contents directory files and pops up a dialog +which allows you to select which Java methods or BeanShell scripts +you wish to export as Office scripts. +Once you have finish making your selections, it creates a +<Parcel Recipe Name>.sxp Script Parcel file in the Parcel +Recipe directory. You can configure what files are put into the +Script Parcel using the File Filter property. If you script includes any +jar files that need to be in the classpath when it is executed you should +add them to the Classpath property of your Parcel Recipe. + +
Configure: This pops up the Configure dialog, which allows you +to select what Office scripts to export. Any changes you make in +this dialog will only appear in your Script Parcel after you run +Build again. +

+Top + +

+ +

Actions available for Script Parcels

+ +Script Parcels supports only one action: + +

Deploy: This will deploy the Script Parcel to an Office Document +or to an Office installation. If the Script Parcel already exists +in the target, you will be asked whether you want to overwrite. +

+ +

+Note: If you deploy a Script Parcel to an OpenOffice.org +installation you need to use the Tools/Scripting Add-on's/Refresh All Scripts +menu item for the new script to appear in the Assign Script dialog. + +

+Note: You can also deploy to Office documents within NetBeans +using drag and drop or cut and paste. +

+Top + +

+ +

Actions available for Office Documents

+ +Office Documents are also recognised by NetBeans. Any parcels contained +in the document will be displayed as nodes of the Office document. Deleting +one of these nodes will remove the Script Parcel from the document. You +should ensure that the document is not open in OpenOffice.org before deleting +any parcels it may contain. + +Office documents support the standard Delete, Cut and Copy actions and +the following custom actions: + +

Open: This will open the document in Office using the path +in the Office Settings property to find the Office installation. + +
+If the path to Office is not valid, an error dialog will be popped +up informing the user that they need to set their Path to Office +Installation property. This setting can be changed by bringing +up the Tools/Options dialog and changing +IDE Configuration/Server and External Tool Settings/Office Settings +

+Top + +

+ +

Debugging Java Office scripts in NetBeans

+ +

Follow the instructions at + +Debugging Java components in NetBeans/Forte for Java +to set up your Office installation to allow debugging of the JVM. + +
Start OpenOffice and run one of your Java scripts. This will +make sure the JVM is running. + +
Attach to Office JVM using the NetBeans Debug/Start Session/Attach... +menu option. + +
Load a script source in NetBeans and set up breakpoints using +Debug/New Breakpoint... menu option. + +
Run the script in Office. +

+ +

+Note: As the BeanShell scripting language does not support debugging +it is not possible to debug BeanShell Office scripts from NetBeans. You +can however use the Interactive BeanShell scripting menu item under the Tools +menu in OpenOffice.org to test BeanShell code. Just enter any BeanShell code +and hit the Eval button to execute it. +

+Top + +

+ +

Troubleshooting

+ +

If you encounter problems when developing or deploying scripts in +NetBeans, one thing you can try is to move your NetBeans settings directory +(.netbeans on UNIX, netbeans in Windows - can be found in your home +directory) to another name and restart NetBeans. + +
The Choose What to Export as Scripts dialog only displays +methods which are defined within class files, it will not display +methods in class files which are within jar files in the Parcel Recipe. + +
If you include package directives in the Java source files of your +Parcel Recipe, you should ensure that the source files are in the appropriate +directories for your package directives. This is because the +default NetBeans compiler implementation does not use the -d switch to the +Java compiler. As a result class files do not get placed in the appropriate +directories and methods in these classes will not appear in the +Choose What to Export as Scripts dialog. + +
+There are a couple of workarounds for this problem: + +
+
1. Use the command line tools +
2. Set the Target flag in the Tools/Options window under +Building/Compiler Types/Internal Compilation +
+

+ +

+Top + +

+Last Modified: Tue Mar 12 11:40:28 GMT 2003 + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/release-notes.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/release-notes.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/release-notes.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,49 @@ + + + + + + + + + + + + +

+ +

+ + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/runtime-howto.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/runtime-howto.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/runtime-howto.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,49 @@ + + + + + + + + + + + + +

+ +

+ + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/uninstall-guide.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/uninstall-guide.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/uninstall-guide.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,167 @@ + + + + + + +Uninstalling the Scripting Framework + + + + + + + + +

+ +

+ + + + + +

Guide for Uninstalling the Office Scripting Framework

+ + + +

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). The Scripting Framework will eventually +be included in the standard OpenOffice.org install/uninstall process. + +

+To remove the Scripting Framework: +

Delete the files: +
- <Office Installation>/user/uno_packages/ooscriptframe.zip
- <Office Installation>/user/uno_packages/bshruntime.zip
- <Office Installation>/user/basic/ScriptBindingLibrary/ (delete entire directory)
+
Switch to the <Office Installation>/program directory and run the command: pkgchk +
- On Windows: pkgchk.exe
- On Solaris/Linux: ./pkgchk
+
Use the Tools/Configure dialog to remove the "Scripting Add-ons" entry in the Tools menu.

+ +

+If you wish to remove any scripts from your installation they are stored in the directories: +

<Office Installation>/user/Scripts +
<Office Installation>/share/Scripts +

+ + + + +

+To remove any menu, key or event bindings that you have set up for Office scripts. +

The original configuration can be restored by removing the files used by the Scripting Framework and replacing them with the files that were backed up during installation.
cd <Office>/user/config/soffice.cfg/
Delete all files that don't end in a .bak extension.
Rename the .bak files to their original name (i.e. without the .bak extension).

e.g. writermenubar.xml.bak to writermenubar.xml

cd to META-INF
Delete manifest.xml
If it is there, rename manifest.xml.bak to manifest.xml
NOTE: The configuration files are only created when a change is made through Tools -> Configure. It is possible that no files needed to be backed up during installation of the Scripting Framework.
List of config files possibly backed up in <Office>/user/config/soffice.cfg/

writermenubar.xml
writerkeybinding.xml
calcmenubar.xml
calckeybinding.xml
impressmenubar.xml
impresskeybinding.xml
drawmenubar.xml
drawkeybinding.xml
META-INF/manifest.xml

+ + + + + +

+If you have installed Office Scripting support into a NetBeans installation +you can remove it by deleting: +

<NetBeans Installation>/modules/office.jar +

+ +Top + +

+Last Modified: Tue Mar 12 11:40:28 GMT 2003 + + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/user-guide.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/user-guide.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/user-guide.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,49 @@ + + + + + + + + + + + + +

+ +

+ + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/whats-next.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/whats-next.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.2/whats-next.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,49 @@ + + + + + + + + + + + + +

+ +

+ + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/SFrameworkInstall.jar ============================================================================== Binary file - no diff available. Propchange: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/SFrameworkInstall.jar ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/SmokeTest.html ============================================================================== --- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/SmokeTest.html (added) +++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/SmokeTest.html Fri Nov 25 20:05:15 2011 @@ -0,0 +1,96 @@ + + + + + + + + + + + + + + + + + + + Smoke Test + + + + + + + + + + + + +

+ +

+ + + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/assign-event.gif ============================================================================== Binary file - no diff available. Propchange: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/assign-event.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/assign-menu.gif ============================================================================== Binary file - no diff available. Propchange: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/assign-menu.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/beanshell.gif ============================================================================== Binary file - no diff available. Propchange: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/beanshell.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream

Developing Scripts on the Command Line

Contents

Prerequisites

The CommandLineTools class

Examples

Writing Scripts in BeanShell and Java

Contents

Hello World in BeanShell

Trying out your BeanShell script

Hello World in Java

Writing Office scripts and the XScriptContext type

Tips on writing Office scripts

Parcel Descriptor DTD and sample XML

New Features in this Release

Features of the Office Scripting Framework

Scripting Framework

Script Development and IDE support

Executing Scripts

Security

Installation Guide for the Office Scripting Framework

Contents

Who Should Read This Document

Pre-requisites

Downloading the Scripting Framework

Installing the Scripting Framework

Writing Office Scripts in JavaScript

Contents

Installation

Hello World in JavaScript

Invoking a JavaScript script in OpenOffice.org

Developing Scripts in NetBeans

Contents:

Pre-requisites

Creating a Parcel Recipe

Actions available for Parcel Recipe

Actions available for Script Parcels

Actions available for Office Documents

Debugging Java Office scripts in NetBeans

Troubleshooting

Guide for Uninstalling the Office Scripting Framework

Uninstalling the Scripting Framework