db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject svn commit: r441307 - in /db/derby/docs/trunk/src/workingwithderby: cwwdsummary.dita rwwdactivity3.dita twwdIntro.dita twwdactivity1.dita twwdactivity2.dita
Date Fri, 08 Sep 2006 00:23:47 GMT
Author: jta
Date: Thu Sep  7 17:23:46 2006
New Revision: 441307

URL: http://svn.apache.org/viewvc?view=rev&rev=441307
Log:
DERBY-1821 :  Fixed minor formatting and typos in the Working With Derby Guide.

Patch DERBY-1821_wwd_20060907.diff by Myrna van Lunteren <m.v.lunteren@gmail.com>.

Modified:
    db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita
    db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita
    db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita
    db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita
    db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita

Modified: db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita?view=diff&rev=441307&r1=441306&r2=441307
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/cwwdsummary.dita Thu Sep  7 17:23:46 2006
@@ -21,8 +21,8 @@
 <concept id="cwwdsummary" rev="1.0" xml:lang="en-us">
 <title>What next with Derby</title>
 <shortdesc>Congratulations on completing the activities in this workbook.
-You now have experience with using Derby in both the embedded and client /
-server architectures. With this basic knowledge you are ready to begin using
+You now have experience with using Derby in both the embedded and Client-Server 
+architectures. With this basic knowledge you are ready to begin using
 Derby to address your own specific needs. We recommend visiting the Apache
 Derby website as your next step in learning about this lightweight and powerful
 tool.</shortdesc>
@@ -39,7 +39,7 @@
 a few moments to become familiar with the many online resources available
 to Derby users and developers by browsing the Derby website at Apache. Whether
 you are performing a general evaluation of Derby or have a specific need to
-address the above link is a good stepping stone to finding additional information
+address, the above link is a good stepping stone to finding additional information
 of interest. The <xref format="html" href="http://db.apache.org/derby/quick_start.html"
 scope="local">Derby Quick Start page</xref> is a good reference page organized
 by area of interest. You will find many content rich areas such as the <cite>Derby

Modified: db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita?view=diff&rev=441307&r1=441306&r2=441307
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/rwwdactivity3.dita Thu Sep  7 17:23:46 2006
@@ -20,7 +20,7 @@
 -->
 <reference id="rwwdactivity3" rev="1.1" xml:lang="en-us">
 <title>The WwdEmbedded program</title>
-<shortdesc>This section describes the <codeph>WwdEmbedded</codeph> program,
+<shortdesc>This section describes the <codeph>WwdEmbedded.java</codeph>
program,
 highlighting details specific to accessing a Derby database from a JDBC program.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>WwdEmbedded.java<indexterm>code description</indexterm><indexterm>org.apache.derby.jdbc.EmbeddedDriver</indexterm></indexterm>
@@ -28,8 +28,8 @@
 <indexterm>SQLException</indexterm></keywords>
 </metadata></prolog>
 <refbody>
-<section>The <codeph>WwdEmbedded.java</codeph> program is described here.
-Most of the code related to the database activities performed is included
+<section>
+Most of the code related to the database activities performed is included in this document
 but you may find it helpful to open the program file and follow along in a
 text viewer or editor. The <cite>SECTION NAMES</cite> referred to in this
 text can be found in the comments within the program code and serve as cross-reference
@@ -37,7 +37,7 @@
 from the <codeph>WwdUtils</codeph> class. The utility class code is not described
 here but is available for review in the file <codeph>WwdUtils.java</codeph></section>
 <section><title>Initialize the program</title> <cite>INITIALIZATION
SECTION</cite>:
-The initial lines of code identify the Java libraries used in the program
+The initial lines of code identify the Java libraries used in the program,  
 then set up the Java class <codeph>WwdEmbedded</codeph> and the <codeph>main</codeph>
method
 signature. Refer to a standard Java programming guide for information on these
 program constructs.<codeblock frame="topbot">import java.sql.*;
@@ -93,7 +93,7 @@
 Program objects needed to perform subsequent SQL operations are initialized
 here and a check is made to see if the required data table exists.<p>The statement
 object <codeph>s</codeph> is initialized. If the utility method <codeph>WwdUtils.wwdChk4Table</codeph>
does
-not find the <varname>WISH_LIST</varname> table it is create by executing
+not find the <varname>WISH_LIST</varname> table it is created by executing
 the SQL stored in the variable <varname>createString</varname> via this statement
 object. </p><codeblock frame="topbot">s = conn.createStatement();
 if (! WwdUtils.wwdChk4Table(conn))
@@ -110,13 +110,13 @@
 </codeblock></section>
 <section><title>Interact with the Database</title><cite>ADD / DISPLAY
RECORD
 SECTION</cite>: This section uses the utility method <codeph>WwdUtils.getWishItem</codeph>
to
-gather information from the User. It then utilizes the objects setup previously
+gather information from the User. It then utilizes the objects set up previously
 to insert the data into the <varname>WISH_LIST</varname> table and then display
 all records. A standard <codeph>do</codeph> loop causes the program to repeat
 this series of steps until <userinput>exit</userinput> is entered.  The data
 related activities performed in this section are:<p>The <codeph>setString</codeph>
method
 sets the substitution parameter of the <codeph>psInsert</codeph> object to
-the value entered by the User then <codeph>executeUpdate</codeph> is called
+the value entered by the User. Then <codeph>executeUpdate</codeph> is called
 to perform the database insert.<codeblock frame="topbot">psInsert.setString(1,answer);
 psInsert.executeUpdate();  
 </codeblock></p><p>The statement object <codeph>s</codeph>
