db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r1605809 - in /db/derby/docs/trunk/src/ref: crefmpref11181.dita crefmpref23223.dita crefmpref23947.dita crefmprefsyntax.dita
Date Thu, 26 Jun 2014 15:01:57 GMT
Author: chaase3
Date: Thu Jun 26 15:01:57 2014
New Revision: 1605809

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

Modified 4 Reference Manual topics.

Patch: DERBY-6379-ref-pref.diff

Modified:
    db/derby/docs/trunk/src/ref/crefmpref11181.dita
    db/derby/docs/trunk/src/ref/crefmpref23223.dita
    db/derby/docs/trunk/src/ref/crefmpref23947.dita
    db/derby/docs/trunk/src/ref/crefmprefsyntax.dita

Modified: db/derby/docs/trunk/src/ref/crefmpref11181.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefmpref11181.dita?rev=1605809&r1=1605808&r2=1605809&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefmpref11181.dita (original)
+++ db/derby/docs/trunk/src/ref/crefmpref11181.dita Thu Jun 26 15:01:57 2014
@@ -20,13 +20,15 @@ limitations under the License.
  "../dtd/concept.dtd">
 <concept id="crefmpref11181" xml:lang="en-us">
 <title>Purpose of this document</title>
+<shortdesc>This document, the <ph conref="../conrefs.dita#pub/citref"></ph>,
+provides reference information about
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
 <conbody>
-<p>This book, the <cite><ph conref="../conrefs.dita#pub/citref"></ph></cite>,
-provides reference information about <ph conref="../conrefs.dita#prod/productshortname"></ph>.
-It covers <ph conref="../conrefs.dita#prod/productshortname"></ph>'s SQL language,
-the <ph conref="../conrefs.dita#prod/productshortname"></ph> implementation
-of JDBC, <ph conref="../conrefs.dita#prod/productshortname"></ph> system catalogs,
<ph
-conref="../conrefs.dita#prod/productshortname"></ph> error messages, <ph conref="../conrefs.dita#prod/productshortname"></ph>
properties,
+<p>It covers <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
SQL
+language, the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+implementation of JDBC, <ph conref="../conrefs.dita#prod/productshortname"></ph>
+system catalogs, <ph conref="../conrefs.dita#prod/productshortname"></ph> error
+messages, <ph conref="../conrefs.dita#prod/productshortname"></ph> properties,
 and SQL keywords.</p>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/ref/crefmpref23223.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefmpref23223.dita?rev=1605809&r1=1605808&r2=1605809&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefmpref23223.dita (original)
+++ db/derby/docs/trunk/src/ref/crefmpref23223.dita Thu Jun 26 15:01:57 2014
@@ -20,15 +20,18 @@ limitations under the License.
  "../dtd/concept.dtd">
 <concept id="crefmpref23223" xml:lang="en-us">
 <title>Audience</title>
+<shortdesc>This document is a reference for
+<ph conref="../conrefs.dita#prod/productshortname"></ph> users, typically
+application developers. </shortdesc>
 <conbody>
-<p>This book is a reference for <ph conref="../conrefs.dita#prod/productshortname"></ph>
users,
-typically application developers. <ph conref="../conrefs.dita#prod/productshortname"></ph>
users
-who are not familiar with the SQL standard or the Java programming language
-will benefit from consulting books on those topics. </p>
-<p><ph conref="../conrefs.dita#prod/productshortname"></ph> users who want
-a how-to approach to working with <ph conref="../conrefs.dita#prod/productshortname"></ph>
or
-an introduction to <ph conref="../conrefs.dita#prod/productshortname"></ph> concepts
-should read the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.</p>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> users who are
not
+familiar with the SQL standard or the Java programming language will benefit
+from consulting documentation on those topics.</p>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> users who want
a
+how-to approach to working with
+<ph conref="../conrefs.dita#prod/productshortname"></ph> or an introduction to
+<ph conref="../conrefs.dita#prod/productshortname"></ph> concepts should read
+the <ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
 </conbody>
 </concept>
 

Modified: db/derby/docs/trunk/src/ref/crefmpref23947.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefmpref23947.dita?rev=1605809&r1=1605808&r2=1605809&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefmpref23947.dita (original)
+++ db/derby/docs/trunk/src/ref/crefmpref23947.dita Thu Jun 26 15:01:57 2014
@@ -20,46 +20,56 @@ limitations under the License.
  "../dtd/concept.dtd">
 <concept id="crefmpref23947" xml:lang="en-us">
 <title>How this guide is organized</title>
+<shortdesc>This guide includes the following sections.</shortdesc>
 <conbody>
-<p>This guide includes the following sections:   <ul>
-<li><i><xref href="crefsqlj23296.dita#crefsqlj23296"></xref></i>
  <p>Reference information
-about <ph conref="../conrefs.dita#prod/productshortname"></ph>'s SQL language,
+<ul>
+<li><i><xref href="crefsqlj23296.dita"></xref></i>
+<p>Reference information about
+<ph conref="../conrefs.dita#prod/productshortname"></ph>'s SQL language,
 including manual pages for statements, functions, and other syntax elements.</p></li>
 <li><i><xref href="rrefsqljargmatching.dita#rrefsqljargmatching"></xref></i>

 <p>Information about argument matching in Java functions and
 procedures.</p></li>
