svn commit: r1528473 - in /db/derby/docs/trunk/src: getstart/rgsdocs10012.dita ref/crefmprefsyntax.dita ref/refderby.ditamap

[ch...@apache.org]

Author: chaase3
Date: Wed Oct  2 13:52:46 2013
New Revision: 1528473

URL: http://svn.apache.org/r1528473
Log:
DERBY-6353  Update syntax description in Getting Started, use in Reference 
Manual too

Modify topic in Getting Started, add modified version to Reference Manual

Patch: DERBY-6353-2.diff

Added:
    db/derby/docs/trunk/src/ref/crefmprefsyntax.dita   (with props)
Modified:
    db/derby/docs/trunk/src/getstart/rgsdocs10012.dita
    db/derby/docs/trunk/src/ref/refderby.ditamap

Modified: db/derby/docs/trunk/src/getstart/rgsdocs10012.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgsdocs10012.dita?rev=1528473&r1=1528472&r2=1528473&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgsdocs10012.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgsdocs10012.dita Wed Oct  2 13:52:46 2013
@@ -50,8 +50,8 @@ special meaning in some SQL statements.<
 </row>
 <row>
 <entry colname="1"><codeph>{ }</codeph></entry>
-<entry colname="2">Groups items so that they can be marked with one of the
-symbols <codeph>[&nbsp;]</codeph>, <codeph>|</codeph>, or <codeph>*</codeph>.</entry>
+<entry colname="2">Groups required items so that they can be marked with the
+symbol <codeph>|</codeph>.</entry>
 </row>
 <row>
 <entry colname="1"><codeph>( )  . , </codeph></entry>
@@ -61,8 +61,8 @@ symbols <codeph>[&nbsp;]</codeph>, <code
 </tgroup>
 </table></section>
 <section><p>The following example shows how SQL syntax is presented:
-<codeblock><b>CREATE [ UNIQUE ] INDEX <b><i>IndexName</i></b>
-  ON <b><i>TableName</i></b> ( <b><i>SimpleColumnName</i></b> [ , <b><i>SimpleColumnName</i></b> ] * ) </b></codeblock></p></section>
+<codeblock><b>CREATE [ UNIQUE ] INDEX <b><i>indexName</i></b>
+  ON <b><i>tableName</i></b> ( <b><i>simpleColumnName</i></b> [ , <b><i>simpleColumnName</i></b> ]* ) </b></codeblock></p></section>
 <section><p>Command-line syntax for running Java programs and utilities (as
 well as examples) always begins with the command <i>java</i>: <codeblock>java org.apache.derby.tools.ij</codeblock></p></section>
 <section><p>This documentation attempts to be JVM neutral, but any command line examples or syntax using JVM specific references should be verified with your JVM documentation.</p></section>

Added: db/derby/docs/trunk/src/ref/crefmprefsyntax.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefmprefsyntax.dita?rev=1528473&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/crefmprefsyntax.dita (added)
+++ db/derby/docs/trunk/src/ref/crefmprefsyntax.dita Wed Oct  2 13:52:46 2013
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
+<concept id="crefmprefsyntax" xml:lang="en-us">
+<title>SQL syntax used in this manual</title>
+<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>
+<desc>This table lists the BNF meta-symbols used in SQL syntax examples and describes their meanings.</desc>
+<tgroup cols="2" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="30*"/>
+<colspec colname="2" colnum="2" colwidth="70*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Symbol</entry>
+<entry colname="2">Meaning</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1"><codeph>|</codeph></entry>
+<entry colname="2">Or. Choose one of the items.</entry>
+</row>
+<row>
+<entry colname="1"><codeph>[ ]</codeph></entry>
+<entry colname="2">Encloses optional items.</entry>
+</row>
+<row>
+<entry colname="1"><codeph>*</codeph></entry>
+<entry colname="2">Flags items that you can repeat 0 or more times. Has a
+special meaning in some SQL statements.</entry>
+</row>
+<row>
+<entry colname="1"><codeph>{ }</codeph></entry>
+<entry colname="2">Groups required items so that they can be marked with the
+symbol <codeph>|</codeph>. Has a special meaning in JDBC escape syntax (see
+<xref href="rrefjdbc1020262.dita#rrefjdbc1020262"></xref>).</entry>
+</row>
+<row>
+<entry colname="1"><codeph>( )  . , </codeph></entry>
+<entry colname="2">Other punctuation that is part of the syntax.</entry>
+</row>
+</tbody>
+</tgroup>
+</table></section>
+<section><p>The following example shows how SQL syntax is presented:
+<codeblock><b>CREATE [ UNIQUE ] INDEX <b><i>indexName</i></b>
+  ON <b><i>tableName</i></b> ( <b><i>simpleColumnName</i></b> [ , <b><i>simpleColumnName</i></b> ]* ) </b></codeblock>
+</p></section>
+</conbody>
+</concept>

Propchange: db/derby/docs/trunk/src/ref/crefmprefsyntax.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=1528473&r1=1528472&r2=1528473&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Wed Oct  2 13:52:46 2013
@@ -576,8 +576,8 @@ limitations under the License.
 <topicref href="crefmpref11181.dita" navtitle="Purpose of this document">
 </topicref>
 <topicref href="crefmpref23223.dita" navtitle="Audience"></topicref>
-<topicref href="crefmpref23947.dita" navtitle="How this guide is organized">
-</topicref>
+<topicref href="crefmpref23947.dita" navtitle="How this guide is organized"></topicref>
+<topicref href="crefmprefsyntax.dita" navtitle="SQL syntax used in this manual"></topicref>
 </topicref>
 <topicref collection-type="family" href="crefsqlj23296.dita" navtitle="SQL language reference">
 <topicref href="rrefsqlj28468.dita" navtitle="Capitalization and special characters">