incubator-ooo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r799253 [13/16] - in /websites/staging/ooo-site/trunk/content/framework: documentation/ documentation/devmanual/ documentation/filters/ documentation/filterui/ documentation/mimetypes/ documentation/others/ drafts/ proposals/ proposals/appl...
Date Fri, 25 Nov 2011 20:05:43 GMT
Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/netbeans-devguide.html
==============================================================================
--- websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/netbeans-devguide.html
(added)
+++ websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/netbeans-devguide.html
Fri Nov 25 20:05:15 2011
@@ -0,0 +1,288 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<link href="/css/ooo.css" rel="stylesheet" type="text/css">
+
+
+<title>Developing Scripts in NetBeans</title>
+
+<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+
+
+</head>
+
+<body>
+  <div id="banner">
+    <div id="bannerleft"><a alt="Apache OpenOffice.org (incubating)" href="/">
+      <img id="ooo-logo alt="Apache OpenOffice.org (Incubating)" src="/images/ooo-logo.png"/></a></div>
+    <div id="bannerright"><a alt="Apache Incubator" href="http://incubator.apache.org">
+      <img id="asf-logo" alt="Apache Incubator" src="/images/apache-incubator-logo.png"/></a></div>
+   <div id="bannercenter"><br/>(incubating)&nbsp;|&nbsp;The Free and
Open Productivity Suite</div>
+  </div>
+  <div id="clear"></div>
+  
+  <div id="content">
+  
+    
+    
+<a name="top"></a>     
+
+<h1>Developing Scripts in NetBeans</h1>
+         
+This document describes how to set up NetBeans for Office Scripting
+and how to write a simple script using NetBeans. You can download
+the NetBeans IDE from the <a href="http://www.netbeans.org/ide/download.html">
+NetBeans download page</a>.
+
+<h2>Contents:</h2>
+
+<ul>
+<li><p><a href="#prerequisites">Pre-requisites</a>
+<li><p><a href="#recipe-create">Creating a Parcel Recipe</a>
+<li><p><a href="#recipe-actions">Actions available for Parcel Recipes</a>
+<li><p><a href="#parcel-actions">Actions available for Script Parcels</a>
+<li><p><a href="#document-actions">Actions available for Office Documents</a>
+<li><p><a href="#debugging">Debugging Java Office scripts in NetBeans</a>
+<li><p><a href="#troubleshooting">Troubleshooting</a>
+</ul>
+
+<a name="prerequisites"></a>
+<h2>Pre-requisites</h2>
+
+<ul>
+<!-- <li>You need to install the Office API support module for NetBeans which
+can be obtained from
+<a href="http://api.openoffice.org/common/man/IDEintegration/OfficeNetBeansIntegration.html">here</a>.
+This module must be installed in NetBeans if you wish to use the
+Office API in your scripts.
+-->
+
+<li>The Office Scripting module works with NetBeans 3.4
+
+<li>You should have installed the Office Scripting module during the
+installation process for the Scripting Framework. If you have not installed
+it, see the <a href="install-guide.html">Installation Guide</a> for
+instructions on how to install.
+
+<li>On Linux, you will need to ensure that your DISPLAY environment
+variable is set to &lt;your hostname&gt;:0 in the shell from which you
+start NetBeans to work around a problem with Java GUIs in Office.
+
+<li>Create a directory somewhere on your machine in which you will develop
+your scripts.
+</ul>
+
+Now start NetBeans and mount the directory you created using the
+File/Mount Filesystem menu option. You also need to mount all of the jar
+files in the &lt;Office installation&gt;/program/classes directory in
+order to access the Office API from your scripts.
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="recipe-create"></a>
+<h2>Creating a Parcel Recipe</h2>
+
+Office scripts are delivered in Script Parcels. Like Office documents they
+are zip files. Script Parcels have the .sxp extension. Script Parcels are
+generated from Parcel Recipes where all of the files that are necessary
+to create the parcel are put together. To create a new Parcel Recipe:
+
+<ul>
+<li>Right click on your mounted filesystem
+<li>Select New/Office Scripting/Parcel Recipe
+<li>In the New Wizard window that appears enter a name for your Parcel Recipe
+<li>Select a language for your Parcel Recipe from the Initial Script
+Language dropdown list.
+<li>Click the Finish button to create your Parcel Recipe
+</ul>
+                         
+This will create a new directory with the name you chose. In this directory
+you will find a Contents directory where all of your files will
+be placed. An empty stub file will have been placed in the
+Contents directory and can be used as a starting point for your script.
+
+<p>
+<b>Note:</b> To add further empty stub scripts to your Parcel Recipe, right
+click on the Contents directory and use the New/Office Scripting/Empty Script
+menu item.
+
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="recipe-actions"></a>
+<h2>Actions available for Parcel Recipe</h2>
+
+If the user right clicks on the parcel directory they should be
+able to use the following actions:
+
+<ul>
+<li><b>Compile:</b> Compiles all of the .java files in the Parcel Recipe
+
+<li><b>Build:</b> Compiles all of the .java files in the Parcel Recipe.
+It then searches for valid Office scripts in the language you selected
+in the Contents directory files and pops up a dialog
+which allows you to select which Java methods or BeanShell scripts
+you wish to export as Office scripts.
+Once you have finish making your selections, it creates a
+&lt;Parcel Recipe Name&gt;.sxp Script Parcel file in the Parcel
+Recipe directory. You can configure what files are put into the
+Script Parcel using the File Filter property. If you script includes any
+jar files that need to be in the classpath when it is executed you should
+add them to the Classpath property of your Parcel Recipe.
+
+<li><b>Configure:</b> This pops up the Configure dialog, which allows you
+to select what Office scripts to export. Any changes you make in
+this dialog will <b>only</b> appear in your Script Parcel after you run
+Build again.
+</ul>
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="parcel-actions"></a>
+<h2>Actions available for Script Parcels</h2>
+
+Script Parcels supports only one action:
+
+<ul>
+<li><b>Deploy:</b> This will deploy the Script Parcel to an Office Document
+or to an Office installation. If the Script Parcel already exists
+in the target, you will be asked whether you want to overwrite.
+</ul>
+
+<p>
+<b>Note:</b> If you deploy a Script Parcel to an OpenOffice.org
+installation you need to use the Tools/Scripting Add-on's/Refresh All Scripts
+menu item for the new script to appear in the Assign Script dialog.
+
+<p>
+<b>Note:</b> You can also deploy to Office documents within NetBeans
+using drag and drop or cut and paste.
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="document-actions"></a>
+<h2>Actions available for Office Documents</h2>
+
+Office Documents are also recognised by NetBeans. Any parcels contained
+in the document will be displayed as nodes of the Office document. Deleting
+one of these nodes will remove the Script Parcel from the document. You
+should ensure that the document is not open in OpenOffice.org before deleting
+any parcels it may contain.
+
+Office documents support the standard Delete, Cut and Copy actions and
+the following custom actions:
+
+<ul>
+<li><b>Open:</b> This will open the document in Office using the path
+in the Office Settings property to find the Office installation.
+
+<p>
+If the path to Office is not valid, an error dialog will be popped
+up informing the user that they need to set their Path to Office
+Installation property. This setting can be changed by bringing
+up the Tools/Options dialog and changing
+IDE Configuration/Server and External Tool Settings/Office Settings
+</ul>
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="debugging"></a>
+<h2>Debugging Java Office scripts in NetBeans</h2>
+
+<ul>
+<li>Follow the instructions at
+<a href="http://api.openoffice.org/common/man/IDEintegration/OfficeNetBeansIntegration.html#Debugging">
+Debugging Java components in NetBeans/Forte for Java</a>
+to set up your Office installation to allow debugging of the JVM.
+
+<li>Start OpenOffice and run one of your Java scripts. This will
+make sure the JVM is running.
+
+<li>Attach to Office JVM using the NetBeans Debug/Start Session/Attach...
+menu option.
+
+<li>Load a script source in NetBeans and set up breakpoints using
+Debug/New Breakpoint... menu option.
+
+<li>Run the script in Office.
+</ul>
+
+<p>
+<b>Note:</b> As the BeanShell scripting language does not support debugging
+it is not possible to debug BeanShell Office scripts from NetBeans. You
+can however use the Interactive BeanShell scripting menu item under the Tools
+menu in OpenOffice.org to test BeanShell code. Just enter any BeanShell code
+and hit the Eval button to execute it.
+<p>
+<a href="#top">Top</a>
+
+<p>
+<a name="troubleshooting"></a>
+<h2>Troubleshooting</h2>
+
+<ul>
+<li><p>If you encounter problems when developing or deploying scripts in
+NetBeans, one thing you can try is to move your NetBeans settings directory
+(.netbeans on UNIX, netbeans in Windows - can be found in your home
+directory) to another name and restart NetBeans.
+
+<li><p>The Choose What to Export as Scripts dialog <b>only</b> displays
+methods which are defined within class files, it will not display
+methods in class files which are within jar files in the Parcel Recipe.
+
+<li><p>If you include package directives in the Java source files of your
+Parcel Recipe, you should ensure that the source files are in the appropriate
+directories for your package directives. This is because the
+default NetBeans compiler implementation does not use the -d switch to the
+Java compiler. As a result class files do not get placed in the appropriate
+directories and methods in these classes will not appear in the
+Choose What to Export as Scripts dialog.
+
+<p>
+There are a couple of workarounds for this problem:
+
+<p>
+<ol>
+<li>Use the <a href="commandline-devguide.html">command line tools</a>
+<li>Set the Target flag in the Tools/Options window under
+Building/Compiler Types/Internal Compilation
+</ol>
+</ul>
+
+<p>
+<a href="#top">Top</a>
+
+<hr>
+Last Modified: Tue Mar 12 11:40:28 GMT 2003
+
+
+  </div>
+
+  <div id="footera">
+    <div id="poweredbya">
+      <p><img src="/images/feather-small.gif"/><br/>Powered by the Apache
CMS.</p>
+    </div>
+    <div id="copyrighta">
+      <p>
+	Apache "OpenOffice.org" is an effort undergoing incubation at The Apache Software Foundation
(ASF), sponsored by the Apache Incubator.
+	Incubation is required of all newly accepted projects until a further review indicates that
the infrastructure, communications, and
+	decision making process	have stabilized in a manner consistent with other successful ASF
projects. While incubation status is
+	not necessarily a reflection of the completeness or stability of the code, it does indicate
that the project has
+	yet to be fully endorsed by the ASF.</p>
+      <p>
+	<a href="/contact.html">Contact Us</a> |
+	<a href="/terms.html">Terms of Use</a>
+	<br />Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+	<br />OpenOffice.org and the seagull logo are registered trademarks of The Apache
Software Foundation.
+	<br />Other names appearing on the site may be trademarks of their respective owners.
+      </p>
+    </div>
+  </div>
+
+</body>
+</html>

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

Added: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/rhino.gif
==============================================================================
Binary file - no diff available.

Propchange: websites/staging/ooo-site/trunk/content/framework/scripting/release-0.3/rhino.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream



Mime
View raw message