Author: chaase3
Date: Mon Jun 23 13:13:40 2014
New Revision: 1604790
URL: http://svn.apache.org/r1604790
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Modified 13 Reference Manual topics.
Patch: DERBY-6379-ref-misc.diff
Modified:
db/derby/docs/trunk/src/ref/rrefapi1003363.dita
db/derby/docs/trunk/src/ref/rrefapi10613.dita
db/derby/docs/trunk/src/ref/rrefapi24806.dita
db/derby/docs/trunk/src/ref/rrefapi33761.dita
db/derby/docs/trunk/src/ref/rrefdbmlimits.dita
db/derby/docs/trunk/src/ref/rrefdttlimits.dita
db/derby/docs/trunk/src/ref/rrefidlengthlimits.dita
db/derby/docs/trunk/src/ref/rreflimits.dita
db/derby/docs/trunk/src/ref/rreflimitsxml.dita
db/derby/docs/trunk/src/ref/rrefnumericlimits.dita
db/derby/docs/trunk/src/ref/rrefproperpasswordthreshold.dita
db/derby/docs/trunk/src/ref/rrefsqlj75638.dita
db/derby/docs/trunk/src/ref/rrefstringlimits.dita
Modified: db/derby/docs/trunk/src/ref/rrefapi1003363.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefapi1003363.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefapi1003363.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefapi1003363.dita Mon Jun 23 13:13:40 2014
@@ -19,6 +19,9 @@ limitations under the License.
-->
<reference id="rrefapi1003363" xml:lang="en-us">
<title>DataSource classes</title>
+<shortdesc>These classes are all related to
+<ph conref="../conrefs.dita#prod/productshortname"></ph>'s implementation of
+<i>javax.sql.DataSource</i> and related APIs.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource</indexterm>
@@ -36,14 +39,11 @@ limitations under the License.
</keywords>
</metadata></prolog>
<refbody>
-<section><p>These classes are all related to
-<ph conref="../conrefs.dita#prod/productshortname"></ph>'s implementation of
-<i>javax.sql.DataSource</i> and related APIs. For more information, see
-<xref href="crefjdbc12657.dita#crefjdbc12657"></xref>,
-<xref href="rrefjdbc4_2compactprofiles.dita#rrefjdbc4_2compactprofiles"></xref>,
-"Classes that pertain to resource managers" in the
-<ph conref="../conrefs.dita#pub/citdevelop"></ph>, and "Accessing the Network
-Server by using a DataSource object" in the
+<section><p>For more information, see
+<xref href="crefjdbc12657.dita">JDBC reference</xref>,
+<xref href="rrefjdbc4_2compactprofiles.dita"/>, "Classes that pertain to
+resource managers" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>, and
+"Accessing the Network Server by using a DataSource object" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
<p>Embedded environment, for applications using Java SE 8 Compact Profile 2:</p>
<ul>
Modified: db/derby/docs/trunk/src/ref/rrefapi10613.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefapi10613.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefapi10613.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefapi10613.dita Mon Jun 23 13:13:40 2014
@@ -20,17 +20,22 @@ limitations under the License.
<reference id="rrefapi10613" xml:lang="en-us">
<title>Derby API</title>
<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
-Javadoc HTML files of API classes and interfaces in the <i>javadoc</i> subdirectory.</shortdesc>
+documentation of API classes and interfaces in the <i>javadoc</i>
+subdirectory.</shortdesc>
<refbody>
-<section><p>This appendix provides a brief overview of the API. <ph conref="../conrefs.dita#prod/productshortname"></ph> does
-not provide the Javadoc for the <i>java.sql</i> packages, the main API for
-working with <ph conref="../conrefs.dita#prod/productshortname"></ph>, because
-it is included in the JDBC API. For information about <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
-implementation of JDBC, see <xref href="crefjdbc12657.dita#crefjdbc12657"></xref>.</p></section>
-<section><p>This document divides the API classes and interfaces into several
-categories. The stand-alone tools and utilities are java classes that stand
-on their own and are invoked in a command window. The JDBC implementation
-classes are standard JDBC APIs, and are not invoked on the command-line. Instead,
-you invoke these only within a specified context within another application.</p></section>
+<section><p>This section provides a brief overview of the API.
+<ph conref="../conrefs.dita#prod/productshortname"></ph> does not provide the
+API documentation for the <i>java.sql</i> packages, the main API for working
+with <ph conref="../conrefs.dita#prod/productshortname"></ph>, because it is
+included in the JDBC API. For information about
+<ph conref="../conrefs.dita#prod/productshortname"></ph>'s implementation of the
+JDBC API, see <xref href="crefjdbc12657.dita">JDBC reference</xref>.</p>
+</section>
+<section><p>This section divides the API classes and interfaces into several
+categories. The stand-alone tools and utilities are Java classes that stand on
+their own and are invoked on the command line. The JDBC implementation classes
+are standard JDBC APIs and are not invoked on the command line. Instead, you
+invoke these only within a specified context within another application.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefapi24806.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefapi24806.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefapi24806.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefapi24806.dita Mon Jun 23 13:13:40 2014
@@ -20,19 +20,38 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefapi24806" xml:lang="en-us">
<title>Stand-alone tools and utilities</title>
+<shortdesc>These classes are in the package
+<i>org.apache.derby.tools</i>.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>org.apache.derby.tools.ij</indexterm>
+<indexterm>org.apache.derby.tools.sysinfo</indexterm>
+<indexterm>org.apache.derby.tools.dblook</indexterm>
+</keywords>
+</metadata></prolog>
<refbody>
-<section><p>These classes are in the packages <i>org.apache.derby.tools</i>.
- <ul>
-<li><i>org.apache.derby.tools.ij</i> <p>An SQL scripting tool that can run
-as an embedded or a remote client/server application. See the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite>.</p></li>
-<li><i>org.apache.derby.tools.sysinfo<ph><indexterm>org.apache.derby.tools.sysinfo</indexterm></ph></i>
- <p>A command-line, server-side utility that displays information about your
-JVM and <ph conref="../conrefs.dita#prod/productshortname"></ph> product.
-See the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite>.</p></li>
-<li><i>org.apache.derby.tools.dblook</i> <p>A utility to view all or parts
-of the Data Definition Language (DDL) for a given database. See the <cite><ph
-conref="../conrefs.dita#pub/citutilities"></ph></cite>.</p></li>
-</ul></p></section>
+<section>
+<p>For information about these classes, see the
+<ph conref="../conrefs.dita#pub/citutilities"></ph>.</p>
+<ul>
+<li><i>org.apache.derby.tools.ij</i>
+<p>An SQL scripting tool that can run as an embedded or a remote client/server
+application.</p></li>
+<li><i>org.apache.derby.tools.sysinfo</i>
+<p>A command-line, server-side utility that displays information about your Java
+Virtual Machine (JVM) and
+<ph conref="../conrefs.dita#prod/productshortname"></ph> product.</p></li>
+<li><i>org.apache.derby.tools.dblook</i>
+<p>A utility to view all or parts of the Data Definition Language (DDL) for a
+given database.</p></li>
+<li><i>org.apache.derby.tools.SignatureChecker</i>
+<p>A utility that identifies any SQL functions and procedures in a database that
+do not follow the SQL Standard argument matching rules described in
+<xref href="rrefsqljargmatching.dita"/>.</p></li>
+</ul>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> also supports some
+optional tools that are described in the "Optional tools" section of the
+<ph conref="../conrefs.dita#pub/citutilities"></ph>.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefapi33761.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefapi33761.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefapi33761.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefapi33761.dita Mon Jun 23 13:13:40 2014
@@ -18,19 +18,26 @@ See the License for the specific languag
limitations under the License.
-->
<reference id="rrefapi33761" xml:lang="en-us">
-<title>JDBC driver</title>
+<title>JDBC drivers</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> has two JDBC
+drivers.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>org.apache.derby.jdbc. EmbeddedDriver</indexterm><indexterm>org.apache.derby.jdbc.
-ClientDriver</indexterm></keywords>
+<keywords><indexterm>org.apache.derby.jdbc.EmbeddedDriver</indexterm>
+<indexterm>org.apache.derby.jdbc.ClientDriver</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>This is the JDBC driver for <ph conref="../conrefs.dita#prod/productshortname"></ph>:
- <ul>
-<li><i>org.apache.derby.jdbc.EmbeddedDriver<ph></ph></i> <p>Used to boot
-the embedded built-in JDBC driver and the <ph conref="../conrefs.dita#prod/productshortname"></ph> system.</p></li>
-<li><i>org.apache.derby.jdbc.ClientDriver<ph></ph></i><p>Used to connect to
-the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server
-in client-server mode.</p></li>
-</ul>See the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>. </p></section>
+<section>
+<ul>
+<li><i>org.apache.derby.jdbc.EmbeddedDriver<ph></ph></i>
+<p>Used to boot the embedded built-in JDBC driver and the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> system. See the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph> for more information.</p></li>
+<li><i>org.apache.derby.jdbc.ClientDriver<ph></ph></i>
+<p>Used to connect to the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server in
+client-server mode. See the <ph conref="../conrefs.dita#pub/citadmin"></ph> for
+more information.</p></li>
+</ul>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefdbmlimits.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefdbmlimits.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdbmlimits.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefdbmlimits.dita Mon Jun 23 13:13:40 2014
@@ -20,14 +20,15 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefdbmlimits" xml:lang="en-us">
<title>Limitations for database values</title>
+<shortdesc>The following table lists limitations on various database values in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>limitations<indexterm>database values</indexterm></indexterm>
<indexterm>database<indexterm>limitations</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The following table lists limitations on various database
-values in <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<section>
<table frame="all">
<title>Database limitations</title>
<desc>This table lists the limitations on <ph conref="../conrefs.dita#prod/productshortname"></ph> database values.</desc>
Modified: db/derby/docs/trunk/src/ref/rrefdttlimits.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefdttlimits.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdttlimits.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefdttlimits.dita Mon Jun 23 13:13:40 2014
@@ -20,6 +20,8 @@ limitations under the License.
-->
<reference id="rrefdttlimits" xml:lang="en-us">
<title>DATE, TIME, and TIMESTAMP limitations</title>
+<shortdesc>The following table lists limitations on date, time, and timestamp
+values in <ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>limitations<indexterm>DATE, TIME, and TIMESTAMP values</indexterm></indexterm>
<indexterm>DATE values<indexterm>limitations</indexterm></indexterm>
@@ -28,8 +30,7 @@ limitations under the License.
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The following table lists limitations on date, time, and timestamp
-values in <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<section>
<table frame="all">
<title>DATE, TIME, and TIMESTAMP limitations</title>
<desc>This table lists the limitations on <ph conref="../conrefs.dita#prod/productshortname"></ph> date, time, and timestamp values.</desc>
Modified: db/derby/docs/trunk/src/ref/rrefidlengthlimits.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefidlengthlimits.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefidlengthlimits.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefidlengthlimits.dita Mon Jun 23 13:13:40 2014
@@ -19,14 +19,15 @@ limitations under the License.
-->
<reference id="rrefidlengthlimits" xml:lang="en-us">
<title>Limitations on identifier length </title>
+<shortdesc>The following table lists limitations on identifier lengths in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>limitations<indexterm>identifier lengths</indexterm></indexterm>
<indexterm>identifiers<indexterm>length limitations</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The following table lists limitations on identifier lengths in
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<section>
<table frame="all">
<title>Identifier length limitations</title>
<desc>This table lists the limitations on <ph conref="../conrefs.dita#prod/productshortname"></ph> identifier lengths.</desc>
Modified: db/derby/docs/trunk/src/ref/rreflimits.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreflimits.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rreflimits.dita (original)
+++ db/derby/docs/trunk/src/ref/rreflimits.dita Mon Jun 23 13:13:40 2014
@@ -20,9 +20,9 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rreflimits" xml:lang="en-us">
<title>Derby limitations</title>
+<shortdesc>This section lists the limitations associated with
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<refbody>
-<section><p>The section lists the limitations associated with <ph
-conref="../conrefs.dita#prod/productshortname"></ph>.</p></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rreflimitsxml.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreflimitsxml.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rreflimitsxml.dita (original)
+++ db/derby/docs/trunk/src/ref/rreflimitsxml.dita Mon Jun 23 13:13:40 2014
@@ -20,14 +20,15 @@ limitations under the License.
-->
<reference id="rreflimitsxml" xml:lang="en-us">
<title>XML limitations</title>
+<shortdesc>The following table lists limitations on XML data types in <ph
+conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>limitations<indexterm>XML data type</indexterm></indexterm>
<indexterm>XML data type<indexterm>limitations</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The following table lists limitations on XML data types in <ph
-conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<section>
<table frame="all">
<title>XML limitations</title>
<desc>This table lists the limitations on <ph conref="../conrefs.dita#prod/productshortname"></ph> XML data types.</desc>
Modified: db/derby/docs/trunk/src/ref/rrefnumericlimits.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefnumericlimits.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefnumericlimits.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefnumericlimits.dita Mon Jun 23 13:13:40 2014
@@ -20,14 +20,15 @@ limitations under the License.
-->
<reference id="rrefnumericlimits" xml:lang="en-us">
<title>Numeric limitations</title>
+<shortdesc>The following table lists limitations on the numeric values in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>limitations<indexterm>numeric values</indexterm></indexterm>
<indexterm>data types<indexterm>numeric limitations</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The following lists limitations on the numeric values in
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<section>
<table frame="all">
<title>Numeric limitations</title>
<desc>This table lists the limitations on <ph conref="../conrefs.dita#prod/productshortname"></ph> numeric values.</desc>
Modified: db/derby/docs/trunk/src/ref/rrefproperpasswordthreshold.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperpasswordthreshold.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperpasswordthreshold.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproperpasswordthreshold.dita Mon Jun 23 13:13:40 2014
@@ -37,8 +37,7 @@ warning when the remaining lifetime of a
<codeph>(derby.authentication.native.passwordLifetimeThreshold *
derby.authentication.native.passwordLifetimeMillis)</codeph>.</p>
<p>To set the lifetime of the password, use the
-<i><xref href="rrefproperpasswordmillis.dita#rrefproperpasswordmillis">derby.authentication.native.passwordLifetimeMillis</xref></i>
-property.</p>
+<i><xref href="rrefproperpasswordmillis.dita"/></i> property.</p>
</section>
<refsyn><title>Syntax</title>
<codeblock><b>derby.authentication.native.passwordLifetimeThreshold=<i>proportion</i></b></codeblock>
Modified: db/derby/docs/trunk/src/ref/rrefsqlj75638.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsqlj75638.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsqlj75638.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsqlj75638.dita Mon Jun 23 13:13:40 2014
@@ -19,17 +19,17 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<reference id="rrefsqlj75638" xml:lang="en-us">
-<title>Supported locales </title>
+<title>Supported locales</title>
+<shortdesc>The following table lists the locales supported by
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Locales<indexterm>supported</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The following table lists the locales supported by
-<ph conref="../conrefs.dita#prod/productshortname"></ph>. Use the
-<i><xref href="rrefattrib56769.dita#rrefattrib56769">territory=ll_CC</xref></i>
-URL attribute to set the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> locale.</p>
+<section><p>Use the
+<i><xref href="rrefattrib56769.dita">territory=ll_CC</xref></i> URL attribute to
+set the <ph conref="../conrefs.dita#prod/productshortname"></ph> locale.</p>
<table>
<title>Supported locales</title>
<desc>This table lists the locales supported by <ph conref="../conrefs.dita#prod/productshortname"></ph>.</desc>
@@ -39,8 +39,7 @@ URL attribute to set the
<thead>
<row valign="bottom">
<entry colname="col1">Locale</entry>
-<entry colname="col2"><ph conref="../conrefs.dita#prod/productshortname"></ph>
-<i>territory=ll_CC</i> Setting</entry>
+<entry colname="col2"><i>territory=ll_CC</i> Setting</entry>
</row>
</thead>
<tbody>
Modified: db/derby/docs/trunk/src/ref/rrefstringlimits.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefstringlimits.dita?rev=1604790&r1=1604789&r2=1604790&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefstringlimits.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefstringlimits.dita Mon Jun 23 13:13:40 2014
@@ -20,14 +20,15 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefstringlimits" xml:lang="en-us">
<title>String limitations</title>
+<shortdesc>The following table lists limitations on string values in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>limitations<indexterm>string values</indexterm></indexterm>
<indexterm>string values<indexterm>limitations</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The following table lists limitations on string values in
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<section>
<table frame="all">
<title>String limitations</title>
<desc>This table lists the limitations on <ph conref="../conrefs.dita#prod/productshortname"></ph> string values.</desc>