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 [11/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.1/faq.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/faq.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/faq.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/faq.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,162 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<HTML>
+<HEAD>
+	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
+	<TITLE>FAQ</TITLE>
+	<META NAME="GENERATOR" CONTENT="StarOffice 6.1 EA2 (Solaris Sparc)">
+	<META NAME="CREATED" CONTENT="20021203;15313500">
+	<META NAME="CHANGED" CONTENT="20021203;17425800">
+</HEAD>
+<BODY LANG="en-US">
+<H1><A NAME="top"></A>Frequently Asked Questions for the Office
+Scripting Framework</H1>
+<H2>Questions</H2>
+<OL>
+	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#1">Why can't I see the
+	script I deployed to a document from the [Assign Script] dialog?</A>
+		</P>
+	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#2">Why can't I bind
+	scripts to events?</A> 
+	</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="1"></A>Why can't I see the script I deployed to a
+	document from the [Assign Script] dialog? 
+	</P>
+	<P>Currently, the [Assign Script] dialog only displays scripts
+	located in the user area (also, the IDE only supports deployment to
+	document and user area). This will be fixed in the next release. 
+	</P>
+	<P><B>Workaround:</B> To bind to scripts deployed in the application
+	share area you can hand edit the appropriate (app)keybinding.xml or
+	(app)menubinding.xml file located in the /user/config/soffice.cfg/
+	directory. Changes to these files require a restart of the
+	application to take effect. 
+	</P>
+	<P STYLE="margin-bottom: 0cm"><A HREF="#top">Top</A> 
+	</P>
+	<LI><P><A NAME="2"></A>Why can't I bind scripts to events? 
+	</P>
+	<P>This is the first release of the scripting framework, some work
+	is still needed in the office source in order to support scripting
+	fully. In particular the way events are handled is different to how
+	menu and keybindings are handled and currently we cannot support
+	event bindings. It is our intention to add this functionality in the
+	future. 
+	</P>
+	<P STYLE="margin-bottom: 0cm"><A HREF="#top">Top</A> 
+	</P>
+	<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>
+	<P STYLE="margin-bottom: 0cm">To store bindings in document follow
+	the steps below; 
+	</P>
+	<UL>
+		<LI><P STYLE="margin-bottom: 0cm">Use the IDE deploy the Script to
+		the user area as well as to the document. 
+		</P>
+		<LI><P STYLE="margin-bottom: 0cm">Create the binding (key or menu)
+		as normal using the [Assign Script] dialog to the user script which
+		matches that in the document. 
+		</P>
+		<LI><P STYLE="margin-bottom: 0cm">Restart office. 
+		</P>
+		<LI><P STYLE="margin-bottom: 0cm">Select [Configure] from the
+		[Tools] menu, select the appropriate tab (Keyboard or Menu). Click
+		on the save button and select the document you wish to save the
+		bindings to.</P>
+		<LI><P STYLE="margin-bottom: 0cm">Due to an issue with deploying to
+		document from an ide a couple of extra manual steps are needed. 
+		</P>
+		<UL>
+			<LI><P STYLE="margin-bottom: 0cm">You need to extract the
+			parcel-descriptor file from the document you deployed to. 
+			</P>
+			<UL>
+				<LI><P STYLE="margin-bottom: 0cm">On Solaris/Linux the command
+				is:</P>
+				<P STYLE="margin-bottom: 0cm">unzip &lt;path to document&gt;
+				Scripts/java/&lt;ParcelName&gt;/parcel-descriptor.xml</P>
+				<LI><P STYLE="margin-bottom: 0cm">On Windows refer to user doc of
+				the Zip/Unzip utility of your choice [ e.g. <A HREF="http://www.pkware.com/">PKUnzip</A>
+				and <A HREF="http://www.winzip.com/">WinZip</A> ].</P>
+			</UL>
+			<LI><P STYLE="margin-bottom: 0cm">Edit the parcel-descriptor.xml
+			file you have extracted and modify the line:</P>
+			<P STYLE="margin-bottom: 0cm">&lt;prop name=&quot;classpath&quot;
+			value=&quot;.&quot;/&gt;&rdquo; to be &lt;prop name=&quot;classpath&quot;
+			value=&quot;&quot;/&gt;</P>
+			<LI><P STYLE="margin-bottom: 0cm">Save the updates.</P>
+			<LI><P STYLE="margin-bottom: 0cm">Update the document with the
+			&ldquo;parcel-descriptor.xml&rdquo; you have just modified</P>
+			<UL>
+				<LI><P STYLE="margin-bottom: 0cm">On Solaris/Linux use: 
+				</P>
+				<P STYLE="margin-bottom: 0cm">zip &lt;path to document&gt;
+				Scripts/java/&lt;ParcelName&gt;/parcel-descriptor.xml</P>
+				<LI><P STYLE="margin-bottom: 0cm">On windows refer to the user
+				documentation for your Zip/unZip utility on how to update files
+				in an archive.</P>
+			</UL>
+		</UL>
+	</UL>
+	<P>You now have a key or menu binding for this script stored in the
+	document along with the script. The ability to add document bindings
+	directly will be added in the future. 
+	</P>
+	<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
+	office. 
+	</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: Fri Nov 29 15:18:53 GMT 2002 
+</P>
+</BODY>
+</HTML>
\ No newline at end of file

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

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/index.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/index.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/index.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/index.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,200 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<HTML>
+<HEAD>
+	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
+	<TITLE>OpenOffice.org Scripting Framework</TITLE>
+	<META NAME="GENERATOR" CONTENT="StarOffice 6.1 Beta 1 (Solaris Sparc)">
+	<META NAME="CREATED" CONTENT="20021216;16321100">
+	<META NAME="CHANGED" CONTENT="20021216;16360100">
+</HEAD>
+<BODY LANG="en-US" DIR="LTR">
+<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>
+<P>The Early Developer release (Version 0.1) of the Office Scripting
+Framework will work with <A HREF="http://www.openoffice.org/dev_docs/source/643c/index.html">OpenOffice.org
+643C</A> 
+</P>
+<TABLE WIDTH=844 BORDER=0 CELLPADDING=2 CELLSPACING=0 BGCOLOR="#f0f0f0">
+	<COL WIDTH=270>
+	<COL WIDTH=6>
+	<COL WIDTH=220>
+	<COL WIDTH=171>
+	<COL WIDTH=117>
+	<COL WIDTH=36>
+	<TR>
+		<TD COLSPAN=6 WIDTH=840 BGCOLOR="#00315a">
+			<P ALIGN=CENTER><FONT COLOR="#ffffff"><B>Documentation for the
+			Early Developer Release (Version 0.1)</B> </FONT>
+			</P>
+		</TD>
+	</TR>
+	<TR>
+		<TH WIDTH=270 BGCOLOR="#99ccff">
+			<P ALIGN=CENTER><FONT COLOR="#00315a"><B>Name</B> </FONT>
+			</P>
+		</TH>
+		<TH COLSPAN=5 WIDTH=566 BGCOLOR="#99ccff">
+			<P ALIGN=CENTER><FONT COLOR="#00315a"><B>Description</B> </FONT>
+			</P>
+		</TH>
+	</TR>
+	<TR VALIGN=TOP>
+		<TD WIDTH=270>
+			<P><A HREF="developer-release-features.html">Features</A></P>
+		</TD>
+		<TD COLSPAN=5 WIDTH=566>
+			<P>Features of the Early Developer Release</P>
+		</TD>
+	</TR>
+	<TR VALIGN=TOP>
+		<TD WIDTH=270>
+			<P><A HREF="SFrameworkInstall.jar">Download</A></P>
+		</TD>
+		<TD COLSPAN=5 WIDTH=566>
+			<P>Download the Office Scripting Framework (2 MB). Refer to the
+			install section for installation guidelines.</P>
+		</TD>
+	</TR>
+	<TR VALIGN=TOP>
+		<TD WIDTH=270>
+			<P><A HREF="install-guide.html">Install</A></P>
+		</TD>
+		<TD COLSPAN=5 WIDTH=566>
+			<P>Installation Guide for the Office Scripting Framework</P>
+		</TD>
+	</TR>
+	<TR VALIGN=TOP>
+		<TD ROWSPAN=3 WIDTH=270>
+			<P>Script User Guides</P>
+		</TD>
+		<TD ROWSPAN=2 WIDTH=6></TD>
+		<TD COLSPAN=2 WIDTH=395>
+			<P><A HREF="user-guide.html">General User Guide</A></P>
+		</TD>
+		<TD ROWSPAN=2 COLSPAN=2 WIDTH=157></TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=2 WIDTH=395 VALIGN=TOP>
+			<P><A HREF="../examples-download.html">Examples: Scripts contributed by the OpenOffice.org community</A></P>
+		</TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=5 WIDTH=566 VALIGN=TOP></TD>
+	</TR>
+	<TR VALIGN=TOP>
+		<TD ROWSPAN=5 WIDTH=270>
+			<P>Script Developer Guides</P>
+		</TD>
+		<TD ROWSPAN=4 WIDTH=6></TD>
+		<TD WIDTH=220>
+			<P><A HREF="developer-guide.html">General Developer Guidelines</A>
+						</P>
+		</TD>
+		<TD ROWSPAN=4 COLSPAN=3 WIDTH=332></TD>
+	</TR>
+	<TR>
+		<TD WIDTH=220 VALIGN=TOP>
+			<P><A HREF="netbeans-devguide.html">Developer Guide for NetBeans</A>
+						</P>
+		</TD>
+	</TR>
+	<TR>
+		<TD WIDTH=220 VALIGN=TOP>
+			<P><A HREF="jedit-devguide.html">Developer Guide for jEdit</A> 
+			</P>
+		</TD>
+	</TR>
+	<TR>
+		<TD WIDTH=220 VALIGN=TOP>
+			<P>Developing Scripts without an IDE 
+			</P>
+		</TD>
+	</TR>
+	<TR>
+		<TD COLSPAN=5 WIDTH=566 VALIGN=TOP></TD>
+	</TR>
+	<TR VALIGN=TOP>
+		<TD WIDTH=270>
+			<P><A HREF="faq.html">FAQ</A></P>
+		</TD>
+		<TD COLSPAN=5 WIDTH=566>
+			<P>Frequently Asked Questions for the Office Scripting Framework</P>
+		</TD>
+	</TR>
+	<TR VALIGN=TOP>
+		<TD WIDTH=270>
+			<P><A HREF="issues-list.html">Issues</A></P>
+		</TD>
+		<TD COLSPAN=5 WIDTH=566>
+			<P>Known Issues list for the Early Developer Release</P>
+		</TD>
+	</TR>
+	<TR VALIGN=TOP>
+		<TD WIDTH=270>
+			<P><A HREF="whats-next.html">What's Next</A></P>
+		</TD>
+		<TD COLSPAN=5 WIDTH=566>
+			<P>Upcoming features in future releases of the Office Scripting
+			Framework</P>
+		</TD>
+	</TR>
+</TABLE>
+<HR>
+<TABLE CELLPADDING=4 CELLSPACING=0>
+	<TR VALIGN=TOP>
+		<TD WIDTH=32%>
+			<P><A HREF="mailto:dev@framework.openoffice.org">Mailing List</A></P>
+		</TD>
+		<TD WIDTH=68%>
+			<P>Installation, User or Developer queries on the Office Scripting
+			Framework</P>
+		</TD>
+	</TR>
+	<TR VALIGN=TOP>
+		<TD WIDTH=32%>
+			<P>Issues</P>
+		</TD>
+		<TD WIDTH=68%>
+			<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>
+</TABLE>
+<P>Last Modified: Fri Nov 29 14:14:24 GMT 2002 
+</P>
+</BODY>
+</HTML>

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

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/install-guide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/install-guide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/install-guide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/install-guide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,211 @@
+<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 Early Developer Release (Version 0.1)</h1>
+          
+This document tells you how to download and install the Early Developer
+Release of the Office Scripting Framework.
+
+<h2>Contents</h2>
+
+<ul>
+<li><p><a href="#who">Who Should Read This Document</a>
+<li><p><a href="#prerequisites">Pre-requisites</a>
+<li><p><a href="#download">Downloading the Scripting Framework</a>
+<li><p><a href="#install">Installing the Scripting Framework</a>
+<li><p><a href="#uninstall">Uninstalling the Scripting Framework</a>
+</ul>
+
+<a name="who"></a>
+
+<h2>Who Should Read This Document</h2>
+          
+This document should be read by:
+
+<ul>
+<li><p>Application Developers who wish to enhance OpenOffice.org
+functionality without needing to develop UNO components or to connect to
+OpenOffice.org from a remote JVM
+
+<li><p>OpenOffice.org users who wish to execute Office scripts written
+in Java via menu and key bindings in OpenOffice.org
+</ul>
+
+<a href="#top">Top</a>
+<a name="prerequisites"></a>
+
+<h2>Pre-requisites</h2>
+
+<ul>
+<li>This is an Early Developer Release of the Office Scripting Framework
+provided for users and developers of OpenOffice.org to try out and provide
+feedback. Future releases of the Framework may change.
+<li>This release of the Scripting Framework runs
+<a href="http://www.openoffice.org/dev_docs/source/643c/index.html">
+<b>only on OpenOffice.org 643C</b></a>
+<li>The Scripting Framework is currently available in English only.
+</ul>
+
+The table below shows the JDK and memory requirements for running the
+Office Scripting Framework on OpenOffice.org 643C.
+
+<p>
+<center>
+<table colspan=4 cellpadding=5 border=1>
+<tr>
+<th>User</th><th>IDE</th><th>JDK required</th><th>Memory required</th>
+</tr>
+<tr>
+<td>Script User</td><td>-</td><td>1.3</td><td>256MB</td>
+</tr>
+<tr>
+<td>Script Developer</td><td>NetBeans 3.4</td><td>1.3</td><td>512MB</td>
+</tr>
+<tr>
+<td>Script Developer</td><td>jEdit 4.0.3</td><td>1.4</td><td>512MB</td>
+</tr>
+</table>
+</center>
+
+<a href="#top">Top</a>
+<a name="download"></a>
+
+<h2>Downloading the Scripting Framework</h2>
+
+The Scripting Framework is available for download in the form of a Jar 
+file which can be obtained from <a href="SFrameworkInstall.jar">here</a>.
+The contents of the Jar file are as follows:
+
+<ul>
+<li><b>installer</b> - A platform-independent installer for the Scripting
+Framework written in Java.
+
+<li><b>bindingdialog</b> - A collection of StarBasic dialogs
+to enable the user to assign (bind) scripts written in Java to menu and
+key items. This directory also contains the necessary XML files
+for the menu items that invoke these StarBasic dialogs.
+
+<li><b>examples</b> - Two example scripts written in Java.
+
+<li><b>sframework</b> - A UNO package <!--<sup>*</sup>--> containing
+the Scripting Framework libraries, Jar files and types.
+Additionally, a resource file for a security-related dialog.
+
+<li><b>ide</b> - The Jar files for NetBeans and jEdit integration.
+
+<li><b>(platform dirs)</b> - These contain the platform dependent
+<font face="Courier, monospace" size="2">regsingleton</font>
+tool used to add singleton entries in the OpenOffice.org services datatbase.
+</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.  
+<p>
+To install the Scripting Framework:
+
+<ul>
+<li>Open a terminal (Linux/UNIX) or DOS Command Prompt (Windows)
+<li>Ensure that java is in your execution path
+<li>Copy the Scripting Framework Jar file you downloaded into the program
+directory of the OpenOffice.org installation into which you
+wish to install the Framework.
+<li>Switch to the &lt;Office Installation&gt;/program directory
+<li>Run the command:
+<font face="Courier, monospace" size="2">java -jar SFrameworkInstaller.jar</font>
+</ul>
+         
+<p>
+This will cause the Scripting Framework to be installed in the
+&lt;Office Installation&gt;/user/uno_packages directory of your Office
+installation. If the installer detects an installation of either
+<a href="http://www.netbeans.org/ide/download.html"> NetBeans 3.4</a> or
+<a href="http://www.jedit.org/index.php?page=download">jEdit 4.0.3</a>
+you will be asked whether you wish to install the Scripting Framework
+add-ins for these IDEs. These add-ins provide support for developing
+and deploying Office Scripts in Java.
+
+<p>
+<b>Note:</b> The installer detects IDE installations by looking for
+session related files in the home directory of the user running the install,
+so in order for your IDE to be detected you will need to have run it at
+least once.
+
+<p>
+<b>Note:</b> If you are installing the Scripting Framework into a network
+installed OpenOffice.org, the Framework install will need to be run as
+the same user who did the initial network install.  This is because one of
+the files (ProtocolHandler.xcu) that needs to be modified during the
+Framework install is in the &lt;Office Installation&gt;/share directory,
+<p>
+
+<a href="#top">Top</a>
+<a name="uninstall"></a>
+
+<h2>Uninstalling the Scripting Framework</h2>
+
+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).
+
+<p>
+To remove the Scripting Framework:
+<ul>
+<li>Delete the file &lt;Office Installation&gt;/user/uno_packages/ooscriptframe.zip
+<li>Switch to the &lt;Office Installation&gt;/program directory and run the command: <font face="Courier, monospace" size="2">pkgchk</font>
+</ul>
+
+<p>
+If you wish to remove any scripts from your installation they are stored in the directories:
+<ul>
+<li>&lt;Office Installation&gt;/user/Scripts
+<li>&lt;Office Installation&gt;/share/Scripts
+</ul>
+
+<p>
+You can use the Tools/Configure dialog to remove any menu or key bindings
+that you have setup for Office scripts.
+
+<p>
+If you have installed Office Scripting support into a NetBeans installation
+you can remove it by deleting:
+<ul>
+<li>&lt;NetBeans Installation&gt;/modules/office.jar
+</ul>
+
+<p>
+If you have installed Office Scripting support into a jEdit installation
+you can remove it by deleting:
+<ul>
+<li>&lt;jEdit Installation&gt;/jars/OfficeScripting.jar
+<li>&lt;jEdit Installation&gt;/jars/idesupport.jar
+</ul>
+
+<a href="#top">Top</a>
+
+<hr>
+Last Modified: Fri Nov 29 14:19:53 GMT 2002
+
+</body>
+</html>

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

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/issues-list.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/issues-list.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/issues-list.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/issues-list.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,103 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<HTML>
+<HEAD>
+	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
+	<TITLE>Known Issues</TITLE>
+	<META NAME="GENERATOR" CONTENT="StarOffice 6.1 BETA1 (Solaris Sparc)">
+	<META NAME="CREATED" CONTENT="20021203;16132100">
+	<META NAME="CHANGED" CONTENT="20021213;13552000">
+</HEAD>
+<BODY LANG="en-US">
+<H1>Known Issues in the Early Developer Release (Version 0.1)</H1>
+<H2>Invocation</H2>
+<UL>
+	<LI><P STYLE="margin-bottom: 0cm">Currently deployment and
+	invocation of document scripts is not fully supported by the IDE and
+	Tools/Assign Scripts dialog. Further releases will allow users to
+	assign Menu and Keybinding to document scripts. [Refer to <A HREF="faq.html#4">FAQ
+	question/answer 4</A> for details on how to do this manually.]</P>
+</UL>
+<H2>Binding</H2>
+<UL>
+	<LI><P STYLE="margin-bottom: 0cm">The Assign Script dialog which
+	appears when you use the Tools/Assign Scripts (Java) menu item is
+	for creating application level bindings only, you cannot create
+	document bindings using this dialog. 
+	</P>
+	<LI><P STYLE="margin-bottom: 0cm">Currently, bindings to Java
+	scripts apply to either Writer or Calc, they cannot be applied
+	across all OpenOffice.org applications, as can be done with Star
+	Basic macros. 
+	</P>
+	<LI><P>The Java script bindings are not integrated into the Star
+	Basic Tools/Configure dialog at this time, so there may be
+	inconsistencies between the bindings displayed in the Tools/Assign
+	Scripts and the Tools/Configure dialogs, (For instance in the
+	MemoryUtils example, the CTRL-Shift-M keybinding is not listed as a
+	binding under the Tools/Assign script (Java)/Key... dialog, but is
+	under the Tools/Configure/Keyboard tab)</P>
+	<LI><P>You should not add menu bindings to the Format menu. If you
+	do, it may cause any menu bindings you have created to disappear. If
+	this happens you should reinstall the Scripting Framework to restore
+	the Tools/Assign Scripts and Tools/Refresh User Scripts menu items.
+	Future releases of the Scripting Framework will not allow menu
+	bindings to be added to the Format menu. 
+	</P>
+</UL>
+<H2>Netbeans</H2>
+<UL>
+	<LI><P STYLE="margin-bottom: 0cm">When using the Netbeans Scripting
+	Framework support on Windows to Build/Configure a script parcel, the
+	configure dialog sometimes does not contain any methods in the
+	&ldquo;Available Methods&rdquo; panel. This problem is due to a bug
+	in the plugin when building the classpath to introspect on the class
+	files for the parcel recipie. The problem occurs if the unoil.jar is
+	the last jar mounted.</P>
+	<P STYLE="margin-bottom: 0cm"></P>
+	<P STYLE="margin-bottom: 0cm">[Note: generally the unoil.jar from
+	the installation is mounted automatically the first time you compile
+	a parcel, therefore it is normally the last jar mounted. However,
+	you will not see this jar in the NetBeans Explorer window as it is
+	hidden].</P>
+	<P STYLE="margin-bottom: 0cm"></P>
+	<P STYLE="margin-bottom: 0cm">Workaround: After building a parcel
+	recipie, in which you see the above problem occur, mount any other
+	jar. This will be added after the hidden unoil.jar and the module
+	will now function correctly.</P>
+	<P></P>
+</UL>
+<H2>Linux</H2>
+<UL>
+	<LI><P STYLE="margin-bottom: 0cm">On Linux, you need to ensure that
+	your DISPLAY environment variable is set to &lt;your hostname&gt;:0
+	in the shell from which you start Office to work around a problem
+	with Java GUIs causing Office to crash. 
+	</P>
+	<LI><P>On Linux (Red Hat) some issues were reported when installing
+	the JEdit plugin to an existing JEdit installation. Deleting the
+	.jedit directory from the user's home directory, restarting JEdit
+	and then reinstalling the JEdit Scripting Framework support, solved
+	the problem. 
+	</P>
+</UL>
+<H2>Solaris</H2>
+<UL>
+	<LI><P>When invoking key bindings on Solaris, you need to hit them
+	twice to get first invocation, after that hit it once and it works. 
+	</P>
+</UL>
+<H2>Other</H2>
+<UL>
+	<LI><P STYLE="margin-bottom: 0cm">There may be a slight delay in
+	running the first script in Java after starting OpenOffice.org as
+	the JVM is loaded. 
+	</P>
+	<LI><P>The Framework does not currently support &quot;./&quot; in
+	the classpath property in the parcel-descriptor.xml file. 
+	</P>
+</UL>
+<HR>
+<P>Last Modified: Fri Nov 29 14:19:53 GMT 2002 
+</P>
+</BODY>
+</HTML>
\ No newline at end of file

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/issues-list.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/jedit-devguide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/jedit-devguide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/jedit-devguide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/jedit-devguide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,369 @@
+<html>
+<head>
+<!-- jEdit options: -->
+<!-- :tabSize=8:indentSize=2:noTabs=true:maxLineLen=80: -->
+<title>Developer Guide for jEdit</title>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+</head>
+
+<body>
+<h1>Developer Guide for jEdit</h1>
+ 
+<h2>Contents</h2>
+
+<ul>
+<li><a href="#prerequisites">Pre-requisites</a>
+<li><a href="#setup">Setting up the Office Scripting plugin</a>
+<li><a href="#using">Using the Office Scripting plugin</a>
+<li><a href="#options">Options</a>
+<li><a href="#steps">Step by step actions</a>
+<li><a href="#troubleshooting">Troubleshooting</a>
+</ul>
+       
+<h2><a name="prerequisites"></a>Pre-requisites</h2>
+    
+<ul>
+<li>The plugin only runs in jEdit 4.0.3 (available from
+<a href="http://www.jedit.org/index.php?page=download">jedit.org</a>)
+
+<li>You <b>MUST</b> have the following plugins installed: AntFarm, Console<br>
+(see below for instructions on installing them)
+
+<li>If you wish to have code completion when writing Office scripts you
+also need to install the SpeedJava plugin
+</ul>
+       
+<h2><a name="setup"></a>
+Setting up the Office Scripting plugin</h2>
+
+See the <a href="install-guide.html">Installation Guide</a>
+for instructions on installing the Office Scripting plugin.
+
+<blockquote>
+<h3>Setting up the http proxy</h3>
+
+<ul>
+<li>Browse to Utilities/Global Options...
+<li>Browse in the Global Options dialog box to the Proxy Servers.
+<li>Check "Use HTTP proxy Servers" and set all information needed for
+jEdit to access the web.
+<li>Click on OK.
+</ul>
+
+<h3>Installing required plugins</h3>
+
+<ul>
+<li>Browse to Plugins/Plugin Manager...
+<li>Click on Install Plugins (If you get erors then your Proxy is not
+well setup)
+<li>Then you get a list of plugins.
+<li>The plugins needed by the Office Scripting plugin are AntFarm and Console.
+<li>So just select them if you cant find them on the list then you have
+them already installed.
+<li>Click on install
+<li>Click on OK if needed then Close.
+<li>Exit jEdit.
+</ul>
+
+<h3>Setting up the Office Scripting plugin for jEdit</h3>
+
+If you did not install the Office Scripting plugin according to the
+instructions in the Installation Guide you need to do so first.
+
+<ul>
+<li>Browse to Utilities/Global Options...
+<li>Select Plugins/Office Scripting
+  <ul>
+  <li>Select which Office version you want to work with
+  <li>You must click OK to verify your choice even if there is only one
+      Office version listed.
+  </ul>
+<li>Select Plugins/AntFarm/Build Options
+  <ul>
+  <li>Select <i>Run Ant Targets in the same JVM</i>.
+  </ul>
+</ul>
+
+<h3>Recommended layout for the jEdit window</h3>
+
+<ul>
+<li>Browse to Utilities/Global Options...
+<li>Select Docking
+  <ul>
+  <li>Activity Log docking position: <b>bottom</b>
+  <li>Ant Farm docking position: <b>right</b>
+  <li>Console docking position: <b>bottom</b>
+  <li>Error List docking position: <b>bottom</b>
+  <li>File System Browser docking position: <b>left</b>
+  <li>Scripting Framework docking position: <b>right</b>
+  </ul>
+<li>Click on OK.
+</ul>
+</blockquote>
+ 
+<h2><a name="using"></a>Using the Office Scripting plugin</h2>
+
+<blockquote>
+<h3>Popup Menu actions</h3>
+The Scripting plugin provides a dockable window listing your scripts.  A
+number of actions are available in this window:
+
+<ul>
+
+<li><p><b>On the ROOT (All Parcels node)</b>          
+  <ul>
+  <li><i>Open... </i>: This will open a file chooser dialog box. You
+      can select an .sxp file, directory or Office Document.
+
+  <li><i>New... </i>: This will prompt you for a parcel name and then
+      create by default everything needed for a scripting parcel
+
+  <li><i>Parcel Wizard...</i>: Kind of the same than Parcel Template
+      except you choose the java files you want to include in the parcel.
+  </ul>
+</li>
+
+<li><p><b>On a Script Parcel</b>
+  <p>
+  If the parcel is a directory (created from parcel template or parcel wizard):
+
+  <ul>
+  <li><i>Add Directory</i>: This will prompt you for a Directory Name
+      and it will create it under the selected Node.
+
+  <li><i>Add File</i>: This will prompt you with a file chooser dialog
+      box and you can select the files you want to add to the selected node.
+
+  <li><i>Rename</i>: This prompt you for the new name and rename the parcel.
+
+  <li><i>Remove</i>: This will remove the parcel.
+
+  <li><i>Generate Build.xml</i>: This menu is only displayed if no
+      build.xml file exists in the Parcel directory. To avail the options
+      below you need to generate this build.xml file.
+
+  <li><i>Reload Parcel</i>: This will reload the Parcel if the content
+      on disk changed.
+
+  <li><i>Edit Build File</i>: This will open the build.xml file that
+      you can edit. This file is generated automatically when using
+      wizard or parcel template.
+
+  <li><i>Ant Targets</i>: The Ants targets will automatically be displayed
+      and by selecting them you will run the Ant command (requires AntFarms).
+
+  <li><i>ScriptCompile</i>: Default Ant target to compile the full parcel.
+
+  <li><i>ScriptClean</i>: Deafult Ant target to clean all compilation
+      output files.
+
+  <li><i>Build SXP</i>: This will compile and create the .sxp Parcel file.
+
+  <li><i>Configure Parcel...</i>: This will display the available methods
+      name in the Parcel and you can select which methods can be available
+      in OpenOffice.org.
+  </ul>
+
+  <p>
+  If the parcel selected is contained in an Office Document
+  the actions available are:
+
+  <ul>
+  <li><i>Remove</i>: This will remove the parcel from the document
+  </ul>
+</li>
+   
+<li><p><b>On a File/Directory</b>
+  <p>Some typical menu items are available on file and directory Items:<br>
+
+  <ul>
+  <li><i>Add Directory</i>: Only on directory. This will add a directory
+      under the selected directory.
+
+  <li><i>Add File</i>: Only on directory. This will prompt you with a file
+      chooser and add the selected files in the selected directory.
+
+  <li><i>Rename</i>: this will rename physically the selected entry.
+
+  <li><i>Remove</i>: this will remove physically the selected entry.
+  </ul>
+
+<li><p><b>On a Script Parcel (.sxp) file</b>
+
+  <p>The following actions are available on Script Parcel files:<br>
+
+  <ul>
+  <li><i>Deploy to</i>
+    <ul>
+    <li><i>Office Versions</i>: this will deploy the Parcel to an
+        installed version of OpenOffice.org. If you have OpenOffice.org
+        running, you need to use the Tools/Refresh User Scripts (Java)
+        menu item in OpenOffice.org for the script to appear in the
+        Assign Script dialog in Office.
+
+    <li><i>Office Document</i>: this will deploy the Parcel to an
+        Office Document.
+
+    <li><i>Remove SXP</i>: will remove physically the .sxp file generated
+        by the build command.
+    </ul>
+  </ul>
+</ul>
+         
+<h3>Menu actions</h3>
+
+Menu actions available are:
+
+<ul>
+<li><i>New...</i>
+<li><i>Add...</i>
+<li><i>Parcel Wizard...</i>
+</ul>
+</blockquote>
+   
+<h2><a name="options"></a>Options</h2>
+
+<blockquote>
+
+You may configure some options in
+<b>Utilities/Global Options/Plugin Options/Scripting</b>
+Most of them are self-explanatory, but some need further explanation:
+
+<ul>
+<li><i>OpenOffice.org Directory</i>: Locations of all OpenOffice.org
+installations. You need to select one.
+
+<li><i>Show tooltips in tree</i>: Show tooltips in the tree of Parcels in
+the Office Scripting window
+
+<li><i>Warn before removing File from Parcel</i>: Will display a
+confirmation box before removing a file.
+
+<li><i>Warn before removing Directory from Parcel</i>: Will display a
+confirmation box before removing a directory.
+
+<li><i>Include source code</i>: This will include the source code in
+the Script Parcel (.sxp) file.
+</ul>
+</blockquote>
+    
+<h2><a name="steps"></a>Step by step actions</h2>
+
+<blockquote>
+<h3>How to create a Parcel using the New... menu.</h3>
+
+By clicking on the first button or by right clicking on the
+&quot;All Parcels&quot; tree item and selecting New...  a dialog box
+is displayed asking the name of the parcel you want to create. After you
+have input the name is this dialog, another dialog box is displayed
+requesting the destination path where that parcel should be created.
+
+<p>
+Clicking on OK will create the full tree structure for the parcel
+if no problem were encountered.
+
+<h3>How to create a Parcel using the Wizard... menu.</h3>
+
+By clicking on the third button or by right clicking on the
+"All Parcels" tree item and selecting Parcel Wizard... a dialog box
+is displayed. You need to enter the Parcel Name, the destination path
+where the parcel will be created and select the java files you wish
+to include in the parcel.
+
+<p>
+Clicking on OK will create the full tree structure for the parcel
+if no problem is encountered.
+
+<h3>How to open a Parcel using the Open... menu.</h3>
+
+By clicking on the second button or by right clicking on the
+"All Parcels" tree item and selecting Open..., a file chooser
+dialog box will be displayed you can select a directory parcel, and
+.sxp file representing a Parcel or an Office Document.
+
+<p>
+A directory parcel should look like this:
+
+<p>
+<pre>
+Parcel Name
+  - Contents
+    - Java files
+    - Directories
+</pre>
+
+<p>
+A .sxp file should look like this:
+
+<p>
+<pre>
+Parcel Name
+  - Contents
+    - Java files
+    - Directories
+  - .sxp File output
+</pre>
+
+<p>
+An Office Document look like this:
+
+<p>
+<pre>
+Office Document
+  - Contents
+    - Parcels
+</pre>
+
+<h3>How to Compile a Parcel using the ScriptCompile menu.</h3>
+
+This action is only available on a Directory parcel for the moment. The
+ScriptCompile menu item is only available if a build.xml file is available
+in the parcel.
+
+<p>
+By clicking on this menu item the parcel will be compiled and errors will
+be shown in the ErrorList Plugin.
+
+<h3>How to Build a Parcel using the Build SXP menu</h3>
+
+This action is only available on a Directory parcel for the moment. By
+clicking on this item, the parcel will be rebuilt and a dialog box will
+be displayed showing the available methods in the parcel. This dialog
+box enables you to select methods that you want to export as scripts
+in Office.
+
+<p>
+For each method you can assign a Logical Name to use as a script name
+in OpenOffice.org. Clicking on OK will create the .sxp File.
+</blockquote>
+ 
+<h2><a name="troubleshooting"></a>Troubleshooting</h2>
+
+<ul>
+<li><p>If you reinstall the Scripting Framework you will need to update any
+build files that were generated for old scripts that you wrote to reflect
+the path to the new framework under your
+&lt;Office Installation&gt;/user/uno_packages directory for those scripts to
+build.
+
+<li><p>The Choose Methods 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 get the message &quot;Could not generate Ant build. No Office
+Directory set in the Options&quot;, you need to do the following:
+
+<ul>
+<li>Select the Utilities/Global Options menu item
+<li>Go to the Plugin Options/Office Scripting section
+<li>Select one of the Office installations from the list and click OK.
+</ul>
+</ul>
+<p>
+
+<hr>
+Last Modified: Fri Nov 29 14:19:53 GMT 2002
+
+</body>
+</html>

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

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/netbeans-devguide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/netbeans-devguide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/netbeans-devguide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/netbeans-devguide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,214 @@
+<html>
+<head>
+<title>Developer Guide for NetBeans</title>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+</head>
+
+<body>
+<a name="top"></a>     
+
+<h1>Developer Guide for NetBeans</h1>
+         
+This document describes how to set up NetBeans for Office Scripting
+in Java 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 Office scripts in NetBeans</a>
+<li><p><a href="#troubleshooting">Troubleshooting</a>
+</ul>
+
+<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 you can enter a name for your
+Parcel Recipe or you can leave it as default
+<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 java source files will
+be placed. An empty stub file Empty.java will have been placed in the
+Contents directory and can be used as a starting point for your script.
+<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 introspects on the generated class files and pops up a dialog
+which allows you to select which methods you wish to export as scripts.
+Once you have selected the methods to export, 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.
+
+<li><b>Configure:</b> This pops up the Configure dialog, which allows you
+to select which methods get exported as scripts. 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/Refresh User Scripts (Java) 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.
+
+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 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>
+<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 Methods 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, the class files generated when compiling will not get placed
+in subdirectories reflecting your package directive. This is because the
+default NetBeans compiler implementation does not use the -d switch to the
+Java compiler. As a result methods in these classes will not appear in the
+Choose Methods to Export as Scripts dialog.
+</ul>
+
+<p>
+<a href="#top">Top</a>
+
+<hr>
+Last Modified: Fri Nov 29 14:19:53 GMT 2002
+
+</body>
+</html>

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

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/user-guide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/user-guide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/user-guide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/user-guide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,136 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>General User Guide</title>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+</head>
+
+<body>
+<a name="top"></a>     
+
+<h1>User Guide for the Early Developer Release (Version 0.1)</h1>
+
+This is a simple user guide for the Early Developer Release of the
+Office Scripting Framework
+          
+<h2>Contents</h2>
+
+<ul>
+<li><p><a href="#prerequisites">Pre-requisites</a>
+<li><p><a href="#usingsf">Running the example Office Scripts</a>
+<li><p><a href="#troubleshooting">Troubleshooting</a>
+</ul>
+
+<a href="#top">Top</a>
+<a name="prerequisites"></a>
+
+<h2>Pre-requisites</h2>
+
+Before you install the Scripting Framework, be aware of the following:
+
+<ul>
+<li>This is an Early Developer Release of the Office Scripting Framework
+provided for users and developers of OpenOffice.org to try out and provide
+feedback. Future releases of the Framework may change.
+<li>This release of the Scripting Framework runs only on OpenOffice.org 643C.  
+<li>The Scripting Framework is currently available in English only.
+</ul>
+         
+<a href="#top">Top</a>
+<a name="usingsf"></a>
+
+<h2>Running the example Office Scripts</h2>
+
+There are two examples scripts supplied with the Scripting Framework,
+namely Highlight, and MemoryUsage.
+
+Highlight is an application level script for Writer that allows the
+user to search for a word or phrase. It will highlight all instances
+in red and give a count of the number of instances. 
+     
+<p>
+The second example, MemoryUsage, is a script stored in a Calc
+spreadsheet that checks the current memory usage in the Java Virtual
+Machine and updates cells in the spreadsheet with the usage values.
+The spreadsheet also contains a graph which will update when the cell
+values are changed.
+       
+<p>
+The examples are placed in &lt;Office Installation&gt;/user/Scripts/java 
+by the installer.
+
+<p>
+<b>Running the Highlight example</b>
+
+<p>
+To run this example you first need to create a menu item from which you
+can execute the script.
+
+<ul>
+<li>Start OpenOffice.org and open an existing Writer document or create
+a new one.
+
+<li>Select the menu item Tools/Assign Scripts (Java) To/Menu...
+
+<li>In the &quot;Assign Scripts (Java) To Menu&quot; dialog that pops up
+do the following:
+
+<ul>
+<li><i>Select script function</i>
+  <ul><li>Select the script function HighlightText.showForm from the list.
+  </ul>
+
+<li><i>Choose the menu to insert the script menu after</i>
+  <ul><li>Select the top level menu and submenu under which you want
+          to place your new menu item.
+  </ul>
+
+<li><i>Assign script to new menu</i>
+  <ul><li>In the New Menu text field enter the label you want for your
+          menu item (eg. Highlight)
+      <li>Click New Script Menu to create the new script menu item.
+  </ul>
+</ul>
+
+<li>Finally click on the OK button to save your new script menu item.
+
+<li>Restart OpenOffice.org and open a Writer document 
+  <ul><li><b>Note:</b> Menu items are not updated on the fly, hence the
+          need to restart, this will be addressed in a future release. 
+  </ul>
+
+<li>Your new menu item will now be available and clicking on it will
+invoke the Java script.
+
+<li>You should see a Highlight Text dialog appear which you can use
+to highlight various text strings you are looking for in the document.
+</ul>
+
+<p>
+<b>Running the MemoryUsage example</b>
+
+<p>
+The MemoryUsage example is already deployed inside an Office document,
+<nop>ExampleSpreadSheet.sxc. To run the example, just open:
+
+<p>
+&lt;Office Installation&gt;/user/Scripts/java/ExampleSpreadSheet.sxc.
+
+<p>
+You can then execute the MemoryUsage script by pressing <b>CTRL+Shift+M</b>
+with the <nop>ExampleSpreadSheet.sxc window focused. You should
+see the memory usage values being updated, and the graph should change to
+reflect the new values.
+<p>
+
+<a href="#top">Top</a>
+<h2>Troubleshooting</h2>
+
+See the <a href="issues-list.html">Known Issues</a> page.
+
+<hr>
+Last Modified: Fri Nov 29 14:19:53 GMT 2002
+
+</body>
+</html>

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

Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/whats-next.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/whats-next.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/whats-next.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/whats-next.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,161 @@
+<html>
+<head>
+<title>What's Next</title>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+</head>
+<BODY>
+<h1>What's Next</h1>
+<h1>Upcoming Features in future releases of the Office Scripting Framework</h1>
+
+The basic Scripting Framework core is now in place. This document intends
+to outline enhancements to the framework core and features which
+are currently being considered
+for up and coming releases.  The intention is to release updates
+regularly as new features become available.  Those interesting in
+scriting are encouragged to try out the releases, offer feedback and
+suggestions on future directions.
+
+<h2>Next Release</h2>
+
+<h3>Additional Language Support</h3>
+
+The Scripting Framework has been
+designed to allow other scripting language runtimes to be plugged in.
+The only dependancy is that the appropriate UNO to &lt;language&gt;
+bridge is available.
+
+<p>
+Which Languages?
+
+<p>
+Scripts tend to be written in type-less scripting style languages, which are
+simpler to program in than more formal strictly typed programming
+languages.  Given the UNO to Java Bridge already exists, the plan is
+to support a scripting style language written in Java. BeanShell is a
+small interpreter (around 135k) and is integrated into NetBeans.
+
+<p>
+<b>BeanShell</b>
+
+<p>
+This is a small, free, embeddable, Java source interpreter with object
+scripting language features, written in Java. BeanShell executes
+standard Java statements and expressions, in addition to obvious
+scripting commands and syntax. It is supported in NetBeans so should
+enable NetBeans IDE integration. It will be integrated into the
+existing Java Runtime.
+
+<p><b>Note:</b> There are a variety of other scripting languages
+implemented in Java that could be looked at
+after BeanShell, such as Jython or Rhino.
+
+<h3>Other Language Runtimes</h3>
+
+Documentation is due on the design
+and implementation requirements for a Language Runtime as part of
+this release.  This will enable any member of the community to
+implement other language runtimes for which there is an UNO bridge
+available such as the UNO Python bridge.
+
+<h3>Binding</h3>
+
+<ul>
+<li><p>Enable binding to document scripts in the &ldquo;Assign Script...&rdquo;
+       dialogs.<br>
+       Currently it is not possible to view scripts in a
+       document within the &ldquo;Assign Script...&rdquo; dialogs. This
+       makes it difficult to assign menu or key bindings to scripts in
+       documents.
+
+<li><p>Support language selection in the &ldquo;Assign Script...&rdquo;
+       dialog.<br>
+       See what if any modifications are needed to support multiple script
+       languages in the &ldquo;Assign Script...&rdquo; dialogs.
+
+<li><p>Enable binding to OpenOffice.org events.<br>
+       Add another dialog to allow users to bind Java scripts to specific 
+       OpenOffice.org events, such as document open [Note: this will
+       require some minor changes in  OpenOffice.org event execution before
+       this can be done].
+</ul>
+
+<h2>Future Releases</h2>
+
+<h3>IDE Add-ins</h3>
+
+<ul>
+<li><p>NetBeans enhancement.<br>
+       Enhance the support, to make it more consistent with other NetBean
+       modules, in areas such as installation and help support.
+
+<li><p>Other IDE's<br>
+       The current release has a common core set of IDE functionality that is
+       shared between both the NetBeans and Jedit add-ins.  Enhancements to this
+       common core, along with appropriate documentation, so that they
+       could be used by any community member to add support for their
+       favorite IDE.
+
+<li><p>Programming Model<br>
+       It would be very useful to provide developers with additional UNO helper
+       interfaces and more task oriented API's to allow them to create
+       powerful OpenOffice.org scripts more quickly, than using the raw UNO
+       API as it stands today.
+</ul>
+
+<h3>Performance</h3>
+
+<ul>
+<li><p>OpenOffice.org integration<br>
+       Currently the basic invocation objects are being
+       created at the point of execution of the scripts.  Moving this
+       creation to the point of document open or creation, should enhance
+       script execution [this should be under configuration control, so
+       users can optimize for document open or script execution].
+
+<li><p>Runtime enhancements<br>
+       Caching of jars, classes and script objects to be considered as a means
+       of enhancing script execution times.
+</ul>
+
+<h3>Macro Configuration</h3>
+
+General configuration settings are available for StarBasic macros, such as
+don't run macros, run only from specified locations and so on. We
+would like to offer the same degree of configuration control for our
+new language macros, and extend these settings if appropriate.
+
+<ul>
+<li><p>StarBasic Integration<br>
+       Currently the &ldquo;Assign Script..&rdquo; dialogs
+       have no connection with the Tools/ Configure dialog used by
+       StarBasic. These dialogs should be integrated so all script binding
+       management can be done from the same dialog set.
+</ul>
+
+<h3>Security</h3>
+
+<ul>
+<li><p>Digital Signing Support<br>
+       The intention is to use digital signing of script
+       parcels to give a higher degree of security for OpenOffice.org users
+       of these new language scripts. The Scripting Framework will have to
+       be enhanced to verify the digital signatures of scripts before they
+       are executed. Appropriate configuration settings could be added so
+       users can control if they only want to run digitally signed scripts
+       and to allow them to choose which digital certificates they trust.
+
+<li><p>Packaging Format<br>
+       We will move to a common packaging format for both UNO
+       components and collections of Scripts.  A jar file format would
+       facilitate jar signing support available in the IDE's.  Scripts will
+       not be unpacked into the user and share areas of OpenOffice.org
+       installations, but will deployed in single digitally signed
+       packages.
+</ul>
+
+<hr>
+Last Modified: Fri Nov 29 17:03:03 GMT 2002
+
+</body>
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.1/whats-next.html
------------------------------------------------------------------------------
    svn:eol-style = native

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

Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/SFrameworkInstall.jar
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream



Mime
View raw message