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 ha...@apache.org on 2006/06/21 23:01:57 UTC
svn commit: r416109 -
/db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita
Author: halleypo
Date: Wed Jun 21 14:01:57 2006
New Revision: 416109
URL: http://svn.apache.org/viewvc?rev=416109&view=rev
Log:
DERBY-1394 Working With Derby - Introduction and prerequisites - Improvements
Modified:
db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita
Modified: db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita?rev=416109&r1=416108&r2=416109&view=diff
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita Wed Jun 21 14:01:57 2006
@@ -1,40 +1,44 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- File Edit date of Contribution: May 10, 2006 -->
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
- "task.dtd">
+ "../dtd/task.dtd">
<!--
-Copyright 2006 The Apache Software Foundation or its licensors, as applicable.
+Copyright 2006 The Apache Software Foundation or its licensors, as applicable.
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0
+http://www.apache.org/licenses/LICENSE-2.0
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
limitations under the License.
-->
<task id="twwdIntro" rev="1.4" xml:lang="en-us">
<title>Introduction and prerequisites</title>
-<shortdesc>Welcome to Derby! We think you'll find Derby to be an easy to
-use and fully functional RDBMS. Through the activities in this document we
-hope to help you get up and running with Derby as quickly as possible. In
-way of introduction this sections provides a brief description of Derby. This
-is followed by information on the skills and software required to perform
-the activities presented in this document. The section ends with a brief description
-of what is presented by each of the Working With Derby activities .</shortdesc>
+<shortdesc>Welcome to Derby!
+To help you get up and running with Derby as quickly as possible,
+this self-study guide highlights some of the more important features of Derby
+through a series of activities designed to demonstrate the use of Derby in
+embedded and client-server configurations.
+After performing these activities, you will find Derby to be an easy to use and
+fully functional RDBMS.
+This section provides a brief description of Derby, followed by information on
+the skills and software required to perform the activities presented in this
+document, and ends with a brief description of what is presented by each of the
+Working With Derby activities.</shortdesc>
<prolog><metadata>
<keywords><indexterm>JAVA<indexterm>verifying</indexterm></indexterm><indexterm>Derby<indexterm>downloading</indexterm><indexterm>getting
help</indexterm></indexterm></keywords>
</metadata></prolog>
<taskbody>
-<context><p>Derby is a full featured, open source relational database engine
-that is written and implemented completely in Java. It provides users with
-a small footprint, standards-based Java database that can be tightly embedded
-into any Java based solution. Derby insures data integrity and provides sophisticated
+<context><p>Derby is a full featured, open source relational database engine.
+It is written and implemented completely in Java, and provides users with a
+small footprint standards-based database engine that can be tightly embedded
+into any Java based solution. Derby insures data integrity and provides sophisticated
transactional support. In it's default configuration there is no separate
database server to be installed or maintained by the end user. For more information
on Derby visit the Derby website at: <xref format="html" href="http://db.apache.org/derby"
@@ -42,10 +46,10 @@
With Derby activities requires no prior knowledge of Java, JDBC or SQL. Each
Activity Sequence section provides the complete command syntax needed to execute
each operation on a Windows machine or in a UNIX/Linux Korn shell. This document
-demonstrates but does not teach the Java, JDBC and SQL presented so readers
+demonstrates, but does not teach, the Java, JDBC and SQL presented, so readers
wishing a deeper understanding of these topics will need additional reference
materials.</p><p>Performing the Working With Derby activities does require
-that Java and Derby software be installed on the computer and the ability
+that Java and Derby software be installed on the computer, and the ability
to enter computer operating system commands. Specifically:<ul>
<li>A Java development kit version 1.3 or higher</li>
<li>The binary (<codeph>bin</codeph>) installation of Apache Derby version
@@ -54,7 +58,7 @@
<li>how to start a command shell or window</li>
<li>how to navigate the filesystem hierarchy</li>
</ul></li>
-</ul></p><p>If unsure about the Java or Derby environments installed perform
+</ul></p><p>If unsure about the Java or Derby environments installed, perform
the following steps before attempting the subsequent activities:</p></context>
<steps>
<step><cmd>Verify that the JAVA_HOME environment variable is set and points
@@ -62,25 +66,45 @@
window and run the command <codeph>java -version</codeph> using the appropriate
syntax for your system:</info><stepxmp><dl><dlentry>
<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>"%JAVA_HOME%\bin\java" -version</b></codeblock></dd>
+<dd><codeblock frame="topbot"><b>"%JAVA_HOME%\bin\java" -version</b></codeblock></dd>
</dlentry><dlentry>
<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>"$JAVA_HOME/bin/java" -version</b></codeblock></dd>
+<dd><codeblock frame="topbot"><b>"$JAVA_HOME/bin/java" -version</b></codeblock></dd>
</dlentry></dl></stepxmp><stepresult>The output from the command will look
-something like this:<codeblock frame="topbot"><i>java version "1.4.2_04" Java(TM) 2 Runtime Environment,
-Standard Edition (build 1.4.2_04-b05) Java HotSpot(TM)
+something like this:<codeblock frame="topbot"><i>java version "1.4.2_04" Java(TM) 2 Runtime Environment,
+Standard Edition (build 1.4.2_04-b05) Java HotSpot(TM)
Client VM (build 1.4.2_04-b05, mixed mode)</i></codeblock>The output you see
-may be different from what is shown here because the <userinput>java -version</userinput> command
+may be different from what is shown here, because the <userinput>java -version</userinput> command
outputs vendor-specific information. If the command produced an error or the
-version listed is not 1.3 or higher please install a Java development kit
+version listed is not 1.3 or higher, please install a Java development kit
before continuing.</stepresult></step>
-<step><cmd>Note the filesystem path to the Derby installation (referred to
-as <b>DERBY_HOME</b>).</cmd><info>If Derby is not installed or cannot be found
-please install a copy now. The most recent version of Derby can be downloaded
-from: <xref format="html" href="http://db.apache.org/derby/derby_downloads.html"
-scope="local"></xref>. From the Downloads page use the link to the 'Latest
-Official Release' then locate the <codeph>bin</codeph> distribution (e.g.
-db-derby-10.2.0-bin). Download the file and unbundle the release.</info></step>
+<step><cmd>Verify that the DERBY_HOME environment variable is set and points to
+the filesystem path to the root directory of the Derby 10.2 installation:</cmd>
+<info>Open a command window and run the appropriate command for your system:</info>
+<stepxmp><dl><dlentry>
+<dt>On Windows platforms:</dt>
+<dd><codeblock frame="topbot"><b>echo %DERBY_HOME%</b></codeblock></dd>
+</dlentry><dlentry>
+<dt>On UNIX Korn Shell platforms:</dt>
+<dd><codeblock frame="topbot"><b>echo $DERBY_HOME</b></codeblock></dd>
+</dlentry></dl>
+</stepxmp>
+<stepresult>The output from the command will look something like this:
+<codeblock frame="topbot"><i>Windows: C:\derby
+Unix/Linux: /opt/derby</i></codeblock>
+If Derby is not installed or cannot be found, please install a copy now.
+The most recent version of Derby can be downloaded from:
+<xref format="html" href="http://db.apache.org/derby/derby_downloads.html"
+scope="local"></xref>. From the Download page use the link to the 'Latest
+Official Release', then locate the <codeph>bin</codeph> distribution (e.g.
+db-derby-<version>-bin.zip and db-derby-<version>-bin.tar.gz).
+Download the appropriate file for your platform, '-bin.zip' for Windows or
+'-bin.tar.gz' for Unix/Linux, and unzip/untar this file. After decompressing
+the downloaded file, move the directory created to the filesystem path chosen
+to be the root directory of the Derby installation
+(e.g. move db-derby-<version>-bin C:\derby).
+</stepresult>
+</step>
</steps>
<postreq>Anyone having problems with any aspect of these activities can gain
assistance via e-mail by writing to derby-user@db.apache.org. The questions