db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r1607450 [1/2] - /db/derby/docs/trunk/src/tools/
Date Wed, 02 Jul 2014 19:12:16 GMT
Author: chaase3
Date: Wed Jul  2 19:12:15 2014
New Revision: 1607450

URL: http://svn.apache.org/r1607450
Log:
DERBY-6379  Manuals are inconsistent in their use of the <shortdesc> element

Modified 48 Tools Guide topics.

Patch: DERBY-6379-tools-com.diff

Modified:
    db/derby/docs/trunk/src/tools/ctoolsijcomref14191.dita
    db/derby/docs/trunk/src/tools/ctoolsijcomref15645.dita
    db/derby/docs/trunk/src/tools/ctoolsijcomref18998.dita
    db/derby/docs/trunk/src/tools/ctoolsijcomref21190.dita
    db/derby/docs/trunk/src/tools/ctoolsijcomref23268.dita
    db/derby/docs/trunk/src/tools/ctoolsijcomref30411.dita
    db/derby/docs/trunk/src/tools/ctoolsijcomref32407.dita
    db/derby/docs/trunk/src/tools/ctoolsijcomref36744.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref1003067.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref10316.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref11128.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref11943.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref12281.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref12297.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref12333.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref16653.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref17631.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref18077.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref20382.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref22318.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref24423.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref25570.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref25753.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref27997.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref28886.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref30679.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref31510.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref33358.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref33373.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref34110.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref36618.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref37862.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref39042.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref40155.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref44032.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref53869.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref61092.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref61708.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref62772.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref79286.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref88554.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref94092.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomref97975.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomrefhold.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomrefnohold.dita
    db/derby/docs/trunk/src/tools/rtoolsijcomrefshow.dita

Modified: db/derby/docs/trunk/src/tools/ctoolsijcomref14191.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijcomref14191.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijcomref14191.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijcomref14191.dita Wed Jul  2 19:12:15 2014
@@ -18,9 +18,9 @@ limitations under the License.
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
 <concept xml:lang="en-us" id="ctoolsijcomref14191">
 <title>JAVA ERROR</title>
+<shortdesc>When an unexpected Java exception occurs, <codeph>ij</codeph> prints
+a message with the prefix "JAVA ERROR".</shortdesc>
 <prolog>
 </prolog>
 <conbody>
-<p>When an unexpected Java exception occurs, <codeph>ij</codeph> prints a message
-with the prefix "JAVA ERROR".</p>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsijcomref15645.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijcomref15645.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijcomref15645.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijcomref15645.dita Wed Jul  2 19:12:15 2014
@@ -18,35 +18,45 @@ limitations under the License.
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
 <concept xml:lang="en-us" id="ctoolsijcomref15645">
 <title>ij SQL command behavior</title>
+<shortdesc>Any commands other than those documented in the <codeph>ij</codeph>
+command reference are handed to the current connection to execute
+directly.</shortdesc>
 <prolog>
 </prolog>
 <conbody>
-<p>Any command other than those documented in the <codeph>ij</codeph> command reference
-are handed to the current connection to execute directly. The statement's
-closing semicolon, used by <codeph>ij</codeph> to determine that it has ended, is
-not passed to the underlying connection. Only one statement at a time is passed
-to the connection. If the underlying connection itself accepts semicolon-separated
-statements (which <ph conref="../conrefs.dita#prod/productshortname"></ph> does not), they can be passed to the connection
-using <codeph>ij</codeph>'s Execute command to pass in a command string containing
-semicolon-separated commands.</p>
+<p>The statement's closing semicolon, used by <codeph>ij</codeph> to determine
+that it has ended, is not passed to the underlying connection. Only one
+statement at a time is passed to the connection. If the underlying connection
+itself accepts semicolon-separated statements (which
+<ph conref="../conrefs.dita#prod/productshortname"></ph> does not), they can be
+passed to the connection using <codeph>ij</codeph>'s
+<codeph><xref href="rtoolsijcomref30679.dita">Execute</xref></codeph> command to
+pass in a command string containing semicolon-separated commands.</p>
 <p><codeph>ij</codeph> uses the result of the JDBC execute request to determine
 whether it should print a number-of-rows message or display a result set.</p>
-<p>If a JDBC execute request causes an exception, it displays the <i>SQLState</i>, if any, and error message.</p>
-<p>Setting the <codeph>ij</codeph> property <i><xref href="rtoolsijpropref25589.dita#rtoolsijpropref25589">ij.showErrorCode</xref></i> to <i>true</i> displays the <i>SQLException</i>'s error code (see <xref href="rtoolsijpropref29864.dita#rtoolsijpropref29864"/>).</p>
+<p>If a JDBC execute request causes an exception, it displays the
+<i>SQLState</i>, if any, and an error message.</p>
+<p>Setting the <codeph>ij</codeph> property
+<codeph><xref href="rtoolsijpropref25589.dita">ij.showErrorCode</xref></codeph>
+to <codeph>true</codeph> displays the <i>SQLException</i>'s error code (see
+<xref href="rtoolsijpropref29864.dita"/>).</p>
 <p>The number-of-rows message for inserts, updates, and deletes conforms to
 the JDBC specification for any SQL statement that does not have a result set.
-DDL (data definition language) commands typically report "0 rows inserted/updated/deleted"
-when they successfully complete.</p>
-<p>To display a result set, <codeph>ij</codeph> formats a banner based on the JDBC <i>ResultSetMetaData</i> information returned from <i>getColumnLabel</i> and <i>getColumnWidth</i>. Long columns
-wrap the screen width, using multiple lines. An <i>&amp;</i> character
-denotes truncation (<codeph>ij</codeph> limits displayed width of a column to 128
-characters by default; see <xref href="rtoolsijcomref12281.dita#rtoolsijcomref12281"/>).</p>
+DDL (data definition language) commands typically report "0 rows
+inserted/updated/deleted" when they successfully complete.</p>
+<p>To display a result set, <codeph>ij</codeph> formats a banner based on the
+JDBC <i>ResultSetMetaData</i> information returned from <i>getColumnLabel</i>
+and <i>getColumnWidth</i>. Long columns wrap the screen width, using multiple
+lines. An <codeph>&amp;</codeph> character denotes truncation
+(<codeph>ij</codeph> limits displayed width of a column to 128 characters by
+default; see <xref href="rtoolsijcomref12281.dita"/>).</p>
 <p><codeph>ij</codeph> displays rows as it fetches them. If the underlying DBMS
-materializes rows only as they are requested, ij displays a partial result
-followed by an error message if there is a error in fetching a row partway
-through the result set.</p>
-<p><codeph>ij</codeph> verifies that a connection exists before issuing statements
-against it and does not execute SQL when no connection has yet been made.</p>
-<p>There is no support in <codeph>ij</codeph> for the JDBC feature multiple result
-sets.</p>
+materializes rows only as they are requested, <codeph>ij</codeph> displays a
+partial result followed by an error message if there is a error in fetching a
+row partway through the result set.</p>
+<p><codeph>ij</codeph> verifies that a connection exists before issuing
+statements against it and does not execute SQL when no connection has yet been
+made.</p>
+<p>There is no support in <codeph>ij</codeph> for the JDBC feature multiple
+result sets.</p>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsijcomref18998.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijcomref18998.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijcomref18998.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijcomref18998.dita Wed Jul  2 19:12:15 2014
@@ -18,9 +18,9 @@ limitations under the License.
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
 <concept xml:lang="en-us" id="ctoolsijcomref18998">
 <title>ij errors</title>
+<shortdesc><codeph>ij</codeph> might issue messages to inform the user of errors
+during processing of statements.</shortdesc>
 <prolog>
 </prolog>
 <conbody>
-<p>ij might issue messages to inform the user of errors
-during processing of statements.</p>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsijcomref21190.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijcomref21190.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijcomref21190.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijcomref21190.dita Wed Jul  2 19:12:15 2014
@@ -18,12 +18,13 @@ limitations under the License.
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
 <concept xml:lang="en-us" id="ctoolsijcomref21190">
 <title>WARNING SQLState</title>
+<shortdesc>Upon completion of execution of any JDBC request, <codeph>ij</codeph>
+issues a <i>getWarnings</i> request and displays the <i>SQLWarning</i>s that are
+returned.</shortdesc>
 <prolog>
 </prolog>
 <conbody>
-<p>Upon completion of execution of any JDBC request, <codeph>ij</codeph> will issue
-a <i>getWarnings</i> request and display the SQLWarnings
-that are returned. Each <i>SQLWarning</i> message is displayed
-with the prefix "WARNING <i>SQLState</i>". If an <i>SQLWarning</i> has no SQLState associated with it, the prefix "WARNING
-(no SQLState)" is used.</p>
+<p>Each <i>SQLWarning</i> message is displayed with the prefix "WARNING
+<i>SQLState</i>". If an <i>SQLWarning</i> has no <i>SQLState</i> associated with
+it, the prefix "WARNING (no SQLState)" is used.</p>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsijcomref23268.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijcomref23268.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijcomref23268.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijcomref23268.dita Wed Jul  2 19:12:15 2014
@@ -18,18 +18,23 @@ limitations under the License.
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
 <concept xml:lang="en-us" id="ctoolsijcomref23268">
 <title>ij commands</title>
