You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by jt...@apache.org on 2005/05/26 04:59:29 UTC
svn commit: r178570 [5/6] - in /incubator/derby/site/trunk: build/site/
build/site/binaries/ build/site/images/ build/site/integrate/
build/site/integrate/plugin_help/ build/site/integrate/plugin_help/images/
build/site/releases/ src/documentation/content/binaries/
src/documentation/content/xdocs/ src/documentation/content/xdocs/images/
src/documentation/content/xdocs/integrate/
src/documentation/content/xdocs/integrate/plugin_help/
src/documentation/content/xdocs/integrate/plugin_help/images/
Modified: incubator/derby/site/trunk/build/site/releases/release-10.0.2.1.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/build/site/releases/release-10.0.2.1.html?rev=178570&r1=178569&r2=178570&view=diff
==============================================================================
--- incubator/derby/site/trunk/build/site/releases/release-10.0.2.1.html (original)
+++ incubator/derby/site/trunk/build/site/releases/release-10.0.2.1.html Wed May 25 19:59:25 2005
@@ -243,9 +243,6 @@
<a title="" href="../binaries/UsingDotsDerbySystemTest.pdf">DOTS System</a>
</div>
<div class="menuitem">
-<a title="" href="../integrate/derby_plugin.html">Eclipse</a>
-</div>
-<div class="menuitem">
<a title="" href="../binaries/DerbyCodeCoverageUsingEmma.pdf">EMMA</a>
</div>
<div class="menuitem">
@@ -255,13 +252,85 @@
<a title="" href="../binaries/DerbyAndRedHatAppServer.pdf">JOnAS (PDF)</a>
</div>
</div>
-<div onclick="SwitchMenu('menu_1.9', '../skin/')" id="menu_1.9Title" class="menutitle">Manuals</div>
+<div onclick="SwitchMenu('menu_1.9', '../skin/')" id="menu_1.9Title" class="menutitle">Eclipse Plug-ins</div>
<div id="menu_1.9" class="menuitemgroup">
<div class="menuitem">
+<a title="" href="../integrate/derby_plugin.html">10.0 Core</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/func_spec_plugins.html">1.0 UI Functional Spec</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_howto.html">10.1 Core and 1.0 UI</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_slides.html">10.1 Core and 1.0 UI Slides and Lab</a>
+</div>
+<div onclick="SwitchMenu('menu_1.9.5', '../skin/')" id="menu_1.9.5Title" class="menutitle">10.1 Core and 1.0 UI Documentation</div>
+<div id="menu_1.9.5" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/start_toc.html">Getting Started</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/java_project.html">Creating an Eclipse Project</a>
+</div>
+<div onclick="SwitchMenu('menu_1.9.5.3', '../skin/')" id="menu_1.9.5.3Title" class="menutitle">Derby Nature</div>
+<div id="menu_1.9.5.3" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/nature_toc.html">Adding or Removing</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/nature.html">Adding the Derby Nature</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/remove_nature.html">Removing the Derby Nature</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.9.5.4', '../skin/')" id="menu_1.9.5.4Title" class="menutitle">Network Server</div>
+<div id="menu_1.9.5.4" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/server_toc.html">Starting and Stopping</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/start_server.html">Starting the Server</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/stop_server.html">Stopping the Server</a>
+</div>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/properties.html">Derby Properties</a>
+</div>
+<div onclick="SwitchMenu('menu_1.9.5.6', '../skin/')" id="menu_1.9.5.6Title" class="menutitle">ij</div>
+<div id="menu_1.9.5.6" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/ij_toc.html">Using ij</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/ij.html">SQL commands</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/ij2.html">SQL scripts</a>
+</div>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/derby_app.html">Building a Java App</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/sysinfo.html">Running sysinfo</a>
+</div>
+<div class="menuitem">
+<a title="" href="../integrate/plugin_help/resources.html">Derby Manuals</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.10', '../skin/')" id="menu_1.10Title" class="menutitle">Manuals</div>
+<div id="menu_1.10" class="menuitemgroup">
+<div class="menuitem">
<a title="" href="../manuals/index.html">About</a>
</div>
-<div onclick="SwitchMenu('menu_1.9.2', '../skin/')" id="menu_1.9.2Title" class="menutitle">10.0 Manuals</div>
-<div id="menu_1.9.2" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.10.2', '../skin/')" id="menu_1.10.2Title" class="menutitle">10.0 Manuals</div>
+<div id="menu_1.10.2" class="menuitemgroup">
<div class="menuitem">
<a title="" href="http://incubator.apache.org/derby/docs/10.0/manuals/getstart/gspr02.html">Getting Started</a>
</div>
@@ -281,13 +350,13 @@
<a title="" href="http://incubator.apache.org/derby/docs/10.0/manuals/tools/tools02.html">Tools & Utility Guide</a>
</div>
</div>
-<div onclick="SwitchMenu('menu_1.9.3', '../skin/')" id="menu_1.9.3Title" class="menutitle">10.1 Alpha Manuals</div>
-<div id="menu_1.9.3" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.10.3', '../skin/')" id="menu_1.10.3Title" class="menutitle">10.1 Alpha Manuals</div>
+<div id="menu_1.10.3" class="menuitemgroup">
<div class="menuitem">
<a title="" href="../manuals/dita.html">DITA Source</a>
</div>
-<div onclick="SwitchMenu('menu_1.9.3.2', '../skin/')" id="menu_1.9.3.2Title" class="menutitle">Getting Started</div>
-<div id="menu_1.9.3.2" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.10.3.2', '../skin/')" id="menu_1.10.3.2Title" class="menutitle">Getting Started</div>
+<div id="menu_1.10.3.2" class="menuitemgroup">
<div class="menuitem">
<a title="" href="http://incubator.apache.org/derby/docs/getstart/getstartderby.pdf">PDF</a>
</div>
@@ -298,8 +367,8 @@
<a title="" href="http://incubator.apache.org/derby/docs/getstart/">HTML Files</a>
</div>
</div>
-<div onclick="SwitchMenu('menu_1.9.3.3', '../skin/')" id="menu_1.9.3.3Title" class="menutitle">Reference</div>
-<div id="menu_1.9.3.3" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.10.3.3', '../skin/')" id="menu_1.10.3.3Title" class="menutitle">Reference</div>
+<div id="menu_1.10.3.3" class="menuitemgroup">
<div class="menuitem">
<a title="" href="http://incubator.apache.org/derby/docs/ref/refderby.pdf">PDF</a>
</div>
@@ -310,8 +379,8 @@
<a title="" href="http://incubator.apache.org/derby/docs/ref/">HTML Files</a>
</div>
</div>
-<div onclick="SwitchMenu('menu_1.9.3.4', '../skin/')" id="menu_1.9.3.4Title" class="menutitle">Developer's Guide</div>
-<div id="menu_1.9.3.4" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.10.3.4', '../skin/')" id="menu_1.10.3.4Title" class="menutitle">Developer's Guide</div>
+<div id="menu_1.10.3.4" class="menuitemgroup">
<div class="menuitem">
<a title="" href="http://incubator.apache.org/derby/docs/devguide/derbydev.pdf">PDF</a>
</div>
@@ -322,8 +391,8 @@
<a title="" href="http://incubator.apache.org/derby/docs/devguide/">HTML Files</a>
</div>
</div>
-<div onclick="SwitchMenu('menu_1.9.3.5', '../skin/')" id="menu_1.9.3.5Title" class="menutitle">Tuning Derby</div>
-<div id="menu_1.9.3.5" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.10.3.5', '../skin/')" id="menu_1.10.3.5Title" class="menutitle">Tuning Derby</div>
+<div id="menu_1.10.3.5" class="menuitemgroup">
<div class="menuitem">
<a title="" href="http://incubator.apache.org/derby/docs/tuning/tuningderby.pdf">PDF</a>
</div>
@@ -334,8 +403,8 @@
<a title="" href="http://incubator.apache.org/derby/docs/tuning/">HTML Files</a>
</div>
</div>
-<div onclick="SwitchMenu('menu_1.9.3.6', '../skin/')" id="menu_1.9.3.6Title" class="menutitle">Server & Admin</div>
-<div id="menu_1.9.3.6" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.10.3.6', '../skin/')" id="menu_1.10.3.6Title" class="menutitle">Server & Admin</div>
+<div id="menu_1.10.3.6" class="menuitemgroup">
<div class="menuitem">
<a title="" href="http://incubator.apache.org/derby/docs/adminguide/derbyadmin.pdf">PDF</a>
</div>
@@ -346,8 +415,8 @@
<a title="" href="http://incubator.apache.org/derby/docs/adminguide/">HTML Files</a>
</div>
</div>
-<div onclick="SwitchMenu('menu_1.9.3.7', '../skin/')" id="menu_1.9.3.7Title" class="menutitle">Tools & Utility Guide</div>
-<div id="menu_1.9.3.7" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.10.3.7', '../skin/')" id="menu_1.10.3.7Title" class="menutitle">Tools & Utility Guide</div>
+<div id="menu_1.10.3.7" class="menuitemgroup">
<div class="menuitem">
<a title="" href="http://incubator.apache.org/derby/docs/tools/derbytools.pdf">PDF</a>
</div>
Added: incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_lab.pdf
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_lab.pdf?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_lab.pdf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_lab.sxw
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_lab.sxw?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_lab.sxw
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_lab.zip
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_lab.zip?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_lab.zip
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_slides.pdf
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_slides.pdf?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/binaries/derby_plugins_slides.pdf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: incubator/derby/site/trunk/src/documentation/content/xdocs/derby_downloads.xml
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/derby_downloads.xml?rev=178570&r1=178569&r2=178570&view=diff
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/derby_downloads.xml (original)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/derby_downloads.xml Wed May 25 19:59:25 2005
@@ -38,7 +38,7 @@
<a href="binaries/incubating-derby-snapshot-10.1-178324.tar.gz">tar.gz</a>]
</li>
<li>
- <a href="integrate/derby_plugin.html">Eclipse plug-in</a> 10.1.0
+ <a href="integrate/plugin_howto.html">Eclipse plug-in</a> 10.1.0
(May 25, 2005 / SVN 178324)
[<a href="binaries/derby_core_plugin_10.1.0.178324.zip">zip</a>]
</li>
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/images/add_nature.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/images/add_nature.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/images/add_nature.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/Readme.xml
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/Readme.xml?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/Readme.xml (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/Readme.xml Wed May 25 19:59:25 2005
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+ "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>Obtaining the Source and Building the Derby 1.0 UI and Help Plug-ins</title>
+ </header>
+
+ <body>
+
+ <p>This document describes how to obtain the source for the
+ Apache Derby 1.0 UI and Help plug-ins for Eclipse. Instructions
+ for importing the source as an Eclipse project and packaging the
+ plug-ins as a zip file are also included.</p>
+
+<source><![CDATA[
+Contents:
+
+ I. Creating the Apache Derby UI and Help Plug-in Projects
+ II. Creating zip files for the Derby UI and Help Plug-ins via the Project
+
+=================================================================================
+
+I. Creating the Apache Derby UI and Help Plug-in projects:
+
+1) Check out the source for the UI and Help plug-ins via SVN (Subversion).
+
+ Refer to the detailed instructions on readying your environment
+ to check out any Derby source here:
+
+ http://incubator.apache.org/derby/derby_downloads.html
+
+ To check out the entire development trunk use this command:
+
+ svn checkout https://svn.apache.org/repos/asf/incubator/derby/code/trunk/
+
+ This includes the source for both the UI and Help plugins. If you want to
+ check out only the UI and Help plugins, and not the entire Derby source code
+ issue this command instead:
+
+ svn checkout https://svn.apache.org/repos/asf/incubator/derby/code/trunk/plugins
+
+
+2) Install Eclipse 3.x and the JDK needed
+
+3) Install the Apache Derby 10.1.0 Eclipse Core plug-in from:
+ http://incubator.apache.org/derby/derby_downloads.html
+
+ It is available as a zip file:
+
+ for example; derby_core_plugin_10.1.0.178324.zip
+
+ Unzip this file into the directory where the eclipse executable is located.
+ For instance, if Eclipse is installed in C:\eclipse, unzip the Derby
+ Core plug-in zip file to C:\eclipse.
+
+4) Invoke the Eclipse IDE, provide an appropriate location as the workspace
+
+ for example: c:\derby\plugin
+
+5) Import the Apache Derby UI project:
+ File -> Import -> Existing Project into Workspace
+ - Click Next
+ - Click Browse and point to the "org.apache.derby.ui" directory (created in
+ Step 1, which is under the plugins/eclipse directory where you checked
+ out the source)
+ - Click Finish
+
+6) Switch to the Plug-in perspective
+ Window -> Open Perspective -> Other -> Select Plug-in Development
+
+7) To invoke and test the Apache Derby UI Plug-in in this development environment
+
+ Run ->Run As -> Eclipse Application (Eclipse 3.1)
+ OR
+ Run --> Run As --> Run-time Workbench (Eclipse 3.0)
+
+ An alternate way would be to open the plugin.xml and select the
+ 'Launch a runtime workbench' link.
+
+ This will open a new Eclipse window with all the current plug-ins under
+ development in its environment.
+
+Follow steps 4 - 7 as above for creating the Help plug-in project, substituting
+org.apache.derby.plugin.doc for org.apache.derby.ui.
+================================================================================
+
+II. Creating zip files for the Derby UI and Help Plug-ins via the Project
+
+In order to install the plug-ins easily in another Eclipse environment creating
+a zip file is useful.
+
+1) From within the Plug-in Development perspective, right-click the org.apache.derby.ui
+ project. Select Export --> Deployable plug-ins and fragments, then the Next button.
+
+2) In the Export Plug-ins and Fragments window select the org.apache.derby.ui project
+ listed in the Available Plug-ins and Fragments text area. For the Export Options
+ section select Deploy as: a single ZIP file. Click the Build Options button.
+ Check any options desired from the Build Options Preferences window and then
+ click OK.
+
+3) Browse to a Destination where you would like to put the zip file and name it
+ org.apache.derby.ui_1.0.0.zip to represent the name and version of the plug-in.
+
+4) Finally, click Finish.
+
+5) Repeat the above steps for the org.apache.derby.plugin.doc project and create
+ a zip file called org.apache.derby.plugin.doc_1.0.0.zip.]]></source>
+</body>
+</document>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/Readme.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/derby_plugin.xml
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/derby_plugin.xml?rev=178570&r1=178569&r2=178570&view=diff
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/derby_plugin.xml (original)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/derby_plugin.xml Wed May 25 19:59:25 2005
@@ -3,7 +3,7 @@
<document>
<header>
- <title>Apache Derby Core Plug-in for Eclipse</title>
+ <title>Derby 10.0 Core Plug-in for Eclipse</title>
</header>
<body>
@@ -48,6 +48,31 @@
</section>
<section>
+<title>Compatibility with the UI plug-in</title>
+<p>
+A contribution of the IBM Integration plug-in for Derby which adds UI
+functionality to the core plug-in was made in May, 2005. The changes
+to the new UI plug-in include support for the new Derby client driver.
+This newly contributed UI plug-in requires the new 10.1 core plug-in.
+</p>
+<p>
+See the document, <a href="plugin_howto.html">Using the 10.1 Core and 1.0
+UI Derby plug-ins</a> for complete information about compatibility between
+the 'Core' and 'UI' plug-ins.
+</p>
+<p>
+To use the UI components with this 10.0 Derby Core plug-in, see the
+article on the IBM site, <a href="http://www-106.ibm.com/developerworks/db2/library/techarticle/dm-0501cline/">IBM Integration plug-in for Derby</a>.
+</p>
+<p>
+Once the 10.1 version of Derby becomes an Official Release, the IBM Integration
+plug-in for Derby will no longer exist, nor will the 10.0 version of the Core
+plug-in. All new users will need to use the 10.1 Core and the 1.0 Derby UI
+plug-in.
+</p>
+</section>
+
+<section>
<title>Software Requirements</title>
<ul>
<li>Java Development Kit
@@ -92,7 +117,7 @@
<p>
-<em>Last updated: January 10, 2005</em>
+<em>Last updated: May 23, 2005</em>
</p>
</body>
</document>
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/func_spec_plugins.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/func_spec_plugins.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/func_spec_plugins.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/func_spec_plugins.html Wed May 25 19:59:25 2005
@@ -0,0 +1,465 @@
+<html>
+<head>
+<title>
+Derby 1.0 UI Plug-in for Eclipse
+</title>
+
+</head>
+<body>
+
+
+<hr>
+<h1 align=center>Derby 1.0 UI Plug-in for Eclipse</h1>
+<hr>
+
+<h2><a name="overview">Background and Overview<a></h2>
+<p>
+In its present form the Derby Core plug-in contains only three jar files - derby.jar, derbytools.jar, derbynet.jar. The functionality of the core plug-in makes available these jar files, and thus the Derby database to Eclipse users. Using only this plug-in
+means manually adding the Derby jar files to the Java Build path in Eclipse.
+The plug-in is available for download (or to build) at the Apache Derby web site.
+Note: the core plug-in does not add these jars to an Eclipse user's classpath.
+They are installed in the Eclipse plug-ins directory, but are not associated with
+any particular project.
+</p>
+<p>
+Another set of plug-ins which is currently available as sister plug-ins to
+the Derby Core plug-in is the IBM Integration plug-in for Derby.
+These plug-ins contain db2jcc.jar, db2jcc_license_c.jar, ui.jar and the html
+help files. The db2jcc.jar file contains the IBM DB2 JDBC Universal driver which acts as a client to the Derby Network server.
+</p>
+<p>
+By installing the IBM Integration plug-ins in addition to the Derby Core plug-in the following functionality is provided:
+</p>
+<ul>
+<li>
+Ability to configure the Derby network server for each project,
+including the port number and derby.system.home
+</li>
+<li>
+All Derby jar files are added to the Java Build Path of an Eclipse project
+</li>
+<li>
+Run ij and entire SQL scripts from within Eclipse
+</li>
+<li>
+Start and stop the network server from within Eclipse and track them for
+each project
+</li>
+<li>
+Run sysinfo from within Eclipse
+</li>
+<li>
+Integrated help and tutorial on using the plug-ins.
+</li>
+</ul>
+<p>
+These plug-ins are available for download as one zip file at the IBM
+developerWorks web site.
+</p>
+<h2>Proposal for new plug-ins with addition of Derby Network Client</h2>
+<p>
+With the creation of the Derby Network Client, we are proposing that the Derby Core plug-in and the IBM Integration plug-in be changed into three new plug-ins.
+The new Derby core plug-in will contain derby.jar, derbytools.jar, derbynet.jar and derbyclient.jar.
+The new UI plug-in, Derby tools plug-in (this name has not been finalized and is open for discussion), will contain ui.jar and the help plug-in will contain
+the html help files.
+</p>
+
+<hr>
+<h2><a name="rationale">Rationale for separate plug-ins</a></h2>
+
+<h2>Current plug-ins</h2>
+<p>
+Currently there are two plug-ins required to make use of the Derby tools like ij and sysinfo and to start the Derby network server from within Eclipse.
+The core plug-in adds the Derby jar files and the IBM Integration
+plug-in adds the DB2 network client jar files and the UI components to the Eclipse platform.
+</p>
+<p>
+There are several reasons for having two plug-ins:
+</p>
+<ul>
+<li>Legal requirements</li>
+<ul>
+<li>
+By using the db2jcc and db2jcc_license_c.jar files we needed to
+have customers agree to the license agreement prior to downloading the UI plugin.
+This meant the plug-in had to be hosted at IBM.
+</li>
+</ul>
+<li>
+The core plug-in can be built at the same time the Derby jar files are built using the ant script available at Apache Derby. By separating the plug-ins the core plug-in can be built from the latest available source at the Derby site. The UI plug-in just contains the DB2 JDBC driver jar files, the UI components which change infrequently.
+</li>
+<li>
+Plug-ins frequently depend on other plug-ins and require they already be present
+or that they be installed at the same time.
+Also, it's part of the design of Eclipse to separate the UI components - the View
+layer from the Model layer. An example of this can be found at the CVS repository
+for the <a href="http://cvs.sourceforge.net/viewcvs.py/dbedit/">DBEdit</a> plug-in.
+</li>
+</ul>
+
+<h2>New plug-ins</h2>
+<p>
+We believe it is best to have two plug-ins, a UI and a Core, as this follows
+the pattern generally adhered to for Eclipse plug-ins. The core functionality
+is separated from the UI functionality. A third plug-in, the help, would
+document the functionality associated with the UI plug-in.
+</p>
+<p>
+Listed below are the scenarios to first build the plug-ins and second, download the plug-ins from the Apache Derby web site.
+</p>
+<hr>
+<h2><a name="source">Source and Binaries at Apache</a></h2>
+<p>
+Presently there is only one plug-in hosted at Apache, the Derby core plug-in.
+The core plug-in can be downloaded via a web page as a zip file, from the
+Apache web site <a href="http://incubator.apache.org/derby/derby_downloads.html">
+downloads</a> page. The source for the existing Derby plug-in can be checked out via SVN and built using the same ant script used
+to build the derby jar files. The source for the new plug-in should also
+be able to be checked out, as well as downloaded in its binary form.
+</p>
+<p>
+Starting with the release of the plug-in that contains the new Derby network
+client, we would like to propose some changes to the way the source tree
+holds the new ui plug-in, as well as ways to obtain the binary version
+of both the core and ui plug-ins.
+To obtain or update the 'binary' version of the plug-ins an Eclipse Update Manager site would need to exist at the Apache web site. To check out the
+source to build the ui plug-in will require a new branch off of the trunk
+directory at the Apache Derby source tree.
+Additional information about these options are discussed below.
+</p>
+<h2>Downloading the binary version of the plug-ins via the Eclipse Update
+Manager</h2>
+<p>
+The most commonly used and efficient way for Eclipse users to download plug-ins
+is to use the Eclipse Update Manager feature. This tool allows users to
+point Eclipse to a web site (common http URL) to download a plug-in and
+any plug-in it depends upon. For instance, if we have two plug-ins we can
+allow users to download only the core plug-in, or both plug-ins. If they
+choose to download the UI plug-in they will either have to download the core
+plug-in, or else Eclipse will check to see if they already have the core plug-in
+and allow the download to continue.
+</p>
+<p>
+We know how to do this, all we need is to determine if we want to have an Update Site now, when it is possible the URL for Apache Derby may change in the future.
+If we change the URL we will have to redirect users to a new URL when it changes.
+</p>
+<h2>Obtaining the source for the UI plug-in</h2>
+<p>
+We propose creating a new directory/location off the current source tree
+to get all source files from subversion as an Eclipse plug-in project.
+Once the source files are imported into the Eclipse workspace as a
+plug-in project the user would be able to build the plug-in from the source.
+The html documentation for the help plug-in would be included in this source.
+</p>
+<p>
+The specific details will be worked out on derby-dev@db.apache.org if the vote
+accepting this contribution passes.
+</p>
+<p>
+Some examples of this style of checking out source code suitable to import as an Eclipse project are at the Apache Forrest site, Web Tools Project (Eclipse) and the DBEdit (SourceForge) plugins sites.
+</p>
+<ul>
+<li>
+Forrest: <a href="http://svn.apache.org/viewcvs.cgi/forrest/trunk/tools/eclipse/">
+http://svn.apache.org/viewcvs.cgi/forrest/trunk/tools/eclipse/</a>
+</li>
+<li>
+WTP: <a href="http://www.eclipse.org/webtools/testtutorials/developingwtp/DevelopingWTP.html">http://www.eclipse.org/webtools/testtutorials/developingwtp/DevelopingWTP.html</a>
+</li>
+<li>
+DBEdit:
+ <a href="http://cvs.sourceforge.net/viewcvs.py/dbedit/">http://cvs.sourceforge.net/viewcvs.py/dbedit/</a>.
+</li>
+</ul>
+
+<p>
+Some proposed structures, subject to community approval, for the source tree at Derby could be,
+</p>
+<ul>
+<li>
+/trunk/tools/eclipse
+</li>
+<li>
+/trunk/plugins/eclipse
+</li>
+</ul>
+<p>
+The first option is the way forrest has the source tree for Eclipse plug-ins
+and the second option is something we thought would be nice if Derby ever
+had a plug-in for something like the NetBeans IDE. For instance the second
+structure would lend itself to adding a /trunk/plugins/netbeans directory
+for the NetBeans IDE and would make the use of the term plugins generic.
+The idea is to put these options as a vote to the Derby list as well as to
+ask for other suggestions.
+</p>
+
+<hr>
+<h2><a name="build_path">Eclipse Java Build Path</a></h2>
+<p>
+derby.jar, derbynet.jar, derbytools.jar and derbyclient.jar are added to the Eclipse project Java Build Path when the Apache Derby nature is added to the Eclipse project.
+</p>
+<hr>
+<h2><a name="tools">Tools</a></h2>
+<p>
+The 'ui' plugin adds the derbytools.jar to the project build/run path, this enables the Derby tools like 'ij' and 'sysinfo' to be run
+within the Eclipse environment. The ability to run the 'dblook' utility has not been yet been provided.
+</p>
+<hr>
+<h2><a name="product_layout">Product layout and versioning</a></h2>
+<p>
+The Derby core plug-in will contain derby.jar, derbytools.jar,
+derbynet.jar and derbyclient.jar. The UI plug-in will contain ui.jar and
+the help plug-in with contain the html help files.
+The version of the core plug-in will be the version of the Derby release
+which is offered at the time of release of the plug-in, currently thought
+to be 10.1.0.0. The version of the UI and help plug-ins will be 1.0.0.
+</p>
+<p>
+The information contained in the Eclipse help files associated with
+the plug-in and the sample program have been changed to reflect the new
+Derby client database connection URL.
+</p>
+<p>
+Since the core plug-in will now have an addtional jar file contained in it,
+namely derbyclient.jar, the java class, DerbyEclipsePlugin.java, that
+creates the plugin.xml file for the existing core plug-in will need to be
+modified to include derbyclient.jar.
+</p>
+<hr>
+<h2><a name="compare">Comparision with previous plug-ins</a></h2>
+<p>
+At this time the functionality between the previous versions of the plug-in and
+the newer versions will be identical except for any differences due to
+changes in behaviour of the Derby Client replacing the DB2 Universal Driver
+client.
+</p>
+<hr>
+<h2><a name="testing">Testing </a></h2>
+<p>
+Below is a list of manual testing steps which have been completed at the
+time of this contribution. The timing of this testing should occur whenever
+a new binary version of the plug-ins is made available at http://incubator.apache.org/derby/derby_downloads.html, or more frequently if desired, such as
+when a new milestone of Eclipse is released.
+</p>
+<ol>
+<li>
+Unzip the plug-ins into the $ECLIPSE_HOME directory. For instance, if
+Eclipse is installed under /eclipse, unzip the plug-ins into /eclipse.
+<br/>
+<br/>
+</li>
+<li>
+Create a simple project in Eclipse and add the Apache Derby nature to
+the project. Verify the following jar files have been added to the
+project and the Java Build path of the project contains the following:
+derby.jar, derbynet.jar, derbyclient.jar, derbytools.jar.
+<br/>
+The Java Build path can be verified by right-clicking the project and
+selecting Properties. Once the Properties window appears select Java
+Build Path from the left frame, then select the Libraries tab. The Libraries
+tab should contain all of the jar files mentioned above.
+<br/>
+<br/>
+</li>
+<li>
+Create a java project in Eclipse and add the Apache Derby nature to
+the project. Verify the following jar files have been added to the
+project and the Java Build path of the project contains the following:
+derby.jar, derbynet.jar, derbyclient.jar, derbytools.jar.
+<br/>
+<br/>
+</li>
+<li>
+From one of the projects created above, start the derby network server at
+the default port on the localhost by right-clicking the project, then selecting
+<b>Apache Derby >> Start Derby Network Server</b>. Verify it starts.
+<br/>
+<br/>
+</li>
+<li>
+From the project which started the network server, select <b>Apache Derby >>
+ij (Interactive SQL)</b>, from the menu.
+Verify connection to the network server with a database URL in this format:
+<br/>
+<br/>
+<pre>
+connect 'jdbc:derby://localhost:1527/myDB;create=true;user=me;password=mine';
+</pre>
+</li>
+<li>
+After the connection is made to the network server via ij, create a table
+in the myDB database, and verify rows can be inserted into the table.
+<br/>
+<br/>
+</li>
+<li>
+Issue a disconnect and exit from ij. Verify the ij console window terminates.
+<br/>
+<br/>
+</li>
+<li>
+From the project which started the network server, create a new file,
+<b>File >> New >> File</b>, and give it a .sql extension.
+Enter the following SQL in the file, once the file appears in the editor.
+<br/>
+<br/>
+<pre>
+connect 'jdbc:derby://localhost:1527/myDB;user=me;password=mine';
+create table foo (id integer, name varchar(20));
+insert into foo values (1, 'derby');
+insert into foo values (2, 'derby plug-ins');
+disconnect;
+exit;
+</pre>
+Right click the file just created and select <b>Apache Derby >> Run SQL Script
+using 'ij'</b>. Verify the script ran correctly, including connecting to the
+existing myDB database and inserting values into the foo table.
+<br/>
+<br/>
+</li>
+<li>
+From the same project the network server was started from, stop the derby
+network server at the default port on the localhost. Verify it stops.
+<br/>
+<br/>
+</li>
+<li>
+Select a project which has the Apache Derby nature added to it and select
+the menu item <b>Apache Derby >> sysinfo (Derby System Information)</b>. Ensure
+the Derby Information section includes the following jar files: derby.jar,
+derbynet.jar, derbyclient.jar and derbytools.jar.
+<br/>
+<br/>
+</li>
+<li>
+Select a project which has the Apache Derby nature added to it and select
+the menu item <b>Properties</b>. Verify in the Properties window the Apache
+Derby item is available in the left hand frame. Select it. Change the
+value of the Network Server Port to some other available port number (not
+1527, the default value), and change the Network Server Host value to
+the ip address of the host running eclipse. For instance, 9.10.111.11.
+Change the value of the derby.system.home Derby System Property to a path
+on the file system. For instance, /eclipse/mynewdir on Unix and Linux,
+or C:/temp, on Windows. Apply the changes, then click OK.
+<br/>
+<br/>
+</li>
+<li>
+Select the project just modified above with new values for the network server
+and derby.system.home settings. Start the Derby Network Server.
+Verify it starts on the newly set values for host and port.
+<br/>
+<br/>
+</li>
+
+<li>
+From the project which started the network server, launch <b>ij
+(Interactive SQL)</b>, from the menu.
+Verify connection to the network server with a database URL like this:
+<pre>
+connect 'jdbc:derby://9.10.111.11:9999/differentDB;create=true;user=me;password=mine';
+</pre>
+Substitute the actual values entered in the Properties window in
+step 11 above. Verify the database, differentDB, was actually
+created in the directory for derby.system.home entered in step 11.
+For instance, either in /eclipse/mynewdir or in C:/temp, there should
+now be a differentDB directory.
+<br/>
+<br/>
+</li>
+<li>
+From the same project the network server was started from, stop the
+derby network server. Verify it stops.
+<br/>
+<br/>
+</li>
+<li>
+Select a project which has the Apache Derby nature added to it and select
+the menu item <b>Apache Derby >> Remove Apache Derby nature</b>.
+Verify the following jar files have been removed from the
+project and the Java Build path of the project no longer contains the
+following: derby.jar, derbynet.jar, derbyclient.jar, derbytools.jar.
+<br/>
+<br/>
+</li>
+<li>
+Verify the Help documentation is installed. Select the menu item
+<b>Help >> Help Contents >> Derby Plug-ins User Guide</b>.
+Expand the Getting Started section to see the various topics.
+<br/>
+<br/>
+</li>
+<li>
+Follow each step, complete all examples and build and run the
+sample application contained in the Derby Plug-ins User Guide.
+</li>
+</ol>
+
+<hr>
+<h2><a name="doc">Documentation</a></h2>
+<p>
+The html files included with the help plug-in have been updated with
+the following changes to reflect the changes due to the addition of the
+derby network client being used to connect to the network server, instead
+of the DB2 JDBC Driver:
+</p>
+<ul>
+<li>
+package name
+</li>
+<li>
+jar file name
+</li>
+<li>
+database connection URL
+</li>
+<li>
+screen shots
+</li>
+</ul>
+
+<hr>
+
+<h2><a name="items">TO DO or Questions to Resolve</a></h2>
+
+<p>
+This document has listed a few items which need to be resolved, and others
+that have not yet been mentioned. These items which need action or
+further discussion on the derby-dev mailing list are shown below.
+</p>
+<ol>
+<li>
+Determine source code structure for the repository of the UI source.
+</li>
+<li>
+Update BUILDING.TXT to include instructions on how to build the core plug-in.
+<ul>
+<li>
+Presently the instructions on how to build the core plug-in is only referenced in an email. These instructions need to be contained in the source tree.
+</li>
+</ul>
+</li>
+<li>
+Modify org.apache.derbyBuild.plugin.DerbyEclipsePlugin.java to add the new
+derbyclient.jar to the list of jars contained in the core plug-in.
+</li>
+<li>
+Provide a second document contained in the new source code structure
+explaining how to build the UI plugin in the Eclipse environment.
+</li>
+<li>
+Provide new documentation for the Apache Web site on how to use the
+new plug-ins.
+</li>
+<li>
+Updating existing documentation on the Apache Web site for the old plug-in.
+</li>
+<li>
+Provide the help files for the new plug-in on the Apache Web site.
+</li>
+</ol>
+
+<hr>
+
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/func_spec_plugins.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/index.xml
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/index.xml?rev=178570&r1=178569&r2=178570&view=diff
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/index.xml (original)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/index.xml Wed May 25 19:59:25 2005
@@ -38,11 +38,7 @@
<td> <a href="../binaries/UsingDotsDerbySystemTest.pdf"><em>Using DOTS
as Apache Derby System Test</em></a></td>
</tr>
-<tr>
- <td>Eclipse</td>
- <td><em><a href="derby_plugin.html">Apache Derby Core Plug-in
- for Eclipse</a></em></td>
-</tr>
+
<tr>
<td>EMMA</td>
<td><em><a href="../binaries/DerbyCodeCoverageUsingEmma.pdf">Derby
@@ -60,8 +56,51 @@
Integration</a></em></td>
</tr>
</table>
+<p>
+
+</p>
+
+<table>
+<tr>
+ <th>Navigation Menu Entry</th>
+ <th>Sub Menu Entry</th>
+ <th>Title</th>
+</tr>
+
+<tr>
+ <td>Eclipse Plug-ins</td>
+ <td>10.0 Core</td>
+ <td><em><a href="derby_plugin.html">Derby 10.0 Core Plug-in
+ for Eclipse</a></em></td>
+</tr>
+
+<tr>
+ <td> </td>
+ <td>1.0 UI Functional Spec</td>
+ <td><em><a href="func_spec_plugins.html">Derby 1.0 UI Plug-in for Eclipse</a></em></td>
+</tr>
+
+<tr>
+ <td> </td>
+ <td>10.1 Core and 1.0 UI</td>
+ <td><em><a href="plugin_howto.html">Using the 10.1 Core and 1.0 UI Derby plug-ins</a></em></td>
+</tr>
+
+<tr>
+ <td> </td>
+ <td>10.1 Core and 1.0 UI Slides and Lab</td>
+ <td><em><a href="plugin_slides.html">10.1 Derby Plug-ins
+ Presentation and Lab</a></em></td>
+</tr>
+
+<tr>
+ <td> </td>
+ <td>10.1 Core and 1.0 UI Documentation</td>
+ <td><em>10.1 Core and 1.0 UI Documentation</em></td>
+</tr>
+</table>
-<p><em>Last Updated: May 15, 2005</em></p>
+<p><em>Last Updated: May 24, 2005</em></p>
</body>
</document>
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/derby_app.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/derby_app.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/derby_app.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/derby_app.html Wed May 25 19:59:25 2005
@@ -0,0 +1,264 @@
+<html>
+<head>
+<title>Creating a Java application to access a Derby database</title>
+</head>
+<body>
+<h1>Creating a Java application to access a Derby database</h1>
+<p>
+Once you've become familiar with starting the network server and running
+SQL queries, you'll want to use Derby from within a Java application.
+This section will demonstrate using Derby from a stand-alone Java
+application.
+</p>
+<p>
+This example will access the data in our sample database, <b>myDB</b>,
+which contains the restaurants table. By following the two <a href="ij_toc.html"><b>ij</b></a> sections in the help, this database and table will have already
+been created and ready to use. If you have not created the database and the table return to the <a href="ij_toc.html"><b>ij</b></a> sections and create them now.
+</p>
+<h2>Steps to create a stand-alone Java application</h2>
+<ul>
+<li>
+From the <b>Java</b> perspective, select the project in the <b>Package Explorer</b> view. Right-click the project to bring up the context menu and select
+<b>New, Class</b>.
+</li>
+</ul>
+</p>
+<img src="images/new_class.GIF" alt="Creating a Java class in Eclipse" width="898" height="620"></img>
+<p>
+Give the Java class a package name, <b>myapp</b>, name the class
+<b>Restaurants</b>, make it a public class, and include a main method
+in the class since this will be a stand-alone application. The image
+below shows an example of this.
+Click <b>Finish</b> to create the class.
+</p>
+<img src="images/create_class.GIF" alt="New Java class wizard" width="515" height="566"></img>
+
+<p>
+The Java class shown below, <b>Restaurants.java</b>, connects to the Derby Network Server, inserts a row into the restaurants table, and then displays a select
+from the restaurants table. Copy the code below into the Java editor window
+for the <b>Restaurants.java</b> class you just created.
+</p>
+
+<pre>
+package myapp;
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.sql.Statement;
+import java.sql.ResultSetMetaData;
+
+
+public class Restaurants
+{
+ private static String dbURL = "jdbc:derby://localhost:1527/myDB;create=true;user=me;password=mine";
+ private static String tableName = "restaurants";
+ // jdbc Connection
+ private static Connection conn = null;
+ private static Statement stmt = null;
+
+ public static void main(String[] args)
+ {
+ createConnection();
+ insertRestaurants(5, "LaVals", "Berkeley");
+ selectRestaurants();
+ shutdown();
+ }
+
+ private static void createConnection()
+ {
+ try
+ {
+ Class.forName("org.apache.derby.jdbc.ClientDriver").newInstance();
+ //Get a connection
+ conn = DriverManager.getConnection(dbURL);
+ }
+ catch (Exception except)
+ {
+ except.printStackTrace();
+ }
+ }
+
+ private static void insertRestaurants(int id, String restName, String cityName)
+ {
+ try
+ {
+ stmt = conn.createStatement();
+ stmt.execute("insert into " + tableName + " values (" +
+ id + ",'" + restName + "','" + cityName +"')");
+ stmt.close();
+ }
+ catch (SQLException sqlExcept)
+ {
+ sqlExcept.printStackTrace();
+ }
+ }
+
+ private static void selectRestaurants()
+ {
+ try
+ {
+ stmt = conn.createStatement();
+ ResultSet results = stmt.executeQuery("select * from " + tableName);
+ ResultSetMetaData rsmd = results.getMetaData();
+ int numberCols = rsmd.getColumnCount();
+ for (int i=1; i<=numberCols; i++)
+ {
+ //print Column Names
+ System.out.print(rsmd.getColumnLabel(i)+"\t\t");
+ }
+
+ System.out.println("\n-------------------------------------------------");
+
+ while(results.next())
+ {
+ int id = results.getInt(1);
+ String restName = results.getString(2);
+ String cityName = results.getString(3);
+ System.out.println(id + "\t\t" + restName + "\t\t" + cityName);
+ }
+ results.close();
+ stmt.close();
+ }
+ catch (SQLException sqlExcept)
+ {
+ sqlExcept.printStackTrace();
+ }
+ }
+
+ private static void shutdown()
+ {
+ try
+ {
+ if (stmt != null)
+ {
+ stmt.close();
+ }
+ if (conn != null)
+ {
+ DriverManager.getConnection(dbURL + ";shutdown=true");
+ conn.close();
+ }
+ }
+ catch (SQLException sqlExcept)
+ {
+
+ }
+
+ }
+}
+</pre>
+<p>
+Once Restaurants.java is compiled without errors, run the Java application by
+right-clicking it from the Package Explorer view and selecting <b>Run, Java Application</b>.
+</p>
+
+<img src="images/run_javaapp.GIF" alt="Running a java application" width="936" height="712"></img>
+
+<p>
+The output from running <b>Restaurants.java</b> is shown below. It shows the
+successful insert of a row into our restaurants table and a select of all rows
+in the table. If you encounter any errors when running the application make
+sure the Derby Network Server has been started on port 1527 and the myDB
+database exists in the current workspace and Java project.
+</p>
+<img src="images/completed_javaapp.GIF" alt="Output from a java application" width="918" height="604"></img>
+
+<h2>Changing the application to use the Derby Embedded Driver</h2>
+<p>
+<b>Restaurants.java</b> accessed the Derby database, <b>myDB</b> using
+the Derby Network Client Driver. The values for loading the driver and the
+Database connection URL are shown below.
+</p>
+<ul>
+<li>
+<b>
+Driver name <br/>
+</b>
+org.apache.derby.jdbc.ClientDriver
+<br/><br/>
+</li>
+<li>
+<b>
+Database connection URL<br/>
+</b>
+jdbc:derby://localhost:1527/myDB;create=true;user=me;password=mine
+<br/><br/>
+</li>
+</ul>
+<p>
+To change the application to use the Derby Embedded Driver we need to change
+these values to:
+</p>
+<ul>
+<li>
+<b>
+Driver name <br/>
+</b>
+org.apache.derby.jdbc.EmbeddedDriver
+<br/><br/>
+</li>
+<li>
+<b>
+Database connection URL<br/>
+</b>
+jdbc:derby:myDB;create=true;user=me;password=mine
+<br/><br/>
+</li>
+</ul>
+
+<h2>About Schema Names</h2>
+<p>
+If a database is created in Derby using the embedded driver and no user
+name is specified, the default schema used becomes <b>APP</b>. Therefore
+any tables created in the database have a schema name of <b>APP</b>.
+However, when creating a Derby database using the Network Server, the value
+for the schema becomes the value of the username used to connect with as
+part of the database URL. In our example we first created the <b>myDB</b>
+database using the user <b>me</b>.
+</p>
+<p>
+When we change the application to connect using the embedded driver, the
+schema will default to <b>APP</b> unless we explicitly specify a schema,
+or pass the username as part of the Database connection URL. To access the
+table without passing the username as part of the embedded driver Database
+URL we would refer to the table as <b>ME.restaurants</b>.
+</p>
+<p>
+Only two lines of code need to be changed in Restaurants.java to use the
+Derby Embedded Driver to access the myDB database and insert and select into
+the me.restaurants table. The old values are listed below.
+</p>
+<pre>
+// variables
+private static String dbURL = "jdbc:derby://localhost:1527/myDB;create=true;user=me;password=mine";
+
+// from the createConnection method
+Class.forName("org.apache.derby.jdbc.ClientDriver").newInstance();
+</pre>
+<p>
+The new values are shown below to use the Embedded Driver.
+</p>
+<pre>
+// variables
+private static String dbURL = "jdbc:derby:myDB;create=true;user=me;password=mine";
+
+// from the createConnection method
+Class.forName("org.apache.derby.jdbc.EmbeddedDriver");
+</pre>
+
+<p>
+Comment out the old values and replace them with the new ones shown above.
+Recompile the class and if your Derby Network Server is running stop it before
+running the Java application with the Embedded Driver.
+</p>
+<p>
+Applications which use the Derby Embedded Driver may only access the database
+from the same JVM. Applications which use the Derby Network Server can
+access the database from other JVM's.
+</p>
+<p>
+</p>
+
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/derby_app.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij.html Wed May 25 19:59:25 2005
@@ -0,0 +1,90 @@
+<html>
+<head>
+<title>Using ij to issue SQL commands</title>
+</head>
+<body>
+<h1>Using ij to issue SQL commands</h1>
+<p>
+<b>ij</b>, the interactive SQL scripting tool provided with Derby, allows
+you to issue ad-hoc queries against a Derby database. Running <b>ij</b> from
+within Eclipse speeds application development by testing and running SQL
+statements prior to coding JDBC calls.
+</p>
+<h2>To launch <b>ij</b></h2>
+<ul>
+<li>
+Select the project and bring up the context menu. Select the menu item, <b>Apache Derby, ij (Interactive SQL)</b>.
+</li>
+</ul>
+<p>
+<img src="images/start_ij.GIF" width="782" height="682" alt="ij menu item"></img>
+</p>
+<ul>
+<li>
+The <b>Console</b> view will show the <b>ij</b> prompt.
+For this example we assume the Derby Network Server has been started; if you
+haven't started it, go ahead and start it up now.
+<br/><br/>
+</li>
+<li>
+The first step to using Derby is to connect to the database using a database
+JDBC connection URL. <br/>
+The database connection URL we'll use for this example will connect to our
+Network Server using the Derby Network Client driver on the localhost. We'll
+create a database called <b>myDB</b> as the user 'me' with a password of 'mine.'
+<br/>
+<br/>
+To connect to the database from <b>ij</b> we need to issue the <b>connect</b>
+command, so the entire command to connect to our database looks like this:
+<pre>
+connect 'jdbc:derby://localhost:1527/myDB;create=true;user=me;password=mine';
+</pre>
+</li>
+<li>
+Cut and paste the above connection URL into the <b>ij</b> console window.
+It should create a database in the current workspace, under the current Java
+project, called <b>myDB</b>.
+<br/><br/>
+</li>
+<li>
+We'll also create a table in our myDB database, insert some rows and select
+all rows from the table. Here is the SQL to do this:
+<pre>
+create table restaurants(id integer, name varchar(20), city varchar(50));
+insert into restaurants values (1, 'Irifunes', 'San Mateo');
+insert into restaurants values (2, 'Estradas', 'Daly City');
+insert into restaurants values (3, 'Prime Rib House', 'San Francisco');
+select * from restaurants;
+</pre>
+</li>
+<li>
+Cut and paste this SQL (one line at a time) into the <b>ij</b> console window.
+</li>
+</ul>
+</p>
+<p>
+Sample output from our <b>ij</b> session which runs the sql commands listed above is shown below.
+</p>
+<p>
+<img src="images/ij_commands.GIF" width="943" height="663" alt="ij console output"></img>
+</p>
+
+<p>
+The database connection URL shown above is used to connect to the Derby Network Server. If you want to connect to the database using the Derby JDBC embedded
+driver the connection URL would look like <b>jdbc:derby:myDB;create=true</b>
+and the ij command would be this:
+<pre>
+connect 'jdbc:derby:myDB;create=true';
+</pre>
+</p>
+<p>
+For detailed information on the proper syntax to use for the Connection URL
+refer to the Derby <i>Tools & Utility
+Guide</i>. The section called <b>Getting started with ij</b> provides the
+necessary information to start using ij.
+</p>
+<p>
+</p>
+
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij2.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij2.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij2.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij2.html Wed May 25 19:59:25 2005
@@ -0,0 +1,87 @@
+<html>
+<head>
+<title>Using ij to run SQL scripts</title>
+</head>
+<body>
+<h1>Using ij to run SQL scripts</h1>
+<p>
+<b>ij</b> scripts, files that end in an .sql extension and contain SQL
+commands, can be run using the Derby plug-ins.
+This allows you to use SQL scripts containing multiple commands
+and run them in a single execution of <b>ij</b>.
+</p>
+<h2>Follow these steps to run an SQL script</h2>
+<ul>
+<li>
+Create a script which contains SQL commands and save the file with a .sql
+extension. Remember to make the database connection your first command
+in the script - no default connection exists.
+<br/><br/>
+</li>
+<li>
+Save the file in your current workspace, under your Java project, or import
+it into your workspace.
+<br/><br/>
+</li>
+<li>
+Run the script using the menu item <b>Apache Derby, Run SQL script using 'ij'</b>
+<br/><br/>
+</li>
+<li>
+The output appears in the <b>ij</b> console window.
+<br/><br/>
+</li>
+</ul>
+<h2>Example of creating and running an SQL script</h2>
+<p>
+We'll go through a complete example below with an sql file called
+<b>restaurants.sql</b>. This script relies on a table we created in the
+help section, <a href="ij.html">Using ij to issue SQL commands.</a>
+Run that SQL prior to completing these steps.
+</p>
+<p>
+From the main Eclipse menu select <b>File, New, File</b>.
+</p>
+<img src="images/create_file.GIF" alt="Creating a new file in Eclipse" width="841" height="574"></img>
+<p>
+Use the current Java project as the parent folder, for example, myJavaProject.
+Name the file <b>restaurants.sql</b>, and click <b>Finish</b>.
+</p>
+<p>
+Now the workspace will look like this.
+</p>
+<img src="images/create_restaurant.GIF" alt="Adding an sql file to the Java project" width="850" height="575"></img>
+<p>
+Type the following in the restaurants.sql editor window (you may need to
+double click the restaurants.sql file to create an editor window to type in.)
+</p>
+<pre>
+connect 'jdbc:derby://localhost:1527/myDB;create=true;user=me;password=mine';
+insert into restaurants values (4, 'Grande Burrito', 'Oakland');
+update restaurants set city = 'Ukiah' where name = 'Irifunes';
+select * from restaurants;
+disconnect;
+exit;
+</pre>
+<p>
+Now save the restaurants.sql file so we can run the script. Use <b>Ctrl + S</b>
+in the windows environment to save an open file. Once the file has been saved
+the asterisk will disappear next to the name of the file in the editor.
+</p>
+<p>
+The last step is to run the SQL script. Right-click the <b>restaurants.sql</b>
+file in the <b>Package Explorer</b> view and select <b>Apache Derby, Run SQL
+Script using 'ij'</b>.
+</p>
+<img src="images/restaurant_editor.GIF" alt="Run SQL Script using 'ij'" width="910" height="663"></img>
+<p>
+The <b>Console</b> view shows the SQL commands contained in the file
+and executing in <b>ij</b> along with the output of the commands.
+</p>
+
+<img src="images/restaurant_script.GIF" alt="Console view of ij script output" width="910" height="633"></img>
+<p>
+</p>
+
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij2.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij_toc.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij_toc.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij_toc.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij_toc.html Wed May 25 19:59:25 2005
@@ -0,0 +1,21 @@
+<html>
+<head>
+<title>Using ij</title>
+</head>
+<body>
+<h1>Using ij</h1>
+<p>
+To issue SQL commands against a Derby database, use <b>ij</b>, the SQL
+scripting tool.
+</p>
+<h2>Using ij to issue SQL commands</h2>
+<p>
+ij, the interactive SQL scripting tool, can be run via the Eclipse console.
+See the page, <a href="ij.html">Using ij to issue SQL commands</a>
+</p>
+<h2>Using ij to run SQL scripts</h2>
+<p>
+Entire SQL <a href="ij2.html">scripts</a>, can be executed using ij.
+</p>
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/ij_toc.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/add_nature.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/add_nature.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/add_nature.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/completed_javaapp.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/completed_javaapp.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/completed_javaapp.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/create_class.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/create_class.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/create_class.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/create_file.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/create_file.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/create_file.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/create_restaurant.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/create_restaurant.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/create_restaurant.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/ij_commands.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/ij_commands.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/ij_commands.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/new_class.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/new_class.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/new_class.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/properties.gif
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/properties.gif?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/properties.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/properties_new.gif
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/properties_new.gif?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/properties_new.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/remove_nature.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/remove_nature.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/remove_nature.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/restaurant_editor.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/restaurant_editor.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/restaurant_editor.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/restaurant_script.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/restaurant_script.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/restaurant_script.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/run_javaapp.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/run_javaapp.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/run_javaapp.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/server_popup.gif
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/server_popup.gif?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/server_popup.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/shutdown_success.gif
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/shutdown_success.gif?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/shutdown_success.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/start_ij.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/start_ij.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/start_ij.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/start_server.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/start_server.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/start_server.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/start_server_console.gif
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/start_server_console.gif?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/start_server_console.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/stop_popup.gif
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/stop_popup.gif?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/stop_popup.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/stop_server.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/stop_server.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/stop_server.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/sysinfo_output.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/sysinfo_output.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/sysinfo_output.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/sysinfo_start.GIF
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/sysinfo_start.GIF?rev=178570&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/images/sysinfo_start.GIF
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/java_project.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/java_project.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/java_project.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/java_project.html Wed May 25 19:59:25 2005
@@ -0,0 +1,53 @@
+<html>
+<head>
+<title>Creating an Eclipse Java project</title>
+</head>
+<body>
+<h1>Creating an Eclipse Java project</h1>
+<p>
+The steps below outline how to create a Java project using many of the default
+settings to make it easy to get started.
+</p>
+<p>
+<ul>
+<li>
+From the main workbench window, click File > New > Project. The New Project
+wizard opens. <br/><br/>
+</li>
+<li>
+Select Java Project and click Next.<br/><br/>
+</li>
+<li>
+In the Project name field, type a name for your new Java project, like
+myJavaProject. <br/><br/>
+</li>
+<li>
+For Location, choose <b>Create project in workspace</b> and for the Project
+Layout, select <b>Use project folder as root for sources and class files</b>.
+<br/>
+<br/>
+</li>
+<li>
+Click the Next button, then Finish.
+<br/>
+<br/>
+</li>
+
+<li>
+You may be prompted about switching to the Java Perspective. Answer Yes to
+this question.
+<br/>
+<br/>
+</li>
+
+<li>
+The Package Explorer view now shows your new Java project.
+<br/>
+<br/>
+</li>
+</ul>
+
+</p>
+
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/java_project.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature.html Wed May 25 19:59:25 2005
@@ -0,0 +1,36 @@
+<html>
+<head>
+<title>Adding the Derby nature to a Java project</title>
+</head>
+<body>
+<h1>Adding the Derby nature to a Java project</h1>
+<p>
+Once a Java project is created the Derby nature can be added from within
+the Java perspective. To add the Derby nature to your project:
+</p>
+<ul>
+<li>
+From the <b>Java</b> perspective, select the project in the <b>Package Explorer</b> view. Right-click the project to bring up the context menu and select
+the menu item, <b>Apache Derby, Add Apache Derby nature</b>.
+</li>
+</ul>
+
+<img src="images/add_nature.GIF" alt="Adding the Derby nature to a project" width="720" height="615"></img>
+<p>
+Adding the Derby nature to your Java project does the following:
+</p>
+<ul>
+<li>
+Adds the <b>derby.jar, derbynet.jar, derbytools.jar, derbyclient.jar</b> jar files to the Java Build Path of the project.<br/><br/>
+</li>
+<li>
+Enables the Derby features for the project. The <b>ij</b> and <b>sysinfo</b>
+tools are now accessible from the Eclipse menu, and the Apache Derby Network Server can now be started and stopped from within Eclipse. <br/><br/>
+</li>
+<li>
+Allows Apache Derby properties to be set for the project.
+</li>
+</ul>
+
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature_toc.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature_toc.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature_toc.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature_toc.html Wed May 25 19:59:25 2005
@@ -0,0 +1,35 @@
+<html>
+<head>
+<title>The Derby Nature</title>
+</head>
+<body>
+<h1>The Derby Nature</h1>
+<p>
+Enabling a nature for a project allows a plug-in to give a project a
+personality or characteristics it desires. By adding the Derby Nature
+to a specific project you are enabling the Derby features for that project.
+</p>
+<p>
+<h2>Adding the Derby nature to a Java project</h2>
+<p>
+<a href="nature.html">Adding the Derby nature to a Java project</a>
+</p>
+<p>
+The Derby jar files are added to the Java project and the project class path
+is automatically updated to include these jar files. All Derby features,
+like starting and stopping the Network Server, and running <b>ij</b>
+and <b>sysinfo</b> are enabled for the project.
+</p>
+<p>
+<h2>Removing the Derby nature from a Java project</h2>
+<p>
+<a href="remove_nature.html">Removing the Derby nature from a Java project</a>
+</p>
+<p>
+All Derby jar files are removed from the project and all Derby
+features are disabled for the Java project.
+</p>
+<p>
+</p>
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/nature_toc.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/properties.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/properties.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/properties.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/properties.html Wed May 25 19:59:25 2005
@@ -0,0 +1,122 @@
+<html>
+<head>
+<title>Setting Derby properties for a project</title>
+</head>
+<body>
+<h1>Setting Derby properties for a project</h1>
+<p>
+Properties relating to Apache Derby can be specified for any project
+which has had the Apache Derby nature added to it. The two categories
+of properties available to change are the Network Server and Derby System
+properties.
+</p>
+<p>
+<b>Network Server Properties</b>
+</p>
+<p>
+By starting the Derby Network Server using the default values the
+server runs on the localhost, which is the host running Eclipse,
+on port 1527.
+</p>
+<p>
+The value used for the Network Server host name impacts the ability of
+remote hosts to connect to the Network Server. If the Network Server
+Host value in the Apache Derby Properties for the project is set to
+<b>localhost</b>, only clients running on the host where Eclipse is
+running can connect to the network server. If an ip address or hostname
+(other than the name 'localhost')
+is used, client applications running on other hosts can connect to the
+Derby Network Server. For additional information about starting the Derby
+Network Server see the <i>Derby Server and Administration Guide</i>.
+The section called <b>Starting the Network Server</b> explains the effect
+of setting the value for the hostname differently.
+</p>
+<p>
+If connections from other hosts is allowed, it is recommended to run
+under the Java security manager and enable user authentication prior to
+starting the Derby Network Server.
+</p>
+<b>Network Server Settings</b>
+<p>
+<ul>
+<li>
+Network Server Port - default value of 1527<br/><br/>
+Valid values for this field are:
+<ul>
+<li>
+Any port number not currently used by another process to listen on
+<br/><br/>
+</li>
+</ul>
+</li>
+<li>
+Network Server Host - default value of localhost <br/><br/>
+Valid values for this field are:
+<ul>
+<li>
+localhost
+</li>
+<li>
+The ip address of the host running Eclipse
+</li>
+<li>
+The host name of the host running Eclipse
+</li>
+<li>
+The ip address of 0.0.0.0 (to listen on all interfaces)
+</li>
+</ul>
+</li>
+</ul>
+</p>
+
+
+<p>
+<b>Derby System Properties</b>
+</p>
+<p>
+<b>derby.system.home</b> refers to the file system directory where the
+Derby database system will look for databases when Derby is started.
+Setting this property allows for ease of use when specifiying a JDBC
+connection URL to a Derby database which is not in the current directory.
+For additional information on <b>derby.system.home</b> refer to the <i>Tuning Derby</i> guide.
+</p>
+<p>
+<b>Derby System Property values</b>
+</p>
+<ul>
+<li>
+derby.system.home - default value of '.', the current project directory<br/><br/>
+Valid values for this field are:
+<ul>
+<li>A directory path on the local host. Either an existing directory or a new
+one which has not yet been created.
+</li>
+</ul>
+</li>
+</ul>
+</p>
+<h2>Changing the default Apache Derby properties for a project</h2>
+<p>
+<ul>
+<li>
+With the Java project active in the <b>Package Explorer</b> or <b>Navigator</b>
+view, select the menu item <b>Project, Properties</b>.
+</li>
+</ul>
+</p>
+<img src="images/properties_new.gif" alt="Project Properties" width="736" height="619"></img>
+
+<ul>
+<li>
+The list of properties available to modify for the project appears. Select
+the <b>Apache Derby</b> item in the list. <br/><br/>
+</li>
+<li>
+Make any of the desired changes to the Apache Derby settings.
+</li>
+</ul>
+</p>
+<img src="images/properties.gif" alt="Apache Derby project properties" width="541" height="406"></img>
+<p>
+</p>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/properties.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/remove_nature.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/remove_nature.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/remove_nature.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/remove_nature.html Wed May 25 19:59:25 2005
@@ -0,0 +1,35 @@
+<html>
+<head>
+<title>Removing the Derby nature from a Java project</title>
+</head>
+<body>
+<h1>Removing the Derby nature from a Java project</h1>
+<p>
+The Derby nature can be removed from a Java project from within the Java
+perspective. To remove the Derby nature:
+</p>
+<ul>
+<li>
+From the <b>Java</b> perspective, select the project in the <b>Package Explorer</b> view. Right-click the project to bring up the context menu and select
+the menu item, <b>Apache Derby, Remove Apache Derby nature</b>.
+</li>
+</ul>
+<img src="images/remove_nature.GIF" alt="Removing the Derby nature from a project" width="713" height="685"></img>
+<p>
+Removing the Derby nature from your Java project does the following:
+</p>
+<ul>
+<li>
+Removes the <b>derby.jar, derbynet.jar, derbytools.jar, derbyclient.jar</b> jar files from the Java Build Path of the project.<br/><br/>
+</li>
+<li>
+Removes the menu options for <b>ij</b>, <b>sysinfo</b> and starting and stopping
+the Derby Network Server. <br/><br/>
+</li>
+<li>
+Removes the <b>Apache Derby</b> item from the project's properties.
+</li>
+</ul>
+
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/remove_nature.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/resources.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/resources.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/resources.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/resources.html Wed May 25 19:59:25 2005
@@ -0,0 +1,15 @@
+<html>
+<head>
+<title>Derby Documentation</title>
+</head>
+<body>
+<h1>Derby Documentation</h1>
+<p>
+Derby documentation can be found on-line at
+<a href="http://incubator.apache.org/derby/manuals/index.html" target="_blank">http://incubator.apache.org/derby/manuals/index.html</a>.
+<br/><br/>
+</p>
+<p>
+</p>
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/resources.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/server_toc.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/server_toc.html?rev=178570&view=auto
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/server_toc.html (added)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/server_toc.html Wed May 25 19:59:25 2005
@@ -0,0 +1,34 @@
+<html>
+<head>
+<title>Starting and Stopping the Derby Network Server</title>
+</head>
+<body>
+<h1>Starting and Stopping the Derby Network Server</h1>
+<p>
+The Derby Network Server for the host running Eclipse can be started and
+stopped within Eclipse. Multiple network servers can be started
+using this option by changing the port number the Derby Network
+Server listens on.
+</p>
+<p>
+<h2>Starting the Derby Network Server</h2>
+<p>
+<a href="start_server.html">Starting the Derby Network Server</a>
+</p>
+<p>
+Multiple Derby Network Servers can be started on the host running Eclipse
+using this menu option. Additionally, the Derby Network Server can be
+started using the ip address of the host running Eclipse to allow remote
+client access to the network server.
+</p>
+<h2>Stopping the Derby Network Server</h2>
+<p>
+<a href="stop_server.html">Stopping the Derby Network Server</a>
+</p>
+<p>
+Any Derby Network Server started from within Eclipse can be stopped using this menu option.
+</p>
+<p>
+</p>
+</body>
+</html>
Propchange: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/plugin_help/server_toc.html
------------------------------------------------------------------------------
svn:eol-style = native