X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref-syntax.xml;h=787b4a3b08b28d1c09672447ad171a28e7286984;hb=0817beb5857835cfe68867e7026161f356869bdf;hp=e0e091eb77f741fe2a0a278907a07f3a12b499bc;hpb=528064c179b6b74f0a9d6a43c42e71de3f0e9a3a;p=clsql.git

diff --git a/doc/ref-syntax.xml b/doc/ref-syntax.xml
index e0e091e..787b4a3 100644
--- a/doc/ref-syntax.xml
+++ b/doc/ref-syntax.xml
@@ -23,7 +23,7 @@
       <refentrytitle>ENABLE-SQL-READER-SYNTAX</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Macro</emphasis> <emphasis role="bold">ENABLE-SQL-READER-SYNTAX</emphasis></refname>
+      <refname>ENABLE-SQL-READER-SYNTAX</refname>
       <refpurpose>Globally enable square bracket reader syntax.</refpurpose>
       <refclass>Macro</refclass>
     </refnamediv>
@@ -84,6 +84,11 @@
       <para>
         The symbolic SQL syntax is disabled by default. 
       </para>
+      <para> 
+        &clsql; differs from &commonsql; in that
+        <function>enable-sql-reader-syntax</function> is defined as a
+        macro rather than a function.
+      </para>
     </refsect1>
   </refentry>
 
@@ -92,7 +97,7 @@
       <refentrytitle>DISABLE-SQL-READER-SYNTAX</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Macro</emphasis> <emphasis role="bold">DISABLE-SQL-READER-SYNTAX</emphasis></refname>
+      <refname>DISABLE-SQL-READER-SYNTAX</refname>
       <refpurpose>Globally disable square bracket reader syntax.</refpurpose>
       <refclass>Macro</refclass>
     </refnamediv>
@@ -153,6 +158,11 @@
       <para>
         The symbolic SQL syntax is disabled by default. 
       </para>
+      <para> 
+        &clsql; differs from &commonsql; in that
+        <function>disable-sql-reader-syntax</function> is defined as a
+        macro rather than a function.
+      </para>
     </refsect1>
   </refentry>
 
@@ -161,7 +171,7 @@
       <refentrytitle>LOCALLY-ENABLE-SQL-READER-SYNTAX</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Macro</emphasis> <emphasis role="bold">LOCALLY-ENABLE-SQL-READER-SYNTAX</emphasis></refname>
+      <refname>LOCALLY-ENABLE-SQL-READER-SYNTAX</refname>
       <refpurpose>Globally enable square bracket reader syntax.</refpurpose>
       <refclass>Macro</refclass>
     </refnamediv>
@@ -225,6 +235,11 @@
       <para>
         The symbolic SQL syntax is disabled by default. 
       </para>
+      <para> 
+        &clsql; differs from &commonsql; in that
+        <function>locally-enable-sql-reader-syntax</function> is
+        defined as a macro rather than a function.
+      </para>
     </refsect1>
   </refentry>
 
@@ -234,7 +249,7 @@
       <refentrytitle>LOCALLY-DISABLE-SQL-READER-SYNTAX</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Macro</emphasis> <emphasis role="bold">LOCALLY-DISABLE-SQL-READER-SYNTAX</emphasis></refname>
+      <refname>LOCALLY-DISABLE-SQL-READER-SYNTAX</refname>
       <refpurpose>Locally disable square bracket reader syntax.</refpurpose>
       <refclass>Macro</refclass>
     </refnamediv>
@@ -302,6 +317,11 @@
       <para>
         The symbolic SQL syntax is disabled by default. 
       </para>
+      <para> 
+        &clsql; differs from &commonsql; in that
+        <function>locally-disable-sql-reader-syntax</function> is
+        defined as a macro rather than a function.
+      </para>
     </refsect1>
   </refentry>
 
@@ -310,7 +330,7 @@
       <refentrytitle>RESTORE-SQL-READER-SYNTAX-STATE</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Macro</emphasis> <emphasis role="bold">RESTORE-SQL-READER-SYNTAX-STATE</emphasis></refname>
+      <refname>RESTORE-SQL-READER-SYNTAX-STATE</refname>
       <refpurpose>
         Restore square bracket reader syntax to its previous state.
       </refpurpose>
@@ -381,6 +401,11 @@
       <para>
         The symbolic SQL syntax is disabled by default. 
       </para>
+      <para> 
+        &clsql; differs from &commonsql; in that
+        <function>restore-sql-reader-syntax-state</function> is
+        defined as a macro rather than a function.
+      </para>
     </refsect1>
   </refentry>
 
@@ -389,7 +414,7 @@
       <refentrytitle>SQL</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL</emphasis></refname>
+      <refname>SQL</refname>
       <refpurpose>Construct an SQL string from supplied expressions.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
@@ -488,7 +513,7 @@
       <refentrytitle>SQL-EXPRESSION</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL-EXPRESSION</emphasis></refname>
+      <refname>SQL-EXPRESSION</refname>
       <refpurpose>Constructs an SQL expression from supplied keyword arguments.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
@@ -646,7 +671,7 @@
       <refentrytitle>SQL-OPERATION</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL-OPERATION</emphasis></refname>