+<shortdesc><codeph>ij</codeph> accepts several commands to control its use of
+JDBC.</shortdesc>
 <prolog>
 </prolog>
 <conbody>
-<p><codeph>ij</codeph> accepts several commands to control its use of JDBC. It recognizes
-a semicolon as the end of an <codeph>ij</codeph> or SQL command; it treats semicolons
-within SQL comments, strings, and delimited identifiers as part of those constructs,
-not as the end of the command. Semicolons are required at the end of an <codeph>ij</codeph> or SQL statement.</p>
-<p>All <codeph>ij</codeph> commands, identifiers, and keywords are case-insensitive.</p>
-<p>Commands can span multiple lines without any special escaping for the ends
-of lines. This means that if a string spans a line, the new lines will show
-up in the value in the string.</p>
-<p><codeph>ij</codeph> treats any command that it does not recognize as an SQL command
-to be passed to the underlying connection, so syntactic errors in <codeph>ij</codeph> commands will cause them to be handed to the SQL engine and will probably
-result in SQL parsing errors.</p>
+<p>It recognizes
+a semicolon as the end of an <codeph>ij</codeph> or SQL command; it treats
+semicolons within SQL comments, strings, and delimited identifiers as part of
+those constructs, not as the end of the command. A semicolon is required at the
+end of an <codeph>ij</codeph> or SQL statement.</p>
+<p>All <codeph>ij</codeph> commands, identifiers, and keywords are
+case-insensitive.</p>
+<p>Commands can span multiple lines without any special escaping for the ends of
+lines. This means that if a string spans a line, the new lines will appear in
+the value in the string.</p>
+<p><codeph>ij</codeph> treats any command that it does not recognize as an SQL
+command to be passed to the underlying connection, so syntactic errors in
+<codeph>ij</codeph> commands will cause them to be handed to the SQL engine and
+will probably result in SQL parsing errors.</p>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsijcomref30411.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijcomref30411.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijcomref30411.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijcomref30411.dita Wed Jul  2 19:12:15 2014
@@ -18,11 +18,12 @@ limitations under the License.
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
 <concept xml:lang="en-us" id="ctoolsijcomref30411">
 <title>IJ ERROR</title>
+<shortdesc>When <codeph>ij</codeph> runs into errors processing user commands,
+it prints out a message with the prefix "IJ ERROR".</shortdesc>
 <prolog>
 </prolog>
 <conbody>
-<p>When <codeph>ij</codeph> runs into errors processing user commands, such as being
-unable to open the file named in a <xref href="rtoolsijcomref28886.dita#rtoolsijcomref28886">Run</xref> command
-or not having a connection to disconnect from, it prints out a message with
-the prefix "IJ ERROR".</p>
+<p>Examples of errors include being unable to open the file named in a
+<codeph><xref href="rtoolsijcomref28886.dita">Run</xref></codeph> command and
+not having a connection to disconnect from.</p>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsijcomref32407.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijcomref32407.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijcomref32407.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijcomref32407.dita Wed Jul  2 19:12:15 2014
@@ -18,9 +18,10 @@ limitations under the License.
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
 <concept xml:lang="en-us" id="ctoolsijcomref32407">
 <title>IJ WARNING</title>
+<shortdesc><codeph>ij</codeph> displays warning messages to let the user know if
+behavior might be unexpected. <codeph>ij</codeph> warnings are prefixed with
+"IJ WARNING".</shortdesc>
 <prolog>
 </prolog>
 <conbody>
-<p><codeph>ij</codeph> displays warning messages to let the user know if behavior
-might be unexpected. <codeph>ij</codeph> warnings are prefixed with "IJ WARNING".</p>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/ctoolsijcomref36744.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijcomref36744.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijcomref36744.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijcomref36744.dita Wed Jul  2 19:12:15 2014
@@ -18,10 +18,11 @@ limitations under the License.
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
 <concept xml:lang="en-us" id="ctoolsijcomref36744">
 <title>ERROR SQLState</title>
+<shortdesc>When the underlying JDBC driver returns an <i>SQLException</i>,
+<codeph>ij</codeph> displays the <i>SQLException</i> message with the prefix
+"ERROR SQLState". If the <i>SQLException</i> has no <i>SQLState</i> associated
+with it, the prefix "ERROR (no SQLState)" is used.</shortdesc>
 <prolog>
 </prolog>
 <conbody>
-<p>When the underlying JDBC driver returns an <i>SQLException</i>, <codeph>ij</codeph> displays the <i>SQLException</i> message
-with the prefix "ERROR SQLState". If the <i>SQLException</i> has no SQLState associated with it, the prefix "ERROR (no SQLState)"
-is used.</p>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref1003067.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref1003067.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref1003067.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref1003067.dita Wed Jul  2 19:12:15 2014
@@ -18,19 +18,18 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref1003067">
 <title>Conventions for ij examples</title>
+<shortdesc>Examples in this document show input from the keyboard or a file in
+bold text and console output from the command prompt or the <codeph>ij</codeph>
+application in regular text.</shortdesc>
 <prolog>
 </prolog>
 <refbody>
-<section><p>Examples in this document show input from the keyboard or a file in bold
-text and console output from the DOS prompt or the <codeph>ij</codeph> application
-in regular text.  
-<codeblock>C:\&gt; REM This example is from a DOS prompt:
-C:\&gt; <b>java -Dij.protocol=jdbc:derby: org.apache.derby.tools.ij</b>
+<section>
+<codeblock><b>java -Dij.protocol=jdbc:derby: org.apache.derby.tools.ij</b>
 ij version <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>
 ij&gt; <b>connect 'menuDB;create=true';</b>
 ij&gt; <b>CREATE TABLE menu(course CHAR(10), item CHAR(20), price INTEGER);</b>
 0 rows inserted/updated/deleted
 ij&gt; <b>disconnect;</b>
-ij&gt;<b> exit;</b>
-C:\&gt; </codeblock></p></section>
+ij&gt; <b>exit;</b></codeblock></section>
 </refbody></reference>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref10316.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref10316.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref10316.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref10316.dita Wed Jul  2 19:12:15 2014
@@ -18,6 +18,8 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref10316">
 <title>Help command</title>
+<shortdesc>The <codeph>Help</codeph> command prints out a brief list of the
+<codeph>ij</codeph> commands.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Help command</indexterm>
 </keywords>
@@ -26,6 +28,4 @@ limitations under the License.
 <refsyn><title>Syntax</title>
 <codeblock><b>HELP</b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>Prints out a brief list of the <codeph>ij</codeph> commands.</p>
-</section></refbody></reference>
+</refbody></reference>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref11128.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref11128.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref11128.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref11128.dita Wed Jul  2 19:12:15 2014
@@ -18,18 +18,23 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref11128">
 <title>Next command</title>
+<shortdesc>The <codeph>Next</codeph> command fetches the next row from the
+specified named cursor.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Next command</indexterm><indexterm>Cursors<indexterm>fetching next row</indexterm></indexterm>
+<keywords><indexterm>Next command</indexterm>
+<indexterm>Cursors<indexterm>fetching next row</indexterm></indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>The command displays a banner and the values of the row. The cursor must have
+been created with the <codeph><xref href="rtoolsijcomref36618.dita">Get
+Cursor</xref></codeph> or <codeph><xref href="rtoolsijcomref62772.dita">Get
+Scroll Insensitive Cursor</xref></codeph> command.</p>
+</section>
 <refsyn><title>Syntax</title>
-<codeblock><b>NEXT <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i></b></b></codeblock>
+<codeblock><b>NEXT <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i></b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>Fetches the next row from the named cursor created with the <xref href="rtoolsijcomref36618.dita#rtoolsijcomref36618">Get Cursor</xref> command or <xref href="rtoolsijcomref62772.dita#rtoolsijcomref62772">Get Scroll Insensitive Cursor</xref>. It
-displays a banner and the values of the row.</p>
-</section>
 <example><title>Example</title>
 <codeblock>ij&gt; <b>get cursor menuCursor as 'SELECT * FROM menu';</b>
 ij&gt; <b>next menuCursor;</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref11943.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref11943.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref11943.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref11943.dita Wed Jul  2 19:12:15 2014
@@ -18,20 +18,24 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref11943">
 <title>After Last command</title>
+<shortdesc>The <codeph>After Last</codeph> command moves the cursor to after the
+last row, then fetches the row.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>After Last command</indexterm><indexterm>Cursors<indexterm>fetching next row</indexterm></indexterm>
+<keywords><indexterm>After Last command</indexterm>
+<indexterm>Cursors<indexterm>fetching next row</indexterm></indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>Since there is no current row, it returns the message <codeph>No current
+row</codeph>.</p>
+<p>The cursor must have been created with the
+<codeph><xref href="rtoolsijcomref62772.dita">Get Scroll Insensitive Cursor</xref></codeph>
+command.</p>
+</section>
 <refsyn><title>Syntax</title>
