You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openoffice.apache.org by ks...@apache.org on 2011/11/25 21:02:33 UTC
svn commit: r1206297 [15/19] - in
/incubator/ooo/ooo-site/trunk/content/framework: documentation/
documentation/devmanual/ documentation/filters/ documentation/filterui/
documentation/mimetypes/ documentation/others/ drafts/ proposals/
proposals/apply/...
Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/user-guide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/user-guide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/user-guide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/user-guide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,497 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+ <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
+ <TITLE></TITLE>
+ <META NAME="GENERATOR" CONTENT="StarOffice 6.1 Beta 1 (Linux)">
+ <META NAME="CREATED" CONTENT="20030313;16153200">
+ <META NAME="CHANGED" CONTENT="20030313;16505100">
+</HEAD>
+<BODY LANG="en-US" DIR="LTR">
+<H1><A NAME="top"></A>User Guide for the Office Scripting Framework</H1>
+<H2>Contents</H2>
+<UL>
+ <LI><P STYLE="margin-bottom: 0in"><A HREF="#prerequisites">Pre-requisites</A>
+ </P>
+ <LI><P STYLE="margin-bottom: 0in"><A HREF="#bindscripts">Binding
+ Office Scripts</A>
+ </P>
+ <LI><P STYLE="margin-bottom: 0in"><A HREF="#usingsf">Running the
+ example Office Scripts</A></P>
+ <LI><P STYLE="margin-bottom: 0in"><A HREF="#Leveraging_StarBasic_Security">Leveraging
+ StarBasic Security</A></P>
+ <LI><P STYLE="margin-bottom: 0in"><A HREF="#Different_behaviour_in_the_Scripting">Different
+ behaviour in the Scripting Framework</A></P>
+ <LI><P><A HREF="#Troubleshooting">Troubleshooting</A>
+ </P>
+</UL>
+<H2><A NAME="prerequisites"></A>Pre-requisites</H2>
+<P>Before you install the Scripting Framework, be aware of the
+following:
+</P>
+<UL>
+ <LI><P STYLE="margin-bottom: 0in">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.
+ </P>
+ <LI><P STYLE="margin-bottom: 0in">This release of the Scripting
+ Framework runs only on
+ <a href="http://www.openoffice.org/dev_docs/source/644/index.html">
+ OpenOffice.org 644</a> and above.
+ </P>
+ <LI><P>The Scripting Framework is currently available in English
+ only.
+ </P>
+</UL>
+<H2><A NAME="bindscripts"></A>Binding Office
+Scripts</H2>
+<P>The execution of Office scripts can be bound to menu and key items
+and also to application or document events. These bindings can be
+defined via a set of Assign dialogs which can be started from the
+Tools/Scripting Add-on's menu
+</P>
+<P><B>Assigning scripts to Menu and Key items</B>
+</P>
+<P>The dialog shown below is the Assign Script to Menu dialog. This
+dialog is similar in design and function to the Assign Script to Key
+dialog and the instructions below should be seen to apply also to the
+Assign Script to Key dialog.
+</P>
+<P><IMG SRC="assign-menu.gif" NAME="Graphic1" ALIGN=BOTTOM WIDTH=396 HEIGHT=496 BORDER=0></P>
+<UL>
+ <LI><P>Location
+ </P>
+ <P>The location combo box will be populated with “User”,”Share”
+ or “Document” the default value will be “User”
+ which will display all scripts (with the selected language type) in
+ the “User” area.</P>
+</UL>
+<UL>
+ <LI><P>Language
+ </P>
+ <P>The language combox is populated with the list of supported
+ languages. The default language is set to java.</P>
+</UL>
+<UL>
+ <LI><P>Script ListBox
+ </P>
+ <P>Only necessary information will be displayed, logicalname will
+ always be displayed, if the “Detailed view” check box is
+ selected the scripts will be displayed as follows “logicalname
+ [functionname]”</P>
+</UL>
+<UL>
+ <LI><P>New</P>
+ <P>This button will not be selectable unless a script from the
+ script ListBox and a menu name is entered in the new menu text box
+ (opposite New button), clicking [New] creates a binding between two.</P>
+ <LI><P>Delete</P>
+ <P>This button will not be selectable unless a sub menu with a
+ script binding is selected, clicking [Delete] removes the binding.
+ </P>
+ <LI><P>OK</P>
+ <P>Clicking [OK] commits all of the changes the user has made
+ </P>
+ <LI><P>Cancel</P>
+ <P>Disposes the dialog without committing any changes.</P>
+ <LI><P>Help</P>
+ <P>Will display a dialog describing how to use each of the “Assign
+ Script” dialogs.</P>
+</UL>
+<P><B>Note: </B>Unlike StarBasic it will not be possible to setup a
+key binding that applies for the whole Office suite – key
+bindings can only be setup for an application or a document of that
+application type.</P>
+<P><B>Assigning scripts to events</B></P>
+<P><IMG SRC="assign-event.gif" NAME="Graphic2" ALIGN=BOTTOM WIDTH=396 HEIGHT=442 BORDER=0></P>
+<UL>
+ <LI><P>Event ListBox</P>
+ <P>The ListBox will be populated with the list all event types, if a
+ script has already been assigned to an event the existing binding is
+ displayed as follows</P>
+ <P>Event [ script URI ]</P>
+ <P>example:
+ </P>
+ <P>Start Application<SPAN STYLE="text-decoration: none">
+ <FONT SIZE=2>[script://Highlighter.BeanShell?language=BeanShell&function=highlighter.bsh&location=user]</FONT></SPAN></P>
+ <LI><P>Radio Buttons</P>
+ <P>By default the “Document” radio button is selected,
+ if selected the event binding is for this document only. If “All
+ Applications” is selected then the event binding is for all
+ documents of all application types ( writer, calc etc. )</P>
+ <LI><P>Assign</P>
+ <P>This button will not be selectable unless a script from the
+ script ListBox and event from the event ListBox are highlighted
+ (selected), clicking [Assign] creates a binding between two.</P>
+ <LI><P>Delete</P>
+ <P>This button will not be selectable unless an event with a script
+ binding from the event ListBox is selected, clicking [Delete]
+ removes the binding.
+ </P>
+ <LI><P>OK</P>
+ <P>Clicking [OK] commits all of the changes the user has made
+ </P>
+ <LI><P>Cancel</P>
+ <P>Disposes the dialog without committing any changes.</P>
+ <LI><P>Help</P>
+ <P>Will display a dialog describing how to use each of the “Assign
+ Script” dialogs.
+ </P>
+</UL>
+
+<P><B>Other Scripting-Add'ons Menu Items</B></P>
+<P>Two other menu items are available under the Tools/Scripting Add-on's submenu:
+<UL>
+<LI><P>Interactive BeanShell Scripting - This pops up a window in which the user can experiment with writing and executing BeanShell code against the current document. See <a href="developer-guide.html">Writing Scripts in BeanShell and Java</a> for more information on using this window.
+
+<LI><P>Refresh All Scripts - This is used to refresh the script lists that appear in the Assign dialogs after new scripts have been deployed into your OpenOffice.org installation or documents.
+</UL>
+
+<P><A HREF="#top">Top</A>
+</P>
+<H2><A NAME="usingsf"></A>Running the example Office Scripts</H2>
+
+<P>There are two examples scripts supplied with the Scripting
+Framework, 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>
+<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>
+<P>The examples are available for both Java and BeanShell in the
+language directories created under <Office Installation>/user/Scripts
+by the installer.
+</P>
+<P><B>Running the Highlight example</B></P>
+<P>To run this example you first need to create a menu item from
+which you can execute the script.
+</P>
+<UL>
+ <LI><P STYLE="margin-bottom: 0in">Start OpenOffice.org and open an
+ existing Writer document or create a new one.
+ </P>
+ <LI><P STYLE="margin-bottom: 0in">Select the menu item
+ Tools/Scripting Add-on's/Assign Scripts To Menu...
+ </P>
+ <LI><P STYLE="margin-bottom: 0in">In the "Assign Scripts To
+ Menu" dialog that pops up do the following:
+ </P>
+ <UL>
+ <LI><P STYLE="margin-bottom: 0in"><I>Select location and language</I></P>
+ <UL>
+ <LI><P STYLE="margin-bottom: 0in">Set the location to User and the language to Java in the drop down lists.</P>
+ </UL>
+ <LI><P STYLE="margin-bottom: 0in"><I>Select script</I></P>
+ <UL>
+ <LI><P STYLE="margin-bottom: 0in">Select the script
+ HighlightText.showForm from the list.</P>
+ </UL>
+ <LI><P STYLE="margin-bottom: 0in"><I>Choose the menu to insert the
+ script menu after</I></P>
+ <UL>
+ <LI><P STYLE="margin-bottom: 0in">Select the top level menu and
+ submenu under which you want to place your new menu item.
+ </P>
+ </UL>
+ <LI><P STYLE="margin-bottom: 0in"><I>Assign script to new menu</I></P>
+ <UL>
+ <LI><P STYLE="margin-bottom: 0in">In the New Menu text field enter
+ the label you want for your menu item (eg. Highlight)
+ </P>
+ <LI><P STYLE="margin-bottom: 0in">Click New Script Menu to create
+ the new script menu item.
+ </P>
+ </UL>
+ </UL>
+ <LI><P STYLE="margin-bottom: 0in">Finally click on the OK button to
+ save your new script menu item.
+ </P>
+ <LI><P STYLE="margin-bottom: 0in">Your new menu item will now be
+ available and clicking on it will invoke the script.
+ </P>
+ <LI><P>You should see a Highlight Text dialog appear which you can
+ use to highlight various text strings you are looking for in the
+ document.
+ </P>
+</UL>
+<P><B>Running the MemoryUsage example</B></P>
+<P>The Java version of the MemoryUsage example is already deployed
+inside an Office document, ExampleSpreadSheet.sxc. To run the Java
+example, just open:
+</P>
+<P><Office Installation>/user/Scripts/java/ExampleSpreadSheet.sxc.
+</P>
+<P>You can then execute the MemoryUsage script by pressing
+<B>CTRL+Shift+M</B> with the ExampleSpreadSheet.sxc window focused.
+You should see the memory usage values being updated, and the graph
+should change to reflect the new values.
+</P>
+<P><A HREF="#top">Top</A>
+</P>
+<H2><A NAME="Leveraging_StarBasic_Security"></A>Leveraging StarBasic
+Security</H2>
+<P STYLE="margin-bottom: 0in">As part of the Early Developer Release
+v0.2 of the Scripting Framework, we have attempted to mimic the
+Security settings for StarBasic. The settings allow the user to
+control the execution of macros present in OpenOffice.org documents.
+Found in the Tools->Options dialog under
+OpenOffice.org->Security, these settings allow the user
+to specify the conditions under which it is permissable to execute
+document based StarBasic macros. The settings in this dialog now
+apply to both StarBasic macros and Scripting Framework scripts.<BR>A
+full description of how these settings work can be found by clicking
+the "Help" button in the dialog, and then clicking
+"OpenOffice.org", and "Security" in the left-hand
+pane of the Help dialog. The possible scenarios associated with the
+security settings are summarised in the table below.</P>
+<TABLE BORDER=2 CELLPADDING=2 CELLSPACING=2>
+ <TR>
+ <TH>
+ <P>"Run Macro"</P>
+ </TH>
+ <TH>
+ <P>"Confirm in the case of other document sources"</P>
+ </TH>
+ <TH>
+ <P>"Show Warning before Running"</P>
+ </TH>
+ <TH>
+ <P>Document path in "Path List"</P>
+ </TH>
+ <TH>
+ <P>Behaviour</P>
+ </TH>
+ </TR>
+ <TR>
+ <TD>
+ <P>Never</P>
+ </TD>
+ <TD>
+ <P>N/A</P>
+ </TD>
+ <TD>
+ <P>N/A</P>
+ </TD>
+ <TD>
+ <P>N/A</P>
+ </TD>
+ <TD>
+ <P>Macros never run. No warning displayed.
+ </P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>According to path list</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>Macros never run. No warning displayed.
+ </P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>According to path list</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>Macros run. No warning displayed.
+ </P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>According to path list</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>Macros never run. No warning displayed.
+ </P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>According to path list</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>Warning displayed on document load. If "Run" button
+ clicked macros will run, otherwise they will not.</P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>According to path list</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>Warning with checkbox to add path to path list is displayed on
+ document load. If "Run" button clicked macros will run,
+ otherwise they will not. Regardless of which button is clicked, if
+ checkbox is ticked document path is added to "Path List".</P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>According to path list</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>Macros run. No warning displayed.
+ </P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>According to path list</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>Warning with checkbox to add path to path list is displayed on
+ document load. If "Run" button clicked macros will run,
+ otherwise they will not. Regardless of which button is clicked, if
+ checkbox is ticked document path is added to "Path List".</P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>According to path list</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>Warning displayed on document load. If "Run" button
+ clicked macros will run, otherwise they will not.</P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>Always</P>
+ </TD>
+ <TD>
+ <P>N/A</P>
+ </TD>
+ <TD>
+ <P>No</P>
+ </TD>
+ <TD>
+ <P>N/A</P>
+ </TD>
+ <TD>
+ <P>Macros run. No warning displayed.
+ </P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <P>Always</P>
+ </TD>
+ <TD>
+ <P>N/A</P>
+ </TD>
+ <TD>
+ <P>Yes</P>
+ </TD>
+ <TD>
+ <P>N/A</P>
+ </TD>
+ <TD>
+ <P>Warning displayed on document load. If "Run" button
+ clicked macros will run, otherwise they will not.</P>
+ </TD>
+ </TR>
+</TABLE>
+<P><BR><BR><A HREF="#top">Top</A></P>
+<H2><A NAME="Different_behaviour_in_the_Scripting"></A>Different
+behaviour in the Scripting Framework</H2>
+<P>The Script Security has one significant difference in behaviour to
+the StarBasic security. In the Scripting Framework the security
+warning dialogs are displayed only upon the first script invocation
+on a document containing scripts, unlike StarBasic where the dialogs
+are displayed on loading a document containing macros. <BR>If the
+settings are "Always", and "Show Warning Before
+Running", when loading a document containing macros the
+StarBasic dialog display is incorrect (the dialog displayed is more
+appropriate to the "According To Path List" setting). This
+has been logged as <A HREF="http://www.openoffice.org/issues/show_bug.cgi?id=11822">Issue
+11822</A>, the fix for which is not in the OpenOffice.org 1.1 beta
+release. Under the Scripting framework the correct dialog is
+displayed.<BR><BR><A HREF="#top">Top</A></P>
+<H2><A NAME="Troubleshooting"></A>Troubleshooting</H2>
+<P STYLE="margin-bottom: 0in">See the
+<A HREF="release-notes.html">Release Notes</A> page.
+</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.2/user-guide.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/whats-next.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/whats-next.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/whats-next.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/whats-next.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,44 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+ <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
+ <TITLE>What's Next</TITLE>
+ <META NAME="GENERATOR" CONTENT="StarOffice 6.1 Beta 1 (Solaris Sparc)">
+ <META NAME="CREATED" CONTENT="20030319;16220600">
+ <META NAME="CHANGED" CONTENT="20030319;16313000">
+</HEAD>
+<BODY LANG="en-US" DIR="LTR">
+<H1>Upcoming Features of the Office Scripting Framework</H1>
+<H2>StarBasic Integration</H2>
+<P>Currently the “Assign Script..” 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. It is hoped that in the future a
+StarBasic ScriptRuntime implementation can be developed so that
+StarBasic macros can be run via the Scripting Framework.
+</P>
+<H2>NetBeans Enhancements</H2>
+<P>The Office Scripting module for NetBeans will be enhanced to
+include the functionality (code completion for OpenOffice.org API)
+currently offered with the ODK.
+</P>
+<P>The Office Scripting module will take advantage of the new project
+metaphor being introduced with NetBeans 4.0 (see the <A HREF="http://projects.netbeans.org/architecture/dev_guide.html">NetBeans
+Projects System - Developers Guide</A> for more details)
+</P>
+<H2>Digital Signing Support</H2>
+<P>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 be enhanced to verify
+the digital signatures of scripts before they are executed.
+Appropriate configuration settings could be added so users can
+control script execution.</P>
+<H2>Common Packaging Format</H2>
+<P STYLE="margin-bottom: 0in">We will move to a common packaging
+format for UNO components, Office scripts, and StarBasic macros.
+</P>
+<HR>
+<P>Last Modified: Tue Mar 18 17:03:03 GMT 2003
+</P>
+</BODY>
+</HTML>
\ No newline at end of file
Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.2/whats-next.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/SFrameworkInstall.jar
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/SFrameworkInstall.jar?rev=1206297&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/SFrameworkInstall.jar
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/SmokeTest.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/SmokeTest.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/SmokeTest.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/SmokeTest.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,928 @@
+<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
+<html>
+<head>
+
+ <meta http-equiv="Content-Type"
+ content="text/html; charset=iso-8859-1">
+
+ <meta http-equiv="CONTENT-TYPE"
+ content="text/html; charset=iso-8859-1">
+
+ <meta name="GENERATOR"
+ content="Mozilla/4.79C-CCK-MCD [en] (X11; U; SunOS 5.8 sun4u) [Netscape]">
+
+ <meta name="AUTHOR" content="Robert.Kinsella@Sun.COM">
+
+ <meta name="CREATED" content="20010103;10350500">
+
+ <meta name="CHANGED" content="20021008;17390600">
+ <title>Smoke Test</title>
+
+ <style>
+ <!--
+ TD P { color: #000000 }
+ H1 { color: #3333dd }
+ P { color: #000000 }
+ H2 { color: #3333dd }
+ A:link { color: #ff0000 }
+ A:visited { color: #551a8b }
+ -->
+ </style>
+
+ <style>
+ <!--
+ H1 { color: #3333dd }
+ P { color: #000000 }
+ H2 { color: #3333dd }
+ A:link { color: #ff0000 }
+ A:visited { color: #551a8b }
+ -->
+ </style>
+
+ <style>
+ <!--
+ H1 { color: #3333dd }
+ P { color: #000000 }
+ H2 { color: #3333dd }
+ A:link { color: #ff0000 }
+ A:visited { color: #551a8b }
+ -->
+ </style>
+</head>
+ <body text="#000000" bgcolor="#ffffff" link="#ff0000" vlink="#551a8b"
+ lang="en-US">
+
+<table cols="1" width="100%" nosave="">
+ <tbody>
+ <tr nosave="">
+ <td nosave=""> </td>
+ </tr>
+ <tr nosave="">
+ <td nosave="">
+ <center><b><font color="#000000"><font size="+3">Smoke Tests for OpenOffice.org
+ Scripting FrameWork</font></font></b></center>
+ </td>
+ </tr>
+
+ </tbody>
+</table>
+
+<center>
+<table border="1" cellspacing="3" cellpadding="2" width="80%">
+ <caption> </caption> <tbody>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#README">README</a></font></td>
+ <td width="89%">Outline the order by which the installs of various components
+ must occur.</td>
+ </tr>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#install_01">Install_01</a></font></td>
+ <td width="89%"><font size="+0">Test the SFrameworkInstall.jar file when
+ deployed will present to the user options to allow a script to be bound to
+an event. </font> <br>
+ <font size="+0">Also test that scripting framework office.jar
+ file is successfully deployed to NetBeans. </font><br>
+ </td>
+ </tr>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#install_02">Install_02</a></font></td>
+ <td width="89%"><font size="+0">Test the SFrameworkInstall.jar
+will sense directory names longer than 8 characters. </font></td>
+ </tr>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#install_03">Install_03</a></font></td>
+ <td width="89%"><font size="+0">Test the SFrameworkInstall.jar
+will sense directory names which contain a space character. </font></td>
+ </tr>
+ <tr>
+ <td width="11%"><br>
+ </td>
+ <td width="89%"><br>
+ </td>
+ </tr>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#bindings_01">Bindings_01</a></font></td>
+ <td width="89%"><font size="+0">Test that the user can assign a deployed
+ script to a key. </font></td>
+ </tr>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#bindings_02">Bindings_02</a></font></td>
+ <td width="89%"><font size="+0">Test that the user can remove an
+ assigned key. </font></td>
+ </tr>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#bindings_03">Bindings_03</a></font></td>
+ <td width="89%"><font size="+0">Test that the user can assign a deployed
+ script to the File menu item. </font></td>
+ </tr>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#bindings_04">Bindings_04</a></font></td>
+ <td width="89%"><font size="+0">Test that the user can delete an assigned
+ File menu item. </font></td>
+ </tr>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#bindings_05">Bindings_05</a></font></td>
+ <td width="89%"><font color="#000000">Test that the user can execute
+a script stored in a document with a binding stored in the same document.</font></td>
+ </tr>
+ <tr>
+ <td><br>
+ </td>
+ <td><br>
+ </td>
+ </tr>
+ <tr>
+ <td width="11%"><font size="+0"><a href="#netbeans_01">NetBeans_01</a></font></td>
+ <td width="89%"><font color="#000000">Compile and deploy a java script
+to the application user area using NetBeans.</font></td>
+ </tr>
+ <tr>
+ <td><a href="#netbeans_02">NetBeans_02</a></td>
+ <td><font color="#000000">Compile and deploy a java script to a document
+ using NetBeans.</font></td>
+ </tr>
+ <tr>
+ <td><a href="#netbeans_03">NetBeans_03</a></td>
+ <td><font color="#000000">Delete a script deployed to a document
+ using NetBeans.</font></td>
+ </tr>
+ <tr>
+ <td valign="top"><a href="#netbeans_04">NetBeans_04</a><br>
+ </td>
+ <td valign="top">Generate and deploy a script using the command line
+ interface<br>
+ </td>
+ </tr>
+
+ </tbody>
+</table>
+ </center>
+
+<center>
+<h1 style="text-decoration: none;">
+<hr width="100%">
+<hr width="100%"></h1>
+ </center>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="README"></a><font
+ color="#000000">Test Case: README</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Outline the order by which the installs of various
+components must occur.</font> <br>
+
+<p style="margin-bottom: 0cm;"><font color="#000000"><b>Prerequisites</b>:-</font>
+ <br>
+ <font color="#000000">Download NetBeans 3.4 from http://www.netbeans.org.</font>
+ <br>
+ <font color="#000000">Download Scripting Framework from http://framework.openoffice.org/scripting/</font>
+ <br>
+ <font color="#000000">Download OpenOffice.org 1.1Beta or later from http://www.openoffice.org</font>
+ <br>
+ </p>
+
+<hr>
+<p style="text-decoration: none;"><b><font color="#000000">General Description:</font></b>
+ <br>
+ <font color="#000000">It is important that the following steps be executed
+ in order and before and other test cases.</font> </p>
+
+<p><font color="#000000">1. Install NetBeans</font> <br>
+ <font color="#000000">2. Start NetBeans, cd to the install-dir/bin
+and execute runide.sh for unix systems,</font> <br>
+ <font color="#000000">select runide.exe for windows. exit NetBeans.</font>
+ <br>
+ <font color="#000000">3. Install OpenOffice.org.</font> <br>
+ <font color="#000000">4. Copy the SFrameworkInstall.jar file
+ to the users home directory.</font> <br>
+ </p>
+
+<hr>
+<hr>
+<h1 style="text-decoration: none;" align="center"> </h1>
+
+<h1 style="text-decoration: none;"> <a name="install_01"></a><small><font
+ color="#000000">Test Case: install_01</font></small></h1>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Test the SFrameworkInstall.jar file when deployed
+will present to the user options to allow a script to be bound to an event.</font>
+ <br>
+ <font color="#000000">Also test that scripting framework office.jar
+ files is successfully deployed to NetBeans.</font>
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Requirements</font></b>
+ <br>
+ <font color="#000000"><a
+ href="file:///home/rk99157/Apachetest/OpenOffice/assertions/scripting/SmokeTest0.2.html#README">README
+ </a>is performed before running this test case.</font> <br>
+ </p>
+
+<hr>
+<p><b><font color="#000000">Description:</font></b> <br>
+ <font color="#000000">1. Copy the SFrameworkInstall.jar file to the user's
+ home directory.</font> <br>
+ <font color="#000000">2. Ensure OpenOffice.org is not running, also ensure
+ the quickstarters for windows and Linux are not running.</font> <br>
+ <font color="#000000">3. Execute java -jar SFrameworkInstall.jar</font>
+<br>
+ <font color="#000000">4. On the Scripting Framework Installer welcome screen
+ click next, the welcome screen should state the version of SFramework.jar.</font>
+ <br>
+ <font color="#000000">5. Select Install, in the dialog select Next.</font>
+ <br>
+ <font color="#000000">6. When Installation has completed, select Finish,
+the next dialog should prompt you that the installer has</font> <br>
+ <font color="#000000"> found a NetBeans installation,
+ select Next.</font> <br>
+ <font color="#000000">8. Select the IDE's for update, i.e. NetBeans, select
+ Next, Select Install, Select Finish<br>
+ 9. Manually check the NetBeans install directory <netbeans-install>/modules
+ for the following file:-</font> <br>
+ <b><font color="#000000">office.jar</font></b> <br>
+ <font color="#000000">10. Manually check that the SFrameworkInstall.log
+file was writter to the users home directory.</font> <br>
+ <font color="#000000">11. Start OpenOffice.org, select Tools, there should
+ be an entry - Scripting Add On's</font><br>
+ <font color="#000000">12. Select Tools, Scripting Add On's, Interactive
+Beanshell Scripting, An interactive beanshell editor window should be
+launched.</font> </p>
+
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Expected Result:</font></b>
+ <br>
+ <font color="#000000">All operations should complete successfully.</font>
+ </p>
+
+<p> </p>
+
+<center></center>
+ <br>
+
+<hr width="100%"> <br>
+ <br>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="install_02"></a><font
+ color="#000000">Test Case: install_02</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Test the SFrameworkInstall.jar will sense directory
+ names longer than 8 characters.</font>
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Requirements</font></b>
+ <br>
+ <font color="#000000"><a href="#README">README</a>is performed before running
+ this test case.</font> <br>
+ <font color="#000000">OpenOffice.org installation path directory has a
+name which is nine characters or more.</font> <br>
+ <font color="#000000">NetBeans installation path directory has a name which
+ is nine characters or more.</font> <br>
+ </p>
+
+<hr>
+<p><b><font color="#000000">Description:</font></b> <br>
+ <font color="#000000">1. Copy the SFrameworkInstall.jar file to the user's
+ home directory.</font> <br>
+ <font color="#000000">2. Ensure OpenOffice.org is not running, also ensure
+ the quickstarters for windows and Linux are not running.</font> <br>
+ <font color="#000000">3. Execute java -jar SFrameworkInstall.jar</font>
+<br>
+ <font color="#000000">4. On the Scripting Framework Installer welcome screen
+ click next.</font> <br>
+ <font color="#000000">5. Select Install, in the dialog select Next.</font>
+ <br>
+ <font color="#000000">6. When Installation has completed, select Finish,
+the next dialog should prompt you that the installer has</font> <br>
+ <font color="#000000"> a NetBeans installation, select
+ Next.</font> <br>
+ <font color="#000000">8. Select the IDE's for update, i.e. NetBeans, select
+ Next, Select Install, Select Finish.<br>
+ 9. Manually check the NetBeans install directory <netbeans-install>/modules
+ for the following file:-</font> <br>
+ <b><font color="#000000">office.jar.</font></b><br>
+ <font color="#000000">10. Start OpenOffice.org, select Tools, </font><font
+ color="#000000"> there should be an entry - Scripting Add On's</font><br>
+ <font color="#000000">11. Select Tools, Scripting Add On's, Interactive
+Beanshell Scripting, An interactive beanshell editor window should be
+launched.</font> <font color="#000000"></font> </p>
+
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Expected Result:</font></b>
+ <br>
+ <font color="#000000">All operations should complete successfully.</font></p>
+
+<hr> <br>
+ <br>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="install_03"></a><font
+ color="#000000">Test Case: install_03</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Test the SFrameworkInstall.jar will sense directory
+ names which contain a space character.</font>
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Requirements</font></b>
+ <br>
+ <font color="#000000"><a href="#README">README </a>is performed before
+running this test case.</font> <br>
+ <font color="#000000">OpenOffice.org installation path directory has a
+name which contains a space character.</font> <br>
+ <font color="#000000">NetBeans installation path directory has a name which
+ contains a space character.</font> <br>
+ </p>
+
+<hr>
+<p><b><font color="#000000">Description:</font></b> <br>
+ <font color="#000000">1. Copy the SFrameworkInstall.jar file to the user's
+ home directory.</font> <br>
+ <font color="#000000">2. Ensure OpenOffice.org is not running, also ensure
+ the quickstarters for windows and Linux are not running.</font> <br>
+ <font color="#000000">3. Execute java -jar SFrameworkInstall.jar</font>
+<br>
+ <font color="#000000">4. On the Scripting Framework Installer welcome screen
+ click next.</font> <br>
+ <font color="#000000">5. Select Install, in the dialog select Next.</font>
+ <br>
+ <font color="#000000">6. When Installation has completed, select Finish,
+the next dialog should prompt you that the installer has</font> <br>
+ <font color="#000000"> a NetBeans installation, select
+ Next.</font> <br>
+ <font color="#000000">8. Select the IDE's for update, i.e. NetBeans, select
+ Next, Select Install, Select Finish<br>
+ 9. Manually check the NetBeans install directory <netbeans-install>/modules
+ for the following file:-</font> <br>
+ <b><font color="#000000">office.jar</font></b><br>
+ <font color="#000000">10. Start OpenOffice.org, select Tools, </font><font
+ color="#000000"> there should be an entry - Scripting Add On's</font><br>
+ <font color="#000000">11. Select Tools, Scripting Add On's Interactive
+Beanshell Scripting, An interactive beanshell editor window should
+be launched.</font> <font color="#000000"></font> </p>
+
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Expected Result:</font></b>
+ <br>
+ <font color="#000000">All operations should complete successfully.</font>
+ <br>
+ </p>
+
+<hr>
+<hr> <br>
+
+<center></center>
+ <br>
+ <br>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="bindings_01"></a><font
+ color="#000000">Test Case: bindings_01</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Test that the user can assign a deployed script to
+ an key.</font> <br>
+
+<p style="margin-bottom: 0cm;"><font color="#000000">Prerequisites:-</font>
+ <br>
+ <font color="#000000"><a href="#install_01">install_01 </a>is executed
+before running this test case.</font> <br>
+ </p>
+
+<hr>
+<p style="text-decoration: none;"><b><font color="#000000">Description:</font></b>
+ <br>
+ <font color="#000000">1. Start OpenOffice.org writer document.</font>
+ <br>
+ <font color="#000000">2. Select Tools - Script Add On's, Assign Script
+to Key.</font><br>
+ <font color="#000000">3. In the popup dialog,</font> <br>
+ <font color="#000000"> in the select script function
+ select <br>
+ Location- User<br>
+ Language- Java<br>
+ Script - HighlightText.showForm</font> <br>
+ <font color="#000000"> Select Key Group SHIFT +
+CONTROL +F keys.</font> <br>
+ <font color="#000000"> Select ShortcutKey SHIFT + CONTROL
+ + F3.</font> <br>
+ <font color="#000000"> SelectAssign Key.</font> <br>
+ <font color="#000000">4. The Key should now be assigned to HighlightText.showForm.
+ Select OK.</font> <br>
+ <font color="#000000">5. </font><font color="#000000">Select Shift - Control
+ - F3. The Highlight Text box dialog should be displayed.</font> <br>
+ <font color="#000000">6. Select Tools - </font><font color="#000000">Script
+ Add On's - Assign Script to Key.</font><font color="#000000"> <br>
+ SHIFT-CONTROL-F3 should be listed as assigned to HighlightText.showForm.
+Close the Assign Script to Key dialog</font>.<br>
+ <font color="#000000">9. Select Tools - Configure, select the Keyboard
+option, ensure that writer is selected in the top right corner.</font> <br>
+ <font color="#000000">In the shortcut keys scroll to Ctrl+Shift+F3, this
+ should show that it is assigned to [script://HighlightText.showForm].</font>
+ <br>
+ <font color="#000000">10. Close the Configuration dialog.</font> <br>
+ <br>
+ </p>
+
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Expected Result:</font></b>
+ <br>
+ <font color="#000000">All operations should complete successfully.</font>
+ <br>
+ </p>
+ <br>
+
+<hr> <br>
+ <br>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="bindings_02"></a><font
+ color="#000000">Test Case: bindings_02</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Test that the user can remove an assigned key.</font>
+ <br>
+
+<p style="margin-bottom: 0cm;"><font color="#000000">Prerequisites:-</font>
+ <br>
+ <font color="#000000"><a href="#bindings_01">bindings_01 </a>is executed
+before running this test case.</font> <br>
+ </p>
+
+<hr>
+<p style="text-decoration: none;"><b><font color="#000000">Description:</font></b>
+ <br>
+ <font color="#000000">1. Start OpenOffice.org writer document.</font>
+ <br>
+ <font color="#000000">2. Select Tools - </font><font color="#000000">Script
+ Add On's - Assign Script to Key.</font><br>
+ <font color="#000000">3. In the popup dialog,</font> <br>
+ <font color="#000000"> Select Key Group SHIFT +
+CONTROL +F keys.</font> <br>
+ <font color="#000000"> Select ShortcutKey SHIFT + CONTROL
+ + F3.</font> <br>
+ <font color="#000000"> Select Delete Script Key.</font>
+ <br>
+ <font color="#000000">4. The Key should not be assigned to anything. Select
+ OK.</font> <br>
+ <font color="#000000">6. Select Shift - Control - F3. The Highlight Text
+ box dialog should be not displayed.</font> <br>
+ <font color="#000000">7. Select Tools -</font><font color="#000000">Script
+ Add On's - Assign Script to Key</font><font color="#000000"> , <br>
+ Key, SHIFT-CONTROL-F3 should not be listed as assigned to anything. Close
+ the Assign Script (Java) to Key dialog</font> <br>
+ <font color="#000000">8. Select Tools - Configure, select the Keyboard
+option, ensure that writer is selected in the top right corner.</font> <br>
+ <font color="#000000">In the shortcut keys scroll to Ctrl+Shift+F3, this
+ should show that it is not assigned to anything</font> <br>
+ <font color="#000000">9. Close the Configuration dialog.</font> <br>
+ <br>
+ </p>
+
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Expected Result:</font></b>
+ <br>
+ <font color="#000000">All operations should complete successfully.</font>
+ <br>
+ </p>
+
+<hr> <br>
+ <br>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="bindings_03"></a><font
+ color="#000000">Test Case: bindings_03</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Test that the user can assign a deployed script to
+ the File menu item.</font> <br>
+
+<p style="margin-bottom: 0cm;"><font color="#000000">Prerequisites:-</font>
+ <br>
+ <font color="#000000"><a href="#install_01">install_01 </a>is executed
+before running this test case</font> <br>
+ </p>
+
+<hr>
+<p style="text-decoration: none;"><b><font color="#000000">Description:</font></b>
+ <br>
+ <font color="#000000">1. Start OpenOffice.org writer document.</font>
+ <br>
+ <font color="#000000">2. Select Tools, Scripting Add On's, Assign Script
+ to Menu.</font><br>
+ <font color="#000000">3. In the popup dialog,</font> select<br>
+ Location - User<br>
+ Language - Java<br>
+ Script - <font color="#000000"> HighlightText.showForm</font><br>
+ <font color="#000000"> Select File in the Top Level menu drop
+ down list.</font> <br>
+ <font color="#000000"> In the New Menu dialog box , enter
+ a menu item name e.g. menuhighlight.</font> <br>
+ <font color="#000000"> Select New, select ok.</font>
+<font color="#000000"><br>
+ 4. Select File, menuhighlight - a highlight text box should appear.</font>
+ <br>
+ <br>
+ </p>
+
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Expected Result:</font></b>
+ <br>
+ <font color="#000000">All operations should complete successfully.</font>
+ <br>
+ </p>
+
+<hr> <br>
+ <br>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="bindings_04"></a><font
+ color="#000000">Test Case: bindings_04</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Test that the user can delete an assigned File menu
+ item.</font> <br>
+
+<p style="margin-bottom: 0cm;"><font color="#000000">Prerequisites:-</font>
+ <br>
+ <font color="#000000"><a href="#bindings_03">bindings_03</a> is
+ executed before running this test case</font> <br>
+ </p>
+
+<hr>
+<p style="text-decoration: none;"><b><font color="#000000">Description:</font></b>
+ <br>
+ <font color="#000000">1. Start OpenOffice.org writer document.</font>
+ <br>
+ <font color="#000000">2. </font><font color="#000000">Select Tools, Scripting
+ Add On's, Assign Script to Menu.</font><br>
+ <font color="#000000">3. In the popup dialog,</font> <br>
+ <font color="#000000"> Select File in the Top Level menu
+ drop down list.</font> <br>
+ <font color="#000000"> In the Sub Menu, select menuhighlight
+ [ HighlightText.ShowForm]</font> <br>
+ <font color="#000000"> Select Delete Script Menu. Select
+ OK.</font> <br>
+ <font color="#000000">4. Select File, there should now be no menu option
+menuhighlight.</font> <br>
+ <br>
+ </p>
+
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Expected Result:</font></b>
+ <br>
+ <font color="#000000">All operations should complete successfully.</font>
+ <br>
+ </p>
+
+<hr> <br>
+ <br>
+
+<center>
+<h1> <a name="bindings_05"></a><font color="#000000">Test Case: bindings_05</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Test that the user can execute a script stored
+ in a document with a binding stored in the same document.</font> <br>
+
+<p style="margin-bottom: 0cm;"><font color="#000000">Prerequisites:-</font>
+ <br>
+ <font color="#000000"> <a href="#install_01">install_01 </a>is executed
+ before running this test case.</font> <br>
+ </p>
+
+<hr>
+<p style="text-decoration: none;"><b><font color="#000000">Description:</font></b>
+ <br>
+ <font color="#000000">1. Start OpenOffice.org.</font> <br>
+ <font color="#000000">2. Select File - Open, navigate to <OpenOffice.org-install-dir>/user/Scripts/java/MemoryUsage.</font>
+ <br>
+ <font color="#000000">3. Open file ExampleSpreadSheet.sxc, a spreadsheet
+document with a pie chart should be opened</font> <br>
+ <font color="#000000">4. Press ctrl-shift-m, the user is warned that they
+ are about to execute a sctipt.</font> <br>
+ <font color="#000000">Do you want to execute this script.</font> <br>
+ <font color="#000000">5. Select Yes.</font> <br>
+ <font color="#000000">6. The chart updates with JVM memory usage statistics.</font>
+ <br>
+ <font color="#000000">7. Repeat steps 4-6 again.</font> <br>
+ <br>
+ </p>
+
+<p style="margin-bottom: 0cm;"><b><font color="#000000">Expected Result:</font></b>
+ </p>
+
+<div style="margin-bottom: 0cm;"><font color="#000000"><font size="+0">All
+ operations should complete successfully.</font></font></div>
+
+<center>
+<h1 style="text-decoration: none;">
+<hr width="100%">
+<hr width="100%"></h1>
+ </center>
+
+<center>
+<h1 style="text-decoration: none;"><br>
+ </h1>
+ <br>
+ <br>
+ </center>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="netbeans_01"></a><font
+ color="#000000">Test Case: netbeans_01</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Compile and deploy a java script to the application
+ user area using NetBeans.</font>
+<p><b><font color="#000000">Prerequisits</font></b> <br>
+ <font color="#000000"><a href="#install_01">install_01 </a>is executed
+before running this test case.</font> <br>
+ <a
+ href="http://framework.openoffice.org/scripting/release-0.2/netbeans-devguide.html#prerequisites">http://framework.openoffice.org/scripting/release-0.2/netbeans-devguide.html#prerequisites</a><br>
+ </p>
+
+<hr>
+<p style="text-decoration: none;"><b><font color="#000000">Description:</font></b>
+ <br>
+ </p>
+
+<ol start="2">
+ <font color="#000000">1. Create an examples directory e.g. HelloNetBeans.#</font>
+ <br>
+ <font color="#000000">Start NetBeans.</font>
+ <p><font color="#000000">2. Mount the examples directories</font> <br>
+ <font color="#000000">
+Select the File->Mount Filesystem menu item</font> <br>
+ <font color="#000000">
+In the Choose Filesystem Type window select Local Directory and click Next</font>
+ <br>
+ <font color="#000000">
+Mount the examples directory you created i.e. HelloNetBeans.</font> <br>
+ <font color="#000000">
+Select Finish.</font> </p>
+
+ <p><font color="#000000">3. Create a new script parcel</font>
+ <br>
+ <font color="#000000">
+Right click on your mounted examples directory.</font> <br>
+ <font color="#000000">
+Select New->Office Scripting->Parcel Recipe</font> <br>
+ <font color="#000000">
+In the New Wizard window that appears, enter the name you wish to call your
+ new parcel e.g HelloNetBeans.</font> <br>
+ <font color="#000000">
+Select Finish.</font> </p>
+
+ <p><font color="#000000">4. Click on the Contents-Empty file</font>
+ <br>
+ <font color="#000000">-Change the name of 'public class Empty' to 'public
+ class HelloNetBeans'</font> <br>
+ <font color="#000000">-Remove the package declaration 'package HelloNetBeans.Contents;'
+ at the top of the file</font> <br>
+ <font color="#000000">-Add the following lines to the top of the script
+ immediately after the first import statement</font> </p>
+
+ <p><font color="#000000">import com.sun.star.uno.UnoRuntime;</font> <br>
+ <font color="#000000">import com.sun.star.frame.XModel;</font> <br>
+ <font color="#000000">import com.sun.star.text.*;</font> <br>
+ </p>
+
+ <p><font color="#000000">5. Add the following lines to the public
+ method doMethod in the </font>HelloNetBeans class. </p>
+
+ <p><font color="#000000">XModel model = xSc.getDocument();</font> <br>
+ <font color="#000000"> XTextDocument textdoc = (XTextDocument)</font>
+ <br>
+ <font color="#000000">
+ UnoRuntime.queryInterface(XTextDocument.class, model);</font> <br>
+ <font color="#000000"> XText oText = textdoc.getText();</font> <br>
+ <font color="#000000"> XTextCursor oCursor = oText.createTextCursor();</font>
+ <br>
+ <font color="#000000"> oText.insertString(oCursor, "Hello NetBeans",
+ false);</font> </p>
+
+ <p><font color="#000000">6. Right click on the HelloNetBeans in the right
+ frame and select save.</font> </p>
+
+ <p><font color="#000000">7. Right click on the HelloNetBeans
+ directory and select compile. You should note that</font> <br>
+ <font color="#000000">the compile completes successfully from the lower
+ right hand frame (output window) of NetBeans.</font> </p>
+
+ <p><font color="#000000">8. Right click on the HelloNetBeans directory
+ and select build,</font> <br>
+ <font color="#000000">In the dialog which appears select the HelloNetBeans.doMethod
+ and add to scripts , select OK.</font> <br>
+ <font color="#000000">A HelloNetBeans parcel file should be built.</font>
+ </p>
+
+ <p><font color="#000000">9. Right click on the Hello NetBeans parcel file
+ and select Deploy to OpenOffice.org, user.</font> </p>
+
+ <p><font color="#000000">10. Check that the files have been successfully
+ deployed to <office-install>/user/Scripts/java.</font> </p>
+
+ <p><font color="#000000">11. Assign an event to execute the script.</font>
+ <br>
+ <font color="#000000">- Start OpenOffice.org writer document.</font>
+ <br>
+ <font color="#000000">- Select Tools, </font><font color="#000000">Scripting
+ Add On's, Assign Script to Menu.</font><br>
+ <font color="#000000">- In the popup dialog,</font> select<br>
+ Location - user<br>
+ Language - Java<br>
+ Script HelloNetBeans.doMethod<br>
+ <font color="#000000"> Select File in the Top Level menu
+drop down list.</font> <br>
+ <font color="#000000"> In the New Menu, enter a menu item name
+e.g. HelloNetBeans.</font> <br>
+ <font color="#000000"> Select New, select ok.</font> <br>
+ <font color="#000000">- Select File, HelloNetBeans - Hello NetBeans should
+ be inserted into the document.</font></p>
+
+</ol>
+ <b><font color="#000000">Expected Result:</font></b> <br>
+
+<p><font color="#000000">All operations should complete successfully.</font>
+ <br>
+ </p>
+
+<hr> <br>
+ <br>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="netbeans_02"></a><font
+ color="#000000">Test Case: netbeans_02</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Compile and deploy a java script to a document
+ using NetBeans.</font>
+<p><b><font color="#000000">Prerequisites</font></b> <br>
+ <font color="#000000"><a href="#netbeans_01">netbeans_01</a> is executed
+before running this test case.</font> <br>
+ Delete directory <office-install>/user/Scripts/java/HelloNetBeans.
+<br>
+ A previously created OpenOffice.org writer document, e.g. TestBindNB.sxw
+<br>
+ </p>
+
+<hr> <br>
+
+<p>1. Start NetBeans <br>
+ <font color="#000000"> Right click on the HelloNetBeans in the right
+ frame and select the previously opened HelloNetBeans.java file.</font> <br>
+ <font color="#000000">Change the "Hello NetBeans" line to "Hello NetBeans
+ 2 ----"</font> <br>
+ <font color="#000000">Select File Save.</font> </p>
+
+<p><font color="#000000">2. Right click on the HelloNetBeans
+ directory and select compile. You should note that</font> <br>
+ <font color="#000000">the compile completes successfully from the lower
+right hand frame (output window) of NetBeans.</font> </p>
+
+<p><font color="#000000">3. Right click on the HelloNetBeans directory
+ and select build,</font> <br>
+ <font color="#000000">In the dialog which appears select the HelloNetBeans.doMethod
+ and add to scripts , select OK.</font> <br>
+ <font color="#000000">A HelloNetBeans parcel file should be built.</font>
+ </p>
+
+<p><font color="#000000">4. Right click on the Hello NetBeans parcel file
+ and select Deploy to Office Document, select the previously saved</font>
+<font color="#000000">test document i.e. </font>TestBindNB.sxw<font
+ color="#000000">. A warning dialog should warn the user that the douemnt
+ should not already be opened in OpenOffice.org. If the document is opened,
+ close it and select ok.</font> </p>
+
+<p><font color="#000000">5. Check that the script has been successfully deployed
+ to the document by running unzip -l </font>TestBindNB.sxw<font
+ color="#000000">. (Unix) or pkunzip -v </font>TestBindNB.sxw <font
+ color="#000000">(Windows). You should see the script saved in the document.</font>
+ </p>
+
+<p><font color="#000000">6. Assign an event to execute the script.</font>
+ <br>
+ <font color="#000000">- Open the TestBindNB.sxw test document.</font> <br>
+ <font color="#000000">- Select Tools, </font><font
+ color="#000000">Scripting Add On's, Assign Script to Menu.</font> <br>
+ <font color="#000000">- In the popup dialog,</font> select<br>
+ <font color="#000000"> Location - Document,<br>
+ Language - Java,<br>
+ Script- HelloNetBeans.doMethod</font> <br>
+ <font color="#000000"> Select File in the Top Level menu drop
+ down list.</font> <br>
+ <font color="#000000"> In the New Menu, enter a menu item name
+ e.g. HelloNetBeans.</font> <br>
+ <font color="#000000"> Select New, select ok.</font> <br>
+ <br>
+ <font color="#000000">- Select File, HelloNetBeans - Hello NetBeans 2 ----
+ should be inserted into the document.</font> <br>
+ </p>
+
+<p> </p>
+
+<hr> <br>
+ <br>
+
+<center>
+<h1 style="text-decoration: none;"> <a name="netbeans_03"></a><font
+ color="#000000">Test Case: netbeans_03</font></h1>
+ </center>
+
+<h2 style="text-decoration: none;"> <font color="#000000">Test Area: Solaris
+ - Linux - Windows</font></h2>
+ <b><font color="#000000">Test Aim</font></b> <br>
+ <font color="#000000">Delete a script deployed to a document
+using NetBeans.</font>
+<p><b><font color="#000000">Prerequisits</font></b> <br>
+ <font color="#000000"><a href="#netbeans_02">netbeans_02</a> is executed
+before running this test case.</font> <br>
+ </p>
+
+<hr>
+<p>1. Start NetBeans. <br>
+ Mount the file system where <font color="#000000"> </font>TestBindNB.sxw<font
+ color="#000000">. is stored. If TestBindNB.sxw is opened in OpenOffice.org,
+ close it.</font> </p>
+
+<p><font color="#000000">2. Expand the file TestBindNB.sxw file . Right click
+ on the PARCEL_FILE and select Delete.</font> </p>
+
+<p><font color="#000000">3. The Script saved in the office document TestBindNB.sxw
+ should now be deleted.</font> </p>
+
+<p><font color="#000000">4. Check that it is deleted by running unzip -l </font>TestBindNB.sxw<font
+ color="#000000">. (Unix) or pkunzip -v </font>TestBindNB.sxw <font
+ color="#000000">(Windows). You should see that the previously saved
+script in the document is now gone.</font> </p>
+
+<p> </p>
+
+<hr> <br>
+
+<div align="center"> <b><big></big></b>
+<h1 style="text-decoration: none;"> <a name="netbeans_04"></a><font
+ color="#000000"><b><big><big><big>Test Case : netbeans_04</big></big></big></b></font><br>
+ </h1>
+ </div>
+ <br>
+ <br>
+ <b>Test Aim</b><br>
+ Generate and deploy a script using the command line interface.<br>
+ <br>
+ <b>Prerequisits</b><br>
+ <a href="#netbeans_03">netbeans_03</a> is executed before running this
+test case.<br>
+<a
+ href="http://framework.openoffice.org/scripting/release-0.2/commandline-devguide.html#prereqs">http://framework.openoffice.org/scripting/release-0.2/commandline-devguide.html#prereqs</a><br>
+ Set the users CLASSPATH to include <br>
+ <netbeans-install-dir>/modules.jar<br>
+ all jar files <office-install-dir>/program/classes/ directory.<br>
+ all jar files in the xerces installation path directory.<br>
+ <br>
+ 1. Create a new examples directory, e.g. examplesCLI. Create a Contents
+directory in examplesCLI.<br>
+ 2. Copy the <font color="#000000">HelloNetBeans.java </font>and <font
+ color="#000000">HelloNetBeans.class path from the examples directory (HelloNetBeans)
+ previously </font>generated in netbeans_02 to the newly created Contents
+directory in examplesCLI.<br>
+ 3. Enter the command 'java CommandLineTools -g examplesCLI -l Java'.<br>
+ You should be prompted that a examplesCLI.sxp file has been generated.<br>
+ 4. Enter the command 'java CommandLineTools -d <absolute path>/examplesCLI.sxp
+ <office-install-dir/share/Scripts.<br>
+ 5. Start OpenOffice.org, Select Tools, Scripting Add On's, Assign Script
+ to Menu.<br>
+ Select,<br>
+ Location - Share<br>
+ Language - Java<br>
+ Script - HelloNetBeans.doMethod<br>
+ <br>
+ Create a binding to the File menu, and execute it. HelloNetBeans 2 ----
+should be entered in the text document.<br>
+ <br>
+ <br>
+ <br>
+ <br>
+</body>
+</html>
Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/SmokeTest.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/assign-event.gif
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/assign-event.gif?rev=1206297&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/assign-event.gif
------------------------------------------------------------------------------
svn:mime-type = image/gif
Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/assign-menu.gif
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/assign-menu.gif?rev=1206297&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/assign-menu.gif
------------------------------------------------------------------------------
svn:mime-type = image/gif
Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/beanshell.gif
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/beanshell.gif?rev=1206297&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/beanshell.gif
------------------------------------------------------------------------------
svn:mime-type = image/gif
Added: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/build-guide.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/build-guide.html?rev=1206297&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/build-guide.html (added)
+++ incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/build-guide.html Fri Nov 25 20:00:55 2011
@@ -0,0 +1,573 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+ <meta http-equiv="CONTENT-TYPE"
+ content="text/html; charset=iso-8859-1">
+ <title></title>
+ <meta name="GENERATOR" content="StarOffice 6.1 Beta 1 (Solaris Sparc)">
+ <meta name="CREATED" content="20030318;15201604">
+ <meta name="CHANGED" content="20030319;14323000">
+ <style>
+ <!--
+ @page { margin-left: 1.25in; margin-right: 1.25in; margin-top: 1in; margin-bottom: 1in }
+ -->
+ </style>
+</head>
+<body lang="en-US" dir="ltr">
+<h1><a
+ name="Building the Scripting Framework for OpenOffice.org|outline"></a>
+Building the Scripting Framework for OpenOffice.org</h1>
+<h2>Contents</h2>
+<ul>
+ <li>
+ <p style="margin-bottom: 0in;">Building Scripting Framework </p>
+ <ul>
+ <li>
+ <p style="margin-bottom: 0in;"><a href="#Pre-requisites">Pre-requisites</a>
+ </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><a href="#projects">Projects
+& Modifications</a> </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><a
+ href="#Building%20the%20Scripting%20Framework%20for%20OpenOffice.org%7Coutline">Building
+ </a> </p>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;">Installation </p>
+ <ul>
+ <li>
+ <p style="margin-bottom: 0in;"><a href="#autoinstaller">Building
+Automated Installer</a></p>
+ </li>
+ <li>
+ <p><a href="#install">Manual install</a> </p>
+ </li>
+ </ul>
+ </li>
+</ul>
+<h2><a name="Pre-requisites"></a>Pre-requisites</h2>
+<ul>
+ <li>
+ <p style="margin-bottom: 0in;">JDK1.3 or greater </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;">ANT which is available from <a
+ href="http://ant.apache.org/bindownload.cgi">http://ant.apache.org/bindownload.cgi</a>
+ </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;">Full OO1.1rc or later solver and
+installation set </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;">OO1.1beta or later OpenOffice build
+environment</p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;">bsh-1.2b7.jar available from <a
+ href="http://www.beanshell.org/download.html">http://www.beanshell.org/download.html</a></p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;">NetBeans IDE - this is currently
+needed for the build (unless you modify one of the makefiles. It is
+intended to develop a makefile that will detect the presence or absence
+of the NetBeans IDEand react accordingly) </p>
+ <ul>
+ <li>
+ <p><a href="http://www.netbeans.org/ide/download.html">NetBeans
+3.4</a></p>
+ </li>
+ </ul>
+ </li>
+</ul>
+<h3>Setting up build environment </h3>
+<p>If you have not configured your environment with Java and Ant,
+please re-run the configure script from the <tt>config_office</tt>
+project including the options <tt>--with-jdk-home=<JAVA_HOME>
+ --with-ant-home=<ANT_HOME></tt> and source or run the
+environment set-up script. See the <a
+ href="http://tools.openoffice.org/">Tools</a>
+project homepage for details. </p>
+<p>If configure can not find Ant, after you have sourced or run the
+environment set-up script, you may need to add all jarfiles
+under <tt><ANT_HOME>/lib</tt> to your <tt>$CLASSPATH</tt>.</p>
+<h2><a name="projects"></a>Making Scripting Framework Services and
+Interfaces available</h2>
+<p>If you only have solvers, you will need to checkout the following
+modules on a tag that is appropriate to the release you are building
+for (eg. <tt>OO1.1beta</tt>) </p>
+<ul>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>unoil</tt> </p>
+ </li>
+ <li>
+ <p><tt>offapi</tt> </p>
+ </li>
+</ul>
+<p>The Scripting Framework is work-in-progress. For this reason it is
+not included in the main OpenOffice build & install set. Thus, at
+this moment it is necessary to make several patches to the sources
+&
+build a separate install set for the Scripting Framework. It is
+intended that at some point in the future the Scripting Framework
+will be integrated into OpenOffice. Since we will be modifying these
+projects, it is a good idea to backup your unoil and offapi modules
+and then checkout the following with the tag <tt>SF-OO644_ED02_1</tt></p>
+<ul>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>scripting</tt> </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>unoil/drafts/com/sun/star/script/framework
+(drafts/com/sun/star/script/framework,</tt>needs to be in the <tt>unoil
+ </tt> module) </p>
+ </li>
+ <li>
+ <p><tt>offapi/drafts/com/sun/star/script/framework (drafts/com/sun/star/script/framework,</tt>needs
+to be in the <tt>offapi</tt> module) </p>
+ </li>
+</ul>
+<p>You will need to modify the offapi and unoil modules so that the
+services and interfaces for scripting are available. </p>
+<h3><tt>offapi</tt> module</h3>
+<ol>
+ <li>
+ <p style="margin-bottom: 0in;">Ensure that you have the
+drafts/com/sun/star/script/framework directory under the offapi module,
+if you don't, you will need to check it out from CVS with the tag <font
+ face="Cumberland">SF-OO644_ED02_1</font></p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;">Modify the <tt>prj/build.lst</tt>,
+you will need to add the following lines </p>
+ <ul>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>oa offapi\drafts\com\sun\star\script\framework\runtime nmake - all oa_scriptfruntime_drafts NULL</tt></p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>oa offapi\drafts\com\sun\star\script\framework\security nmake - all oa_sfsecurity_drafts
+NULL</tt> </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>oa offapi\drafts\com\sun\star\script\framework\provider nmake - all oa_sfprovider_drafts NULL</tt>
+ </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>oa offapi\drafts\com\sun\star\script\framework\storage nmake - all oa_sfstorage_drafts NULL</tt>
+ </p>
+ </li>
+ </ul>
+ <p style="margin-bottom: 0in;"><b>and add</b> "<font
+ face="Cumberland">oa_scriptfruntime_draft</font><tt><font
+ face="Cumberland">s oa_sfsecurity_drafts oa_sfprovider_drafts oa_sfstorage_drafts</font></tt>"
+to the last line before "<tt>NULL</tt>" </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;">Modify the <tt>prj/d.lst</tt>, you
+will need to add the following line <br>
+ <tt>..\%__SRC%\ucr\ScriptFramework.rdb %_DEST%\bin%_EXT%\ScriptFramework.rdb</tt>
+ <b>after</b> the line: <br>
+ <tt>..\%__SRC%\ucr\offapi.db %_DEST%\bin%_EXT%\offapi.rdb</tt>
+ </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;">Modify the <tt>util/makefile.mk</tt>
+and add the following to UNOIDLDBFILES list </p>
+ <ul>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>$(UCR)$/dcssscriptfruntime.db \</tt>
+ </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>$(UCR)$/dcsssfprovider.db \</tt>
+ </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>$(UCR)$/dcsssfsecurity.db \</tt>
+ </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>$(UCR)$/dcsssfstorage.db</tt>
+ </p>
+ </li>
+ </ul>
+ </li>
+ <li>Modify the <tt>util/makefile.mk</tt> and add the following line
+to the target <tt>$(UCR)$/types.db</tt><br>
+ <tt>+$(REGMERGE) $(UCR)$/ScriptFramework.rdb /
+$(UCR)$/dcssscriptfruntime.db $(UCR)$/dcsssfprovider.db
+$(UCR)$/dcsssfsecurity.db $(UCR)$/dcsssfstorage.db
+ </tt> </li>
+</ol>
+<h3><tt>unoil</tt> module</h3>
+<ol>
+ <li>
+ <p style="margin-bottom: 0in;">Modify <tt>prj/build.lst</tt> </p>
+ <ul>
+ <li>
+ <p style="margin-bottom: 0in;">Add <tt>ul_scriptf_drafts</tt>
+to the last line before <tt>NULL</tt> </p>
+ </li>
+ <li>
+ <p style="margin-bottom: 0in;"><tt>The line should now look
+something like this <br>
+ul unoil\drafts\com\sun\star\script\framework nmake - all ul_scriptf_drafts ul_ucb ul_frame ul_ucb NULL</tt>
+ </p>
+ </li>
+ </ul>
+ </li>
+</ol>
+<h2>Building the Scripting Framework module </h2>
+<h3><tt>scripting</tt> module</h3>
+<ol>
+ <li>
+ <p>Modify j<font face="Cumberland">ava/build.env</font> to point to
+the point to <font face="Thorndale">beanshell </font><font
+ face="Cumberland">bsh-1.2b7.jar</font>, ( see install.dir entry in
+build.env ) </p>
+ </li>
+ <li>
+ <p>Assuming you have NetBeans installed, modify the <tt>java/build.env</tt>
+to point at the NetBeans installation (see the openide.class.path entry
+in the build.xml for more details). </p>
+ </li>
+ <li>
+ <p>Alternatively, if you do not wish to build the add-in, delete
+the following entries from the depends section of the target "all" in
+the build.xml </p>
+ <ul>
+ <li>
+ <p>No NetBeans add-in </p>
+ <ul>
+ <li>
+ <p>localoffice.jar </p>
+ </li>
+ <li>
+ <p>netbeans.jar </p>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+</ol>
+<h3>Building</h3>
+<ol>
+ <li>
+ <p>Execute <tt>build</tt> and <font face="Cumberland">deliver</font>
+in the <tt>offapi</tt> module </p>
+ </li>
+ <li>
+ <p>Execute <tt>build and <font face="Cumberland">deliver</font> </tt>in
+the <tt>unoil</tt> module </p>
+ </li>
+ <li>
+ <p>Execute <tt>build</tt> in the <tt>scripting</tt> module </p>
+ </li>
+</ol>
+<h2><a name="autoinstaller"></a>Automated Installer</h2>
+<p>In <tt>scripting/workben</tt> there is an ANT build.xml file for
+compiling the examples installer, creating the UNO package, and
+creating a Jar file for an automated install. Running <tt>dmake</tt>
+in the <tt>scripting/workben</tt> directory should result in the
+creation of the <tt>SFrameworkInstall.jar</tt> in the <tt></tt>
+directory under the output directory appriate for your platform (eg.
+wntmsci9.pro).</p>
+<h2><a name="install"></a>Manual Installation of the Scripting
+Framework</h2>
+<p>The use of the automated installer, written in Java, is
+recommended, unless you're on a platform other than Solaris/SPARC,
+Linux/x86, Windows! It is recommended that even on such a platform
+that every effort should be made to get the installer to work. If
+this isn't possible the following is the set of steps needed to
+manually install the framework. The first stage in the manual
+installation is to build the <a
+ href="http://api.openoffice.org/DevelopersGuide/DevelopersGuide.html">UNO
+package</a> containing the libraries & Jar files. </p>
+<ol>
+ <li>
+ <p>Create a two directories (<tt>$pkgsf</tt>) for scripting
+framework and (<tt>$pkgbs</tt>) from beanshell support. </p>
+ </li>
+ <li>
+ <p>Create directories called <tt>$pkgsf/<PLATFORM>.plt </tt>and
+ <tt><font face="Cumberland">$pkgsf/skip_registration</font></tt>
+(Where <tt><PLATFORM></tt> is like linux_x86)<br>
+NOTE: A list of supported directories is available in the source file
+desktop/source/pkgchk/pkgchk_packages.cxx, you may need to modify this,
+if your platform is not supported </p>
+ </li>
+ <li>
+ <p>Copy in the libraries from <tt>scripting/<platform>/lib </tt>to
+ <tt><font face="Cumberland">$pkgsf/<PLATFORM>.plt</font></tt>
+ </p>
+ </li>
+ <li>
+ <p>Copy in <tt>ScriptRuntimeForJava.jar</tt> from <tt>scripting/<platform>/class</tt>
+into the top level directory, <tt>$pkgsf</tt> </p>
+ </li>
+ <li>
+ <p>Copy in <tt>unoil.jar </tt>from <tt><font face="Cumberland">$pkgsf/unoil/<platform>/class</font>
+ </tt>to <font face="Cumberland">$pkgsf/</font><tt><font
+ face="Cumberland">skip_registration</font></tt> directory</p>
+ </li>
+ <li>
+ <p>Copy <font face="Cumberland">ScriptRuntimeForBeanShell.jar</font>
+from <font face="Cumberland">scripting/<platform>/class</font>
+to <font face="Cumberland">$pkgbs</font></p>
+ </li>
+ <li>
+ <p>Copy <font face="Cumberland">bsh-1.2b7.jar</font>, available
+from <a href="http://www.beanshell.org/download.html">http://www.beanshell.org/download.html<span
+ style="text-decoration: none;"> </span></a>to <font face="Cumberland">$pkgbs/skip_registration</font>
+directory.</p>
+ </li>
+ <li>
+ <p>Copy <font face="Cumberland">ScriptFramework.rdb</font> from <font
+ face="Cumberland">offapi/<platform>/ucr/ScriptFramework.rdb</font>
+to <font face="Cumberland">$pkgsf</font></p>
+ </li>
+ <li>
+ <p>Copy <font face="Cumberland">ProtocolHandler.xcu</font> from <font
+ face="Cumberland">scripting/workben/installer/</font> to <font
+ face="Cumberland">$pkgsf</font></p>
+ </li>
+ <li>
+ <p>Now, zip up all files in directory, <font face="Cumberland">$pkgsf</font>
+to ooscriptf.zip</p>
+ </li>
+ <li>
+ <p>Now, zip up all file in directory, <font face="Cumberland">$pkgbs</font>
+to bshruntime.zip</p>
+ </li>
+</ol>
+<p>The next stage is to take the UNO packages and install them in an
+OpenOffice installation. </p>
+<ol>
+ <li>
+ <p>Copy the zips file into your OpenOffice installation under the <tt>user/uno_packages</tt>
+directory </p>
+ </li>
+ <li>
+ <p>In the program directory, run pkgchk on each of the zip files </p>
+ </li>
+</ol>
+<p><font face="Thorndale">The next stage is to install the
+Starbasic dialogs, configuration files and example scripts.</font></p>
+<ol>
+ <ol>
+ <li>
+ <p><font face="Thorndale">Create a directory </font><font
+ face="Cumberland"><tt>ScriptBindingLibrary</tt></font><font
+ face="Thorndale, serif">, from the directory <font face="Cumberland"><tt>scripting/workben/binding</tt></font><font
+ face="Thorndale"> copy the following files to </font><font
+ face="Cumberland"><tt>ScriptBindingLibrary</tt>,</font><font
+ face="Thorndale"> </font><font face="Cumberland"><tt>dialog.xlb</tt></font>,<font
+ face="Thorndale"> </font><font face="Cumberland"><tt>HelpBinding.xdl</tt></font><font
+ face="Thorndale">, </font><font face="Cumberland"><tt>MenuBinding.xdl</tt></font>,
+ <font face="Cumberland"><tt>script.xlb</tt></font>, <font
+ face="Cumberland"><tt>EventsBinding.xdl</tt></font>, <font
+ face="Cumberland"><tt>KeyBinding.xdl</tt></font>, </font><font
+ face="Cumberland"><tt>ScriptBinding.xba</tt></font></p>
+ </li>
+ <li>
+ <p><font face="Thorndale">Copy </font><font face="Cumberland"><tt>ScriptBindingLibrary</tt></font><font
+ face="Thorndale, serif"> <font face="Thorndale">directory and its
+contents to</font> <font face="Cumberland"><tt><OpenOffice
+path>/user/basic</tt></font> <font face="Thorndale">directory.</font>
+ </font> </p>
+ </li>
+ <li>
+ <p><font face="Thorndale, serif"><font face="Thorndale">Insert
+the following lines into</font> <font face="Cumberland"><tt><OpenOffice
+path>/user/basic/script.xlc</tt></font> </font><font
+ face="Thorndale">( insert these lines immediately above the entry for
+the Standard library) </font> </p>
+ <ol>
+ <p><tt><font face="Cumberland"><library:library
+library:name="ScriptBindingLibrary" xlink:href="file:://<OpenOffice
+path>user/basic/ScriptBindingLibrary/script.xlb/"
+xlink:type="simple" library:link="false"/></font></tt></p>
+ </ol>
+ </li>
+ <li>
+ <p><font face="Thorndale">Insert this following lines into </font><font
+ face="Cumberland"><OpenOffice path>/user/basic/dialog.xlc</font>
+( insert these lines immediately above the entry for the Standard
+library) </p>
+ <ol>
+ <p><tt><font face="Cumberland"><library:library
+library:name="ScriptBindingLibrary" xlink:href="file://<OpenOffice
+path>/user/basic/ScriptBindingLibrary/dialog.xlb/"
+xlink:type="simple" library:link="false"/></font></tt></p>
+ </ol>
+ </li>
+ <li>
+ <p><font face="Thorndale">Create a </font><font
+ face="Thorndale, serif"><font face="Cumberland"><tt>Scripts</tt></font><font
+ face="Thorndale"> directory, create sub-directories </font><font
+ face="Cumberland"><tt>java</tt></font><font face="Thorndale"> and <tt>beanshell</tt>
+in </font><font face="Cumberland"><tt>Scripts</tt></font><font
+ face="Thorndale"> directory. </font>
+Create sub directories <tt>MemoryUsage</tt>, <tt>InteractiveBeanShell</tt>
+in the <tt>beanshell</tt> directory. Copy the contents of each of the <tt>scripting/examples/beanshell</tt>
+directories into the newly created directories.
+Create sub directories <font face="Cumberland"><tt>Highlight</tt></font><font
+ face="Thorndale">, </font><font face="Cumberland"><tt>MemoryUsage</tt></font><font
+ face="Thorndale"> and </font><font face="Cumberland"><tt>ScriptFrmwrkHelper</tt></font></font><font
+ face="Thorndale"> in the <tt>java</tt> directory. </font> Using the
+tables below populate the <tt>java</tt> directory with the appropriate
+files<font face="Thorndale"> ( make sure to rename files where
+necessary )</font></p>
+ <table width="100%" border="1" cellpadding="4" cellspacing="3">
+ <col width="97*"> <col width="159*"> <thead> <tr valign="top">
+ <th width="38%">
+ <p>Source (scripting/examples/java)</p>
+ </th>
+ <th width="62%">
+ <p>Destination file</p>
+ </th>
+ </tr>
+ </thead> <tbody>
+ <tr valign="top">
+ <td width="38%">
+ <p>HighlightTextParcel.xml</p>
+ </td>
+ <td width="62%">
+ <p><OpenOffice
+Path>/user/Scripts/java/Highlight/parcel-descriptor.xml</p>
+ </td>
+ </tr>
+ <tr valign="top">
+ <td width="38%">
+ <p>HighlightUtil.java</p>
+ </td>
+ <td width="62%">
+ <p><OpenOffice
+Path>/user/Scripts/java/Highlight/HighlightUtil.java</p>
+ </td>
+ </tr>
+ <tr valign="top">
+ <td width="38%">
+ <p>HighlightText.java </p>
+ </td>
+ <td width="62%">
+ <p><OpenOffice
+Path>/user/Scripts/java/Highlight/HighlightText.java </p>
+ </td>
+ </tr>
+ <tr valign="top">
+ <td width="38%">
+ <p>MemoryUsage.java</p>
+ </td>
+ <td width="62%">
+ <p><OpenOffice
+Path>/user/Scripts/java/MemoryUsage/MemoryUsage.java</p>
+ </td>
+ </tr>
+ <tr valign="top">
+ <td width="38%">
+ <p>MemoryUsageParcel.xml</p>
+ </td>
+ <td width="62%">
+ <p><OpenOffice
+Path>/user/Scripts/java/MemoryUsage/parcel-descriptor.xml</p>
+ </td>
+ </tr>
+ <tr valign="top">
+ <td width="38%">
+ <p>ScriptFrmwrkHelper.java</p>
+ </td>
+ <td width="62%">
+ <p><OpenOffice
+Path>/user/Scripts/java/ScriptFrmwrkHelper/ScriptFrmwrkHelper.java</p>
+ </td>
+ </tr>
+ <tr valign="top">
+ <td width="38%">
+ <p>ScriptFrameWkHelperParcel.xml</p>
+ </td>
+ <td width="62%">
+ <p><OpenOffice
+Path>/user/Scripts/java/ScriptFrmwrkHelper/parcel-descriptor.xml</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+ <li>
+ <p><font face="Thorndale">Build example and framework helper
+scripts. Create a classpath with the following jars </font><font
+ face="Cumberland"><tt><SOLVERPATH>/<platform>/bin/unoil.jar</tt></font>,<font
+ face="Cumberland"><tt><SOLVERPATH>/<platform>/bin/jurt.jar</tt></font>,
+ <tt><font face="Cumberland"><SOLVERPATH>/<platform>/</font><font
+ face="Cumberland">bin/jut.jar</font></tt>, <tt><font face="Cumberland"><SOLVERPATH>/<platform>/bin/java_uno.jar</font></tt>,
+ <tt><font face="Cumberland"><SOLVERPATH>/<platform>/bin/ridl.jar</font></tt>,
+ <tt><font face="Cumberland"><SOLVERPATH>/<platform>/bin/sandbox.jar</font></tt>.
+ <font face="Thorndale"> Change directory to </font><font
+ face="Cumberland"><tt>Highlight</tt></font>, <font face="Cumberland"><tt>MemoryUsage</tt></font>
+and <font face="Cumberland"><tt>ScriptFrmwrkHelper</tt></font> <font
+ face="Thorndale">in turn, building all java files in each one. Jar up
+the class files in each directory creating </font><font
+ face="Cumberland"><tt>ScriptFrmwrkHelper.jar</tt></font><font
+ face="Thorndale"> in </font><font face="Cumberland"><tt>ScriptFrmwrkHelper</tt></font>,
+ <font face="Cumberland"><tt>Highlight.jar</tt></font> in <font
+ face="Cumberland"><tt>Highlight</tt></font> and finally <font
+ face="Cumberland"><tt>MemUsage.jar</tt></font> in <font
+ face="Cumberland"><tt>MemoryUsage</tt></font>.</p>
+ </li>
+ <li>
+ <p>Copy the entire <font face="Cumberland"><tt>Scripts</tt></font>
+directory hierarchy to <font face="Cumberland"><tt><OpenOffice
+Path>/user/</tt></font></p>
+ </li>
+ <li>
+ <p>Install the configuration files. Firstly backup any config
+files ( *.xml ) present in the <font face="Cumberland"><tt><OpenOffice
+Path>/user/config/soconfig</tt> directory</font> ( including
+sub-directories ). Copy all files with “.xml” extention ( except <font
+ face="Cumberland"><tt>manifest.xml</tt></font> ) from <font
+ face="Cumberland"><tt>scripting/workben/bindings to <OpenOffice
+Path>/user/config/soconfig</tt></font>. If <font face="Cumberland"><tt><OpenOffice
+Path>/user/config/soconfig/META-INF</tt></font> directory doesn't
+exist create it. Copy <font face="Cumberland"><tt>manifest.xml</tt></font>
+from directory <font face="Cumberland"><tt>scripting/workben/bindings</tt></font>
+to <font face="Cumberland"><tt><OpenOffice
+Path>/user/config/soconfig/META-INF</tt></font> directory.</p>
+ </li>
+ </ol>
+</ol>
+<p>The script framework is now installed.</p>
+<table cellpadding="4" cellspacing="0">
+ <tbody>
+ <tr>
+ <td width="25%">
+ <p><a href="mailto:dev@framework.openoffice.org">Mailing List</a></p>
+ </td>
+ <td width="75%">
+ <p>Installation, User or Developer queries on the Office
+Scripting Framework</p>
+ </td>
+ </tr>
+ <tr>
+ <td width="25%">
+ <p>Issues</p>
+ </td>
+ <td width="75%">
+ <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>
+<h2><br>
+Last revision: Wed Mar 19 17:39:14 GMT 2003
+</h2>
+</body>
+</html>
Propchange: incubator/ooo/ooo-site/trunk/content/framework/scripting/release-0.3/build-guide.html
------------------------------------------------------------------------------
svn:eol-style = native