+      <refname>SQL-OPERATION</refname>
       <refpurpose>Constructs an SQL expression from a supplied operator and arguments.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
@@ -750,7 +775,7 @@
       <refentrytitle>SQL-OPERATOR</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Function</emphasis> <emphasis role="bold">SQL-OPERATOR</emphasis></refname>
+      <refname>SQL-OPERATOR</refname>
       <refpurpose>Returns the symbol for the supplied SQL operator.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
@@ -816,117 +841,120 @@
     </refsect1>
     <refsect1>
       <title>Notes</title>
-      <para>&clsql;'s symbolic SQL syntax currently has support for
-      the following SQL operators:
+      <para>
+        &clsql;'s symbolic SQL syntax currently has support for the
+        following &commonsql; compatible SQL operators:
       </para> 
       <simplelist> 
         <!-- CommonSQL Compatible --> 
-        <member><function>any
-        </function></member>, 
-        <member><function>some 
-        </function></member>, 
-        <member><function>all
-        </function></member>, 
-        <member><function>not
-        </function></member>, 
-        <member><function>union
-        </function></member>, 
-        <member><function>intersect
-        </function></member>, 
-        <member><function>minus
-        </function></member>, 
+        <member><function>any</function></member> 
+        <member><function>some</function></member> 
+        <member><function>all</function></member> 
+        <member><function>not</function></member> 
+        <member><function>union</function></member> 
+        <member><function>intersect</function></member> 
+        <member><function>minus</function></member>
         <member><function>except 
-        </function></member>, 
+        </function></member> 
         <member><function>order-by 
-        </function></member>, 
+        </function></member> 
         <member><function>null
-        </function></member>, 
+        </function></member> 
         <member><function>*
-        </function></member>, 
+        </function></member> 
         <member><function>+
-        </function></member>, 
+        </function></member> 
         <member><function>/
-        </function></member>, 
+        </function></member> 
         <member><function>-
-        </function></member>, 
+        </function></member> 
         <member><function>like
-        </function></member>, 
+        </function></member> 
         <member><function>and
-        </function></member>, 
+        </function></member> 
         <member><function>or
-        </function></member>, 
+        </function></member> 
         <member><function>in
-        </function></member>, 
+        </function></member> 
         <member><function>substr 
-        </function></member>, 
+        </function></member> 
         <member><function>|| 
-        </function></member>, 
+        </function></member> 
         <member><function>=
-        </function></member>, 
+        </function></member> 
         <member><function>&lt;
-        </function></member>, 
+        </function></member> 
         <member><function>>
-        </function></member>, 
+        </function></member> 
         <member><function>>=
-        </function></member>, 
+        </function></member> 
         <member><function>&lt;=
-        </function></member>, 
+        </function></member> 
         <member><function>&lt;>
-        </function></member>, 
+        </function></member> 
         <member><function>count
-        </function></member>, 
+        </function></member> 
         <member><function>max
-        </function></member>, 
+        </function></member> 
         <member><function>min
-        </function></member>, 
+        </function></member> 
         <member><function>avg
-        </function></member>, 
+        </function></member> 
         <member><function>sum
-        </function></member>, 
+        </function></member> 
         <member><function>function 
-        </function></member>, 
+        </function></member> 
         <member><function>between 
-        </function></member>, 
+        </function></member> 
         <member><function>distinct 
-        </function></member>, 
+        </function></member> 
         <member><function>nvl 
-        </function></member>, 
+        </function></member> 
         <member><function>slot-value
-        </function></member>, 
+        </function></member> 
         <member><function>userenv 
+        </function></member> 
+      </simplelist> 
+      <para>
+        as well as the pseudo-operator <function>function</function>. 
+      </para>
+      <para> The following operators are provided as &clsql; extensions to 
+      the &commonsql; API. 
+      <simplelist> 
         <!-- CLSQL Extensions --> 
-        </function></member>, 
         <member><function>concat
-        </function></member>, 
+        </function></member> 
         <member><function>substring 
-        </function></member>, 
+        </function></member> 
         <member><function>limit 
-        </function></member>, 
+        </function></member> 
         <member><function>group-by
-        </function></member>, 
+        </function></member> 
         <member><function>having
-        </function></member>, 
+        </function></member> 
         <member><function>not-null
-        </function></member>, 
+        </function></member> 
         <member><function>exists
-        </function></member>, 
+        </function></member> 
         <member><function>uplike
-        </function></member>, 
+        </function></member> 
         <member><function>is
-        </function></member>, 
+        </function></member> 
         <member><function>==
-        </function></member>, 
+        </function></member> 
         <member><function>the 
-        </function></member>, 
+        </function></member> 
         <member><function>coalesce 
-        </function></member>, 
+        </function></member> 
         <member><function>view-class
         </function></member> 
-      </simplelist> 
-      <para>as well as the pseudo-operator
-      <function>function</function>. Note that some of these operators
-      are not supported by all of the RDBMS supported by
-      &clsql;.</para>
+      </simplelist>
+      </para>
+      <para> 
+        Note that some of these operators are not supported by all of
+        the RDBMS supported by &clsql; (see the <link
+        linkend="appendix">Appendix</link> for details).
+      </para>
     </refsect1>
   </refentry>