-<codeblock><b>AFTER LAST <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i></b></b></codeblock>
+<codeblock><b>AFTER LAST <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i></b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>Moves the cursor to after the last row, then fetches the row. (Since there
-is no current row, it returns the message: <codeph>"No current row."</codeph></p>
-<p>The cursor must have been created with the <xref href="rtoolsijcomref62772.dita#rtoolsijcomref62772">Get Scroll Insensitive Cursor</xref> command.   
-</p>
-</section>
 <example><title>Example</title>
 <codeblock>ij&gt; <b>get scroll insensitive cursor scrollCursor as
 'SELECT * FROM menu FOR UPDATE OF price';</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref12281.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref12281.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref12281.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref12281.dita Wed Jul  2 19:12:15 2014
@@ -19,15 +19,21 @@ limitations under the License.
 -->
 <reference id="rtoolsijcomref12281" xml:lang="en-us">
 <title>MaximumDisplayWidth command</title>
+<shortdesc>The <codeph>MaximumDisplayWidth</codeph> command sets the largest
+display width for columns to the specified value.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>MaximumDisplayWidth command</indexterm></keywords>
 </metadata></prolog>
 <refbody>
-<refsyn><title>Syntax</title> <codeblock><b>MAXIMUMDISPLAYWIDTH <b><i>integer_value</i></b></b></codeblock> </refsyn>
-<section><title>Description</title> <p>Sets the largest display width for
-columns to the specified value. This is generally used to increase the default
-value in order to display large blocks of text.</p> </section>
-<example><title>Example</title> <codeblock>ij&gt; <b>maximumdisplaywidth 3;</b>
+<section>
+<p>This command is generally used to increase the default value in order to
+display large blocks of text.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>MAXIMUMDISPLAYWIDTH <i>integer_value</i></b></codeblock>
+</refsyn>
+<example><title>Example</title>
+<codeblock>ij&gt; <b>maximumdisplaywidth 3;</b>
 ij&gt; <b>VALUES 'NOW IS THE TIME!';</b>
 1
 ---
@@ -36,6 +42,7 @@ ij&gt; <b>maximumdisplaywidth 30;</b>
 ij&gt; VALUES 'NOW IS THE TIME!';
 1
 ----------------
-NOW IS THE TIME!</codeblock> </example>
+NOW IS THE TIME!</codeblock>
+</example>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref12297.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref12297.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref12297.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref12297.dita Wed Jul  2 19:12:15 2014
@@ -18,19 +18,21 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref12297">
 <title>Rollback command</title>
+<shortdesc>The <codeph>Rollback</codeph> command issues a
+<i>java.sql.Connection.rollback</i> request.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Rollback command</indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>Use this command only if auto-commit is off. A
+<i>java.sql.Connection.rollback</i> request undoes the currently active
+transaction and initiates a new transaction.</p>
+</section>
 <refsyn><title>Syntax</title>
-<codeblock><b>ROLLBACK </b></codeblock>
+<codeblock><b>ROLLBACK</b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>Issues a <i>java.sql.Connection.rollback</i> request.
-Use only if auto-commit is off. A <i>java.sql.Connection.rollback</i> request undoes the currently active transaction and initiates a new
-transaction.</p>
-</section>
 <example><title>Example</title>
 <codeblock>ij&gt; <b>autocommit off;</b>
 ij&gt; <b>INSERT INTO menu VALUES ('dessert', 'rhubarb pie', 4);</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref12333.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref12333.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref12333.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref12333.dita Wed Jul  2 19:12:15 2014
@@ -19,25 +19,31 @@ limitations under the License.
 -->
 <reference id="rtoolsijcomref12333" xml:lang="en-us">
 <title>Prepare command</title>
+<shortdesc>The <codeph>Prepare</codeph> command creates a
+<i>java.sql.PreparedStatement</i> using the value of the specified
+<i>String</i>, accessible in <codeph>ij</codeph> by the <i>Identifier</i> given
+to it.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Prepare command</indexterm>
 <indexterm>Prepared statements<indexterm>creating</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
-<refsyn><title>Syntax</title> <codeblock><b>PREPARE <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i></b> AS <b
-><i><xref href="rtoolsijcomref34110.dita#rtoolsijcomref34110">String</xref></i></b></b></codeblock> </refsyn>
-<section><title>Description</title> <p>Creates a <i>java.sql.PreparedStatement</i> using
-the value of the String, accessible in <codeph>ij</codeph> by the <i>Identifier</i> given
-to it. If a prepared statement with that name already exists in <codeph>ij</codeph>,
-an error will be returned and the previous prepared statement will remain.
-Use the <xref href="rtoolsijcomref33373.dita#rtoolsijcomref33373">Remove</xref> command
-to remove the previous statement first. If there are any errors in preparing
-the statement, no prepared statement is created. </p> <p>Any SQL statements
-allowed in the underlying connection's prepared statement can be prepared
-with this command.</p>
+<section>
+<p>If a prepared statement with that name already exists in <codeph>ij</codeph>,
+an error will be returned, and the previous prepared statement will remain. Use
+the
+<codeph><xref href="rtoolsijcomref33373.dita">Remove</xref></codeph> command to
+remove the previous statement first. If there are any errors in preparing the
+statement, no prepared statement is created.</p>
+<p>Any SQL statements allowed in the underlying connection's prepared statement
+can be prepared with this command.</p>
 <p>If the <i>Identifier</i> specifies a <i>connectionName</i>, the statement is
-prepared on the specified connection.</p></section>
+prepared on the specified connection.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>PREPARE <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i> AS <i><xref href="rtoolsijcomref34110.dita">String</xref></i></b></codeblock>
+</refsyn>
 <example><title>Examples</title> 
 <codeblock>ij&gt; <b>prepare seeMenu as 'SELECT * FROM menu';</b>
 ij&gt; <b>execute seeMenu;</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref16653.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref16653.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref16653.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref16653.dita Wed Jul  2 19:12:15 2014
@@ -19,24 +19,24 @@ limitations under the License.
 -->
 <reference id="rtoolsijcomref16653" xml:lang="en-us">
 <title>Syntax for comments in ij commands</title>
+<shortdesc><codeph>ij</codeph> accepts two forms of comments in
+commands.</shortdesc>
 <prolog></prolog>
 <refbody>
-<refsyn><title>Syntax</title> <codeblock><b>-- <i>Text</i></b>
+<refsyn><title>Syntax</title>
+<codeblock><b>-- <i>Text</i></b>
 
-<b>/* <i>Text</i> */</b>
-</codeblock> </refsyn>
-<section><title>Description</title> <p>You can use a double dash to create
-a comment anywhere within an <codeph>ij</codeph> command line and as permitted
-by the underlying connection within SQL commands. The comment is ended at
-the first new line encountered in the text.</p> <p>Comments are ignored on
-input and have no effect on the output displayed.</p> 
-<p>You can also enclose text in <codeph>/*&nbsp;*/</codeph> characters to create 
-either one-line or multi-line comments. Nested comments are permitted. 
-For example, you could put lines like the following into a script named
-<codeph>comment.sql</codeph>:
-</p>
-<codeblock>
-/* start the file with a /* nested comment */ and see what happens */
+<b>/* <i>Text</i> */</b></codeblock> 
+<p>You can use a double dash to create a comment anywhere within an
+<codeph>ij</codeph> command line and as permitted by the underlying connection
+within SQL commands. The comment is ended at the first new line encountered in
+the text.</p>
+<p>Comments are ignored on input and have no effect on the output displayed.</p>
+<p>You can also enclose text in <codeph>/*&nbsp;*/</codeph> characters to create
+either one-line or multi-line comments. Nested comments are permitted. For
+example, you could put lines like the following into a script named
+<codeph>comment.sql</codeph>:</p>
+<codeblock>/* start the file with a /* nested comment */ and see what happens */
 connect 'jdbc:derby:newdb;create=true';
 values 'hi!';
 create table t (x int);
@@ -48,8 +48,10 @@ insert into t values 4, 5, 6;
 /* end the file with a comment */
 values 'This is a test';
 /* This is also a test */
-</codeblock></section>
-<example><title>Examples</title> <codeblock>ij&gt; -- this is a comment;
+</codeblock>
+</refsyn>
+<example><title>Examples</title>
+<codeblock>ij&gt; -- this is a comment;
 -- the semicolons in the comment are not taken as the end
 -- of the command; for that, we put it outside the --:
 <b>;</b>
@@ -80,8 +82,7 @@ This is a test
 1 row selected
 ij&gt; /* This is also a test */
 ;
-ij&gt; 
-</codeblock>
+ij&gt; </codeblock>
 </example>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref17631.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref17631.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref17631.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref17631.dita Wed Jul  2 19:12:15 2014
@@ -18,21 +18,27 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref17631">
 <title>Wait For command</title>
+<shortdesc>The <codeph>Wait For</codeph> command displays the results of a
+previously started asynchronous command.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Wait For command</indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>The identifier for the asynchronous command must have been used in a previous
+<codeph><xref href="rtoolsijcomref37862.dita">Async</xref></codeph> command on
+this connection. The <codeph>Wait For</codeph> command waits for the SQL
+statement to complete execution, if it has not already, and then displays the
+results. If the statement returns a result set, the <codeph>Wait For</codeph>
+command steps through the rows, not the
+<codeph><xref href="rtoolsijcomref37862.dita">Async</xref></codeph> command.
+This might result in further execution time passing during the result
+display.</p>
+</section>
 <refsyn><title>Syntax</title>
-<codeblock><b>WAIT FOR <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i></b></b></codeblock>
+<codeblock><b>WAIT FOR <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i></b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>Displays the results of a previously started asynchronous command.</p>
-<p>The identifier for the asynchronous command must have been used in a previous <xref href="rtoolsijcomref37862.dita#rtoolsijcomref37862">Async</xref> command on this connection. The Wait For command waits for the SQL statement
-to complete execution, if it has not already, and then displays the results.
-If the statement returns a result set, the Wait For command steps through the rows, not the <xref href="rtoolsijcomref37862.dita#rtoolsijcomref37862">Async</xref> command. This might result in further execution time passing
-during the result display. </p>
-</section>
 <example><title>Example</title>
-<p>See <xref href="rtoolsijcomref37862.dita#rtoolsijcomref37862"/>.</p>
+<p>See <xref href="rtoolsijcomref37862.dita"/>.</p>
 </example></refbody></reference>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref18077.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref18077.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref18077.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref18077.dita Wed Jul  2 19:12:15 2014
@@ -18,18 +18,20 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref18077">
 <title>Elapsedtime command</title>
+<shortdesc>The <codeph>Elapsedtime</codeph> command, if set to
+<codeph>ON</codeph>, displays the total time elapsed during statement
+execution.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Elapsedtime command</indexterm><indexterm>JDBC driver<indexterm>loading </indexterm></indexterm>
+<keywords><indexterm>Elapsedtime command</indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>The default value is <codeph>OFF</codeph>.</p>
+</section>
 <refsyn><title>Syntax</title>
 <codeblock><b>ELAPSEDTIME { ON | OFF }</b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>When <codeph>elapsedtime</codeph> is turned on, <codeph>ij</codeph> displays the total
-time elapsed during statement execution. The default value is OFF.</p>
-</section>
 <example><title>Example</title>
 <codeblock>ij&gt; <b>elapsedtime on;</b>
 ij&gt; <b>VALUES current_date;</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref20382.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref20382.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref20382.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref20382.dita Wed Jul  2 19:12:15 2014
@@ -19,34 +19,53 @@ limitations under the License.
 -->
 <reference id="rtoolsijcomref20382" xml:lang="en-us">
 <title>Disconnect command</title>
+<shortdesc>The <codeph>Disconnect</codeph> command disconnects from the
+database.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Disconnect command</indexterm><indexterm>Database connection
-URL<indexterm>shortcut</indexterm></indexterm><indexterm>Disconnecting</indexterm>
+<keywords><indexterm>Disconnect command</indexterm>
+<indexterm>Database connection URL<indexterm>shortcut</indexterm></indexterm>
+<indexterm>Disconnecting</indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
-<refsyn><title>Syntax</title> <codeblock><b>DISCONNECT [ ALL | CURRENT | <b><i>ConnectionIdentifier </i></b>]</b></codeblock> </refsyn>
-<section><title>Description</title> <p>Disconnects from the database. Specifically
-issues a <codeph>java.sql.Connection.close</codeph> request against the connection
-indicated on the command line. There must be a current connection at the time
-the request is made.</p> <p>If ALL is specified, all known connections are
-closed and there will be no current connection.</p> <p>Disconnect CURRENT
-is the same as Disconnect without indicating a connection, the default connection
-is closed.</p> <p>If a connection name is specified with an identifier, the
-command disconnects the named connection. The name must be the name of a connection
-in the current session provided with the <xref href="rtoolsijpropref10135.dita#rtoolsijpropref10135">ij.connection.connectionName</xref> property
-or with the <xref href="rtoolsijcomref22318.dita#rtoolsijcomref22318">Connect</xref> command.</p> <p>If
-the <xref href="rtoolsijpropref28146.dita#rtoolsijpropref28146">ij.database</xref> property
-or the <xref href="rtoolsijcomref22318.dita#rtoolsijcomref22318">Connect</xref> command
-without the AS clause was used, you can supply the name the system generated
-for the connection. If the current connection is the named connection, when
-the command completes, there will be no current connection and you must issue
-a <xref href="rtoolsijcomref39198.dita#rtoolsijcomref39198">Set Connection</xref> or <xref
-href="rtoolsijcomref22318.dita#rtoolsijcomref22318">Connect</xref> command.</p> <p>A
-Disconnect command issued against a <ph conref="../conrefs.dita#prod/productshortname"></ph> connection
-does not shut down the database or <ph conref="../conrefs.dita#prod/productshortname"></ph> (but
-the <xref href="rtoolsijcomref33358.dita#rtoolsijcomref33358">Exit</xref> command
-does).</p> </section>
+<section>
+<p>Specifically, <codeph>Disconnect</codeph> issues a
+<i>java.sql.Connection.close</i> request against the connection indicated on the
+command line. There must be a current connection at the time the request is
+made.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>DISCONNECT [ ALL | CURRENT | <i>ConnectionIdentifier</i> ]</b></codeblock>
+<p>If <codeph>ALL</codeph> is specified, all known connections are closed, and
+there will be no current connection.</p>
+<p><codeph>Disconnect CURRENT</codeph> is the same as
+<codeph>Disconnect</codeph> without indicating a connection: the default
+connection is closed.</p>
+<p>If a connection name is specified with a <i>ConnectionIdentifier</i>, the
+command disconnects the named connection. The name must be the name of a
+connection in the current session provided with the
+<codeph><xref href="rtoolsijpropref10135.dita">ij.connection.<i>connectionName</i></xref></codeph>
+property or with the
+<codeph><xref href="rtoolsijcomref22318.dita">Connect</xref></codeph>
+command.</p>
+<p>If the
+<codeph><xref href="rtoolsijpropref28146.dita">ij.database</xref></codeph>
+property or the
+<codeph><xref href="rtoolsijcomref22318.dita">Connect</xref></codeph> command
+without the <codeph>AS</codeph> clause was used, you can supply the name the
+system generated for the connection. If the current connection is the named
+connection, when the command completes, there will be no current connection,
+and you must issue a
+<codeph><xref href="rtoolsijcomref39198.dita">Set Connection</xref></codeph> or
+<codeph><xref href="rtoolsijcomref22318.dita">Connect</xref></codeph>
+command.</p>
+<p>A <codeph>Disconnect</codeph> command issued against a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> connection does not
+shut down the database or
+<ph conref="../conrefs.dita#prod/productshortname"></ph> (but the
+<codeph><xref href="rtoolsijcomref33358.dita">Exit</xref></codeph> command
+does).</p>
+</refsyn>
 <example><title>Example</title> <codeblock>ij&gt;<b> connect 'jdbc:derby:menuDB;create=true';</b>
 ij&gt; -- we create a new table in menuDB: 
 <b>CREATE TABLE menu(course CHAR(10), ITEM char(20), PRICE integer);</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref22318.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref22318.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref22318.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref22318.dita Wed Jul  2 19:12:15 2014
@@ -19,31 +19,45 @@ limitations under the License.
 -->
 <reference id="rtoolsijcomref22318" xml:lang="en-us">
 <title>Connect command</title>
+<shortdesc>The <codeph>Connect</codeph> command connects to the database
+indicated by the <i>ConnectionURLString</i> argument.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Connect command</indexterm><indexterm>Creating a new database</indexterm>
+<keywords><indexterm>Connect command</indexterm>
+<indexterm>Creating a new database</indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
-<refsyn><title>Syntax</title><codeblock><b>CONNECT <b><i>ConnectionURLString</i></b> [ PROTOCOL <b><i>Identifier</i></b> ]
-    [ AS <b><i>Identifier</i></b> ] [ USER <b><i>String </i></b>
-     PASSWORD <b><i>String</i></b> ]</b></codeblock> </refsyn>
-<section><title>Description</title><p>Connects to the database indicated by
-the <i>ConnectionURLString</i>. Specifically, takes the value of the string (the 
-database connection URL) and issues a <codeph>getConnection</codeph> request using <codeph>java.sql.DriverManager</codeph> or a <codeph>javax.sql.DataSource</codeph> implementation (see the <xref href="rtoolsijproprefdatasource.dita#rtoolsijproprefdatasource">ij.dataSource</xref> property)
-to set the current connection to that database connection URL.</p><p>You have
-the option of specifying a name for your connection. Use the <xref href="rtoolsijcomref39198.dita#rtoolsijcomref39198">Set
-Connection</xref> command to switch between connections. If you do not name
-a connection, the system generates a name automatically.</p><p>You also have
-the option of specifying a named protocol previously created with the <xref
-href="rtoolsijcomref27997.dita#rtoolsijcomref27997">Protocol</xref> command
-or the <xref href="rtoolsijpropref12236.dita#rtoolsijpropref12236">ij.protocol.protocolName</xref> property.</p><p>If
-the connection requires a user name and password, supply those with the optional
-user and password parameters.</p><p>If the connect succeeds, the connection
-becomes the current one and ij displays a new prompt for the next command
-to be entered. If you have more than one open connection, the name of the
-connection appears in the prompt.</p><p>All further commands are processed
-against the new, current connection.</p> </section>
-<example><title>Examples</title><codeblock>ij&gt; <b>connect 'jdbc:derby:menuDB;create=true';</b>
+<section>
+<p>Specifically, the command takes the value of the <i>ConnectionURLString</i>
+(the database connection URL) and issues a <i>getConnection</i> request using
+<i>java.sql.DriverManager</i> or a <i>javax.sql.DataSource</i> implementation
+(see the
+<codeph><xref href="rtoolsijproprefdatasource.dita">ij.dataSource</xref></codeph>
+property) to set the current connection to that database connection URL.</p>
+<p>You have the option of specifying a name for your connection. Use the
+<codeph><xref href="rtoolsijcomref39198.dita">Set Connection</xref></codeph>
+command to switch between connections. If you do not name a connection, the
+system generates a name automatically.</p>
+<p>You also have the option of specifying a named protocol previously created
+with the
+<codeph><xref href="rtoolsijcomref27997.dita">Protocol</xref></codeph> command
+or the
+<codeph><xref href="rtoolsijpropref12236.dita">ij.protocol.<i>protocolName</i></xref></codeph>
+property.</p>
+<p>If the connection requires a user name and password, supply those with the
+optional user and password parameters.</p>
+<p>If the command succeeds, the connection becomes the current one, and
+<codeph>ij</codeph> displays a new prompt for the next command to be entered. If
+you have more than one open connection, the name of the connection appears in
+the prompt.</p>
+<p>All further commands are processed against the new, current connection.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>CONNECT <i>ConnectionURLString</i> [ PROTOCOL <i>Identifier</i> ]
+    [ AS <i>Identifier</i> ] [ USER <i>String</i> PASSWORD <i>String</i> ]</b></codeblock>
+</refsyn>
+<example><title>Examples</title>
+<codeblock>ij&gt; <b>connect 'jdbc:derby:menuDB;create=true';</b>
 ij&gt; -- we create a new table in menuDB:
 <b>CREATE TABLE menu(course CHAR(10), item CHAR(20), price INTEGER);</b>
 ij&gt; <b>protocol 'jdbc:derby:';</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref24423.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref24423.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref24423.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref24423.dita Wed Jul  2 19:12:15 2014
@@ -18,18 +18,24 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref24423">
 <title>Close command</title>
+<shortdesc>The <codeph>Close</codeph> command closes the named
+cursor.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Cursors<indexterm>using</indexterm></indexterm><indexterm>Close command</indexterm>
+<keywords><indexterm>Cursors<indexterm>using</indexterm></indexterm>
+<indexterm>Close command</indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>The cursor must have previously been successfully created with
+<codeph>ij</codeph>'s
+<codeph><xref href="rtoolsijcomref36618.dita">Get Cursor</xref></codeph> or
+<codeph><xref href="rtoolsijcomref62772.dita">Get Scroll Insensitive
+Cursor</xref></codeph> command.</p>
+</section>
 <refsyn><title>Syntax</title>
-<codeblock><b>CLOSE <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i></b></b></codeblock>
+<codeblock><b>CLOSE <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i></b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>Closes the named cursor. The cursor must have previously been successfully
-created with the <codeph>ij</codeph> <xref href="rtoolsijcomref36618.dita#rtoolsijcomref36618">Get Cursor</xref> or <xref href="rtoolsijcomref62772.dita#rtoolsijcomref62772">Get Scroll Insensitive Cursor</xref> commands.</p>
-</section>
 <example><title>Example</title>
 <codeblock>ij&gt;<b> get cursor menuCursor as 'SELECT * FROM menu';</b>
 ij&gt;<b> next menuCursor;</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref25570.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref25570.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref25570.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref25570.dita Wed Jul  2 19:12:15 2014
@@ -19,10 +19,11 @@ limitations under the License.
 -->
 <reference id="rtoolsijcomref25570" xml:lang="en-us">
 <title>ij commands and errors reference</title>
+<shortdesc>This section describes the commands and errors within the
+<codeph>ij</codeph> tool.</shortdesc>
 <prolog><metadata>
 <keywords></keywords>
 </metadata></prolog>
 <refbody>
-<section>This section describes the commands and errors within the ij tool.</section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref25753.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref25753.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref25753.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref25753.dita Wed Jul  2 19:12:15 2014
@@ -19,23 +19,31 @@ limitations under the License.
 -->
 <reference id="rtoolsijcomref25753" xml:lang="en-us">
 <title>Autocommit command</title>
+<shortdesc>The <codeph>Autocommit</codeph> command turns the connection's
+auto-commit mode on or off.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Autocommit command</indexterm><indexterm>Auto-commit<indexterm>turning
-off</indexterm></indexterm></keywords>
+<keywords><indexterm>Autocommit command</indexterm>
+<indexterm>Auto-commit<indexterm>turning off</indexterm></indexterm></keywords>
 </metadata></prolog>
 <refbody>
-<refsyn><title>Syntax</title> <codeblock><b>AUTOCOMMIT { ON | OFF }</b></codeblock> </refsyn>
-<section><title>Description</title> <p>Turns the connection's auto-commit
-mode on or off. JDBC specifies that the default auto-commit mode is <codeph>ON</codeph>.
-Certain types of processing require that auto-commit mode be <codeph>OFF</codeph>.
-For information about auto-commit, see the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.</p> <p>If
-auto-commit mode is changed from off to on when there is a transaction outstanding,
-that work is committed when the current transaction commits, not at the time
-auto-commit is turned on. Use <xref href="rtoolsijcomref31510.dita#rtoolsijcomref31510">Commit</xref> or <xref
-href="rtoolsijcomref12297.dita#rtoolsijcomref12297">Rollback</xref> before
+<section>
+<p>JDBC specifies that the default auto-commit mode is <codeph>ON</codeph>.
+Certain types of processing require that auto-commit mode be
+<codeph>OFF</codeph>. For information about auto-commit, see the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
+<p>If auto-commit mode is changed from off to on when there is a transaction
+outstanding, that work is committed when the current transaction commits, not at
+the time auto-commit is turned on. Use
+<codeph><xref href="rtoolsijcomref31510.dita">Commit</xref></codeph> or
+<codeph><xref href="rtoolsijcomref12297.dita">Rollback</xref></codeph> before
 turning on auto-commit when there is a transaction outstanding, so that all
-prior work is completed before the return to auto-commit mode.</p> </section>
-<example><title>Example</title> <codeblock>ij&gt; <b>autocommit off;</b>
+prior work is completed before the return to auto-commit mode.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>AUTOCOMMIT { ON | OFF }</b></codeblock>
+</refsyn>
+<example><title>Example</title>
+<codeblock>ij&gt; <b>autocommit off;</b>
 ij&gt; <b>DROP TABLE menu;</b>
 0 rows inserted/updated/deleted 
 ij&gt; <b>CREATE TABLE menu (course CHAR(10), item CHAR(20), price INT);</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref27997.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref27997.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref27997.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref27997.dita Wed Jul  2 19:12:15 2014
@@ -18,28 +18,38 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref27997">
 <title>Protocol command</title>
+<shortdesc>The <codeph>Protocol</codeph> command specifies the protocol for
+establishing connections and automatically loads the appropriate
+driver.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Protocol command</indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
-<refsyn><title>Syntax</title>
-<codeblock><b>PROTOCOL <b><i><xref href="rtoolsijcomref34110.dita#rtoolsijcomref34110">String</xref></i></b> [ AS <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i></b> ]</b></codeblock>
-</refsyn>
-<section><title>Description</title>
-<p>Specifies the protocol, as a String, for establishing connections and automatically
-loads the appropriate driver. <i>Protocol</i> is the part
-of the database connection URL syntax appropriate for your environment, including the JDBC protocol
-and the protocol specific to <ph conref="../conrefs.dita#prod/productshortname"></ph>. For further information about the <ph conref="../conrefs.dita#prod/productshortname"></ph> database connection URL,
-see the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>. Only <ph conref="../conrefs.dita#prod/productshortname"></ph> protocols are supported.
-Those protocols are listed in <xref href="rtoolsijpropref35032.dita#rtoolsijpropref35032"/>.</p>
-<p>Providing a protocol allows you to use a shortened database connection URL for connections.
-You can provide only the database name (and a subsubprotocol name if needed)
-instead of the full protocol. In addition,
-you do not need to use the <xref href="rtoolsijcomref39042.dita#rtoolsijcomref39042">Driver</xref> command
+<section>
+<p>Providing a protocol allows you to use a shortened database connection URL
+for connections. You can provide only the database name (and a subsubprotocol
+name if needed) instead of the full protocol. In addition, you do not need to
+use the
+<codeph><xref href="rtoolsijcomref39042.dita">Driver</xref></codeph> command
 or specify a driver at start-up, since the driver is loaded automatically.</p>
-<p>If you name the protocol, you can refer to the protocol name in the <xref href="rtoolsijcomref22318.dita#rtoolsijcomref22318">Connect</xref> command.</p>
 </section>
+<refsyn><title>Syntax</title>
+<codeblock><b>PROTOCOL <i><xref href="rtoolsijcomref34110.dita">String</xref></i> [ AS <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i> ]</b></codeblock>
+<p>The protocol specified by the <i>String</i> is the part of the database
+connection URL syntax appropriate for your environment, including the JDBC
+protocol and the protocol specific to
+<ph conref="../conrefs.dita#prod/productshortname"></ph>. For further
+information about the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+database connection URL, see <xref href="ctoolsijtools16011.dita"/>. Only
+<ph conref="../conrefs.dita#prod/productshortname"></ph> protocols are
+supported. Those protocols are listed in
+<xref href="rtoolsijpropref35032.dita"/>.</p>
+<p>If you name the protocol by specifying an <i>Identifier</i>, you can refer to
+the protocol name in the
+<codeph><xref href="rtoolsijcomref22318.dita">Connect</xref></codeph>
+command.</p>
+</refsyn>
 <example><title>Examples</title>
 <codeblock>ij&gt; <b>protocol 'jdbc:derby:';</b>
 ij&gt; <b>connect 'sample';</b></codeblock>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref28886.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref28886.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref28886.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref28886.dita Wed Jul  2 19:12:15 2014
@@ -18,21 +18,29 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref28886">
 <title>Run command</title>
+<shortdesc>The <codeph>Run</codeph> command redirects <codeph>ij</codeph>
+processing to read from a specified file.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Run command</indexterm><indexterm>Running a script</indexterm>
+<keywords><indexterm>Run command</indexterm>
+<indexterm>Running a script</indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>The command assumes that the value of the specified <i>String</i> is a valid
+file name. It reads from that file until it ends or an
+<codeph><xref href="rtoolsijcomref33358.dita">Exit</xref></codeph> command is
+executed. If the end of the file is reached without <codeph>ij</codeph> exiting,
+reading will continue from the previous input source once the end of the file is
+reached. Files can contain additional <codeph>Run</codeph> commands.</p>
+<p><codeph>ij</codeph> prints out the statements in the file as it executes
+them.</p>
+<p>Any changes made to the <codeph>ij</codeph> environment by the file are
+visible in the environment when processing resumes.</p>
+</section>
 <refsyn><title>Syntax</title>
-<codeblock><b>RUN <b><i><xref href="rtoolsijcomref34110.dita#rtoolsijcomref34110">String</xref></i></b></b></codeblock>
+<codeblock><b>RUN <i><xref href="rtoolsijcomref34110.dita">String</xref></i></b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>Assumes that the value of the string is a valid file name, and redirects <codeph>ij</codeph> processing to read from that file until it ends or an <xref href="rtoolsijcomref33358.dita#rtoolsijcomref33358">Exit</xref> command is executed. If the end of the file is reached without <codeph>ij</codeph> exiting, reading will continue from the previous input source once
-the end of the file is reached. Files can contain Run commands.</p>
-<p><codeph>ij</codeph> prints out the statements in the file as it executes them.</p>
-<p>Any changes made to the <codeph>ij</codeph> environment by the file are visible
-in the environment when processing resumes.</p>
-</section>
 <example><title>Example</title>
 <codeblock>ij&gt; <b>run 'setupMenuConn.ij';</b>
 ij&gt; -- this is setupMenuConn.ij

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref30679.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref30679.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref30679.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref30679.dita Wed Jul  2 19:12:15 2014
@@ -19,38 +19,53 @@ limitations under the License.
 -->
 <reference id="rtoolsijcomref30679" xml:lang="en-us">
 <title>Execute command</title>
+<shortdesc>The <codeph>Execute</codeph> command executes an SQL
+statement or a named prepared statement.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Execute command</indexterm><indexterm>Prepared statements<indexterm>executing</indexterm></indexterm>
+<keywords><indexterm>Execute command</indexterm>
+<indexterm>Prepared statements<indexterm>executing</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
-<refsyn><title>Syntax</title> <codeblock><b>EXECUTE { <i>SQLString</i> | <i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">PreparedStatementIdentifier</xref></i> }
-[ USING { <i><xref href="rtoolsijcomref34110.dita#rtoolsijcomref34110">String</xref></i> | <i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i> } ]</b></codeblock> </refsyn>
-<section><title>Description</title> <p>Has several uses:   <ul>
-<li>To execute an SQL command entered as <i>SQLString</i>, using the Execute <i>String</i> style.
-The String is passed to the connection without further examination or processing
-by <codeph>ij</codeph>. <i>Normally, you execute SQL commands directly, not
-with the Execute command</i>.</li>
-<li>To execute a named command identified by <i>PreparedStatementIdentifier</i>.
-This must be previously prepared with the <codeph>ij</codeph>&nbsp;<xref href="rtoolsijcomref12333.dita#rtoolsijcomref12333">Prepare</xref> command.</li>
-<li>To execute either flavor of command when that command contains dynamic
-parameters, specify the values in the Using portion of the command. In this
-style, the <i>SQLString</i> or previously prepared <i>PreparedStatementIdentifier</i> is
-executed using the values supplied as <i>String</i> or <i>Identifier</i>.
-The <i>Identifier</i> in the USING clause must have a result set as its result.
-Each row of the result set is applied to the input parameters of the command
-to be executed, so the number of columns in the Using's result set must match
-the number of input parameters in the Execute's
-statement. The results of each execution of the Execute statement
-are displayed as they are made. If the Using's result set contains no rows,
-the Execute's
-statement is not executed.   <p>When auto-commit mode is on, the Using's result
-set is closed upon the first execution of the Execute statement.
-To ensure multiple-row execution of the Execute command,
-use the <xref href="rtoolsijcomref25753.dita#rtoolsijcomref25753">Autocommit</xref> command
-to turn auto-commit off.</p></li>
-</ul></p> </section>
-<example><title>Examples</title> <codeblock>ij&gt;<b> autocommit off;</b>
+<refsyn><title>Syntax</title>
+<codeblock><b>EXECUTE { <i>SQLString</i> | <i><xref href="rtoolsijcomref40155.dita">PreparedStatementIdentifier</xref></i> }
+[ USING { <i><xref href="rtoolsijcomref34110.dita">String</xref></i> | <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i> } ]</b></codeblock>
+<p>The  <codeph>Execute</codeph> command can be used in either of the following
+ways:</p>
+<ul>
+<li>To execute an SQL statement entered as an <i>SQLString</i>. The
+<i>SQLString</i> is passed to the connection without further examination or
+processing by <codeph>ij</codeph>.
+<p><note>Normally, you execute SQL statements directly, not with the
+<codeph>Execute</codeph> command.</note></p></li>
+<li>To execute a named statement identified by
+<i>PreparedStatementIdentifier</i>. This command must be previously prepared
+with <codeph>ij</codeph>'s
+<codeph><xref href="rtoolsijcomref12333.dita">Prepare</xref></codeph>
+command.</li>
+</ul>
+<p>To execute either flavor of statement when that statement contains dynamic
+parameters, specify the values in the <codeph>Using</codeph> portion of the
+command. In this style, the <i>SQLString</i> or previously prepared
+<i>PreparedStatementIdentifier</i> is executed using the values supplied as
+<i>String</i> or <i>Identifier</i>. The <i>Identifier</i> in the
+<codeph>Using</codeph> clause must have a result set as its result. Each row of
+the result set is applied to the input parameters of the statement to be
+executed, so the number of columns in the <codeph>Using</codeph> clause's result
+set must match the number of input parameters in the <codeph>Execute</codeph>
+command's SQL statement. The results of each execution of the
+<codeph>Execute</codeph> command's SQL statement are displayed as they are made.
+If the <codeph>Using</codeph> clause's result set contains no rows, the
+<codeph>Execute</codeph> command's SQL statement is not executed.</p>
+<p>When auto-commit mode is on, the <codeph>Using</codeph> clause's result set
+is closed upon the first execution of the <codeph>Execute</codeph> command's SQL
+statement. To ensure multiple-row execution of the <codeph>Execute</codeph>
+command, use the
+<codeph><xref href="rtoolsijcomref25753.dita">Autocommit</xref></codeph> command
+to turn auto-commit off.</p>
+</refsyn>
+<example><title>Examples</title>
+<codeblock>ij&gt;<b> autocommit off;</b>
 ij&gt; <b>prepare menuInsert as 'INSERT INTO menu VALUES (?, ?, ?)';</b>
 ij&gt;<b> execute menuInsert using 'VALUES
     (''entree'', ''lamb chop'', 14),

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref31510.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref31510.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref31510.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref31510.dita Wed Jul  2 19:12:15 2014
@@ -18,19 +18,21 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref31510">
 <title>Commit command</title>
+<shortdesc>The <codeph>Commit</codeph> command issues a
+<i>java.sql.Connection.commit</i> request.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Commit command</indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>Use this command only if auto-commit is off. A
+<i>java.sql.Connection.commit</i> request commits the currently active
+transaction and initiates a new transaction.</p>
+</section>
 <refsyn><title>Syntax</title>
 <codeblock><b>COMMIT</b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>Issues a<i> java.sql.Connection.commit</i> request. Use
-this command only if auto-commit is off. A <i>java.sql.Connection.commit</i> request commits the currently active transaction and initiates a new
-transaction.</p>
-</section>
 <example><title>Example</title>
 <codeblock>ij&gt; <b>commit;</b>
 ij&gt;</codeblock>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref33358.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref33358.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref33358.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref33358.dita Wed Jul  2 19:12:15 2014
@@ -18,27 +18,30 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref33358">
 <title>Exit command</title>
+<shortdesc>The <codeph>Exit</codeph> command causes the <codeph>ij</codeph>
+application to complete and processing to halt.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Exit command</indexterm><indexterm>Shutdown<indexterm>automatic with ij Exit command
-in embedded system</indexterm></indexterm><indexterm>Shutting down JBMS (embedded, from ij)</indexterm>
+<keywords><indexterm>Exit command</indexterm>
+<indexterm>Shutdown<indexterm>automatic with ij Exit command in embedded system</indexterm></indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>Issuing this command from within a file started with the
+<codeph><xref href="rtoolsijcomref28886.dita">Run</xref></codeph> command or on
+the command line causes the outermost input loop to halt.</p>
+<p><codeph>ij</codeph> automatically shuts down a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database running in
+an embedded environment (that is, it issues a
+<codeph>Connect 'jdbc:derby:;shutdown=true</codeph>' request) on exit.</p>
+<p><codeph>ij</codeph> exits when the <codeph>Exit</codeph> command is entered
+or, if given a command file on the Java invocation line, when the end of the
+command file is reached.</p>
+</section>
 <refsyn><title>Syntax</title>
 <codeblock><b>EXIT</b></codeblock>
 </refsyn>
-<section><title>Description</title>
-<p>Causes the <codeph>ij</codeph> application to complete and processing to halt.
-Issuing this command from within a file started with the <xref href="rtoolsijcomref28886.dita#rtoolsijcomref28886">Run</xref> command or on the command line causes the outermost input loop
-to halt.</p>
-<p><codeph>ij</codeph> automatically shuts down a <ph conref="../conrefs.dita#prod/productshortname"></ph> database running in
-an embedded environment (issues a <i>Connect 'jdbc:derby:;shutdown=true</i>' request) on exit.</p>
-<p><codeph>ij</codeph> exits when the <xref href="rtoolsijcomref33358.dita#rtoolsijcomref33358">Exit</xref> command
-is entered or if given a command file on the Java invocation line, when the
-end of the command file is reached.</p>
-</section>
 <example><title>Example</title>
 <codeblock>ij&gt;<b> disconnect;</b>
-ij&gt;<b> exit;</b>
-C:\&gt; </codeblock>
+ij&gt;<b> exit;</b></codeblock>
 </example></refbody></reference>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref33373.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref33373.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref33373.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref33373.dita Wed Jul  2 19:12:15 2014
@@ -18,19 +18,19 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref33373">
 <title>Remove command</title>
+<shortdesc>The <codeph>Remove</codeph> command removes a previously prepared
+statement from <codeph>ij</codeph>.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Remove command</indexterm><indexterm>Prepared statements<indexterm>removing</indexterm></indexterm>
+<keywords><indexterm>Remove command</indexterm>
+<indexterm>Prepared statements<indexterm>removing</indexterm></indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
 <refsyn><title>Syntax</title>
-<codeblock><b>REMOVE <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i></b></b></codeblock>
+<codeblock><b>REMOVE <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i></b></codeblock>
+<p>The specified <i>Identifier</i> is the name by which the statement was
+prepared. The statement is closed to release its database resources.</p>
 </refsyn>
-<section><title>Description</title>
-<p>Removes a previously prepared statement from ij. The identifier is the
-name by which the statement was prepared. The statement is closed to release
-its database resources.</p>
-</section>
 <example><title>Example</title>
 <codeblock>ij&gt;<b> prepare seeMenu as 'SELECT * FROM menu';</b>
 ij&gt; <b>execute seeMenu;</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref34110.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref34110.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref34110.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref34110.dita Wed Jul  2 19:12:15 2014
@@ -20,27 +20,33 @@ limitations under the License.
  "../dtd/reference.dtd">
 <reference id="rtoolsijcomref34110" xml:lang="en-us">
 <title>Syntax for strings in ij commands</title>
+<shortdesc>Some <codeph>ij</codeph> commands require string
+arguments.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Strings in ij</indexterm></keywords>
 </metadata></prolog>
 <refbody>
-<refsyn><title>Syntax</title><codeblock><b>'<i>Text</i>'</b></codeblock> </refsyn>
-<section><title>Description</title><p>Some <codeph>ij</codeph> commands require
-strings. <codeph>ij</codeph> strings are represented by the same literal format
+<refsyn><title>Syntax</title>
+<codeblock><b>'<i>Text</i>'</b></codeblock>
+<p><codeph>ij</codeph> strings are represented by the same literal format
 as SQL strings and are delimited by single quotation marks. To include a single
 quotation mark in a string, you must use two single quotation marks, as shown
 in the examples below. <codeph>ij</codeph> places no limitation on the lengths
 of strings, and will treat embedded new lines in the string as characters
-in the string.</p><p>Some <codeph>ij</codeph> commands execute SQL commands
-specified as strings. Therefore, you must double any single quotation marks
-within such strings, as shown in the second example below.</p><p>The cases
-of letters within a string are preserved.</p> </section>
-<example><title>Example</title> <codeblock>This is a string in ij     And this is its value
+in the string.</p>
+<p>Some <codeph>ij</codeph> commands execute SQL commands specified as strings.
+Therefore, you must double any single quotation marks within such strings, as
+shown in the second example below.</p>
+<p>The cases of letters within a string are preserved.</p>
+</refsyn>
+<example><title>Examples</title>
+<codeblock>This is a string in ij     And this is its value
 <b>'Mary''s umbrella'</b>          Mary's umbrella
 <b>'hello world'</b>               hello world
 
 --returns Joe's
-<b>execute 'VALUES ''Joe''''s''';</b></codeblock> </example>
+<b>execute 'VALUES ''Joe''''s''';</b></codeblock>
+</example>
 </refbody>
 </reference>
 

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref36618.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref36618.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref36618.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref36618.dita Wed Jul  2 19:12:15 2014
@@ -18,31 +18,37 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref36618">
 <title>Get Cursor command</title>
+<shortdesc>The <codeph>Get Cursor</codeph> command creates a cursor with the
+name of the specified <i>Identifier</i> by issuing a
+<i>java.sql.Statement.executeQuery</i> request on the value of the specified
+<i>String</i>.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Get Cursor command</indexterm><indexterm>Cursors<indexterm>working with</indexterm></indexterm>
+<keywords><indexterm>Get Cursor command</indexterm>
+<indexterm>Cursors<indexterm>working with</indexterm></indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>If the <i>String</i> is a statement that does not generate a result set, the
+behavior of the underlying database determines whether an empty result set or an
+error is issued. If there is an error in executing the statement, no cursor is
+created.</p>
+<p><codeph>ij</codeph> sets the cursor name using a
+<i>java.sql.Statement.setCursorName</i> request. Behavior with respect to
+duplicate cursor names is controlled by the underlying database.
+<ph conref="../conrefs.dita#prod/productshortname"></ph> does not allow multiple
+open cursors with the same name.</p>
+<p>Once a cursor has been created, you can use <codeph>ij</codeph>'s
+<codeph><xref href="rtoolsijcomref11128.dita">Next</xref></codeph> and
+<codeph><xref href="rtoolsijcomref24423.dita">Close</xref></codeph> commands to
+step through its rows and (if the connection supports positioned update and
+delete commands) to alter the rows.</p>
+</section>
 <refsyn><title>Syntax</title>
-<codeblock><b>GET [WITH {HOLD|NOHOLD}] CURSOR <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i></b> AS <b><i><xref href="rtoolsijcomref34110.dita#rtoolsijcomref34110">String</xref></i></b></b></codeblock>
-<p>WITH HOLD is the default attribute of the cursor. For a non-holdable cursor,
-use the WITH NOHOLD option.</p>
+<codeblock><b>GET [ WITH { HOLD | NOHOLD } ] CURSOR <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i> AS <i><xref href="rtoolsijcomref34110.dita">String</xref></i></b></codeblock>
+<p><codeph>WITH HOLD</codeph> is the default attribute of the cursor. For a
+non-holdable cursor, use the <codeph>WITH NOHOLD</codeph> option.</p>
 </refsyn>
-<section><title>Description</title>
-<p>Creates a cursor with the name of the <i>Identifier</i> by
-issuing a <i>java.sql.Statement.executeQuery</i> request
-on the value of the <i>String</i>.</p>
-<p>If the <i>String</i> is a statement that does not generate
-a result set, the behavior of the underlying database determines whether an
-empty result set or an error is issued. If there is an error in executing
-the statement, no cursor is created.</p>
-<p><codeph>ij</codeph> sets the cursor name using a <i>java.sql.Statement.setCursorName</i> request. Behavior with respect to duplicate cursor names is controlled
-by the underlying database. <ph conref="../conrefs.dita#prod/productshortname"></ph> does not allow multiple open cursors
-with the same name.</p>
-<p>Once a cursor has been created, the <codeph>ij</codeph>&nbsp;<xref href="rtoolsijcomref11128.dita#rtoolsijcomref11128">Next</xref> and <xref href="rtoolsijcomref24423.dita#rtoolsijcomref24423">Close</xref> commands can
-be used to step through its rows, and if the connection supports positioned
-update and delete commands, they can be issued to alter the rows.</p>
-</section>
 <example><title>Examples</title>
 <codeblock>ij&gt; -- autocommit needs to be off so that the positioned update
 ij&gt; -- can see the cursor it operates against. 

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref37862.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref37862.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref37862.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref37862.dita Wed Jul  2 19:12:15 2014
@@ -18,31 +18,35 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref37862">
 <title>Async command</title>
+<shortdesc>The <codeph>Async</codeph> command lets you execute an SQL statement
+in a separate thread.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Async command</indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
+<section>
+<p>This command is used in conjunction with the
+<codeph><xref href="rtoolsijcomref17631.dita">Wait For</xref></codeph> command
+to get the results.</p></section>
 <refsyn><title>Syntax</title>
-<codeblock><b>ASYNC <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref>&nbsp;<xref href="rtoolsijcomref34110.dita#rtoolsijcomref34110">String</xref></i></b></b></codeblock>
-</refsyn>
-<section><title>Description</title>
-<p>The ASYNC command lets you execute
-an SQL statement in a separate thread. It is used in conjunction with the <xref href="rtoolsijcomref17631.dita#rtoolsijcomref17631">Wait For</xref> command to get the results.</p>
-<p>You supply the SQL statement, which is any valid SQL statement, as a <i>String</i>. The <i>Identifier</i> you must
-supply for the async SQL statement is used in the
-<xref href="rtoolsijcomref17631.dita#rtoolsijcomref17631">Wait For</xref>
-command and is a case-insensitive <codeph>ij</codeph> identifier. An identifier
-that does not specify a <i>connectionName</i> must not be the same as any other
-identifier for an async statement on the current connection; an identifier that
-specifies a <i>connectionName</i> must not be the same as any other identifier
-for an async statement on the designated connection. You cannot reference a
-statement previously prepared and named by the
-<codeph>ij</codeph>&nbsp;<xref href="rtoolsijcomref12333.dita#rtoolsijcomref12333">Prepare</xref>
+<codeblock><b>ASYNC <i><xref href="rtoolsijcomref40155.dita">Identifier</xref>&nbsp;<xref href="rtoolsijcomref34110.dita">String</xref></i></b></codeblock>
+<p>You supply the SQL statement, which is any valid SQL statement, as a
+<i>String</i>. The <i>Identifier</i> you must supply for the async SQL statement
+is used in the <codeph><xref href="rtoolsijcomref17631.dita">Wait
+For</xref></codeph> command and is a case-insensitive <codeph>ij</codeph>
+identifier. An identifier that does not specify a <i>connectionName</i> must not
+be the same as any other identifier for an async statement on the current
+connection; an identifier that specifies a <i>connectionName</i> must not be the
+same as any other identifier for an async statement on the designated
+connection. You cannot reference a statement previously prepared and named by
+the <codeph>ij</codeph>
+<codeph><xref href="rtoolsijcomref12333.dita">Prepare</xref></codeph>
 command in this command.</p>
-<p><codeph>ij</codeph> creates a new thread in the current or designated connection to issue the
-SQL statement. The separate thread is closed once the statement completes.</p>
-</section>
+<p><codeph>ij</codeph> creates a new thread in the current or designated
+connection to issue the SQL statement. The separate thread is closed once the
+statement completes.</p>
+</refsyn>
 <example><title>Examples</title>
 <codeblock>ij&gt; <b>async aInsert 'INSERT into menu values (''entree'',''chicken'',11)';</b>
 ij&gt; <b>INSERT INTO menu VALUES ('dessert','ice cream',3);</b>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref39042.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref39042.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref39042.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref39042.dita Wed Jul  2 19:12:15 2014
@@ -19,21 +19,30 @@ limitations under the License.
 -->
 <reference id="rtoolsijcomref39042" xml:lang="en-us">
 <title>Driver command</title>
+<shortdesc>The <codeph>Driver</codeph> command takes the value of the
+<i>DriverNameString</i> argument and issues a <i>Class.forName</i> request to
+load the named class.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Driver command</indexterm><indexterm>JDBC driver<indexterm>loading </indexterm></indexterm>
+<keywords><indexterm>Driver command</indexterm>
+<indexterm>JDBC driver<indexterm>loading</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
-<refsyn><title>Syntax</title> <codeblock><b>DRIVER <b><i>DriverNameString</i></b></b></codeblock> </refsyn>
-<section><title>Description</title> <p>Takes the value of the <i>DriverNameString</i> and
-issues a <i>Class.forName</i> request to load the named class. The class is
-expected to be a JDBC driver that registers itself with <i>java.sql.DriverManager</i>.</p> <p>If
-the <xref href="rtoolsijcomref39042.dita#rtoolsijcomref39042">Driver</xref> command
-succeeds, a new <codeph>ij</codeph> prompt appears for the next command. </p> </section>
-<example><title>Example</title> <codeblock>ij&gt; -- load the <ph conref="../conrefs.dita#prod/productshortname"></ph> driver so that a connection
+<section>
+<p>The class is expected to be a JDBC driver that registers itself with
+<i>java.sql.DriverManager</i>.</p>
+<p>If the <codeph>Driver</codeph> command succeeds, a new <codeph>ij</codeph>
+prompt appears for the next command.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>DRIVER <i>DriverNameString</i></b></codeblock>
+</refsyn>
+<example><title>Example</title>
+<codeblock>ij&gt; -- load the <ph conref="../conrefs.dita#prod/productshortname"></ph> driver so that a connection
 -- can be made: 
 <b>driver 'org.apache.derby.jdbc.EmbeddedDriver';</b>
-ij&gt;<b> connect 'jdbc:derby:menuDB;create=true';</b>
-ij&gt;</codeblock> </example>
+ij&gt; <b>connect 'jdbc:derby:menuDB;create=true';</b>
+ij&gt;</codeblock>
+</example>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita?rev=1607450&r1=1607449&r2=1607450&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita Wed Jul  2 19:12:15 2014
@@ -18,21 +18,24 @@ limitations under the License.
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
 <reference xml:lang="en-us" id="rtoolsijcomref39198">
 <title>Set Connection command</title>
+<shortdesc>The <codeph>Set Connection</codeph> command specifies which
+connection to make current when more than one connection is open.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Set Connection command</indexterm><indexterm>Connection<indexterm>switching</indexterm></indexterm>
+<keywords><indexterm>Set Connection command</indexterm>
+<indexterm>Connection<indexterm>switching</indexterm></indexterm>
 </keywords>
 </metadata>
 </prolog><refbody>
-<refsyn><title>Syntax</title>
-<codeblock><b>SET CONNECTION <b><i><xref href="rtoolsijcomref40155.dita#rtoolsijcomref40155">Identifier</xref></i></b></b></codeblock>
-</refsyn>
-<section><title>Description</title>
-<p>Allows you to specify which connection to make current when you have more
-than one connection open. Use the <xref href="rtoolsijcomrefshow.dita#rtoolsijcomrefshow/rtoolsijcomref17529">Show Connections</xref> command
-to display open connections.</p>
+<section>
+<p>Use the
+<codeph><xref href="rtoolsijcomrefshow.dita#rtoolsijcomrefshow/rtoolsijcomref17529">Show Connections</xref></codeph>
+command to display open connections.</p>
 <p>If there is no such connection, an error results and the current connection
 is unchanged.</p>
 </section>
+<refsyn><title>Syntax</title>
+<codeblock><b>SET CONNECTION <i><xref href="rtoolsijcomref40155.dita">Identifier</xref></i></b></codeblock>
+</refsyn>
 <example><title>Example</title>
 <codeblock>ij&gt; <b>protocol 'jdbc:derby:';</b>
 ij&gt; <b>connect 'sample' as sample1;</b>



Mime
View raw message