-<li><i><xref href="rrefkeywords29722.dita#rrefkeywords29722"></xref></i>

- <p>SQL keywords beyond the standard SQL-92 keywords.</p></li>
-<li><i><xref href="rrefsqlstandard.dita"/></i>   <p>Lists of
SQL:2011 features
-that <ph conref="../conrefs.dita#prod/productshortname"></ph> does and does not
+<li><i><xref href="rrefkeywords29722.dita"></xref></i> 
+<p>SQL keywords beyond the standard SQL-92 keywords.</p></li>
+<li><i><xref href="rrefsqlstandard.dita"/></i>
+<p>Lists of SQL:2011 features that
+<ph conref="../conrefs.dita#prod/productshortname"></ph> does and does not
 support.</p></li>
-<li><i><xref href="rrefsistabs38369.dita#rrefsistabs38369"></xref></i>
  <p>Reference
-information about the <ph conref="../conrefs.dita#prod/productshortname"></ph>
system
+<li><i><xref href="rrefsistabs38369.dita"></xref></i>
+<p>Reference information about the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> system
 catalogs.</p></li>
-<li><i><xref href="rref_xplain_tables.dita#rref_xplain_tables"></xref></i>
+<li><i><xref href="rref_xplain_tables.dita"></xref></i>
 <p>Information about the optional XPLAIN style system tables.</p></li>
-<li><i><xref href="rrefexcept16677.dita#rrefexcept16677"></xref></i>
  <p>Information
-about <ph conref="../conrefs.dita#prod/productshortname"></ph> exception messages.</p></li>
-<li><i><xref href="crefjdbc12657.dita#crefjdbc12657"></xref></i>
  <p>Information
-about <ph conref="../conrefs.dita#prod/productshortname"></ph>'s implementation
-of the Java Database Connectivity (JDBC) API.</p></li>
-<li><i><xref href="rrefattrib24612.dita#rrefattrib24612"></xref></i>
  <p>Information
-about the supported attributes to <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
-JDBC database connection URL.</p></li>
-<li><i><xref href="rrefproper32213.dita#rrefproper32213"></xref></i>
+<li><i><xref href="rrefexcept16677.dita"></xref></i>
+<p>Information about
+<ph conref="../conrefs.dita#prod/productshortname"></ph> exception
+messages.</p></li>
+<li><i><xref href="crefjdbc12657.dita"></xref></i>
+<p>Information about <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
+implementation of the Java Database Connectivity (JDBC) API.</p></li>
+<li><i><xref href="rrefattrib24612.dita"></xref></i>
+<p>Information about the supported attributes to
+<ph conref="../conrefs.dita#prod/productshortname"></ph>'s JDBC database
+connection URL.</p></li>
+<li><i><xref href="rrefproper32213.dita"></xref></i>
 <p>Information about <ph conref="../conrefs.dita#prod/productshortname"></ph>
 properties.</p></li>
-<li><i><xref href="rrefjta16677.dita#rrefjta16677"></xref></i>
  <p>Information
-about <ph conref="../conrefs.dita#prod/productshortname"></ph>'s support for
the
-Java EE platform, in particular support for the Java Transaction API and the
-JDBC API.</p></li>
-<li><i><xref href="rrefapi10613.dita#rrefapi10613"></xref></i>
  <p>Notes
-about proprietary APIs for <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></li>
-<li><i><xref href="rrefsqlj75638.dita#rrefsqlj75638"></xref></i>
 <p>Locales
-supported by <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></li>
-<li><i><xref href="rreflimits.dita#rreflimits"></xref></i>
 <p>Limitations
-of <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></li>
-</ul></p>
+<li><i><xref href="rrefjta16677.dita"></xref></i>
+<p>Information about <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
+support for the Java EE platform, in particular support for the Java Transaction
+API and the JDBC API.</p></li>
+<li><i><xref href="rrefapi10613.dita"></xref></i>
+<p>Notes about proprietary APIs for
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></li>
+<li><i><xref href="rrefsqlj75638.dita"></xref></i>
+<p>Locales supported by
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></li>
+<li><i><xref href="rreflimits.dita"></xref></i>
+<p>Limitations of
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></li>
+</ul>
 </conbody>
 </concept>
 

Modified: db/derby/docs/trunk/src/ref/crefmprefsyntax.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefmprefsyntax.dita?rev=1605809&r1=1605808&r2=1605809&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefmprefsyntax.dita (original)
+++ db/derby/docs/trunk/src/ref/crefmprefsyntax.dita Thu Jun 26 15:01:57 2014
@@ -20,8 +20,8 @@ limitations under the License.
  "../dtd/concept.dtd">
 <concept id="crefmprefsyntax" xml:lang="en-us">
 <title>SQL syntax used in this manual</title>
+<shortdesc>SQL syntax is presented in modified BNF notation.</shortdesc>
 <conbody>
-<p>SQL syntax is presented in modified BNF notation.</p>
 <section><p>The meta-symbols of BNF are listed in the following table.</p>
 <table frame="all">
 <title>BNF meta-symbols</title>



Mime
View raw message