db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scotsmat...@apache.org
Subject svn commit: r487729 [2/2] - /db/derby/docs/trunk/src/workingwithderby/
Date Sat, 16 Dec 2006 00:22:54 GMT
Modified: db/derby/docs/trunk/src/workingwithderby/twwdactivity3_Setup.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdactivity3_Setup.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdactivity3_Setup.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdactivity3_Setup.dita Fri Dec 15 16:22:53
2006
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!--       File Edit date of Contribution:  May 10, 2006         -->
 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
  "../dtd/task.dtd">
 <!-- 
@@ -18,84 +17,102 @@
 See the License for the specific language governing permissions and  
 limitations under the License.
 -->
-<task id="twwdactivity3_Setup" rev="1.1" xml:lang="en-us">
-<title>Activity 3: Run a JDBC program using the Embedded driver</title>
-<shortdesc>This activity loads the Derby database engine using a simple Java
-JDBC program. JDBC is the Java Database Connectivity API and is also the native
-API for Derby. The program uses the embedded driver to create (if needed)
-and then connect to the <codeph>jdbcDemoDB</codeph> database. You can then
-populate a table within the database with text. The program demonstrates some
-basic JDBC processing along with related error handling.</shortdesc>
+<task id="twwdactivity3_Setup" xml:lang="en-us">
+<title>Activity 3: Run a JDBC program using the embedded driver</title>
+<shortdesc>This activity loads the 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> database engine using

+a simple Java JDBC program. </shortdesc>
 <prolog><metadata>
-<keywords><indexterm>WwdEmbedded.java<indexterm>running</indexterm></indexterm>
-<indexterm>CLASSPATH</indexterm></keywords>
+<keywords><indexterm>WwdEmbedded.java program<indexterm>running</indexterm></indexterm>
+<indexterm>CLASSPATH environment variable</indexterm></keywords>
 </metadata></prolog>
 <taskbody>
 <prereq>This activity assumes that you have opened a command window, navigated
-to the <codeph>DERBYDBS</codeph> directory, and set the <varname>DERBY_HOME</varname>
environment
-variable.</prereq>
-<context>The <varname>CLASSPATH</varname> environment variable is used
by
-Java to locate the binary files (<term>jarfiles</term> and <term>classfiles</term>)
-needed to run Derby and other Java applications. Before performing this activity,
-you need to set the <varname>CLASSPATH</varname> and compile the <codeph>WwdEmbedded.java</codeph>
Java
-program. </context>
+to the <codeph>DERBYDBS</codeph> directory, and set the 
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>

+environment variable.</prereq>
+<context>JDBC is the Java Database Connectivity API and is also the native API 
+for <ph conref="wwdconrefs.dita#prod/productshortname"></ph>. The program uses

+the embedded driver to create the <codeph>jdbcDemoDB</codeph> database (if it

+does not exist) and then connect to it. You can then populate a table within 
+the database with text. The program demonstrates some basic JDBC processing 
+along with related error handling. 
+<p>The Java compiler and runtime use the classpath, specified by the 
+<codeph>CLASSPATH</codeph> environment variable, to locate the binary files 
+(jar files and class files) that are needed to run 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> and other Java 
+applications. Before performing this activity, you need to set the classpath 
+and compile the <codeph>WwdEmbedded.java</codeph> program.</p></context>
 <steps>
 <step><cmd>Copy the program files into the <codeph>DERBYDBS</codeph>