is used to select
@@ -137,7 +137,7 @@
 When an application starts the Derby engine it should shutdown all databases
 prior to exiting. The attribute <codeph>;shutdown=true</codeph> in the Derby
 connection URL performs the shutdown. The shutdown process cleans up records
-in the transaction log to insure a faster startup the next time the database
+in the transaction log to ensure a faster startup the next time the database
 is booted. <p>This section verifies that the embedded driver is being used
 then issues the shutdown command and catches the shutdown exception to confirm
 the database shutdown cleanly. The shutdown status is displayed before the

Modified: db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita?view=diff&rev=441307&r1=441306&r2=441307
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita Thu Sep  7 17:23:46 2006
@@ -40,7 +40,7 @@
 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
+transaction support. In its 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"
 scope="local">http://db.apache.org/derby</xref>.</p><p>Performing the
Working
@@ -72,9 +72,10 @@
 <dt>On UNIX Korn Shell platforms:</dt>
 <dd><codeblock frame="topbot"><b>&quot;$JAVA_HOME/bin/java&quot;
-version</b></codeblock></dd>
 </dlentry></dl></stepxmp><stepresult>The output from the command
will look
-something like this:<codeblock frame="topbot"><i>java version &quot;1.4.2_04&quot;
 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
+something like this:<codeblock frame="topbot"><i>java version &quot;1.4.2_04&quot;
 
+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
 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

Modified: db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita?view=diff&rev=441307&r1=441306&r2=441307
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdactivity1.dita Thu Sep  7 17:23:46 2006
@@ -22,14 +22,14 @@
 <title>Creating the database and running SQL</title>
 <prolog><metadata>
 <keywords><indexterm>Connection URL<indexterm>embedded driver</indexterm><indexterm>create=true</indexterm></indexterm>
-<indexterm>IJ</indexterm><indexterm>Database<indexterm>creating</indexterm><indexterm>connecting
+<indexterm>ij</indexterm><indexterm>Database<indexterm>creating</indexterm><indexterm>connecting
 to</indexterm></indexterm><indexterm>Derby<indexterm>logfile, message
and
 error</indexterm></indexterm><indexterm>SQL<indexterm>create table</indexterm><indexterm>insert</indexterm><indexterm>select</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <taskbody>
 <steps>
-<step><cmd>Run the Derby IJ tool.</cmd><stepxmp><dl><dlentry>
+<step><cmd>Run the Derby ij tool.</cmd><stepxmp><dl><dlentry>
 <dt>On Windows platforms:</dt>
 <dd><codeblock frame="topbot"><b>java -jar %DERBY_HOME%\lib\derbyrun.jar
ij</b>
 
@@ -101,7 +101,7 @@
 </codeblock></stepxmp></substep>
 </substeps>
 </step>
-<step><cmd>Exit the IJ tool.</cmd><stepxmp><codeblock frame="topbot"><b>exit;</b>
+<step><cmd>Exit the ij tool.</cmd><stepxmp><codeblock frame="topbot"><b>exit;</b>
 </codeblock></stepxmp></step>
 <step><cmd>Browse the key files created by the activity.</cmd><stepxmp><ul>
 <li>The <b><filepath><varname>derby.log</varname></filepath></b>
message and
@@ -124,8 +124,9 @@
 </ul></stepxmp></step>
 </steps>
 <postreq><dl><dlentry>
-<dt>Description of connection command: <codeph>connect 'jdbc:derby:firstdb;create=true';</codeph></dt>
-<dd><codeph>connect</codeph> - the IJ command to establish a connection
to
+<dt>Description of connection command:
+<codeph>connect 'jdbc:derby:firstdb;create=true';</codeph></dt>
+<dd><codeph>connect</codeph> - the ij command to establish a connection
to
 a database</dd>
 <dd>The Derby connection URL enclosed in single quotes:<ul>
 <li><codeph>jdbc:derby:</codeph> - JDBC protocol specification for the
Derby
@@ -136,7 +137,7 @@
 <li><codeph>;create=true</codeph> - The Derby <varname>URL attribute</varname>
used
 to create databases. Derby does not have an SQL <varname>create database</varname>
command.</li>
 </ul></dd>
-<dd><codeph><b>;</b></codeph>  (semicolon) - the IJ command
terminator.</dd>
+<dd><codeph><b>;</b></codeph>  (semicolon) - the ij command
terminator.</dd>
 </dlentry></dl></postreq>
 </taskbody>
 </task>

Modified: db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita?view=diff&rev=441307&r1=441306&r2=441307
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdactivity2.dita Thu Sep  7 17:23:46 2006
@@ -19,13 +19,13 @@
 limitations under the License.
 -->
 <task id="twwdactivity2" rev="1.1" xml:lang="en-us">
-<title>Activity 2: Run SQL using the Client Driver</title>
+<title>Activity 2: Run SQL using the Client driver</title>
 <shortdesc>This activity uses Derby within a Client-Server configuration by
 using the Network Server. The <codeph>ij</codeph> tool is the client application
 that connects to the Derby Network Server. A database called <codeph>seconddb</codeph>
is
 created and some basic SQL commands are executed.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Network Server</indexterm><indexterm>Client
Driver</indexterm>
+<keywords><indexterm>Network Server</indexterm><indexterm>Client
driver</indexterm>
 </keywords>
 </metadata></prolog>
 <taskbody>



Mime
View raw message