incubator-ooo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ksch...@apache.org
Subject svn commit: r1206297 [16/19] - in /incubator/ooo/ooo-site/trunk/content/framework: documentation/ documentation/devmanual/ documentation/filters/ documentation/filterui/ documentation/mimetypes/ documentation/others/ drafts/ proposals/ proposals/apply/...
Date Fri, 25 Nov 2011 20:02:33 GMT
Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/commandline-devguide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/commandline-devguide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/commandline-devguide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/commandline-devguide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,178 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <title>Developing Scripts on the Command Line</title>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+</head>
+<body>
+<a name="top"></a>
+<h1>Developing Scripts on the Command Line</h1>
+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.
+<h2>Contents</h2>
+<ul>
+  <li>
+    <p><a href="#prereqs">Prerequisites</a> </p>
+  </li>
+  <li>
+    <p><a href="#usage">The CommandLineTools class</a> </p>
+  </li>
+  <li>
+    <p><a href="#examples">Examples</a> </p>
+  </li>
+</ul>
+<a name="prereqs"> </a>
+<h2><a name="prereqs">Prerequisites</a></h2>
+<ul>
+  <li><a name="prereqs">The Scripting module office.jar file should be
+included in the classpath. You can unpack this file from the Scripting
+Framework installer </a><a href="SFrameworkInstall.jar">SFrameworkInstall.jar</a>
+by running the following command:
+    <p> <font face="Courier, monospace" size="2"> jar xf
+SFrameworkInstall.jar ide/office.jar </font> </p>
+  </li>
+  <li>The CommandLineTools class will only work if an XML parser (such
+as <a href="http://xml.apache.org/xerces2-j/index.html">Apache Xerces</a>)
+is available in the classpath. </li>
+</ul>
+<a name="usage"> </a>
+<h2><a name="usage">The CommandLineTools class</a></h2>
+<a name="usage">The CommandLineTools class takes the following options (<b>Note:</b>
+Options in angle brackets "&lt;&gt;" are required, options in square
+brackets "[]" are optional): </a>
+<blockquote> <a name="usage"><b>-g [Path to Parcel directory] [options]</b> </a>
+  <p> <a name="usage">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. </a></p>
+  <ul>
+    <li><a name="usage">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 </a><a href="developer-guide.html">developer guide</a>
+for more information on the parcel-descriptor.xml file). The following
+options are available:
+      <p> <b>[-l language[=supported extension list]]</b> </p>
+      <p> 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. </p>
+      <p> 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: </p>
+      <p>
+      <table border="1">
+        <tbody>
+          <tr>
+            <th>-l flag used? </th>
+            <th>parcel-descriptor.xml exists? </th>
+            <th>result </th>
+          </tr>
+          <tr>
+            <td align="center">no </td>
+            <td align="center">no </td>
+            <td>error message printed </td>
+          </tr>
+          <tr>
+            <td align="center">yes </td>
+            <td align="center">no </td>
+            <td>parcel-descriptor.xml generated<br>
+parcel.sxp generated </td>
+          </tr>
+          <tr>
+            <td align="center">no </td>
+            <td align="center">yes </td>
+            <td>parcel-descriptor.xml not generated<br>
+parcel.sxp generated </td>
+          </tr>
+          <tr>
+            <td align="center">yes </td>
+            <td align="center">yes </td>
+            <td>if <br>
+language is different from parcel-descriptor.xml language, error <br>
+else <br>
+parcel-descriptor.xml regenerated <br>
+parcel.sxp generated </td>
+          </tr>
+        </tbody>
+      </table>
+      </p>
+      <p> <b>[-p name=value]</b> </p>
+      <p> Specifies a name value pair to be added as a language
+dependent property in the parcel-descriptor.xml file </p>
+      <p> <b>[-v]</b> </p>
+      <p> Specifies that verbose output should be displayed. </p>
+    </li>
+  </ul>
+  <p> <b>-d &lt;Path to Script Parcel&gt; &lt;Target
+Directory|Document&gt;</b> </p>
+  <p> 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. </p>
+  <ul>
+    <li>If deploying to an OpenOffice.org installation the target
+directory should be the &lt;Office Installation&gt;/user/Scripts or
+&lt;Office Installation&gt;/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. </li>
+  </ul>
+</blockquote>
+<p><a href="#top">Top</a> <a name="examples"> </a></p>
+<h2><a name="examples">Examples</a></h2>
+<ul>
+  <li>
+    <p><a name="examples"><font face="Courier, monospace" size="2"> java
+CommandLineTools -g myparceldir -l Java </font> </a></p>
+    <p><a name="examples">Generates a myparceldir.sxp file in
+myparceldir automatically exporting all public Java methods which take
+XScriptContext as their first parameter as Office scripts. </a></p>
+  </li>
+  <li><a name="examples"><font face="Courier, monospace" size="2"> java
+CommandLineTools -g -l BeanShell=.bsh </font> </a>
+    <p><a name="examples">Generates a script parcel file in the current
+directory automatically exporting all files that end with the .bsh
+extension as BeanShell scripts </a></p>
+  </li>
+  <li><a name="examples"><font face="Courier, monospace" size="2"> java
+CommandLineTools -g myparceldir -l BeanShell MyScript.bsh </font> </a>
+    <p><a name="examples">Generates a myparceldir.sxp file in
+myparceldir and exports MyScript.bsh as an Office script. </a></p>
+  </li>
+  <li><a name="examples"><font face="Courier, monospace" size="2"> java
+CommandLineTools -g myparceldir -l Java -p classpath=dep1.jar:dep2.jar </font> </a>
+    <p><a name="examples">Generates a myparceldir.sxp file in
+myparceldir, automatically searching for valid Office scripts, and
+adding the classpath property to each Office script. </a></p>
+  </li>
+  <li><a name="examples"><font face="Courier, monospace" size="2"> java
+CommandLineTools -g myparceldir -l Java -p classpath=dep1.jar:dep2.jar
+-p secondprop=secondvalue </font> </a>
+    <p><a name="examples">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. </a></p>
+  </li>
+  <li><a name="examples"><font face="Courier, monospace" size="2"> java
+CommandLineTools -d myparceldir.sxp /export/home/MyOffice/user/Scripts </font> </a>
+    <p><a name="examples">Deploys the myparceldir.sxp Script Parcel to
+the specified office directory.</a></p>
+  </li>
+  <li><a name="examples"> <font face="Courier, monospace" size="2">java
+CommandLineTools -g myparceldir -l JavaScript MyScript.js</font></a><br>
+    <a name="examples">Generates a myparceldir.sxp file in myparceldir
+and exports MyScript.js as an Office script.</a></li>
+</ul>
+<p><a href="#top">Top</a> </p>
+<hr> Last Modified: Tue Mar 12 11:40:28 GMT 2003
+</body>
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/commandline-devguide.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-guide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-guide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-guide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-guide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,202 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <title>Writing Scripts in BeanShell and Java</title>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+</head>
+<body>
+<h1>Writing Scripts in BeanShell and Java</h1>
+<a name="top"></a>
+<h2>Contents</h2>
+<ul>
+  <li>
+    <p><a href="#bsh">Hello World in BeanShell</a> </p>
+  </li>
+  <li>
+    <p><a href="#bshinvoke">Trying out your BeanShell script</a> </p>
+  </li>
+  <li>
+    <p><a href="#js">Hello World in JavaScript</a> </p>
+  </li>
+  <li>
+    <p><a href="#jsinvoke">Trying out a JavaScript script</a> </p>
+  </li>
+  <li>
+    <p><a href="#java">Hello World in Java</a> </p>
+  </li>
+  <li>
+    <p><a href="#context">Writing Office Scripts and the XScriptContext
+type</a> </p>
+  </li>
+  <li>
+    <p><a href="#tips">Tips on writing Office scripts</a> </p>
+  </li>
+  <li>
+    <p><a href="#dtd">Parcel Descriptor DTD and sample XML</a> </p>
+  </li>
+</ul>
+<a name="bsh"></a>
+<h2>Hello World in BeanShell</h2>
+Here's a BeanShell script that inserts Hello World at the start of an
+OpenOffice.org Writer document:
+<p> </p>
+<pre>    import com.sun.star.frame.XModel;<br>    import com.sun.star.text.*;<br>    import com.sun.star.uno.UnoRuntime;<br>    import drafts.com.sun.star.script.framework.XScriptContext;<br><br>    model = context.getDocument(); <br>    textdoc = (XTextDocument)<br>        UnoRuntime.queryInterface(XTextDocument.class, model);<br><br>    oText = textdoc.getText(); <br>    oCursor = oText.createTextCursor(); <br>    oText.insertString(oCursor, "Hello World", false)<br></pre>
+<a href="#top">Top</a> <a name="bshinvoke"></a>
+<h2>Trying out your BeanShell script</h2>
+Trying out your Hello World BeanShell script is easy:
+<ul>
+  <li>Create a file called hello.bsh and put the above code in the
+file. </li>
+  <li>Start OpenOffice.org and open a new Writer document. </li>
+  <li>Select the Tools/Scripting Add-ons/Edit/Debug Scripts... menu
+item. </li>
+  <li>In the Edit/Debug Scripts dialog that appears select BeanShell as
+your language and FileSystem as your location. Click on the Browse...
+button. </li>
+  <li>In the file selection dialog that pops up, navigate to your
+hello.bsh file and select it. Now click OK. </li>
+  <li>A BeanShell Debugger window will appear with the contents of your
+hello.bsh script loaded. Click on the Run button.<br>
+    <div style="text-align: center;"><img src="beanshell.gif" title=""
+ alt="" style="width: 477px; height: 319px;"><br>
+    </div>
+  </li>
+  <li>You should see Hello World appear at the start of the Writer
+document. </li>
+</ul>
+<p> You can modify the code directly in the evaluation window and click
+eval again to test it. When you are finished making your changes, click
+Save to save them back to the hello.bsh file. If you are new to the
+OpenOffice.org API this is a great way to experiment with it. </p>
+<p> 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 <a
+ href="netbeans-devguide.html">using NetBeans</a> or <a
+ href="commandline-devguide.html">from the command line</a>. </p>
+<p> <a href="#top">Top</a> <a name="js">
+<h2>Hello World in JavaScript</h2>
+</a> Here's a JavaScript script that inserts Hello World at the start of
+an OpenOffice.org Writer document: </p>
+<pre>importClass(Packages.com.sun.star.uno.UnoRuntime);<br>importClass(Packages.com.sun.star.text.XTextDocument);<br><br>var oModel = XSCRIPTCONTEXT.getDocument(); <br>var oTextdoc = UnoRuntime.queryInterface(XTextDocument, oModel);<br>var oText = oTextdoc.getText(); <br>var oCursor = oText.createTextCursor(); <br><br>oText.insertString(oCursor, "Hello World", false);<br></pre>
+<p> The XSCRIPTCONTEXT variable above is a global instance of the
+XScriptContext type which is available to all JavaScript scripts
+executed by the Scripting Framework. See <a href="#context">Writing
+Office Scripts and the XScriptContext type</a> for the methods available
+for the XScriptContext type. </p>
+<p> <a href="#top">Top</a> </p>
+<h2> <a name="jsinvoke"> Trying out a JavaScript script in
+OpenOffice.org </a></h2>
+Once again you can use the Edit/Debug Scripts dialog to open a
+JavaScript script in an editor. The Rhino JavaScript Editor from the <a
+ href="http://mozilla.org/rhino">Mozilla Rhino project</a> can be used
+to debug and test your JavaScript scripts.
+<ul>
+  <li>Create a file called hello.js and put the JavaScript code in the
+file. </li>
+  <li>Select the Tools/Scripting Add-ons/Edit/Debug Scripts... menu
+item. </li>
+  <li>In the Edit/Debug Scripts dialog select JavaScript as your
+language and FileSystem as your location. Click on the Browse...
+button. </li>
+  <li>In the file selection dialog that pops up, navigate to your
+hello.js file and select it. Click OK. </li>
+  <li>A Rhino Debugger window will appear with the contents of your
+hello.js script loaded. To run the script select File/Run and then
+click on the Go button.<br>
+    <div style="text-align: center;"><img src="rhino.gif" title=""
+ alt="" style="width: 640px; height: 646px;"><br>
+    </div>
+  </li>
+  <li>You can change the script and save your changes using the
+File/Save menu item. </li>
+</ul>
+<p> The Rhino Debugger also includes debugging functionality, so you can
+set breakpoints in your JavaScript script and step through the code as
+it is executed. </p>
+<p> <a href="#top">Top</a> <a name="java"></a> </p>
+<h2>Hello World in Java</h2>
+Here's the Hello World script in Java:
+<p> <font face="Courier, monospace" size="2">
+<pre>    import com.sun.star.frame.XModel;<br>    import com.sun.star.text.*;<br>    import com.sun.star.uno.UnoRuntime;<br>    import drafts.com.sun.star.script.framework.XScriptContext;<br><br>    public class MyClass {<br><br>        // The script method must be public<br>        // It can either be static or non-static<br><br>        public void showForm(XScriptContext xSc) {<br><br>            // getting the text document object<br>            XModel xmodel = xSc.getDocument();<br><br>            XTextDocument xtextdoc = (XTextDocument)<br>                UnoRuntime.queryInterface(XTextDocument.class, xmodel);<br>            XText xtext = xtextdoc.getText();<br>            XTextCursor xtextcursor = xtext.createTextCursor();<br><br>            xtext.insertString(xtextcursor, "Hello World", false);<br>        }<br>    }<br></pre>
+</font> </p>
+<p> Office scripts in Java need to be compiled in order to execute them.
+See the <a href="netbeans-devguide.html">Developing Scripts in NetBeans</a>
+and <a href="commandline-devguide.html">Developing Scripts on the
+command line</a> guides for instructions on how to compile and deploy
+Office scripts in Java. </p>
+<p> <a href="#top">Top</a> <a name="context"></a> </p>
+<h2>Writing Office scripts and the XScriptContext type</h2>
+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.
+<p> The following accessor methods are available on the XScriptContext
+type: </p>
+<ul>
+  <li>Current document - access the document context against which the
+script was invoked
+    <p> <font face="Courier, monospace" size="2"> &lt;XScriptContext
+Instance&gt;.getDocument()</font> <br>
+returns <font face="Courier, monospace" size="2">::com::sun::star::frame::XModel</font> </p>
+  </li>
+  <li>Office Desktop - access the desktop of the running Office
+    <p> <font face="Courier, monospace" size="2"> &lt;XScriptContext
+Instance&gt;.getDesktop()</font> <br>
+returns <font face="Courier, monospace" size="2">
+::com::sun::star::frame::XDesktop</font> </p>
+  </li>
+  <li>Component Factory - access a ComponentContext factory to create
+other UNO components as required
+    <p> <font face="Courier, monospace" size="2"> &lt;XScriptContext
+Instance&gt;.getComponentContext()</font> <br>
+returns <font face="Courier, monospace" size="2">
+::com::sun::star::uno::XComponentContext</font> </p>
+  </li>
+</ul>
+The Java or BeanShell script must import the XScriptContext interface,
+using the following import directive: <font face="Courier, monospace"
+ size="2">
+<pre>    import drafts.com.sun.star.script.framework.XScriptContext;<br></pre>
+</font>
+<p> <a href="#top">Top</a> <a name="tips"></a> </p>
+<h2>Tips on writing Office scripts</h2>
+<ul>
+  <li>
+    <p><b>Performance:</b> 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. </p>
+  </li>
+  <li>
+    <p><b>Threading:</b> 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. </p>
+  </li>
+</ul>
+<a href="#top">Top</a> <a name="dtd"></a>
+<h2>Parcel Descriptor DTD and sample XML</h2>
+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
+<pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt;<br>&lt;!-- DTD for Parcel Meta data for use in the OpenOffice.org Scripting Framework Project --&gt;<br>&lt;!ELEMENT logicalname EMPTY&gt;<br>&lt;!ELEMENT description (#PCDATA)&gt;<br>&lt;!ELEMENT displayname EMPTY&gt;<br>&lt;!ELEMENT locale (displayname?, description?)&gt;<br>&lt;!ELEMENT functionname EMPTY&gt;<br>&lt;!ELEMENT prop EMPTY&gt;<br>&lt;!ELEMENT languagedepprops (prop+)&gt;<br>&lt;!ELEMENT file (prop*)&gt;<br>&lt;!ELEMENT fileset (file+)&gt;<br>&lt;!ELEMENT script (locale+, functionname, logicalname, languagedepprops*, fileset*)&gt;<br>&lt;!ELEMENT parcel (script+)&gt;<br>&lt;!ATTLIST logicalname<br>	value CDATA #REQUIRED<br>&gt;<br>&lt;!ATTLIST displayname<br>	value CDATA #REQUIRED<br>&gt;<br>&lt;!ATTLIST locale<br>	lang CDATA #REQUIRED<br>&gt;<br>&lt;!ATTLIST functionname<br>	value CDATA #REQUIRED<br>&gt;<br>&lt;!ATTLIST logicalname<br>	value CDATA #REQUIRED<br>&gt;<br>&lt;!ATTLIST prop<br>	name CDATA #REQUIRED
 <br>	value CDATA #REQUIRED<br>&gt;<br>&lt;!ATTLIST file<br>	name CDATA #REQUIRED<br>&gt;<br>&lt;!ATTLIST fileset<br>	name CDATA #IMPLIED<br>&gt;<br>&lt;!ATTLIST script<br>	language CDATA #REQUIRED<br>&gt;<br>&lt;!ATTLIST parcel<br>	language CDATA #REQUIRED<br>&gt;<br></pre>
+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.
+<pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt;<br>&lt;!--Sample Meta Data for use with the Scripting Framework Project in OpenOffice.org --&gt;<br>&lt;!DOCTYPE parcel SYSTEM "parcel.dtd"&gt;<br>&lt;parcel language="Java"&gt;<br>	&lt;script language="Java"&gt;<br>		&lt;locale lang="english"&gt;<br>			&lt;displayname value="Memory.usage"/&gt;<br>			&lt;description&gt;<br>				Displays the memory current memory usage<br>			&lt;/description&gt;<br>		&lt;/locale&gt;<br>		&lt;functionname value="memoryUtils.memoryUsage"/&gt;<br>		&lt;logicalname value="MemoryUtils.MemUsage"/&gt;<br>		&lt;languagedepprops&gt;<br>			&lt;prop name="classpath" value="/opt/foo.jar:/usr/java/src.jar"/&gt;<br>		&lt;/languagedepprops&gt;<br>		&lt;fileset&gt;<br>			&lt;file name="mems.txt"&gt;<br>				&lt;prop name="type" value="resource"/&gt;<br>			&lt;/file&gt;<br>		&lt;/fileset&gt;<br>	&lt;/script&gt;<br>&lt;/parcel&gt;<br></pre>
+<a href="#top">Top</a>
+<hr> Last Modified: 
+Fri Jun 20 15:28:34 BST 2003
+</body>
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-guide.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-release-features.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-release-features.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-release-features.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-release-features.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,123 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <title>Features for Early Developer Release</title>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+</head>
+<body>
+<h2>New Features in Release 0.3</h2>
+<ul>
+  <li>
+    <p><span style="font-weight: bold;">JavaScript/Rhino runtime<br>
+    <br>
+    </span>This release includes a JavaScript Script runtime based on <a
+ href="http://www.mozilla.org/rhino/">Rhino</a> (used under the <a
+ href="http://www.mozilla.org/MPL/MPL-1.1.html">Mozilla Public License</a>)</p>
+  </li>
+  <li style="font-weight: bold;">Enhanced Debugging support for
+BeanShell &amp; JavaScript scripts<br>
+    <br>
+    <span style="font-weight: normal;">The Tools-&gt;Scripting Add-ons
+menu now contains a new item <a href="user-guide.html#editdebug">"Edit/Debug
+Scripts"</a>, that allows the user to edit and debug BeanShell &amp;
+JavaScript scripts.&nbsp; This required a modification to the Rhino
+class org.mozilla.javascript.tools.debugger.Main. These modifications
+are included in the Jar file, and are also available via the <a
+ href="http://framework.openoffice.org/source/browse/framework/scripting/examples/java/debugger/rhino/Main.java">source
+browser</a>.<br>
+    </span></li>
+</ul>
+<ul>
+  <li><span style="font-weight: bold;">Support for filesystem scripts<br>
+    <br>
+    </span>Users can bind to and run BeanShell &amp; Javacript scripts
+located at any point on their <a href="user-guide.html#filesys">filesystem</a>.
+These scripts do not need to have an associated parcel-descriptor.xml.<br>
+  </li>
+</ul>
+<h2>New Features in Release 0.2<br>
+</h2>
+<ul>
+  <li>
+    <p><b>Additional language support</b> </p>
+    <p> Added support for <a href="http://www.beanshell.org/home.html">BeanShell</a>,
+a loosely typed Java based scripting language supported by NetBeans.
+The Interactive BeanShell Scripting Window available from
+Tools-&gt;Scripting Add-ons allows you to experiment with Office
+scripting without needing to recompile your scripts. </p>
+    <p> This is an example of the implementation of an additional
+script
+runtime, in this case based on Java runtime (see <a
+ href="runtime-howto.html">How to write a runtime</a> for more
+information on writing runtimes). </p>
+  </li>
+  <li>
+    <p><b>Security Enhancements</b> </p>
+    <p> Script execution by the scripting framework now honors the <a
+ href="user-guide.html#Leveraging_StarBasic_Security">security</a>
+settings in Tools -&gt; Options -&gt; Security Settings. (ie. your
+existing settings for StarBasic macros). </p>
+  </li>
+  <li>
+    <p><b>Support for storage of bindings in documents</b> </p>
+    <p> With this release script bindings can now also be stored in
+documents as well as in your OpenOffice.org user directory (see the <a
+ href="release-notes.html">release notes</a> for instructions). </p>
+  </li>
+  <li>
+    <p><b>Support for Event Bindings</b> </p>
+    <p> <a href="user-guide.html#bindscripts">Assign dialogs</a> have
+been enhanced to allow bindings to events as well as to menu items and
+keys. </p>
+  </li>
+</ul>
+<p><b>Notes:</b> </p>
+<ul>
+  <li>New binding assignments can be made without requiring a restart
+of OpenOffice.org </li>
+  <li>Scripts bindings are now fully resolved at binding </li>
+  <li>Command line utilities have been added for packaging and
+deployment (see <a href="commandline-devguide.html"> Developing
+Scripts
+without an IDE</a>) </li>
+  <li>Support for jEdit IDE has been discontinued </li>
+</ul>
+<h2>Features of the Office Scripting Framework</h2>
+<h2>Scripting Framework</h2>
+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.
+<h2>Script Development and IDE support</h2>
+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.
+<p> Debugging of scripts is possible in NetBeans for Java scripts. For
+more information on setting up OpenOffice.org to enable debugging see <a
+ href="http://api.openoffice.org/common/man/IDEintegration/OfficeNetBeansIntegration.html#Debugging">
+Debugging Java components in NetBeans/Forte for Java</a> </p>
+<p> <b>Note:</b> 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. </p>
+<h2>Executing Scripts</h2>
+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.
+<h2>Security</h2>
+The security settings of the Scripting Framework honor the existing
+StarBasic security settings available in Tools -&gt; Options -&gt;
+Security Settings. <br>
+<hr> Last Modified: Fri Jun 20 15:27:16 BST 2003
+</body>
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/developer-release-features.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/edit-debug.gif
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/edit-debug.gif?rev=1206297&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/edit-debug.gif
------------------------------------------------------------------------------
    svn:mime-type = image/gif

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/faq.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/faq.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/faq.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/faq.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,91 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<HTML>
+<HEAD>
+	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
+	<TITLE>FAQ</TITLE>
+	<META NAME="GENERATOR" CONTENT="StarOffice 6.0  (Win32)">
+	<META NAME="CREATED" CONTENT="20021203;15313500">
+	<META NAME="CHANGED" CONTENT="20030318;19405289">
+</HEAD>
+<BODY LANG="en-US">
+<H1><A NAME="top"></A>Frequently Asked Questions for the Office
+Scripting Framework</H1>
+<H2>Questions</H2>
+<OL>
+	<P STYLE="margin-bottom: 0cm"></P>
+	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#3">I have removed the
+	examples provided with the Script Framework installation and
+	installed my own but the script in ExampleSpreadSheet.sxc still
+	works. Why?</A> 
+	</P>
+	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#4">How can I store menu
+	or key bindings for scripting in a document?</A> 
+	</P>
+	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#5">Why is there a delay
+	in starting the first script?</A> 
+	</P>
+	<LI><P><A HREF="#6">Why do I have to use one dialog to work with
+	StarBasic macros [Tools/ Configure] and another to work with my new
+	Java scripts [Assign Script...]?</A> 
+	</P>
+</OL>
+<H2>Answers</H2>
+<OL>
+	<LI><P><A NAME="3"></A>I have removed the examples provided with the
+	Script Framework installation and installed my own but the script in
+	ExampleSpreadSheet.sxc still works. Why? 
+	</P>
+	<P>Both the script and the Key bindings are contained in the
+	document itself, at the moment the [Assign Script] dialog does not
+	display scripts or bindings stored in documents. 
+	</P>
+	<P STYLE="margin-bottom: 0cm"><A HREF="#top">Top</A> 
+	</P>
+	<LI><P><A NAME="4"></A>How can I store a script, menu or key
+	bindings for scripting in a document? 
+	</P>
+</OL>
+<UL>
+	<LI><P STYLE="margin-bottom: 0cm"><FONT COLOR="#000000">In order to
+	save a script event binding to a menu item or key into a document
+	there are two steps which must be followed. Firstly, set up the
+	binding in the usual way using the &quot;Assign Script To ...&quot;
+	dialog. Then open the Tools-&gt;Configure dialog, and select the
+	&quot;Menu&quot; tab. Click the &quot;Save&quot; button, select the
+	document into which you wish to save the binding, and click &quot;Save&quot;.&nbsp;
+	You will be prompted with a dialog that says &quot;The file already
+	exists. Overwrite?&quot;. It is OK to click &quot;Yes&quot; as this
+	will simply write the bindings into the file. Saving a binding to an
+	event into a document can be done by clicking the &quot;Document&quot;
+	radio button in the &quot;Assign Script to Event&quot; dialog.</FONT></P>
+</UL>
+<OL START=0>
+	<P STYLE="margin-bottom: 0cm"><A HREF="#top">Top</A> 
+	</P>
+	<LI><P><A NAME="5"></A>Why is there a delay in starting the first
+	script? 
+	</P>
+	<P>The delay is caused by the startup of the inprocess JVM by
+	OpenOffice. 
+	</P>
+	<P STYLE="margin-bottom: 0cm"><A HREF="#top">Top</A> 
+	</P>
+	<LI><P><A NAME="6"></A>Why do I have to use one dialog to work with
+	StarBasic macros [Tools/ Configure] and another to work with my new
+	Java scripts [Assign Script...]? 
+	</P>
+	<P>The StarBasic macros are completely separate from and do not use
+	the Scripting Framework. As such they use their own configuration
+	and settings dialogs. In the future the Scripting Framework and
+	StarBasic dialogs will be integrated so users have one consistnet
+	way of working with macros/ scripts, regardless of which language
+	they have been written it. 
+	</P>
+	<P><A HREF="#top">Top</A> 
+	</P>
+</OL>
+<HR>
+<P>Last Modified: Tue Mar 12 11:40:28 GMT 2003 
+</P>
+</BODY>
+</HTML>

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/faq.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/index.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/index.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/index.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/index.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,238 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+</head>
+<body>
+<h1>Language Independent Office Scripting Framework</h1>
+<p><b>Project Owners:</b> <a href="mailto:john.rice@sun.com">John Rice</a>,<a
+ href="mailto:noel.power@sun.com">Noel Power</a> </p>
+<p>There are currently two ways for users and developers to add
+functionality to OpenOffice.org, namely macros and UNO components. </p>
+<p>Macros are a set of instructions which OpenOffice.org can interpret
+at runtime to carry out a specific set of tasks in OpenOffice.org.
+Users
+can create a macro by recording a number of tasks in OpenOffice.org,
+save this set of tasks as a macro and then bind this macro to a menu or
+keypress. The macro is run by hitting the bound menu or key. Advanced
+users can write their own StarBasic macros in an embedded StarBasic IDE
+if they wish. </p>
+<p>UNO components are compiled C++ or Java components, which a
+developer can write using the UNO API to access and manipulate
+OpenOffice.org. The component is written in an external IDE in C++ or
+Java (or any language with a supported UNO bridge). The end user needs
+to install any new component in their OpenOffice.org to make use of
+this
+new functionality. UNO component development is supported by the ODK. </p>
+<p>The Scripting Framework aims to strike a balance between these two
+approaches of customizing OpenOffice.org. The framework will allow
+scripts to be written in a variety of languages, deployed into
+OpenOffice.org installations or documents, loaded at runtime and
+executed in OpenOffice.org. The framework will allow any number of
+different scripting languages to be plugged into OpenOffice.org for
+which there is an UNO bridge. Our focus will be to support languages
+with a Java implementation, but the framework can be made to work with
+any scripting langauge with a supported UNO bridge such as the UNO
+Python bridge. In this way users and developers will be able to write
+scripts in any supported scripting language to manipulate
+OpenOffice.org. </p>
+<table style="width: 100%; background-color: rgb(240, 240, 240);"
+ border="0" cellpadding="2" cellspacing="0">
+  <col width="270"> <col width="6"> <col width="220"> <col
+ width="171"> <col width="117"> <col width="36"> <tbody>
+    <tr>
+      <td colspan="6"
+ style="background-color: rgb(0, 49, 90); width: 100%;">
+      <p align="center"><font color="#ffffff"><b>Documentation for the
+Early Developer Release (Version 0.3)</b> </font> </p>
+      </td>
+    </tr>
+    <tr>
+      <th
+ style="background-color: rgb(153, 204, 255); width: 30%; text-align: left;">
+      <p align="left"><font color="#00315a"><b>Name</b> </font> </p>
+      </th>
+      <th colspan="5"
+ style="background-color: rgb(153, 204, 255); width: 70%; text-align: left;">
+      <p align="left"><font color="#00315a"><b>Description</b> </font>
+      </p>
+      </th>
+    </tr>
+    <tr valign="top">
+      <td style="width: 30%;">
+      <p><a href="./developer-release-features.html">Features</a></p>
+      </td>
+      <td colspan="5" style="width: 70%;">
+      <p>Features of the Early Developer Release</p>
+      </td>
+    </tr>
+    <tr valign="top">
+      <td style="width: 30%;">
+      <p><a href="./SFrameworkInstall.jar">Download</a></p>
+      </td>
+      <td colspan="5" style="width: 70%;">
+      <p>Download the Office Scripting Framework (2 MB). Refer to the
+install section for installation guidelines. <span
+ style="color: rgb(255, 0, 0);">Updated to work with
+OpenOffice.org1.1rc1 and later</span><br>
+      </p>
+      </td>
+    </tr>
+    <tr valign="top">
+      <td style="width: 30%;">
+      <p><a href="./install-guide.html">Install</a></p>
+      </td>
+      <td colspan="5" style="width: 70%;">
+      <p>Installation Guide for the Office Scripting Framework</p>
+      </td>
+    </tr>
+    <tr valign="top">
+      <td style="width: 30%;">
+      <p><a href="./uninstall-guide.html">Uninstall</a></p>
+      </td>
+      <td colspan="5" style="width: 70%;">
+      <p>Guide for Uninstalling the Office Scripting Framework</p>
+      </td>
+    </tr>
+    <tr valign="top">
+      <td rowspan="2" style="width: 30%;">
+      <p>Script User Guides</p>
+      </td>
+      <td colspan="4" style="width: 70%;">
+      <p><a href="./user-guide.html">General User Guide</a></p>
+      </td>
+    </tr>
+    <tr>
+      <td colspan="4" width="395" valign="top">
+      <p><a href="../utilities-download.html">Utility Scripts
+contributed
+by the OpenOffice.org community</a></p>
+      </td>
+    </tr>
+    <tr valign="top">
+      <td rowspan="3" width="270">
+      <p>Script Developer Guides</p>
+      </td>
+      <td width="220" colspan="4">
+      <p><a href="./developer-guide.html">Writing Scripts in
+BeanShell, JavaScript and Java</a> </p>
+      </td>
+    </tr>
+    <tr>
+      <td width="220" colspan="4" valign="top">
+      <p><a href="./netbeans-devguide.html">Developing
+Scripts in NetBeans</a> </p>
+      </td>
+    </tr>
+    <tr>
+      <td width="220" colspan="4" valign="top">
+      <p><a href="./commandline-devguide.html">Developing
+Scripts on the command line</a> </p>
+      </td>
+    </tr>
+    <tr>
+      <td style="vertical-align: top;"><a href="./faq.html">FAQ</a></td>
+      <td style="vertical-align: top;" colspan="5">Frequently Asked
+Questions for the Office Scripting Framework</td>
+    </tr>
+    <tr valign="top">
+      <td style="width: 30%;">
+      <p><a href="./release-notes.html">Release Notes</a></p>
+      </td>
+      <td colspan="5" style="width: 70%;">
+      <p>Release Notes</p>
+      </td>
+    </tr>
+    <tr valign="top">
+      <td width="270">
+      <p><a href="./SmokeTest.html">Test</a></p>
+      </td>
+      <td colspan="5" width="566">
+      <p>Guidelines for testing the Framework &#8211; Description of basic
+sanity tests (smoke tests) for the framework.</p>
+      </td>
+    </tr>
+    <tr valign="top">
+      <td style="width: 30%;">
+      <p><a href="./whats-next.html">What's Next</a></p>
+      </td>
+      <td colspan="5" style="width: 70%;">
+      <p>Upcoming features in future releases of the Office Scripting
+Framework</p>
+      </td>
+    </tr>
+  </tbody>
+</table>
+<p>
+<table style="width: 100%; background-color: rgb(240, 240, 240);"
+ border="0" cellpadding="2" cellspacing="0">
+  <col width="270"> <col width="6"> <col width="220"> <col
+ width="171"> <col width="117"> <col width="36"> <tbody>
+    <tr>
+      <td colspan="5"
+ style="width: 100%; background-color: rgb(0, 49, 90);">
+      <p align="center"><font color="#ffffff"><b> Previous Releases</b>
+      </font> </p>
+      </td>
+    </tr>
+    <tr>
+      <th style="background-color: rgb(153, 204, 255); width: 70%;">
+      <p align="left"><font color="#00315a"><b>Version</b> </font> </p>
+      </th>
+      <th colspan="5"
+ style="background-color: rgb(153, 204, 255); width: 30%; text-align: left;">
+      <p align="left"><font color="#00315a"><b>Released</b> </font> </p>
+      </th>
+    </tr>
+    <tr valign="top">
+      <td style="width: 70%;">
+      <p><a href="../release-0.2/index.html">Early Developer Release
+Version 0.2</a></p>
+      </td>
+      <td colspan="5" style="width: 30%;">
+      <p>April 2003</p>
+      </td>
+    </tr>
+    <tr valign="top">
+      <td style="width: 70%;">
+      <p><a href="../release-0.1/index.html">Early Developer Release
+Version 0.1</a></p>
+      </td>
+      <td colspan="5" style="width: 30%;">
+      <p>November 2002</p>
+      </td>
+    </tr>
+  </tbody>
+</table>
+</p>
+<hr>
+<table cellpadding="4" cellspacing="0" style="width: 100%;">
+  <tbody>
+    <tr valign="top">
+      <td style="width: 30%;">
+      <p><a href="mailto:dev@framework.openoffice.org">Mailing List</a></p>
+      </td>
+      <td style="width: 70%;">
+      <p>Installation, User or Developer queries on the Office
+Scripting Framework</p>
+      </td>
+    </tr>
+    <tr valign="top">
+      <td style="width: 30%;">
+      <p>Issues</p>
+      </td>
+      <td style="width: 70%;">
+      <p>Issues found in the Office Scripting Framework should be
+logged in Issuezilla<br>
+      <b>component:</b> framework<br>
+      <b>subcomponent:</b> scripting</p>
+      </td>
+    </tr>
+  </tbody>
+</table>
+<p> Last Modified: 
+Mon Sep 15 16:59:44 BST 2003
+</p>
+</body>
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/index.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/install-guide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/install-guide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/install-guide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/install-guide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,207 @@
+<!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
+&amp; 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>&nbsp; - A UNO package containing the
+core Scripting Framework libraries &amp; 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&amp;dlID=84">
+&sect;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">&lt;Office Installation&gt;/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 &lt;Office
+Installation&gt;/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 &lt;Office Installation&gt; -netbeans
+&lt;NetBeans Installation&gt;</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 &lt;Shared Office Installation&gt; -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 &lt;User </font><font
+ face="Courier, monospace" size="2">Office Installation&gt; -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>

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/install-guide.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/netbeans-devguide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/netbeans-devguide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/netbeans-devguide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/netbeans-devguide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,244 @@
+<html>
+<head>
+<title>Developing Scripts in NetBeans</title>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+</head>
+
+<body>
+<a name="top"></a>     
+
+<h1>Developing Scripts in NetBeans</h1>
+         
+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 <a href="http://www.netbeans.org/ide/download.html">
+NetBeans download page</a>.
+
+<h2>Contents:</h2>
+
+<ul>
+<li><p><a href="#prerequisites">Pre-requisites</a>
+<li><p><a href="#recipe-create">Creating a Parcel Recipe</a>
+<li><p><a href="#recipe-actions">Actions available for Parcel Recipes</a>
+<li><p><a href="#parcel-actions">Actions available for Script Parcels</a>
+<li><p><a href="#document-actions">Actions available for Office Documents</a>
+<li><p><a href="#debugging">Debugging Java Office scripts in NetBeans</a>
+<li><p><a href="#troubleshooting">Troubleshooting</a>
+</ul>
+
+<a name="prerequisites"></a>
+<h2>Pre-requisites</h2>
+
+<ul>
+<!-- <li>You need to install the Office API support module for NetBeans which
+can be obtained from
+<a href="http://api.openoffice.org/common/man/IDEintegration/OfficeNetBeansIntegration.html">here</a>.
+This module must be installed in NetBeans if you wish to use the
+Office API in your scripts.
+-->
+
+<li>The Office Scripting module works with NetBeans 3.4
+
+<li>You should have installed the Office Scripting module during the
+installation process for the Scripting Framework. If you have not installed
+it, see the <a href="install-guide.html">Installation Guide</a> for
+instructions on how to install.
+
+<li>On Linux, you will need to ensure that your DISPLAY environment
+variable is set to &lt;your hostname&gt;:0 in the shell from which you
+start NetBeans to work around a problem with Java GUIs in Office.
+
+<li>Create a directory somewhere on your machine in which you will develop
+your scripts.
+</ul>
+
+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 &lt;Office installation&gt;/program/classes directory in
+order to access the Office API from your scripts.
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="recipe-create"></a>
+<h2>Creating a Parcel Recipe</h2>
+
+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:
+
+<ul>
+<li>Right click on your mounted filesystem
+<li>Select New/Office Scripting/Parcel Recipe
+<li>In the New Wizard window that appears enter a name for your Parcel Recipe
+<li>Select a language for your Parcel Recipe from the Initial Script
+Language dropdown list.
+<li>Click the Finish button to create your Parcel Recipe
+</ul>
+                         
+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.
+
+<p>
+<b>Note:</b> 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.
+
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="recipe-actions"></a>
+<h2>Actions available for Parcel Recipe</h2>
+
+If the user right clicks on the parcel directory they should be
+able to use the following actions:
+
+<ul>
+<li><b>Compile:</b> Compiles all of the .java files in the Parcel Recipe
+
+<li><b>Build:</b> 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
+&lt;Parcel Recipe Name&gt;.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.
+
+<li><b>Configure:</b> This pops up the Configure dialog, which allows you
+to select what Office scripts to export. Any changes you make in
+this dialog will <b>only</b> appear in your Script Parcel after you run
+Build again.
+</ul>
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="parcel-actions"></a>
+<h2>Actions available for Script Parcels</h2>
+
+Script Parcels supports only one action:
+
+<ul>
+<li><b>Deploy:</b> 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.
+</ul>
+
+<p>
+<b>Note:</b> 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.
+
+<p>
+<b>Note:</b> You can also deploy to Office documents within NetBeans
+using drag and drop or cut and paste.
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="document-actions"></a>
+<h2>Actions available for Office Documents</h2>
+
+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:
+
+<ul>
+<li><b>Open:</b> This will open the document in Office using the path
+in the Office Settings property to find the Office installation.
+
+<p>
+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
+</ul>
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="debugging"></a>
+<h2>Debugging Java Office scripts in NetBeans</h2>
+
+<ul>
+<li>Follow the instructions at
+<a href="http://api.openoffice.org/common/man/IDEintegration/OfficeNetBeansIntegration.html#Debugging">
+Debugging Java components in NetBeans/Forte for Java</a>
+to set up your Office installation to allow debugging of the JVM.
+
+<li>Start OpenOffice and run one of your Java scripts. This will
+make sure the JVM is running.
+
+<li>Attach to Office JVM using the NetBeans Debug/Start Session/Attach...
+menu option.
+
+<li>Load a script source in NetBeans and set up breakpoints using
+Debug/New Breakpoint... menu option.
+
+<li>Run the script in Office.
+</ul>
+
+<p>
+<b>Note:</b> 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.
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="troubleshooting"></a>
+<h2>Troubleshooting</h2>
+
+<ul>
+<li><p>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.
+
+<li><p>The Choose What to Export as Scripts dialog <b>only</b> 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.
+
+<li><p>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.
+
+<p>
+There are a couple of workarounds for this problem:
+
+<p>
+<ol>
+<li>Use the <a href="commandline-devguide.html">command line tools</a>
+<li>Set the Target flag in the Tools/Options window under
+Building/Compiler Types/Internal Compilation
+</ol>
+</ul>
+
+<p>
+<a href="#top">Top</a>
+
+<hr>
+Last Modified: Tue Mar 12 11:40:28 GMT 2003
+</body>
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/netbeans-devguide.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/release-notes.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/release-notes.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/release-notes.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/release-notes.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,155 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<html>
+<head>
+  <meta http-equiv="CONTENT-TYPE"
+ content="text/html; charset=iso-8859-1">
+  <title>Release Notes for EDR v0.3</title>
+  <meta name="GENERATOR" content="StarOffice 6.0  (Solaris Sparc)">
+  <meta name="CREATED" content="20030319;16001000">
+  <meta name="CHANGED" content="20030320;9393200">
+</head>
+<body lang="en-US">
+<h1>Release Notes</h1>
+<h2>Installation</h2>
+<ul>
+  <li>
+    <p>The installer now takes some optional command line arguments:</p>
+    <pre style="margin-bottom: 0.51cm;"> java -jar SFrameworkInstall.jar [-office &lt;path_to_office_installation&gt;]<br> [-netbeans &lt;path_to_netbeans_installation&gt;]<br> [-net] [-bindings]<br> [-help]</pre>
+  </li>
+  <li>
+    <p>If you are installing the framework on the windows platform (
+for language other than english ) you may experience difficulties, the
+installer looks for the sversion.ini file in either the user's home
+directory or in the &#8220;Application Data&#8221; sub-directory of the user's
+home directory. To install the framework copy the sversion.ini file to
+the user's home directory or to the &#8220;Application Data&#8221; sub-directory in
+the user's home. (Note: you may need to create the sub-directory called
+&#8220;Application Data&#8221;)</p>
+  </li>
+  <li>The problem with installing the 0.3 release in StarOffice has
+been fixed as of 15 July 2003.</li>
+  <li>Installing the Scripting Framework in a
+network (ie. setup -net) installation is currently broken, this will be rectified as soon as possible.
+</li>
+</ul>
+<h2>Script Binding</h2>
+<ul>
+  <li>
+    <p style="margin-bottom: 0cm;">It is important the only the "Assign
+Script To ..." dialogs are used to create &amp; delete script
+bindings for Scripting framework Java &amp; Beanshell scripts. While
+these bindings also appear in the Tools-&gt;Configure dialog, that
+dialog should <b>not </b>be used to delete these bindings as the
+results are undefined and may lead to a loss of all menu items! In a
+future release, both these dialogs will be integrated, resolving this
+issue.</p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;">&#8220;Assign Script to ..&#8221; dialogs work
+only for the following applications, writer, calc, impress, draw and
+presentation.</p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;">The Languages displayed in the
+&#8220;Language&#8221; combo-box for all &#8220;Assign Script to ...&#8221; menus is populated
+with &#8220;Java&#8221; by default and then with the corresponding languages for
+any associated installed runtimes. </p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;">Given that Control-Shift-Digit key
+combinations are not available to OpenOffice.org on all platforms,
+these bindings are not supported by the Scripting framework. </p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;">The scripting framework contains a
+number of helper scripts for its own use. Logical names starting with
+an underscore followed by a dollar sign and a script name, eg.
+"_$HelperScript" are reserved for this purpose, and will not be
+displayed in the assign dialogs. </p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;"><font color="#000000">In order to
+save a script event binding to a menu item or key into a document there
+are two steps which must be followed. Firstly, set up the binding in
+the usual way using the "Assign Script To ..." dialog. Then
+open the Tools-&gt;Configure dialog, and select the "Menu" tab. Click
+the "Save" button, select the document into which you wish to save the
+binding, and click "Save".&nbsp; You will be prompted with a dialog
+that says "The file already exists. Overwrite?". It is OK to click
+"Yes" as this will simply write the bindings into the file. Saving a
+binding to an event into a document can be done by clicking the
+"Document" radio button in the "Assign Script to Event" dialog.</font></p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;">In both the Writer &amp; Calc
+applications, the Format menu is dynamically generated. For this reason
+the Scripting Framework does not allow the user to bind scripts
+to entries in the Format menu in any of the applications. </p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;">It is not possible to assign scripts
+to menus, keys or events in Web or Formula documents (only Writer,
+Calc, Impress &amp; Draw). </p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;">Currently the Scripting Framework
+does not prevent the user from duplicating menu entries, for example it
+is possible to create a second "New" menu entry under the "File"
+menu. </p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;">The Comboboxes in the "Assign Script
+To ..." dialogs are not read-only. Editing their contents will
+prevent the generation of script bindings and will result in a
+StarBasic error message being displayed. </p>
+  </li>
+  <li>
+    <p>It is not possible to create top-level menus from the "Assign
+Script to Menu" dialog. However, the following steps will create a new
+top-level menu which can then be used in the "Assign Script To Menu"
+dialog. Open the Tools-&gt;Configure dialog, collapse the top-level
+menu entry preceding&nbsp; the location where the new top-level menu
+entry is to be placed and click the "New Menu" button. The new menu
+"Menu" will be placed below the highlighted menu item. Left clicking
+this entry, pausing, and left-clicking again (ie. not a double-click),
+will allow the user to rename the menu. </p>
+  </li>
+  <li>
+    <p style="margin-bottom: 0cm;">The user/Scripts directory should
+not be moved or deleted as it contains scripts (in the
+java/ScriptfrmwrkHelper directory) that are used by the Scripting
+Framework (in the creation of script bindings). While the NetBeans
+deploy will re-create a missing user/Scripts directory it does not
+restore the helper scripts.</p>
+  </li>
+  <li>Binding a script to the "Close Application" event may cause
+openOffice to crash, and where this does not happen the script fails to
+run. This bug is being tracked by <a
+ href="http://www.openoffice.org/project/www/issues/show_bug.cgi?id=15726">issue
+15726</a>.<br>
+  </li>
+</ul>
+<h2>Script Security</h2>
+<ul>
+  <li>
+    <p style="margin-bottom: 0cm;">Security warning dialogs are
+displayed upon first invocation, and not on document load as is done
+for StarBasic. </p>
+  </li>
+  <li>
+    <p>When the security setting is "Always", and "Show Warning Before
+Running" the Scripting Framework displays the correct dialog. StarBasic
+displays a dialog more appropriate to "According To Path List", and
+while this issue has been fixed (<a
+ href="http://www.openoffice.org/issues/show_bug.cgi?id=11822">Issue
+11822</a>) the fix is not present in OpenOffice.org 1.1 beta.</p>
+  </li>
+</ul>
+<h2>IDE &amp; Deployment</h2>
+<ul>
+</ul>
+<hr>
+<p>Last Modified: Tue Jul 15 15:53:53 BST 2003
+</p>
+</body>
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/release-notes.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/rhino.gif
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/rhino.gif?rev=1206297&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/rhino.gif
------------------------------------------------------------------------------
    svn:mime-type = image/gif



Mime
View raw message