directory
-and set the <varname>CLASSPATH</varname>:</cmd><stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>copy %DERBY_HOME%\demo\programs\workingwithderby\*
.
-
-set CLASSPATH=%DERBY_HOME%\lib\derby.jar;.</b>
-</codeblock></dd>
-</dlentry><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>cp $DERBY_HOME/demo/programs/workingwithderby/*
.
-
-export CLASSPATH=$DERBY_HOME/lib/derby.jar:.</b>
-</codeblock></dd>
-</dlentry></dl><note type="important">Include the dot (<b>.</b>)
at the end
-of each command so that your current working directory is included in the <varname>CLASSPATH</varname>
and
-the files are copied to the correct location.</note></stepxmp></step>
-<step><cmd>Compile the <codeph>WwdEmbedded.java</codeph> program:</cmd><stepxmp><codeblock
-frame="topbot"><b>javac WwdEmbedded.java</b>
-</codeblock><note type="important">Only a command prompt will be displayed
-if the compilation is successful. The binary file <codeph>WwdEmbedded.class</codeph>
will
-be created. If an error is displayed please verify that the Java development
-kit is properly installed.</note></stepxmp></step>
-<step><cmd>Run the program:</cmd><info>The <codeph>WwdEmbedded.java</codeph>
program
-populates a table with wish list items. It is a simple Java program that prompts
-the User for text input (up to 32 characters), stores the text entered in
-a database table and then lists the items stored in the table. The program
-will continue to ask for wish list items until the word <userinput>exit</userinput>
is
-entered or a problem is encountered. Some basic information on program progress
-is displayed at the beginning and the end of the program.</info><stepxmp><codeblock
-frame="topbot"><b>java WwdEmbedded</b>
-
-<i>org.apache.derby.jdbc.EmbeddedDriver loaded.
+and set the classpath.</cmd>
+<stepxmp><simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Commands</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>copy %DERBY_HOME%\demo\programs\workingwithderby\*
.
+
+set CLASSPATH=%DERBY_HOME%\lib\derby.jar;.</userinput></b>
+</codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>cp $DERBY_HOME/demo/programs/workingwithderby/*
.
+
+export CLASSPATH=$DERBY_HOME/lib/derby.jar:.</userinput></b>
+</codeblock></stentry>
+</strow>
+</simpletable>
+<note type="important">Include the dot (<codeph>.</codeph>) at the end
+of each command so that your current working directory is included in the 
+classpath and the files are copied to the correct location.
+</note></stepxmp></step>
+<step><cmd>Compile the <codeph>WwdEmbedded.java</codeph> program.</cmd>
+<stepxmp><codeblock><b><userinput>javac WwdEmbedded.java</userinput></b>
+</codeblock>
+<note type="important">A command prompt appears if the compilation is 
+successful. The binary file <codeph>WwdEmbedded.class</codeph> is created. If

+an error message appears, verify that the JDK is properly installed.</note>
+</stepxmp></step>
+<step><cmd>Run the program.</cmd>
+<info><p>The <codeph>WwdEmbedded.java</codeph> program populates
a table with 
+wish-list items. It prompts the user for text input (up to 32 characters), 
+stores the text input in a database table, and then lists the items stored in 
+the table. The program continues to ask for wish-list items until the user 
+types the command <codeph>exit</codeph> or a problem is encountered. Some basic

+information on program progress is displayed at the beginning and the end of 
+the program.</p></info>
+<stepxmp>
+<codeblock><b><userinput>java WwdEmbedded</userinput></b>
+<systemoutput>
+org.apache.derby.jdbc.EmbeddedDriver loaded.
 Connected to database jdbcDemoDB
  . . . . creating table WISH_LIST
 
-Enter wish-list item (enter exit to end):</i>
-<b>a peppermint stick</b>
-
-<i>  _________________________________________________________
-On 2006-09-21 15:11:50.412 I wished for a peppermint stick
-  ________________________________________________________
-
-Enter wish-list item (enter exit to end):</i>
-<b>an all expenses paid vacation</b>
-
-<i>  ________________________________________________________
-On 2006-09-21 15:11:50.412 I wished for a peppermint stick
-On 2006-09-21 15:12:47.024 I wished for an all expenses paid vacation
-  ________________________________________________________
-
-Enter wish-list item (enter exit to end):</i>
-<b>exit</b>
-
-<i>Closed connection
+Enter wish-list item (enter exit to end):</systemoutput>
+<b><userinput>a peppermint stick</userinput></b>
+<systemoutput>
+__________________________________________________________
+On <varname>date</varname> 15:11:50.412 I wished for a peppermint stick
+__________________________________________________________
+
+Enter wish-list item (enter exit to end):</systemoutput>
+<b><userinput>an all expenses paid vacation</userinput></b>
+<systemoutput>
+__________________________________________________________
+On <varname>date</varname> 15:11:50.412 I wished for a peppermint stick
+On <varname>date</varname> 15:12:47.024 I wished for an all expenses paid vacation
+__________________________________________________________
+
+Enter wish-list item (enter exit to end):</systemoutput>
+<b><userinput>exit</userinput></b>
+<systemoutput>
+Closed connection
 Database shut down normally
-Working With Derby JDBC program ending.</i></codeblock></stepxmp></step>
+Working With Derby JDBC program ending.</systemoutput></codeblock></stepxmp></step>
 </steps>
 </taskbody>
 </task>

Modified: db/derby/docs/trunk/src/workingwithderby/twwdactivity4.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdactivity4.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdactivity4.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdactivity4.dita Fri Dec 15 16:22:53 2006
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!--       File Edit date of Contribution:  May 10, 2006         -->
 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
  "../dtd/task.dtd">
 <!-- 
@@ -18,63 +17,85 @@
 See the License for the specific language governing permissions and  
 limitations under the License.
 -->
-<task id="twwdactivity4" rev="1.0" xml:lang="en-us">
-<title>Activity 4: Create and run a JDBC program using the Client driver and
+<task id="twwdactivity4" xml:lang="en-us">
+<title>Activity 4: Create and run a JDBC program using the client driver and
 Network Server</title>
 <shortdesc>This section demonstrates the ease with which a program that embeds
-Derby can be modified for a client/server implementation using the Derby
-Network Server. A Derby client program, <codeph>WwdClient.java</codeph>, is
-created by changing a few lines of the <codeph>WwdEmbedded.java</codeph> program.
-The client program can be run in multiple command shells allowing simultaneous
-update from two or more sources.</shortdesc>
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> can be modified for
a 
+client/server implementation that uses the 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Network Server.
+</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>WwdClient.java<indexterm>org.apache.derby.jdbc.ClientDriver</indexterm></indexterm>
+<keywords><indexterm>WwdClient.java program<indexterm>org.apache.derby.jdbc.ClientDriver</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <taskbody>
-<prereq>This activity assumes you have performed the preceding activities
-and so have a working directory called <codeph>DERBYDBS</codeph>, are familiar
-with setting the <varname>DERBY_HOME</varname> and <varname>CLASSPATH</varname>
environment
-variables and have copies of the program files from the <varname>$DERBY_HOME/demo/programs/workingwithderby/</varname>
directory.
-A basic knowledge of the <codeph>WwdEmbedded.java</codeph> program and experience
-starting and connecting to Network Server is helpful. You will need to use
-a text editor to create the <codeph>WwdClient.java</codeph> program.</prereq>
-<context>Two command windows (<codeph>Server-Shell</codeph> and <codeph>Client-Shell</codeph>)
-are used in this activity. The <codeph>Server-Shell</codeph> is used to start
-the Derby Network Server and display Network Server messages. The <codeph>Client-Shell</codeph>
is
-used to edit, compile and run the newly created <codeph>WwdClient.java</codeph>
program.
-The <varname>CLASSPATH</varname> environment variable is set in <codeph>Client-Shell</codeph>
to
-support the client JDBC program.</context>
+<prereq>This activity assumes you have performed the preceding activities and so 
+have a working directory called <codeph>DERBYDBS</codeph>, are familiar with

+setting the 
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>
and 
+<codeph>CLASSPATH</codeph> environment variables, and have copies of the 
+program files from the 
+<codeph>$<ph conref="wwdconrefs.dita#prod/productinstallpath"></ph>/demo/programs/workingwithderby/</codeph>

+directory. A basic knowledge of the <codeph>WwdEmbedded.java</codeph> program

+and experience starting and connecting to the Network Server are helpful. You 
+will need to use a text editor to create the <codeph>WwdClient.java</codeph>

+program.</prereq>
+<context>You will create a 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> client program, 
+<codeph>WwdClient.java</codeph>, by changing a few lines of the 
+<codeph>WwdEmbedded.java</codeph> program. You can run the client program in

+multiple command shells, allowing simultaneous update from two or more sources.
+<p>You use two command windows (Server-Shell and Client-Shell) in this 
+activity. You use the Server-Shell to start the 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Network Server and 
+display Network Server messages. You use the Client-Shell to edit, compile and 
+run the newly created <codeph>WwdClient.java</codeph> program. You set the 
+<codeph>CLASSPATH</codeph> environment variable in the Client-Shell to support

+the client JDBC program.</p></context>
 <steps>
-<step><cmd><b>Create the WwdClient program.</b></cmd>
+<step><cmd>Create the <codeph>WwdClient</codeph> program using the
following 
+steps:</cmd>
 <substeps>
-<substep><cmd>Open a command window that we'll call the <codeph>Client-Shell</codeph>.</cmd>
+<substep><cmd>Open a command window (Client-Shell).</cmd>
 </substep>
-<substep><cmd>Change directory (<userinput>cd</userinput>) to the
<codeph>DERBYDBS</codeph> directory.</cmd>
+<substep><cmd>Change directory (<codeph>cd</codeph>) to the 
+<codeph>DERBYDBS</codeph> directory.</cmd>
 </substep>
-<substep><cmd>Make a copy of the <codeph>WwdEmbedded.java</codeph>
program called <codeph>WwdClient.java</codeph>.</cmd>
-<stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>copy WwdEmbedded.java WwdClient.java</b>
-</codeblock></dd>
-</dlentry></dl><dl><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>cp WwdEmbedded.java WwdClient.java</b>
-</codeblock></dd>
-</dlentry></dl></stepxmp></substep>
-<substep><cmd>Open the <codeph>WwdClient.java</codeph> file in your
favorite
-text editor and update the class name to reflect the new filename:</cmd><stepxmp><codeblock
-frame="topbot"><b>Original declaration</b>
+<substep><cmd>Make a copy of the <codeph>WwdEmbedded.java</codeph>
program 
+called <codeph>WwdClient.java</codeph>.</cmd>
+<stepxmp>
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>copy WwdEmbedded.java WwdClient.java</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>cp WwdEmbedded.java WwdClient.java</userinput></b></codeblock></stentry>
+</strow>
+</simpletable>
+</stepxmp>
+</substep>
+<substep>
+<cmd>Open the <codeph>WwdClient.java</codeph> file in a text editor and
update 
+the class name to reflect the new file name:</cmd>
+<stepxmp><codeblock><b>Original declaration</b>
      public class WwdEmbedded
 
 <b>New declaration</b>
      public class <b>WwdClient</b>
 </codeblock></stepxmp></substep>
-<substep><cmd>Edit the <cite>DEFINE VARIABLES SECTION</cite> of the
program so
-the <varname>driver</varname> variable contains the name of the Derby Client
-Driver class and the <varname>connectionURL</varname> variable contains the
-hostname and a port number of the Network Server.</cmd><stepxmp><codeblock
-frame="topbot"><b>Original definitions</b>
+<substep><cmd>Edit the <cite>DEFINE VARIABLES SECTION</cite> of the
program so 
+that the <codeph>driver</codeph> variable contains the name of the 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> client driver class

+and the <codeph>connectionURL</codeph> variable contains the hostname and port

+number of the Network Server.</cmd>
+<stepxmp><codeblock><b>Original definitions</b>
      String driver = "org.apache.derby.jdbc.EmbeddedDriver";
      String dbName="jdbcDemoDB";
      String connectionURL = "jdbc:derby:" + dbName + ";create=true";
@@ -84,155 +105,194 @@
      ...
      String connectionURL = <b>"jdbc:derby://localhost:1527/"</b> + dbName +
";create=true";
 </codeblock></stepxmp></substep>
-<substep><cmd>Compile the application.</cmd><stepxmp><codeblock
frame="topbot"><b>javac WwdClient.java</b>
-</codeblock><note type="important">Only a command prompt will be displayed
-if the compilation is successful. The binary file <codeph>WwdClient.class</codeph>
will
-be created. If a syntax error is displayed, modify the line indicated so it
-is identical to the example.</note></stepxmp><info><p>That's all
there is
-to it.</p></info></substep>
+<substep><cmd>Compile the application.</cmd>
+<stepxmp><codeblock><b><userinput>javac WwdClient.java</userinput></b>
+</codeblock>
+</stepxmp>
+<stepresult>A command prompt appears if the compilation is successful. The 
+binary file <codeph>WwdClient.class</codeph> is created. If an error message

+appears, modify the line indicated so that it is identical to the example.
+</stepresult></substep>
 </substeps>
 </step>
-<step><cmd><b>Set up the client/server environment.</b></cmd>
-<info><p>Before you run the <codeph>WwdClient</codeph> program, the
Network 
-Server needs to be started.</p>
-</info>
+<step><cmd>Set up the client/server environment using the following steps:</cmd>
 <substeps>
 <substep>
-<cmd>Open a command window that we'll call the <codeph>Server-Shell</codeph>.</cmd>
+<cmd>Open a command window (Server-Shell).</cmd>
 </substep>
 <substep>
-<cmd>Change directory (<userinput>cd</userinput>) to the <codeph>DERBYDBS</codeph>
directory.</cmd>
+<cmd>Change directory (<codeph>cd</codeph>) to the <codeph>DERBYDBS</codeph>

+directory.</cmd>
 </substep>
 <substep>
-<cmd>Set the <varname>DERBY_HOME</varname> environment variable.</cmd>
+<cmd>Set the 
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>

+environment variable.</cmd>
 </substep>
 <substep>
 <cmd>Start the Network Server:</cmd>
-<stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar %DERBY_HOME%\lib\derbynet.jar
start</b>
-
-<i>Apache Derby Network Server - 10.2.1.6 - (452058) started and
- ready to accept connections on port 1527 at 2006-09-22 
- 00:56:33.091 GMT</i></codeblock></dd>
-</dlentry></dl><dl><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar $DERBY_HOME/lib/derbynet.jar
start</b>
-
-<i>Apache Derby Network Server - 10.2.1.6 - (452058) started and
- ready to accept connections on port 1527 at 2006-09-22 
- 00:56:33.091 GMT</i></codeblock></dd>
-</dlentry></dl></stepxmp>
+<stepxmp>
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbynet.jar
start</userinput></b>
+
+Apache Derby Network Server - <varname>version</varname> - (<varname>tag</varname>)
started and
+ ready to accept connections on port 1527 at <varname>date</varname> 
+ 00:56:33.091 GMT</codeblock></stentry>
+ </strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbynet.jar
start</userinput></b>
+
+Apache Derby Network Server - <varname>version</varname> - (<varname>tag</varname>)
started and
+ ready to accept connections on port 1527 at <varname>date</varname> 
+ 00:56:33.091 GMT</codeblock></stentry>
+ </strow>
+</simpletable>
+</stepxmp>
 </substep>
 </substeps>
 </step>
-<step><cmd><b>Run the client program.</b></cmd>
+<step><cmd>Run the client program using the following steps:</cmd>
 <substeps>
 <substep>
-<cmd>Return to the <codeph>Client-Shell</codeph> window.</cmd>
+<cmd>Return to the Client-Shell window.</cmd>
 </substep>
 <substep>
-<cmd>If it is not already defined, set the <varname>DERBY_HOME</varname>
environment variable.
-</cmd>
+<cmd>If it is not already defined, set the 
+<codeph><ph conref="wwdconrefs.dita#prod/productinstallpath"></ph></codeph>

+environment variable.</cmd>
 </substep>
 <substep>
-<cmd>Set the <varname>CLASSPATH</varname> environment variable to include
-the location of the file <codeph>derbyclient.jar</codeph>:</cmd>
-<stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>set CLASSPATH=%DERBY_HOME%\lib\derbyclient.jar;.</b>
-</codeblock></dd>
-</dlentry></dl><dl><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>export CLASSPATH=$DERBY_HOME/lib/derbyclient.jar:.</b>
-</codeblock></dd>
-</dlentry></dl><note type="important">Include the dot (<b>.</b>)
at the end
-of the command so that your current working directory is included in the <varname>CLASSPATH</varname>.</note>
-</stepxmp>
-</substep>
+<cmd>Set the <codeph>CLASSPATH</codeph> environment variable to include
the 
+location of the file <codeph>derbyclient.jar</codeph>:</cmd>
+<stepxmp>
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>set CLASSPATH=%DERBY_HOME%\lib\derbyclient.jar;.</userinput></b></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>export CLASSPATH=$DERBY_HOME/lib/derbyclient.jar:.</userinput></b></codeblock></stentry>
+</strow>
+</simpletable>
+<note type="important">Include the dot (<codeph>.</codeph>) at the end
of the 
+command so that your current working directory is included in the classpath.
+</note>
+</stepxmp></substep>
 <substep>
 <cmd>Run the program:</cmd>
 <stepxmp>
-<codeblock frame="topbot"><b>java WwdClient</b>
-
-<i>org.apache.derby.jdbc.ClientDriver loaded.
+<codeblock><b><userinput>java WwdClient</userinput></b>
+<systemoutput>
+org.apache.derby.jdbc.ClientDriver loaded.
 Connected to database jdbcDemoDB
 
-Enter wish-list item (enter exit to end):</i>
-<b>a sunny day</b>
-
-<i>  _________________________________________________________
-On 2006-09-21 15:11:50.412 I wished for a peppermint stick
-On 2006-09-21 15:12:47.024 I wished for an all expenses paid vacation
-On 2006-09-22 10:08:21.167 I wished for a sunny day
-  ________________________________________________________
-
-Enter wish-list item (enter exit to end):</i>
-<b>a new car</b>
-
-<i>  ________________________________________________________
-On 2006-09-21 15:11:50.412 I wished for a peppermint stick
-On 2006-09-21 15:12:47.024 I wished for an all expenses paid vacation
-On 2006-09-22 10:08:21.167 I wished for a sunny day
-On 2006-09-22 10:08:33.665 I wished for a new car
-  ________________________________________________________
-
-Enter wish-list item (enter exit to end):</i>
-<b>exit</b>
-
-<i>Closed connection
-Working With Derby JDBC program ending.</i></codeblock>
+Enter wish-list item (enter exit to end):</systemoutput>
+<b><userinput>a sunny day</userinput></b>
+<systemoutput>
+__________________________________________________________
+On <varname>date</varname> 15:11:50.412 I wished for a peppermint stick
+On <varname>date</varname> 15:12:47.024 I wished for an all expenses paid vacation
+On <varname>date</varname> 10:08:21.167 I wished for a sunny day
+__________________________________________________________
+
+Enter wish-list item (enter exit to end):</systemoutput>
+<b><userinput>a new car</userinput></b>
+<systemoutput>
+__________________________________________________________
+On <varname>date</varname> 15:11:50.412 I wished for a peppermint stick
+On <varname>date</varname> 15:12:47.024 I wished for an all expenses paid vacation
+On <varname>date</varname> 10:08:21.167 I wished for a sunny day
+On <varname>date</varname> 10:08:33.665 I wished for a new car
+__________________________________________________________
+
+Enter wish-list item (enter exit to end):</systemoutput>
+<b><userinput>exit</userinput></b>
+<systemoutput>
+Closed connection
+Working With Derby JDBC program ending.</systemoutput></codeblock>
 </stepxmp>
 </substep>
 </substeps>
 </step>
-<step><cmd><b>Shut down the Network Server.</b></cmd>
-<stepxmp><dl><dlentry>
-<dt>On Windows platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar %DERBY_HOME%\lib\derbynet.jar
shutdown</b>
-
-<i>Apache Derby Network Server - 10.2.1.6 - (452058) shutdown 
- at 2006-09-22 19:13:51.445 GMT</i>
-</codeblock></dd>
-</dlentry></dl><dl><dlentry>
-<dt>On UNIX Korn Shell platforms:</dt>
-<dd><codeblock frame="topbot"><b>java -jar $DERBY_HOME/lib/derbynet.jar
shutdown</b>
-
-<i>Apache Derby Network Server - 10.2.1.6 - (452058) shutdown 
- at 2006-09-22 19:13:51.445 GMT</i>
-</codeblock></dd>
-</dlentry></dl></stepxmp><stepresult>The server shutdown confirmation
appears
-in both command windows.</stepresult></step>
+<step><cmd>Shut down the Network Server:</cmd>
+<stepxmp>
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbynet.jar
shutdown</userinput></b>
+
+<systemoutput>Apache Derby Network Server - <varname>version</varname>
- (<varname>tag</varname>) shutdown 
+ at <varname>date</varname> 19:13:51.445 GMT
+</systemoutput></codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbynet.jar
shutdown</userinput></b>
+
+<systemoutput>Apache Derby Network Server - <varname>version</varname>
- (<varname>tag</varname>) shutdown 
+ at <varname>date</varname> 19:13:51.445 GMT</systemoutput>
+</codeblock></stentry>
+</strow>
+</simpletable>
+</stepxmp>
+<stepresult>The server shutdown confirmation appears in both command 
+windows.</stepresult></step>
 </steps>
-<postreq><b>Activity notes</b><p>In a client/server environment,
the client
-program is often used from other computers on the network. Whenever a system
-accepts connections from other computers, there is a chance of abuse. To maintain
-security, the Derby Network Server defaults to accepting connections only from
-clients running on the local machine (<codeph>localhost</codeph>). Before
-this or any other Derby client program can access Network Server from another
-machine, additional steps should be taken to secure the Network Server environment.
-Once secured, the Network Server can be safely configured to accept connections
-from other machines. Refer to the <cite>Network Server security</cite> and <cite>Running
-the Network Server under the security manager</cite> sections of the <cite>Derby
-Server and Administration Guide</cite> for important information on securing
-the Network Server and enabling network connections.</p><p>With Network Server
-started, you can run the client program simultaneously in multiple windows.
-To demonstrate this, open two command windows and perform the substeps of the <cite>Run
-the client program</cite> step in each window. Both clients will operate
-without a problem. In contrast, it would not be possible for a program that
-uses the embedded driver (e.g. <codeph>WwdEmbedded</codeph>) to access the
-database until the database or the Network Server is shut down. </p><p>You
-may have noticed that the client program does not shut down the database. This
-is because the database is a shared resource in a client/server environment
-and, in most cases, should only be shut down when the Server is shut down. If
-multiple clients are accessing the database and one shuts down the database,
-the remaining clients will encounter a failure the next time they attempt
-an SQL command.</p><p>Derby's two architectures have caused confusion for
-some new Derby users. They mistakenly think that embedded is a single user
-configuration. This is not true. The embedded driver supports multiple simultaneous
-connections, performs locking, and provides performance, integrity and recoverability.
-Any application using the embedded driver can open multiple Derby connections
-and then provide a means for multiple users to interact with the database
-on each connection. The Derby Network Server is an example of such an application.</p></postreq>
+<postreq><b>Activity notes</b>
+<p>In a client/server environment, the client program is often used from other 
+computers on the network. Whenever a system accepts connections from other 
+computers, there is a chance of abuse. To maintain security, the 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> Network Server 
+defaults to accepting connections only from clients running on the local 
+machine (<codeph>localhost</codeph>). Before this or any other 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> client program can 
+access the Network Server from another machine, additional steps should be 
+taken to secure the Network Server environment. Once secured, the Network 
+Server can be safely configured to accept connections from other machines. 
+Refer to the "Network Server security" and "Running the Network Server under 
+the security manager" sections of the 
+<cite><ph conref="wwdconrefs.dita#pub/citadmin"></ph></cite> for
important 
+information on securing the Network Server and enabling network 
+connections.</p>
+<p>With the Network Server started, you can run the client program 
+simultaneously in multiple windows. To demonstrate this, open two command 
+windows and perform the substeps of the "Run the client program" step in 
+each window. Both clients will operate without a problem. In contrast, it would 
+not be possible for a program that uses the embedded driver (for example, 
+<codeph>WwdEmbedded.java</codeph>) to access the database until the database
or 
+the Network Server is shut down.</p>
+<p>You may have noticed that the client program does not shut down the 
+database. This is because the database is a shared resource in a client/server 
+environment and, in most cases, should be shut down only when the Network 
+Server is shut down. If multiple clients are accessing the database and one 
+client shuts down the database, the remaining clients will encounter a failure 
+the next time they attempt an SQL command.</p>
+<p><ph conref="wwdconrefs.dita#prod/productshortname"></ph>'s two architectures

+have caused confusion for some new 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> users, who mistakenly

+think that embedded is a single-user configuration. This is not true. The 
+embedded driver supports multiple simultaneous connections, performs locking, 
+and provides performance, integrity, and recoverability. Any application that 
+uses the embedded driver can open multiple 
+<ph conref="wwdconrefs.dita#prod/productshortname"></ph> connections and then

+provide a means for multiple users to interact with the database on each 
+connection. The <ph conref="wwdconrefs.dita#prod/productshortname"></ph> 
+Network Server is an example of such an application.</p></postreq>
 </taskbody>
 </task>

Modified: db/derby/docs/trunk/src/workingwithderby/wwdconrefs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/wwdconrefs.dita?view=diff&rev=487729&r1=487728&r2=487729
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/wwdconrefs.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/wwdconrefs.dita Fri Dec 15 16:22:53 2006
@@ -19,11 +19,41 @@
  "../dtd/ditabase.dtd">
 
 <dita>
+<concept id="prod" xml:lang="en-us">
+<title>Product specific entities</title>
+<conbody>
+<p>Naming convention: <userinput><varname>abb</varname></userinput>
(abbreviation
+for product) followed by <userinput>l</userinput> (long version) or <userinput>s</userinput>
(short
+version), followed by <userinput>t</userinput> if the reference is pre-marked
+with trademarks.</p>
+<p><ph id="productshortname">Derby</ph></p>
+<p><ph id="productlongname">Apache Derby</ph></p>
+<p><ph id="productinstallname">Derby_10</ph></p>
+<p><ph id="productinstallpath">DERBY_HOME</ph></p>
+<p><ph id="productlowercase">derby</ph></p>
+</conbody>
+</concept>
 <concept id="vers" xml:lang="en-us">
 <title>Version and release numbers</title>
 <conbody>
 <p><ph id="fullversionnumber">Version 10.2</ph></p>
 <p><ph id="shortversionnumber">10.2</ph></p>
+</conbody>
+</concept>
+<concept id="pub" xml:lang="en-us">
+<title>Publications</title>
+<conbody>
+<p>Naming convention: <userinput>cit<varname>ABB</varname></userinput>,
where <userinput>cit</userinput> is
+the indicator that the conref is to a publication title and <varname>ABB</varname>
is
+the abbreviation for the publication (say, 2-6 characters).</p>
+<p>We can't use the "correct" DITA cite tag because the IDD wrapper can't
+handle it.</p>
+<p><ph id="citdevelop"><i>Derby Developer's Guide</i></ph></p>
+<p><ph id="citadmin"><i>Derby Server and Administration Guide</i></ph></p>
+<p><ph id="citref"><i>Derby Reference Manual</i></ph></p>
+<p><ph id="citutilities"><i>Derby Tools and Utilities Guide</i></ph></p>
+<p><ph id="citgetstart"><i>Getting Started with Derby</i></ph></p>
+<p><ph id="cittuning"><i>Tuning Derby</i></ph></p>
 </conbody>
 </concept>
 </dita>



Mime
View raw message