You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by ch...@apache.org on 2014/06/26 16:43:21 UTC
svn commit: r1605801 - /db/derby/docs/trunk/src/tools/
Author: chaase3
Date: Thu Jun 26 14:43:20 2014
New Revision: 1605801
URL: http://svn.apache.org/r1605801
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Modified 27 Tools Guide topics.
Patch: DERBY-6379-tools-start.diff
Modified:
db/derby/docs/trunk/src/tools/ctools1003034.dita
db/derby/docs/trunk/src/tools/ctools1004764.dita
db/derby/docs/trunk/src/tools/ctoolsij12001.dita
db/derby/docs/trunk/src/tools/ctoolsij25986.dita
db/derby/docs/trunk/src/tools/ctoolsij32837.dita
db/derby/docs/trunk/src/tools/ctoolsij34525.dita
db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita
db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita
db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita
db/derby/docs/trunk/src/tools/ctoolsijtools25085.dita
db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita
db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita
db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita
db/derby/docs/trunk/src/tools/ctoolsijtools45180.dita
db/derby/docs/trunk/src/tools/ctoolsijtools70959.dita
db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita
db/derby/docs/trunk/src/tools/ctoolspre11181.dita
db/derby/docs/trunk/src/tools/ctoolspre22460.dita
db/derby/docs/trunk/src/tools/ctoolspre23947.dita
db/derby/docs/trunk/src/tools/rtools1003161.dita
db/derby/docs/trunk/src/tools/rtoolsdrvrnmeurl.dita
db/derby/docs/trunk/src/tools/rtoolsijtools16879.dita
db/derby/docs/trunk/src/tools/ttoolsij11815.dita
db/derby/docs/trunk/src/tools/ttoolsij30600.dita
db/derby/docs/trunk/src/tools/ttoolsij97656.dita
db/derby/docs/trunk/src/tools/ttoolsij98878.dita
db/derby/docs/trunk/src/tools/ttoolsijcreatedatabase.dita
Modified: db/derby/docs/trunk/src/tools/ctools1003034.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctools1003034.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctools1003034.dita (original)
+++ db/derby/docs/trunk/src/tools/ctools1003034.dita Thu Jun 26 14:43:20 2014
@@ -19,11 +19,12 @@ limitations under the License.
-->
<concept id="ctools1003034" xml:lang="en-us">
<title>Java Platform, Standard Edition @MINIMUM_JDK@</title>
+<shortdesc>All <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+require Java Platform, Standard Edition (Java SE) @MINIMUM_JDK@ or
+later.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
-<p>All <ph conref="../conrefs.dita#prod/productshortname"></ph> tools require
-Java Platform, Standard Edition (Java SE) @MINIMUM_JDK@ or later.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/ctools1004764.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctools1004764.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctools1004764.dita (original)
+++ db/derby/docs/trunk/src/tools/ctools1004764.dita Thu Jun 26 14:43:20 2014
@@ -18,13 +18,14 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctools1004764">
<title>About locales</title>
+<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph>
+documentation refers to three locales.</shortdesc>
<prolog><metadata>
<keywords>
</keywords>
</metadata>
</prolog>
<conbody>
-<p>In the <ph conref="../conrefs.dita#prod/productshortname"></ph> documentation, we refer to three locales:
<ul>
<li><i>Java system locale</i>
<p>This is the locale of your machine, which is automatically
@@ -42,7 +43,7 @@ the language of database errors.</p></li
This locale determines the language of messages, as well as
the localized display format for numbers, dates, times, and timestamps.
You can use the
-<codeph><xref href="rtoolsijlocale.dita#rtoolsijlocale">derby.ui.locale</xref></codeph>
+<codeph><xref href="rtoolsijlocale.dita">derby.ui.locale</xref></codeph>
property to specify the session locale that should be used.</p></li>
-</ul></p>
+</ul>
</conbody></concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsij12001.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsij12001.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsij12001.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsij12001.dita Thu Jun 26 14:43:20 2014
@@ -18,13 +18,15 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctoolsij12001">
<title>Other uses for ij</title>
+<shortdesc><codeph>ij</codeph> is a JDBC-neutral scripting tool with a small
+command set. It can be used to access any JDBC driver and any database
+accessible through that driver.</shortdesc>
<prolog>
</prolog>
<conbody>
-<p>ij is a JDBC-neutral scripting tool with a small command set. It can be
-used to access any JDBC driver and database accessible through that driver. </p>
-<p>The main benefit of a tool such as ij is that it is easy to run scripts
-for creating a database schema and automating other repetitive database tasks.</p>
-<p>In addition, ij accepts and processes SQL commands interactively for ad
-hoc database access.</p>
+<p>The main benefit of a tool such as <codeph>ij</codeph> is that it is easy to
+run scripts for creating a database schema and automating other repetitive
+database tasks.</p>
+<p>In addition, <codeph>ij</codeph> accepts and processes SQL commands
+interactively for ad hoc database access.</p>
</conbody></concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsij25986.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsij25986.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsij25986.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsij25986.dita Thu Jun 26 14:43:20 2014
@@ -19,23 +19,25 @@ limitations under the License.
-->
<concept id="ctoolsij25986" xml:lang="en-us">
<title>Using ij commands</title>
+<shortdesc>The primary purpose of <codeph>ij</codeph> is to allow the execution
+of <ph conref="../conrefs.dita#prod/productshortname"></ph> SQL statements
+interactively or by means of scripts.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
-<p>The primary purpose of ij is to allow the execution of <ph conref="../conrefs.dita#prod/productshortname"></ph> SQL
-statements interactively or via scripts. Since SQL statements can be quite
-long, ij uses the semicolon to mark the end of a statement or command. All
-statements and commands must be terminated with a semicolon. If you press
-Return before terminating a statement or command, ij places a continuation
-character (>) at the beginning of the next line.</p>
-<p>ij uses properties, listed in
-<xref href="rtoolsijpropref29864.dita#rtoolsijpropref29864"></xref>, to simplify
-its use. </p>
-<p>ij also recognizes specialized commands that
-provide additional features, such as the ability to create and test cursors
-and prepared statements, transaction control, and more. For complete information
-about ij commands, see
-<xref href="rtoolsijcomref25570.dita#rtoolsijcomref25570"></xref>.</p>
+<p>Since SQL statements can be quite long, <codeph>ij</codeph> uses the
+semicolon to mark the end of a statement or command. All statements and commands
+must be terminated with a semicolon. If you press Return before terminating a
+statement or command, <codeph>ij</codeph> places a continuation character
+(<codeph>></codeph>) at the beginning of the next line.</p>
+<p><codeph>ij</codeph> uses properties, listed in
+<xref href="rtoolsijpropref29864.dita">ij properties reference</xref>, to
+simplify its use.</p>
+<p><codeph>ij</codeph> also recognizes specialized commands that provide
+additional features, such as the ability to create and test cursors and prepared
+statements, transaction control, and more. For complete information about
+<codeph>ij</codeph> commands, see <xref href="rtoolsijcomref25570.dita">ij
+commands and errors reference</xref>.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsij32837.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsij32837.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsij32837.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsij32837.dita Thu Jun 26 14:43:20 2014
@@ -19,10 +19,11 @@ limitations under the License.
-->
<concept id="ctoolsij32837" xml:lang="en-us">
<title>Getting started with ij</title>
+<shortdesc>This section discusses the use of the <codeph>ij</codeph>
+tool.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
-<p>This section discusses the use of the ij tool.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsij34525.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsij34525.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsij34525.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsij34525.dita Thu Jun 26 14:43:20 2014
@@ -19,16 +19,18 @@ limitations under the License.
-->
<concept id="ctoolsij34525" xml:lang="en-us">
<title>Using ij</title>
+<shortdesc><codeph>ij</codeph> is
+<ph conref="../conrefs.dita#prod/productshortname"></ph>'s interactive JDBC
+scripting tool. It is a simple utility for running scripts or interactive
+queries against a <ph conref="../conrefs.dita#prod/productshortname"></ph>
+database.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
-<p>ij is <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
-interactive JDBC scripting tool. It is a simple utility for running scripts
-or interactive queries against a
-<ph conref="../conrefs.dita#prod/productshortname"></ph> database.</p>
-<p>ij is a Java application, which you start from a command window such as
-an MS-DOS Command Window or the UNIX shell. ij provides several non-SQL commands
-for ease in accessing a variety of JDBC features for testing.</p>
+<p><codeph>ij</codeph> is a Java application, which you start from a command
+window such as a Windows command prompt or a UNIX shell. <codeph>ij</codeph>
+provides several non-SQL commands for ease in accessing a variety of JDBC
+features for testing.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita Thu Jun 26 14:43:20 2014
@@ -18,16 +18,16 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctoolsijtools11318">
<title>Tools and localization</title>
+<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+provide support for common localization features such as localized message files
+and GUI, locale-appropriate formatting of data, codesets, unicode identifiers
+and data, and database locales.</shortdesc>
<prolog><metadata>
<keywords>
</keywords>
</metadata>
</prolog>
<conbody>
-<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
-provide support for common localization features such as localized message
-files and GUI, locale-appropriate formatting of data, codesets, unicode
-identifiers and data, and database locales.</p>
<p>For general information about localizing
<ph conref="../conrefs.dita#prod/productshortname"></ph> systems, see the
<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita Thu Jun 26 14:43:20 2014
@@ -19,16 +19,18 @@ limitations under the License.
-->
<concept id="ctoolsijtools16011" xml:lang="en-us">
<title>Database connection URLs</title>
+<shortdesc>A JDBC URL provides a way of identifying a database so that the
+appropriate driver recognizes it and connects to it. In the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> documentation, a JDBC
+URL is referred to as a database connection URL.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
-<p>A JDBC URL provides a way of identifying a database so that the appropriate
-driver recognizes it and connects to it. In the <ph conref="../conrefs.dita#prod/productshortname"></ph> documents,
-a JDBC URL is referred to as a database connection URL.</p>
<p>After the driver is loaded, an application must specify the correct database
-connection URL to connect to a specific database. The <ph conref="../conrefs.dita#prod/productshortname"></ph> database
-connection URL allows you to accomplish tasks other than simply connecting.</p>
+connection URL to connect to a specific database. The
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database connection URL
+allows you to accomplish tasks other than simply connecting.</p>
<p>For complete information about the database connection URL, see
the <ph conref="../conrefs.dita#pub/citref"></ph> and the
<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
@@ -65,7 +67,7 @@ framework</p></li>
the portion of the database connection URL called the protocol is
<codeph>jdbc:</codeph>, just as <codeph>http://</codeph> is a protocol in web
URLs. After that, <codeph>derby:</codeph> is officially the subprotocol, and
-anything else between <codeph>jdbc:derby:</codeph> and <i>databaseName</i>) is
+anything else between <codeph>jdbc:derby:</codeph> and <i>databaseName</i> is
called the subsubprotocol. See "Syntax of database connection URLs for
applications with embedded databases" in the
<ph conref="../conrefs.dita#pub/citref"></ph> for details. However, the
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita Thu Jun 26 14:43:20 2014
@@ -19,13 +19,13 @@ limitations under the License.
-->
<concept id="ctoolsijtools20118" xml:lang="en-us">
<title>JDBC connection basics</title>
+<shortdesc>Most of the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+tools are JDBC applications. A JDBC application is one that uses the classes in
+the <i>java.sql</i> package to interact with a DBMS.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
-<p>Most of the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
-are JDBC applications. A JDBC application is one that uses the classes in
-the <i>java.sql</i> package to interact with a DBMS.</p>
<p>When you work with JDBC applications, you need to know about several concepts.
The most basic is the <i>connection</i>. A <i>JDBC connection</i> is the object
through which commands are sent to the <ph conref="../conrefs.dita#prod/productshortname"></ph> engine
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools25085.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools25085.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools25085.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools25085.dita Thu Jun 26 14:43:20 2014
@@ -17,10 +17,13 @@ limitations under the License.
-->
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctoolsijtools25085">
-<title>About Derby databases</title>
+<title>About <ph conref="../conrefs.dita#prod/productshortname"></ph>
+databases</title>
+<shortdesc>A <ph conref="../conrefs.dita#prod/productshortname"></ph> database
+consists of platform-independent files stored in a directory that has the same
+name as the database.</shortdesc>
<prolog>
</prolog>
<conbody>
-<p>A <ph conref="../conrefs.dita#prod/productshortname"></ph> database consists of platform-independent files stored in
-a directory that has the same name as the database.</p>
-</conbody></concept>
+</conbody>
+</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita Thu Jun 26 14:43:20 2014
@@ -18,18 +18,19 @@ See the License for the specific languag
limitations under the License.
-->
<concept id="ctoolsijtools26429" xml:lang="en-us">
-<title>What are the Derby tools and utilities?</title>
+<title>What are the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+tools and utilities?</title>
+<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph> tools and
+utilities are a set of routines supplied with
+<ph conref="../conrefs.dita#prod/productshortname"></ph> that are typically used
+to create, inspect, and update a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Tools<indexterm>how to use</indexterm></indexterm></keywords>
</metadata></prolog>
<conbody>
-<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> tools and
-utilities are a set of routines supplied with
-<ph conref="../conrefs.dita#prod/productshortname"></ph> that are typically used
-to create, inspect, and update a
-<ph conref="../conrefs.dita#prod/productshortname"></ph> database.</p>
-<p>For more complete information on developing a system using <ph conref="../conrefs.dita#prod/productshortname"></ph>,
-see the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.
- </p>
+<p>For more complete information on developing a system using
+<ph conref="../conrefs.dita#prod/productshortname"></ph>, see the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita Thu Jun 26 14:43:20 2014
@@ -19,14 +19,15 @@ limitations under the License.
-->
<concept id="ctoolsijtools30948" xml:lang="en-us">
<title>Overview</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> is a
+database management system (DBMS), accessed by applications through the JDBC
+API. Included with the product are some standalone Java tools and utilities that
+make it easier to use and develop applications for
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
-<p><ph conref="../conrefs.dita#prod/productshortname"></ph> is a database
-management system (DBMS), accessed by applications through the JDBC API.</p>
-<p>Included with the product are some standalone Java tools and utilities
-that make it easier to use and develop applications for <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
<p>These tools and utilities include:</p>
<ul>
<li><i><ph><indexterm>ij<indexterm>description</indexterm></indexterm></ph>ij</i>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools37363.dita Thu Jun 26 14:43:20 2014
@@ -20,10 +20,10 @@ limitations under the License.
<concept id="ctoolsijtools37363" xml:lang="en-us">
<title>Environment setup and the
<ph conref="../conrefs.dita#prod/productshortname"></ph> tools</title>
+<shortdesc>The tools <codeph>ij</codeph>, <codeph>sysinfo</codeph>,
+<codeph>dblook</codeph>, and <codeph>SignatureChecker</codeph> can all be used
+in either an embedded or a client/server environment.</shortdesc>
<prolog></prolog>
<conbody>
-<p>The tools <codeph>ij</codeph>, <codeph>sysinfo</codeph>,
-<codeph>dblook</codeph>, and <codeph>SignatureChecker</codeph> can all be used
-in either an embedded or a client/server environment.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools45180.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools45180.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools45180.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools45180.dita Thu Jun 26 14:43:20 2014
@@ -18,13 +18,13 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctoolsijtools45180">
<title>Database locale</title>
+<shortdesc>To specify a database locale, use the <i>territory=ll_CC</i>
+attribute on the URL connection when creating the database.</shortdesc>
<prolog>
</prolog>
<conbody>
-<p>To specify a database locale, use the <i>territory=ll_CC</i> attribute
-on the URL connection when creating the database.
-<note>You cannot
-modify a database's locale after the database has been created.</note></p>
+<p><note>You cannot modify a database's locale after the database has been
+created.</note></p>
<p>For information about database locales, see "Localizing
<ph conref="../conrefs.dita#prod/productshortname"></ph>" in the
<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools70959.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools70959.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools70959.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools70959.dita Thu Jun 26 14:43:20 2014
@@ -18,11 +18,14 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctoolsijtools70959">
<title>Specifying an alternate codeset</title>
+<shortdesc>You can specify an alternate codeset for your tool
+session.</shortdesc>
<prolog>
</prolog>
<conbody>
-<p>You can specify an alternate codeset for your tool session. </p>
-<p>Use the <i><xref href="rtoolsijpropref97949.dita#rtoolsijpropref97949">derby.ui.codeset</xref></i> property
-when starting <codeph>ij</codeph> or <codeph>dblook</codeph>. This property can be useful
-when working with scripts created on a different system.</p>
+<p>Use the
+<codeph><xref href="rtoolsijpropref97949.dita">derby.ui.codeset</xref></codeph>
+property when starting <codeph>ij</codeph> or <codeph>dblook</codeph>. This
+property can be useful when working with scripts created on a different
+system.</p>
</conbody></concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools90477.dita Thu Jun 26 14:43:20 2014
@@ -18,13 +18,18 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctoolsijtools90477">
<title>Formatting display of locale-sensitive data</title>
+<shortdesc>To display dates, timestamps, numbers, and times in the format of the
+<codeph>ij</codeph> Session locale, use the <codeph>LocalizedDisplay</codeph>
+command.</shortdesc>
<prolog>
</prolog>
<conbody>
-<p>To display dates, timestamps, numbers, and times in the format of the <codeph>ij</codeph> Session locale, use the <i><xref href="rtoolsijcomref88554.dita#rtoolsijcomref88554">LocalizedDisplay</xref></i> command.
-<note>These options do not change how <ph conref="../conrefs.dita#prod/productshortname"></ph> <i>stores</i> locale-sensitive data, simply how the tool displays
-the data.</note></p>
-<p>The following example demonstrates using <i>localizedDisplay</i> in an <i>en_US</i> locale:
+<p><note>These options do not change the way
+<ph conref="../conrefs.dita#prod/productshortname"></ph> <i>stores</i>
+locale-sensitive data, simply the way the tool displays the data.</note></p>
+<p>The following example demonstrates the use of
+<codeph><xref href="rtoolsijcomref88554.dita">LocalizedDisplay</xref></codeph>
+in an <codeph>en_US</codeph> locale:
<codeblock>ij> <b>VALUES CURRENT_DATE;</b>
1
----------
Modified: db/derby/docs/trunk/src/tools/ctoolspre11181.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolspre11181.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolspre11181.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolspre11181.dita Thu Jun 26 14:43:20 2014
@@ -18,11 +18,13 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctoolspre11181">
<title>Purpose of this document</title>
+<shortdesc>This guide describes how to use the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> tools and
+utilities.</shortdesc>
<prolog>
</prolog>
<conbody>
-<p>This book describes how to use the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools and utilities. The
-tools and utilities covered in this book include:</p>
+<p>The tools and utilities covered in this guide include the following.</p>
<ul>
<li><codeph>ij</codeph></li>
<li><codeph>sysinfo</codeph></li>
Modified: db/derby/docs/trunk/src/tools/ctoolspre22460.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolspre22460.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolspre22460.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolspre22460.dita Thu Jun 26 14:43:20 2014
@@ -18,10 +18,10 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctoolspre22460">
<title>Audience</title>
+<shortdesc>The audience for this guide includes several groups.</shortdesc>
<prolog>
</prolog>
<conbody>
-<p>This book is for:</p>
<ul>
<li>Developers, who might use the tools when developing applications</li>
<li>System administrators, who might use the tools to run scripts that perform
Modified: db/derby/docs/trunk/src/tools/ctoolspre23947.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolspre23947.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolspre23947.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolspre23947.dita Thu Jun 26 14:43:20 2014
@@ -19,9 +19,9 @@ limitations under the License.
-->
<concept id="ctoolspre23947" xml:lang="en-us">
<title>How this guide is organized</title>
+<shortdesc>This guide includes the following sections.</shortdesc>
<prolog></prolog>
<conbody>
-<p>This guide includes the following sections:</p>
<ul>
<li><xref href="ctoolsijtools26429.dita#ctoolsijtools26429"></xref> <p>Overview
of the tools and utilities, and <ph conref="../conrefs.dita#prod/productshortname"></ph> and
Modified: db/derby/docs/trunk/src/tools/rtools1003161.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtools1003161.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtools1003161.dita (original)
+++ db/derby/docs/trunk/src/tools/rtools1003161.dita Thu Jun 26 14:43:20 2014
@@ -19,15 +19,16 @@ limitations under the License.
-->
<reference id="rtools1003161" xml:lang="en-us">
<title>Classpath</title>
+<shortdesc>The jar file <codeph>derbyrun.jar</codeph> simplifies the process of
+setting up the <codeph>CLASSPATH</codeph> environment variable to run
+<ph conref="../conrefs.dita#prod/productshortname"></ph> and the
+tools.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<refbody>
-<section><p>The jar file <codeph>derbyrun.jar</codeph> simplifies the process of
-setting up the <codeph>CLASSPATH</codeph> environment variable to run
-<ph conref="../conrefs.dita#prod/productshortname"></ph> and the tools. Adding
-this jar file to your classpath has the effect of putting all the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> jar files in your
+<section><p>Adding this jar file to your classpath has the effect of putting all
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> jar files in your
classpath.</p>
<p>For details on using the
<ph conref="../conrefs.dita#prod/productshortname"></ph> jar files for
Modified: db/derby/docs/trunk/src/tools/rtoolsdrvrnmeurl.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsdrvrnmeurl.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsdrvrnmeurl.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsdrvrnmeurl.dita Thu Jun 26 14:43:20 2014
@@ -19,10 +19,11 @@ limitations under the License.
-->
<reference id="rtoolsdrvrnmeurl" xml:lang="en-us">
<title>The ij Driver name and connection URL</title>
+<shortdesc>The following table summarizes the different ways to specify the
+driver name and database connection URL.</shortdesc>
<prolog></prolog>
<refbody>
-<section><p>The following table summarizes the different ways to specify the
-driver name and database connection URL.</p>
+<section>
<table frame="all">
<title>Specifying the driver name and database connection URL</title>
<desc>This table lists various ways to specify the driver name and connection URL by using system properties, <codeph>ij</codeph> properties, or <codeph>ij</codeph> commands.</desc>
@@ -43,27 +44,29 @@ driver name and database connection URL.
<row>
<entry colname="1">Loading the driver implicitly</entry>
<entry colname="2">None</entry>
-<entry colname="3"><i><xref href="rtoolsijpropref10135.dita#rtoolsijpropref10135">ij.connection.connectionName</xref></i> (plus
-full URL), <i><xref href="rtoolsijpropref28146.dita#rtoolsijpropref28146">ij.database</xref></i> (plus
-full URL), <i><xref href="rtoolsijpropref35032.dita#rtoolsijpropref35032">ij.protocol</xref></i>, <i><xref
-href="rtoolsijpropref12236.dita#rtoolsijpropref12236">ij.protocol.protocolName</xref></i> (plus
-protocol clause in Connect command)</entry>
-<entry colname="4"><i><xref href="rtoolsijcomref27997.dita#rtoolsijcomref27997">Protocol</xref></i>,
-<i><xref href="rtoolsijcomref22318.dita#rtoolsijcomref22318">Connect</xref></i>
-(plus full URL)</entry>
+<entry colname="3"><codeph><xref href="rtoolsijpropref10135.dita">ij.connection.<i>connectionName</i></xref></codeph>
+(plus full URL),
+<codeph><xref href="rtoolsijpropref28146.dita">ij.database</xref></codeph> (plus
+full URL),
+<codeph><xref href="rtoolsijpropref35032.dita">ij.protocol</xref></codeph>,
+<codeph><xref href="rtoolsijpropref12236.dita">ij.protocol.<i>protocolName</i></xref></codeph>
+(plus protocol clause in <codeph>Connect</codeph> command)</entry>
+<entry colname="4"><codeph><xref href="rtoolsijcomref27997.dita">Protocol</xref></codeph>,
+<codeph><xref href="rtoolsijcomref22318.dita">Connect</xref></codeph> (plus full
+URL)</entry>
</row>
<row>
<entry colname="1">Loading the driver explicitly</entry>
-<entry colname="2"><i>jdbc.drivers</i></entry>
-<entry colname="3">-D<i><xref href="rtoolsijpropref41073.dita#rtoolsijpropref41073">ij.Driver</xref></i></entry>
-<entry colname="4"><i><xref href="rtoolsijcomref39042.dita#rtoolsijcomref39042">Driver</xref></i></entry>
+<entry colname="2"><codeph>jdbc.drivers</codeph></entry>
+<entry colname="3"><codeph>-D<xref href="rtoolsijpropref41073.dita">ij.driver</xref></codeph></entry>
+<entry colname="4"><codeph><xref href="rtoolsijcomref39042.dita">Driver</xref></codeph></entry>
</row>
<row>
<entry colname="1">Specifying the database connection URL</entry>
<entry colname="2">None</entry>
-<entry colname="3"><i><xref href="rtoolsijpropref10135.dita#rtoolsijpropref10135">ij.connection.connectionName</xref>,
-<xref href="rtoolsijpropref28146.dita#rtoolsijpropref28146">ij.database</xref></i></entry>
-<entry colname="4"><i><xref href="rtoolsijcomref22318.dita#rtoolsijcomref22318">Connect</xref></i></entry>
+<entry colname="3"><codeph><xref href="rtoolsijpropref10135.dita">ij.connection.<i>connectionName</i></xref></codeph>,
+<codeph><xref href="rtoolsijpropref28146.dita">ij.database</xref></codeph></entry>
+<entry colname="4"><codeph><xref href="rtoolsijcomref22318.dita">Connect</xref></codeph></entry>
</row>
</tbody>
</tgroup>
Modified: db/derby/docs/trunk/src/tools/rtoolsijtools16879.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijtools16879.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijtools16879.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijtools16879.dita Thu Jun 26 14:43:20 2014
@@ -19,14 +19,16 @@ limitations under the License.
-->
<reference id="rtoolsijtools16879" xml:lang="en-us">
<title>JDBC drivers overview</title>
+<shortdesc>Before a JDBC application connects to a database, it must cause the
+proper JDBC driver to be loaded in the Java session.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<refbody>
-<section><p>Before a JDBC application connects to a database, it must cause
-the proper JDBC driver to be loaded in the Java session. <ph conref="../conrefs.dita#prod/productshortname"></ph> provides
-the following JDBC drivers for use with the <ph conref="../conrefs.dita#prod/productshortname"></ph> database
-engine: <ul>
+<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
+the following JDBC drivers for use with the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database engine:
+<ul>
<li><i>org.apache.derby.jdbc.EmbeddedDriver</i> <p>For embedded environments,
when <ph conref="../conrefs.dita#prod/productshortname"></ph> runs in the
same JVM as the application. This is commonly referred to as the embedded
Modified: db/derby/docs/trunk/src/tools/ttoolsij11815.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ttoolsij11815.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ttoolsij11815.dita (original)
+++ db/derby/docs/trunk/src/tools/ttoolsij11815.dita Thu Jun 26 14:43:20 2014
@@ -19,19 +19,23 @@ limitations under the License.
-->
<task id="ttoolsij11815" xml:lang="en-us">
<title>Starting ij</title>
-<taskbody>
-<context> <p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
batch and shell scripts for users in Windows and UNIX environments that can
-be used to start ij. By calling the appropriate script you will start ij and
-be able to connect with a simple command. The scripts are
-found in the <codeph>bin</codeph> directory of your <ph conref="../conrefs.dita#prod/productshortname"></ph>
-installation. You can also customize the ij scripts to suit your environment.</p><p> If you are using <ph conref="../conrefs.dita#prod/productshortname"></ph> as
+be used to start <codeph>ij</codeph>.</shortdesc>
+<taskbody>
+<context>
+<p>By calling the appropriate script, you can start <codeph>ij</codeph> and be
+able to connect with a simple command. The scripts are found in the
+<codeph>bin</codeph> directory of your
+<ph conref="../conrefs.dita#prod/productshortname"></ph> installation. You can
+also customize the <codeph>ij</codeph> scripts to suit your environment.</p>
+<p>If you are using <ph conref="../conrefs.dita#prod/productshortname"></ph> as
a client/server environment, start the Network Server before connecting to the
<ph conref="../conrefs.dita#prod/productshortname"></ph> database. (See
"Starting the Network Server" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph> for details.) You can start
-ij by running the ij scripts for your environment. Follow the instructions in
-"Setting up your environment" in
+<codeph>ij</codeph> by running the <codeph>ij</codeph> scripts for your
+environment. Follow the instructions in "Setting up your environment" in
<ph conref="../conrefs.dita#pub/citgetstart"></ph> to set the
<codeph><ph conref="../conrefs.dita#prod/productinstallpath"></ph></codeph>
and <codeph>JAVA_HOME</codeph> environment variables and to add
@@ -46,33 +50,41 @@ environment variable, then use one of th
[-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock>
<codeblock><b><userinput>java [<varname>options</varname>] org.apache.derby.tools.ij
[-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock>
-<p>If you use the last form of the command, be sure that <codeph>derbyrun.jar</codeph> is in your
-classpath (for pre-10.2 distributions <codeph>derbytools.jar</codeph> and usually <codeph>derby.jar</codeph>
-were required in the classpath).</p>
-<p>If you need to use other classes in addition to <codeph>derbyrun.jar</codeph>,
-you cannot use the <codeph>-cp</codeph> argument or the CLASSPATH
-environment variable to set CLASSPATH variables when you are using the
-<codeph>-jar</codeph> argument to start the <codeph>ij</codeph> tool.
-If you want to run the <codeph>ij</codeph> tool with a custom classpath,
-you cannot use the <codeph>-jar</codeph> argument. Instead, you have to
-use the full class name to start the <codeph>ij</codeph> tool
+<p>If you use the last form of the command, be sure that
+<codeph>derbyrun.jar</codeph> is in your classpath.</p>
+<p>If you need to use other classes in addition to
+<codeph>derbyrun.jar</codeph>, you cannot use the <codeph>-cp</codeph> argument
+or the <codeph>CLASSPATH</codeph> environment variable to set
+<codeph>CLASSPATH</codeph> variables when you are using the
+<codeph>-jar</codeph> argument to start the <codeph>ij</codeph> tool. If you
+want to run the <codeph>ij</codeph> tool with a custom classpath, you cannot use
+the <codeph>-jar</codeph> argument. Instead, you have to use the full class
+name to start the <codeph>ij</codeph> tool
(<codeph>java org.apache.derby.tools.ij</codeph>). </p>
<p>The command line items are:</p> <ul>
-<li id="rtoolsij42358"><b><userinput>java</userinput></b> <p>Start the JVM. </p></li>
-<li id="rtoolsij26546"><b><userinput><varname>options</varname></userinput></b> <p>The options that the JVM uses. You can
-use the -D option to set ij properties (see <xref href="ttoolsij30600.dita#ttoolsij30600"></xref>)
-or system properties, such as <ph conref="../conrefs.dita#prod/productshortname"></ph> properties. </p></li>
-<li id="rtoolsij40855"><b><userinput><varname>propertyFile</varname></userinput></b> <p>A file you can use to set ij properties
-(instead of the -D option). The property file should be in the format created
-by the java.tools.Properties.save methods, which is the same format as the
-derby.properties file.</p></li>
-<li id="rtoolsij39639"><b><userinput><varname>inputFile</varname></userinput></b> <p>A file from which to read commands.
-The ij tool exits at the end of the file or an exit command. Using an input
-file causes ij to print out the commands as it runs them. If you reroute standard
-input, ij does not print out the commands. If you do not supply an input file,
-ij reads from the standard input.</p></li>
+<li><b><userinput>java</userinput></b>
+<p>Start the JVM.</p></li>
+<li><b><userinput><varname>options</varname></userinput></b>
+<p>The options that the JVM uses. You can use the <codeph>-D</codeph> option to
+set <codeph>ij</codeph> properties (see
+<xref href="ttoolsij30600.dita">Starting ij using properties</xref>) or system
+properties, such as <ph conref="../conrefs.dita#prod/productshortname"></ph>
+properties.</p></li>
+<li><b><userinput><varname>propertyFile</varname></userinput></b>
+<p>A file you can use to set <codeph>ij</codeph> properties (instead of the
+<codeph>-D</codeph> option). The property file should be in the format created
+by the <codeph>java.tools.Properties.save</codeph> methods, which is the same
+format as the <codeph>derby.properties</codeph> file.</p></li>
+<li><b><userinput><varname>inputFile</varname></userinput></b>
+<p>A file from which to read commands. The <codeph>ij</codeph> tool exits at the
+end of the file or an <codeph>exit</codeph> command. Using an input file causes
+<codeph>ij</codeph> to print out the commands as it runs them. If you reroute
+standard input, <codeph>ij</codeph> does not print out the commands. If you do
+not supply an input file, <codeph>ij</codeph> reads from the standard input.</p></li>
</ul></example>
-<postreq><p>For detailed information about ij commands, see <xref href="rtoolsijcomref25570.dita#rtoolsijcomref25570"></xref>.
- </p></postreq>
+<postreq><p>For detailed information about <codeph>ij</codeph> commands, see
+<xref href="rtoolsijcomref25570.dita">ij commands and errors
+reference</xref>.</p>
+</postreq>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/tools/ttoolsij30600.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ttoolsij30600.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ttoolsij30600.dita (original)
+++ db/derby/docs/trunk/src/tools/ttoolsij30600.dita Thu Jun 26 14:43:20 2014
@@ -19,38 +19,50 @@ limitations under the License.
-->
<task id="ttoolsij30600" xml:lang="en-us">
<title>Starting ij using properties</title>
+<shortdesc>You can set <codeph>ij</codeph> properties in any of the following
+ways.</shortdesc>
<taskbody>
-<context> <p>You set ij properties in any of the following ways:</p><ol>
-<li>by using the -D option on the command line</li>
-<li>by specifying a properties file using the <codeph>-p propertyfile</codeph> option
-on the command line</li>
-</ol><p><note type="remember">ij property names are case-sensitive, while
-commands are case-insensitive.</note></p></context>
+<context>
+<ul>
+<li>By using the <codeph>-D</codeph> option on the command line</li>
+<li>By specifying a properties file using the <codeph>-p propertyfile</codeph>
+option on the command line</li>
+</ul>
+<p><note type="remember"><codeph>ij</codeph> property names are case-sensitive,
+while commands are case-insensitive.</note></p></context>
<example><title>Examples</title>
-<p>The following examples illustrate how to use ij properties.</p>
-<p>To start ij by using a properties file called <codeph>ij.properties</codeph>,
-use a command like the following (with the addition of the file paths):
-<codeblock><b><userinput>java -jar derbyrun.jar -p ij.properties</userinput></b></codeblock></p><p>To
-start ij with a maximumDisplayWidth of 1000:
-<codeblock><b><userinput>java -Dij.maximumDisplayWidth=1000 -jar derbyrun.jar</userinput></b></codeblock></p><p>To
-start ij with an <xref href="rtoolsijpropref35032.dita#rtoolsijpropref35032">ij.protocol</xref> of <b>jdbc:derby:</b> and
-an <xref href="rtoolsijpropref28146.dita#rtoolsijpropref28146">ij.database</xref> of <b>sample</b>,
-use the following command:
-<codeblock><b><userinput>java -Dij.protocol=jdbc:derby: -Dij.database=sample derbyrun.jar</userinput></b></codeblock></p><p>To start ij with two named
-connections, using the <xref href="rtoolsijpropref10135.dita#rtoolsijpropref10135">ij.connection.connectionName</xref> property,
-use a command like the following (all on one line):
-<codeblock><b><userinput>java -Dij.connection.sample=jdbc:derby:sample
--Dij.connection.History=jdbc:derby:History
--Dderby.system.home=c:\derby\demo\databases
--jar c:\derby\lib\derbyrun.jar</userinput></b></codeblock>To see a list of connection names and
-the URLs used to connect to them, use the following command. (If there is
-a connection that is currently active, it will show up with an * after its
-name.)
+<p>The following examples illustrate how to use <codeph>ij</codeph>
+properties.</p>
+<p>To start <codeph>ij</codeph> by using a properties file called
+<codeph>ij.properties</codeph>, use a command like the following (with the
+addition of the file paths):</p>
+<codeblock><b><userinput>java -jar derbyrun.jar -p ij.properties</userinput></b></codeblock>
+<p>To start <codeph>ij</codeph> with an
+<codeph><xref href="rtoolsijpropref28788.dita">ij.maximumDisplayWidth</xref></codeph>
+of 1000:</p>
+<codeblock><b><userinput>java -Dij.maximumDisplayWidth=1000 -jar derbyrun.jar</userinput></b></codeblock>
+<p>To start <codeph>ij</codeph> with an
+<codeph><xref href="rtoolsijpropref35032.dita">ij.protocol</xref></codeph> of
+<codeph>jdbc:derby:</codeph> and an
+<codeph><xref href="rtoolsijpropref28146.dita">ij.database</xref></codeph> of
+<codeph>sample</codeph>, use the following command:</p>
+<codeblock><b><userinput>java -Dij.protocol=jdbc:derby: -Dij.database=sample derbyrun.jar</userinput></b></codeblock>
+<p>To start <codeph>ij</codeph> with two named connections, using the
+<codeph><xref href="rtoolsijpropref10135.dita">ij.connection.<i>connectionName</i></xref></codeph>
+property, use a command like the following:</p>
+<codeblock><b>java -Dij.connection.sample=jdbc:derby:sample \
+-Dij.connection.History=jdbc:derby:History \
+-Dderby.system.home=c:\derby\demo\databases \
+-jar c:\derby\lib\derbyrun.jar</b></codeblock>
+<p>To see a list of connection names and the URLs used to connect to them, use
+the following command. (If there is a currently active connection, it will
+appear with an asterisk (<codeph>*</codeph>) after its name.)</p>
<codeblock>ij version <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>
ij(HISTORY)> <b><userinput>show connections;</userinput></b>
HISTORY* - jdbc:derby:History
SAMPLE - jdbc:derby:sample
* = current connection
-ij(HISTORY)></codeblock></p></example>
+ij(HISTORY)></codeblock>
+</example>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/tools/ttoolsij97656.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ttoolsij97656.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ttoolsij97656.dita (original)
+++ db/derby/docs/trunk/src/tools/ttoolsij97656.dita Thu Jun 26 14:43:20 2014
@@ -18,97 +18,126 @@ See the License for the specific languag
limitations under the License.
-->
<task id="ttoolsij97656" xml:lang="en-us">
-<title>Connecting to a Derby database</title>
+<title>Connecting to a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database</title>
+<shortdesc>To connect to a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database, you must
+perform the following steps.</shortdesc>
<taskbody>
-<context> <p>To connect to a <ph conref="../conrefs.dita#prod/productshortname"></ph> database,
-you need to perform the following steps: </p> </context>
<steps>
-<step><cmd>Start the JVM</cmd></step>
+<step><cmd>Start the JVM.</cmd></step>
<step><cmd>Load the appropriate driver.</cmd></step>
-<step><cmd>Create a connection by providing a valid database connection URL.</cmd>
-</step>
+<step><cmd>Create a connection by providing a valid database connection
+URL.</cmd></step>
</steps>
-<example><p>When using ij interactively to connect to a <ph conref="../conrefs.dita#prod/productshortname"></ph> database
-connection information is generally supplied on the full database connection
-URL. ij automatically loads the appropriate driver based on the syntax of
-the URL. The following example shows how to connect in this manner by using
-the <b>Connect</b> command and the embedded driver: <codeblock>D:>java org.apache.derby.tools.ij
+<example><p>When you use <codeph>ij</codeph> interactively to connect to a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database, you generally
+supply connection information on the full database connection URL.
+<codeph>ij</codeph> automatically loads the appropriate driver based on the
+syntax of the URL. The following example shows how to connect in this way by
+using the <codeph><xref href="rtoolsijcomref22318.dita">Connect</xref></codeph>
+command and the embedded driver:</p>
+<codeblock><b>java org.apache.derby.tools.ij</b>
ij version <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>
-ij> connect 'jdbc:derby:sample';
-ij></codeblock>If the URL entered contains Network Client information the <b>Connect</b> command
-loads the Network Client driver:<codeblock>D:>java org.apache.derby.tools.ij
+ij> <b>connect 'jdbc:derby:sample';</b>
+ij></codeblock>
+<p>If the URL entered contains Network Client information, the
+<codeph>Connect</codeph> command loads the Network Client driver:</p>
+<codeblock><b>java org.apache.derby.tools.ij</b>
ij version <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>
-ij> connect 'jdbc:derby://localhost:1527/sample';
-ij></codeblock><note>In these and subsequent examples the databases were
-created in the <term>derby.system.home</term> directory. For more information
-on the System Directory see the <ph conref="../conrefs.dita#pub/citdevelop"></ph>.</note></p><p>ij
-provides alternate methods of specifying part or all of a connection URL:
-the <xref href="rtoolsijpropref35032.dita#rtoolsijpropref35032">ij.protocol</xref>, <xref
-href="rtoolsijpropref28146.dita#rtoolsijpropref28146">ij.database</xref>,
-and <xref href="rtoolsijpropref10135.dita#rtoolsijpropref10135">ij.connection.connectionName</xref>
-properties.
-These properties are often used when a script is being used and the database
+ij> <b>connect 'jdbc:derby://localhost:1527/sample';</b>
+ij></codeblock>
+<p><note>In these and subsequent examples, the databases are created in the
+<i>derby.system.home</i> directory. For more information on the System
+Directory, see the <ph conref="../conrefs.dita#pub/citdevelop"></ph>.</note></p>
+<p><codeph>ij</codeph> provides alternate methods of specifying part or all of a
+connection URL: the
+<codeph><xref href="rtoolsijpropref35032.dita">ij.protocol</xref></codeph>,
+<codeph><xref href="rtoolsijpropref28146.dita">ij.database</xref></codeph>, and
+<codeph><xref href="rtoolsijpropref10135.dita">ij.connection.<i>connectionName</i></xref></codeph>
+properties. These properties are often used when a script is being used and the database
path name or the driver name is not known until runtime. The properties
can also to used to shorten the amount of information that must be provided
with the connection URL. The following are some examples of different ways
-to supply the connection information: </p><ul>
-<li>Supplying full connection information on the command line<p>Specifying
-one of the following properties along with a valid connection URL on the ij
-command line starts ij with the connection already active. This is often used
-when running a SQL script so the database path name can be specified at
-runtime.<ul>
-<li> <xref href="rtoolsijpropref28146.dita#rtoolsijpropref28146">ij.database</xref> -
-opens a connection using the URL provided</li>
-<li><xref href="rtoolsijpropref10135.dita#rtoolsijpropref10135">ij.connection.<i>connectionName</i></xref> -
+to supply the connection information:</p>
+<ul>
+<li>Supplying full connection information on the command line
+<p>Specifying one of the following properties along with a valid connection URL
+on the <codeph>ij</codeph> command line starts <codeph>ij</codeph> with the
+connection already active. This mechanism is often used when running a SQL
+script, so that the database path name can be specified at runtime.</p>
+<ul>
+<li><codeph><xref href="rtoolsijpropref28146.dita">ij.database</xref></codeph>:
+Opens a connection using the URL provided</li>
+<li><codeph><xref href="rtoolsijpropref10135.dita">ij.connection.<i>connectionName</i></xref></codeph>:
Used to open one or more connections. The property can appear multiple times
on the command line with different <i>connectionName</i>s and the same or
different URLs.</li>
-</ul>This example shows how to create the database <i>myTours</i> and run
-the script <i>ToursDB_schema.sql</i> by specifying the database URL using
-the <xref href="rtoolsijpropref28146.dita#rtoolsijpropref28146">ij.database</xref> property.<codeblock>C:\><b>java -Dij.database=jdbc:derby:myTours;create=true
- org.apache.derby.tools.ij
+</ul>
+<p>This example shows how to create the database <codeph>myTours</codeph> and
+run the script <codeph>ToursDB_schema.sql</codeph> by specifying the database
+URL using the
+<codeph><xref href="rtoolsijpropref28146.dita">ij.database</xref></codeph>
+property.</p>
+<codeblock><b>java -Dij.database=jdbc:derby:myTours;create=true \
+ org.apache.derby.tools.ij \
%DERBY_HOME%\demo\programs\toursdb\ToursDB_schema.sql</b>
ij version <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>
CONNECTION0* - jdbc:derby:myTours
* = current connection
ij> -- Licensed to the Apache Software Foundation (ASF) under one or more
-- contributor license agreements. See the NOTICE file distributed with
- <b><i>...output removed...</i></b>
+ <i>...output removed...</i>
ij> CREATE TRIGGER TRIG2 AFTER DELETE ON FLIGHTS FOR EACH STATEMENT MODE DB2SQL
INSERT INTO FLIGHTS_HISTORY (STATUS) VALUES ('INSERTED FROM TRIG2');
0 rows inserted/updated/deleted
-ij></codeblock></p></li>
-<li>Defining a Protocol and using a "short form" URL <p>A default URL protocol
-and subprotocol can be specified by setting the property <xref href="rtoolsijpropref35032.dita#rtoolsijpropref35032">ij.protocol</xref> or
-using the ij <xref href="rtoolsijcomref27997.dita#rtoolsijcomref27997">Protocol</xref> command.
-This allows a connection to be made by specifying only the database name.
-This "short form" of the database connection URL defaults the protocol (For
-more information, see <xref href="ctoolsijtools16011.dita#ctoolsijtools16011/ctoolsabtproto"></xref>).</p><p>This
-example uses the ij <xref href="rtoolsijcomref27997.dita#rtoolsijcomref27997">Protocol</xref> command
-and a "short form" connection URL:</p><codeblock>D:><b>java org.apache.derby.tools.ij</b>
+ij></codeblock></li>
+<li>Defining a Protocol and using a "short form" URL
+<p>You can specify a default URL protocol and subprotocol by setting the
+property
+<codeph><xref href="rtoolsijpropref35032.dita">ij.protocol</xref></codeph> or
+using the <codeph><xref href="rtoolsijcomref27997.dita">Protocol</xref></codeph>
+command. This allows you to make a connection by specifying only the database
+name. This "short form" of the database connection URL defaults the protocol
+(For more information, see
+<xref href="ctoolsijtools16011.dita#ctoolsijtools16011/ctoolsabtproto"></xref>).
+</p>
+<p>This example uses the
+<codeph><xref href="rtoolsijcomref27997.dita">Protocol</xref></codeph> command
+and a "short form" connection URL:</p>
+<codeblock><b>java org.apache.derby.tools.ij</b>
ij version <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>
ij><b> protocol 'jdbc:derby:';</b>
ij> <b>connect 'sample';</b>
ij>
</codeblock></li>
-<li>Specifying an alternate Driver <p>If you are using the drivers supplied
-by <ph conref="../conrefs.dita#prod/productshortname"></ph>, you can specify
-the driver names listed in <xref href="rtoolsijtools16879.dita#rtoolsijtools16879"></xref>.
-However, the <ph conref="../conrefs.dita#prod/productshortname"></ph> drivers
-are implicitly loaded when a supported protocol is used so specifying them
-is probably redundant. Specifying a driver is required when ij is used with
-other JDBC drivers to connect to non-<ph conref="../conrefs.dita#prod/productshortname"></ph> databases.
-To use drivers supplied by other vendors explicitly specify the driver one
-of three ways</p><ul>
-<li>with an ij property <xref href="rtoolsijpropref41073.dita#rtoolsijpropref41073">ij.Driver</xref></li>
-<li>using the JVM system property <codeph>jdbc.drivers</codeph></li>
-<li>using the ij <xref href="rtoolsijcomref39042.dita#rtoolsijcomref39042">Driver</xref> command</li>
-</ul>This example specifies the driver using the ij <xref href="rtoolsijcomref39042.dita#rtoolsijcomref39042">Driver</xref> command<codeblock>D:><b
->java org.apache.derby.tools.ij</b>
+<li>Specifying an alternate driver
+<p>If you are using the drivers supplied by
+<ph conref="../conrefs.dita#prod/productshortname"></ph>, you can specify the
+driver names listed in <xref href="rtoolsijtools16879.dita">JDBC drivers
+overview</xref>. However, the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> drivers are implicitly
+loaded when a supported protocol is used, so specifying them is probably
+redundant. Specifying a driver is required when <codeph>ij</codeph> is used with
+other JDBC drivers to connect to
+non-<ph conref="../conrefs.dita#prod/productshortname"></ph> databases. To use
+drivers supplied by other vendors explicitly, specify the driver in one of three
+ways:</p>
+<ul>
+<li>With the <codeph>ij</codeph> property
+<codeph><xref href="rtoolsijpropref41073.dita">ij.driver</xref></codeph></li>
+<li>Using the JVM system property <codeph>jdbc.drivers</codeph></li>
+<li>Using the <codeph>ij</codeph> command
+<codeph><xref href="rtoolsijcomref39042.dita">Driver</xref></codeph></li>
+</ul>
+<p>This example specifies the driver using the <codeph>ij</codeph> command
+<codeph><xref href="rtoolsijcomref39042.dita">Driver</xref></codeph>:</p>
+<codeblock><b>java org.apache.derby.tools.ij</b>
ij version <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>
ij> <b>driver 'sun.jdbc.odbc.JdbcOdbcDriver';</b>
ij> <b>connect 'jdbc:odbc:myOdbcDataSource';</b>
ij></codeblock></li>
-</ul></example>
+</ul>
+</example>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/tools/ttoolsij98878.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ttoolsij98878.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ttoolsij98878.dita (original)
+++ db/derby/docs/trunk/src/tools/ttoolsij98878.dita Thu Jun 26 14:43:20 2014
@@ -19,35 +19,49 @@ limitations under the License.
-->
<task id="ttoolsij98878" xml:lang="en-us">
<title>Running ij scripts</title>
+<shortdesc>You can run scripts in <codeph>ij</codeph> in any of the following
+ways.</shortdesc>
<taskbody>
-<context> <p>You can run scripts in ij in any of the following ways:</p> </context>
<steps-unordered>
-<step><cmd>Name an input file as a command-line argument. </cmd><stepxmp>For
-example:<codeblock>java org.apache.derby.tools.ij <<i>myscript.sql</i>></codeblock></stepxmp>
+<step><cmd>Name an input file as a command-line argument.</cmd>
+<stepxmp>For example:
+<codeblock><b>java org.apache.derby.tools.ij <i>myscript.sql</i></b></codeblock></stepxmp>
</step>
-<step><cmd>Redirect standard input to come from a file. </cmd><stepxmp>For
-example:<codeblock>java org.apache.derby.tools.ij < <<i>myscript.sql</i>></codeblock></stepxmp>
+<step><cmd>Redirect standard input to come from a file.</cmd>
+<stepxmp>For example:
+<codeblock><b>java org.apache.derby.tools.ij < <i>myscript.sql</i></b></codeblock></stepxmp>
</step>
-<step><cmd>Use the <xref href="rtoolsijcomref28886.dita#rtoolsijcomref28886">Run</xref> command
-from the ij command line. </cmd><stepxmp>For example:<codeblock>ij> run '<i>myscript.sql</i>';</codeblock></stepxmp>
+<step><cmd>Use the
+<codeph><xref href="rtoolsijcomref28886.dita">Run</xref></codeph> command from
+the <codeph>ij</codeph> command line.</cmd>
+<stepxmp>For example:
+<codeblock>ij> <b>run '<i>myscript.sql</i>';</b></codeblock></stepxmp>
</step>
</steps-unordered>
<result><note type="note">If you name an input file as a command-line argument
-or if you use the <xref href="rtoolsijcomref28886.dita#rtoolsijcomref28886">Run</xref> command,
-ij echoes input from a file. If you redirect standard input to come from a
-file, ij does not echo commands.</note></result>
-<example><p>You can save output in any of the following ways: </p><ul>
-<li>By redirecting output to a file:<codeblock>java org.apache.derby.tools.ij <<i>myscript.sql</i>> > <<i>myoutput.txt</i>>
-</codeblock></li>
-<li>By setting the <codeph>ij.outfile</codeph> property:<codeblock>java -Dij.outfile=<<i>myoutput.txt</i>> org.apache.derby.tools.ij
- <myscript.sql></codeblock></li>
+or if you use the
+<codeph><xref href="rtoolsijcomref28886.dita">Run</xref></codeph> command,
+<codeph>ij</codeph> echoes input from a file. If you redirect standard input to
+come from a file, <codeph>ij</codeph> does not echo commands.</note></result>
+<example><p>You can save output in any of the following ways: </p>
+<ul>
+<li>By redirecting output to a file:
+<codeblock><b>java org.apache.derby.tools.ij <i>myscript.sql</i> > <i>myoutput.txt</i></b></codeblock>
+</li>
+<li>By setting the <codeph>ij.outfile</codeph> property:
+<codeblock><b>java -Dij.outfile=<i>myoutput.txt</i> org.apache.derby.tools.ij
+ myscript.sql</b></codeblock></li>
</ul> </example>
-<postreq><p>ij exits when you enter the <xref href="rtoolsijcomref33358.dita#rtoolsijcomref33358">Exit</xref> command
-or, if executing a script, when the end of the command file is reached. When
-you use the <xref href="rtoolsijcomref33358.dita#rtoolsijcomref33358">Exit</xref> command,
-ij automatically shuts down an embedded <ph conref="../conrefs.dita#prod/productshortname"></ph> system
-by issuing a <codeph>connect jdbc:derby:;shutdown=true</codeph> request. It
-does not shut down <ph conref="../conrefs.dita#prod/productshortname"></ph> if
-it is running in a server framework.</p></postreq>
+<postreq>
+<p><codeph>ij</codeph> exits when you enter the
+<codeph><xref href="rtoolsijcomref33358.dita">Exit</xref></codeph> command or, if executing a
+script, when the end of the command file is reached. When you use the
+<codeph>Exit</codeph> command, <codeph>ij</codeph>
+automatically shuts down an embedded
+<ph conref="../conrefs.dita#prod/productshortname"></ph> system by issuing a
+<codeph>connect jdbc:derby:;shutdown=true</codeph> request. It does not shut
+down <ph conref="../conrefs.dita#prod/productshortname"></ph> if it is running
+in a server framework.</p>
+</postreq>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/tools/ttoolsijcreatedatabase.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ttoolsijcreatedatabase.dita?rev=1605801&r1=1605800&r2=1605801&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ttoolsijcreatedatabase.dita (original)
+++ db/derby/docs/trunk/src/tools/ttoolsijcreatedatabase.dita Thu Jun 26 14:43:20 2014
@@ -19,16 +19,21 @@ See the License for the specific languag
limitations under the License.
-->
<task id="ttoolsijcreatedatabase" xml:lang="en-us">
-<title>Creating a database using <codeph>ij</codeph></title>
+<title>Creating a database using ij</title>
+<shortdesc>You can create a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database from within
+the <codeph>ij</codeph> tool.</shortdesc>
<taskbody>
-<context>You can create a <ph conref="../conrefs.dita#prod/productshortname"></ph> from
-within the <codeph>ij</codeph> tool.</context>
<steps>
<step><cmd>To create a database with the <codeph>ij</codeph> tool, type the
-following command:</cmd><stepxmp><codeblock>ij> connect 'jdbc:derby:testdb;create=true';</codeblock></stepxmp>
-<stepresult>This command creates a database called <codeph>testdb</codeph> in
-the current directory, populates the system tables, and connects to the database.
-You can then run any SQL statements from the <codeph>ij</codeph> command line.</stepresult>
+following command:</cmd>
+<stepxmp>
+<codeblock>ij> <b>connect 'jdbc:derby:testdb;create=true';</b></codeblock>
+</stepxmp>
+<stepresult><p>This command creates a database called <codeph>testdb</codeph> in
+the current directory, populates the system tables, and connects to the
+database. You can then run any SQL statements from the <codeph>ij</codeph>
+command line.</p></stepresult>
</step>
</steps>
</taskbody>