r9753: all docbook fixes done except for removing hovertext
authorKevin M. Rosenberg <kevin@rosenberg.net>
Sat, 10 Jul 2004 20:33:33 +0000 (20:33 +0000)
committerKevin M. Rosenberg <kevin@rosenberg.net>
Sat, 10 Jul 2004 20:33:33 +0000 (20:33 +0000)
12 files changed:
doc/global-index.xml
doc/ref-clsql.xml
doc/ref-conditions.xml
doc/ref-connect.xml
doc/ref-fdml.xml
doc/ref-ooddl.xml
doc/ref-oodml.xml
doc/ref-prepared.xml
doc/ref-recording.xml
doc/ref-syntax.xml
doc/ref-transaction.xml
doc/schemas.xml

index b7a4110453cdcf8fccbcd8ec30b2a5a52b44edfa..623e3e22bb3fdf8651560835552eb8ec5e17a313 100644 (file)
@@ -1,3 +1,10 @@
+<?xml version='1.0' ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % myents SYSTEM "entities.inc">
+%myents;
+]>
+
 <reference id="indexes">
   <title>Index</title>
   
@@ -8,6 +15,8 @@
     </refnamediv>
     
     <refsect1>
+      <title>
+      </title>
       <simplelist columns="2">
     
     <!-- VARIABLES --> 
index fc99b08ac05d78b47eac2ad1e31323081d2d0ca8..d483332d27d21ac2c039e8bc73343c98835db7d5 100644 (file)
@@ -1891,12 +1891,14 @@ Error: While trying to access database localhost/test2/root
          </varlistentry>
          <varlistentry>
            <term><parameter>field-names</parameter></term>
-           <para>
-             A boolean with a default value of &t;. When &t;, this
-             function results a second value of a list of field
-             names. When &nil;, this function only returns one value
-             - the list of rows.
-           </para>
+           <listitem>
+             <para>
+               A boolean with a default value of &t;. When &t;, this
+               function results a second value of a list of field
+               names. When &nil;, this function only returns one value
+               - the list of rows.
+             </para>
+           </listitem>
          </varlistentry>
          <varlistentry>
            <term><returnvalue>result</returnvalue></term>
index 3e1748903c13a94614c2de75f5c72bb1cc4a11b8..992fa9ab1e7da31b5fd6254d0583ced680460ddc 100644 (file)
@@ -28,7 +28,7 @@
       <refentrytitle>*BACKEND-WARNING-BEHAVIOR*</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Variable</emphasis> <emphasis role="bold">*BACKEND-WARNING-BEHAVIOR*</emphasis></refname>
+      <refname>*BACKEND-WARNING-BEHAVIOR*</refname>
       <refpurpose>Controls behaviour on warnings from underlying RDBMS.</refpurpose>
       <refclass>Variable</refclass>
     </refnamediv>
       <para><symbol>:warn</symbol></para>
     </refsect1>
     <refsect1>
-      <title>Description</title> Action to perform on warning messages
-      from backend. Default is to <symbol>:warn</symbol>. May also be
-      set to <symbol>:error</symbol> to signal an error or
-      <symbol>:ignore</symbol> or &nil; to silently ignore the
-      warning.
+      <title>Description</title>
+      <para>
+       Action to perform on warning messages
+       from backend. Default is to <symbol>:warn</symbol>. May also be
+       set to <symbol>:error</symbol> to signal an error or
+       <symbol>:ignore</symbol> or &nil; to silently ignore the
+       warning.
+      </para>
     </refsect1>
     <refsect1>
       <title>Examples</title>
@@ -76,7 +79,7 @@
       <refentrytitle>SQL-CONDITION</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold"><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-CONDITION</emphasis></emphasis></refname>
+      <refname>SQL-CONDITION</refname>
       <refpurpose>the super-type of all
       &clsql;-specific
       conditions</refpurpose>
       <refentrytitle>SQL-ERROR</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-ERROR</emphasis></refname>
+      <refname>SQL-ERROR</refname>
       <refpurpose>the super-type of all
       &clsql;-specific
       errors</refpurpose>
       <refentrytitle>SQL-WARNING</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-WARNING</emphasis></refname>
+      <refname>SQL-WARNING</refname>
       <refpurpose>the super-type of all
       &clsql;-specific
       warnings</refpurpose>
       <refentrytitle>SQL-DATABASE-WARNING</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-DATABASE-WARNING</emphasis></refname>
+      <refname>SQL-DATABASE-WARNING</refname>
       <refpurpose>Used to warn while accessing a 
       &clsql; database.</refpurpose>
       <refclass>Condition Type</refclass>
       <refentrytitle>SQL-USER-ERROR</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-USER-ERROR</emphasis></refname>
+      <refname>SQL-USER-ERROR</refname>
       <refpurpose>condition representing errors because of invalid
       parameters from the library user.</refpurpose>
       <refclass>Condition Type</refclass>
       <refentrytitle>SQL-DATABASE-ERROR</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-DATABASE-ERROR</emphasis></refname>
+      <refname>SQL-DATABASE-ERROR</refname>
       <refpurpose>condition representing errors during query or
       command execution</refpurpose>
       <refclass>Condition Type</refclass>
       <refentrytitle>SQL-CONNECTION-ERROR</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-CONNECTION-ERROR</emphasis></refname>
+      <refname>SQL-CONNECTION-ERROR</refname>
       <refpurpose>condition representing errors during
       connection</refpurpose>
       <refclass>Condition Type</refclass>
       <refentrytitle>SQL-DATABASE-DATA-ERROR</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-DATABASE-DATA-ERROR</emphasis></refname>
+      <refname>SQL-DATABASE-DATA-ERROR</refname>
       <refpurpose>Used to signal an error with the SQL data passed
       to a database.</refpurpose>
       <refclass>Condition Type</refclass>
       <refentrytitle>SQL-TEMPORARY-ERROR</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-TEMPORARY-ERROR</emphasis></refname>
+      <refname>SQL-TEMPORARY-ERROR</refname>
       <refpurpose>Used to signal a temporary error in the database
       backend.</refpurpose>
       <refclass>Condition Type</refclass>
       <refentrytitle>SQL-TIMEOUT-ERROR</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-TIMEOUT-ERROR</emphasis></refname>
+      <refname>SQL-TIMEOUT-ERROR</refname>
       <refpurpose>condition representing errors when a connection
       times out.</refpurpose>
       <refclass>Condition Type</refclass>
       <refentrytitle>SQL-FATAL-ERROR</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Condition Type</emphasis> <emphasis role="bold">SQL-FATAL-ERROR</emphasis></refname>
+      <refname>SQL-FATAL-ERROR</refname>
       <refpurpose>condition representing a fatal error in a database
       connection</refpurpose>
       <refclass>Condition Type</refclass>
index e63aae2a84d44e2763372fe43762cb2ab1671dd8..35b8cf56b30aef8a446c903a152db9d7763eaf54 100644 (file)
     </refnamediv>
     <refsect1>
       <title>Syntax</title>
-       <title>Syntax</title>
-       <synopsis><function>connect</function> <replaceable>connection-spec</replaceable> &amp;key <replaceable>if-exists</replaceable> <replaceable>database-type</replaceable> <replaceable>pool</replaceable> <replaceable>make-default</replaceable> => <returnvalue>database</returnvalue></synopsis>
+      <synopsis><function>connect</function> <replaceable>connection-spec</replaceable> &amp;key <replaceable>if-exists</replaceable> <replaceable>database-type</replaceable> <replaceable>pool</replaceable> <replaceable>make-default</replaceable> => <returnvalue>database</returnvalue></synopsis>
     </refsect1>
     <refsect1>
       <title>Arguments and Values</title>
index e86dd36219fd90043c2930893b0776ac45f5115b..ca725bdd492e25973f4169adadabcb56f9f57bd1 100644 (file)
       <refname>CACHE-TABLE-QUERIES</refname>
       <refpurpose>Control the caching of table attribute types.</refpurpose>
     </refnamediv>
+    <refsect1>
+      <title>Syntax</title>
+      <para>
+      </para>
+    </refsect1>
   </refentry>
 
   <refentry id="insert-records">
@@ -1320,10 +1325,8 @@ ID FORENAME   SURNAME   EMAIL
     </refsect1>
     <refsect1>
       <title>Side Effects</title>
-      <para>
         <para>Whatever effects the execution of the SQL query has on
         the underlying database, if any.</para>
-      </para>
     </refsect1>
     <refsect1>
       <title>Affected by</title>
index 6ea4d9cdccba6290377c343842c48c5660099217..28fe5796dd737c777c18efaee8adbc8532d94dec 100644 (file)
@@ -24,8 +24,9 @@
       and SQL tables can be deleted with <link
       linkend="drop-view-from-class"><function>drop-view-from-class</function></link>.
     </para>
-    <note>The above functions refer to the Lisp <emphasis>view</emphasis> of the SQL
-    table. This Lisp view should not be confused with SQL <function>VIEW</function> statement.
+    <note>
+      <para>The above functions refer to the Lisp <emphasis>view</emphasis> of the SQL
+    table. This Lisp view should not be confused with SQL <function>VIEW</function> statement.</para>
     </note>
   </partintro>
 
       of all &clsql; View Classes.</para>
     </refsect1>
     <refsect1>
-      <title class="contenttitle">Class details</title>
+      <title>Class details</title>
       <programlisting>(defclass STANDARD-DB-OBJECT ()(...))</programlisting>
     </refsect1>
     <refsect1>
-      <title class="contenttitle">Slots</title>
+      <title>Slots</title>
       <para>
        <simplelist> 
-         <property>slot VIEW-DATABASE is of type (OR NULL DATABASE)
+         <member>slot VIEW-DATABASE is of type (OR NULL DATABASE)
          which stores the associated database for the
-         instance.</property>
+         instance.</member>
        </simplelist> 
       </para>
     </refsect1>
       <title>Affected by</title>
       <para>
        <simplelist>
-         Which view classes have been defined in the Lisp session.
+         <member>Which view classes have been defined in the Lisp session.</member>
        </simplelist>
       </para>
     </refsect1>
index 7ff2a78bbb51fe6bef54b081a777b72c161cfbb6..76df3ec4db0f075f04561ec4a5f9f7ab45f6359f 100644 (file)
       <para>
        This special variable provides the default value for the
        <parameter>max-len</parameter> argument of the function <link
-       linkend="update-object-joins"><function>update-object-joins</function></link>.
+       linkend="update-objects-joins"><function>update-object-joins</function></link>.
       </para>
     </refsect1>
     <refsect1>
     <refsect1>
       <title>See Also</title>
       <simplelist>
-       <member><link linkend="update-object-joins"><function>update-object-joins</function></link></member>
+       <member><link linkend="update-objects-joins"><function>update-object-joins</function></link></member>
       </simplelist>
     </refsect1>
     <refsect1>
       appropriate table of <parameter>database</parameter> which
       defaults to the database associated with
       <parameter>object</parameter> or, if <parameter>object</parameter> is not associated
-      with a database, <variable>*default-database*</variable>.  Join slots are updated but
+      with a database, <varname>*default-database*</varname>.  Join slots are updated but
       instances of the class on which the join is made are not
       updated.
       </para>
       <title>Affected by</title>
       <para>
         <simplelist>
-         Data in SQL database.
+         <member>Data in SQL database.</member>
         </simplelist>
       </para>
     </refsect1>
     <refsect1>
       <title>See Also</title>
       <para>
-        <simplelist>
-          <!-- see also --> 
-        </simplelist>
       </para>
     </refsect1>
     <refsect1>
       <title>Affected by</title>
       <para>
         <simplelist>
-      <simplelist>
-       <member><link
-       linkend="default-update-objects-max-len"><variable>*default-update-objects-max-len*</variable></link></member>
-      </simplelist>
-        </simplelist>
+         <member><link
+         linkend="default-update-objects-max-len"><varname>*default-update-objects-max-len*</varname></link></member>
+       </simplelist>
       </para>
     </refsect1>
     <refsect1>
       <title>See Also</title>
       <para>
         <simplelist>
-          <!-- see also --> 
+         <member><link
+         linkend="default-update-objects-max-len"><varname>*default-update-objects-max-len*</varname></link></member>
         </simplelist>
       </para>
     </refsect1>
       defaults to the database associated with
       <parameter>object</parameter> or, if
       <parameter>object</parameter> is not associated with a database,
-      <variable>*default-database*</variable>.  Join slots are updated
+      <varname>*default-database*</varname>.  Join slots are updated
       but instances of the class on which the join is made are not
       updated.
       </para>
     <refsect1>
       <title>See Also</title>
       <para>
-        <simplelist>
-          <!-- see also --> 
-        </simplelist>
       </para>
     </refsect1>
     <refsect1>
index 8e5d477f63b6fddf15bca0c82aab4f9cb77a5568..ff922fae493db77f20639905f0d3118e5cf94d5d 100644 (file)
@@ -20,7 +20,7 @@
       <refentrytitle>PREPARE-SQL</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Function</emphasis> <emphasis role="bold">PREPARE-SQL</emphasis></refname>
+      <refname>>PREPARE-SQL</refname>
       <refpurpose>Create a prepared statement.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
@@ -97,7 +97,7 @@
       <refentrytitle>RUN-PREPARED-SQL</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Function</emphasis> <emphasis role="bold">RUN-PREPARED-SQL</emphasis></refname>
+      <refname>RUN-PREPARED-SQL</refname>
       <refpurpose>Execute a prepared statement.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
       <refentrytitle>FREE-PREPARED-SQL</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Function</emphasis> <emphasis role="bold">FREE-PREPARED-SQL</emphasis></refname>
+      <refname>FREE-PREPARED-SQL</refname>
       <refpurpose>Delete a prepared statement object.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
       <refentrytitle>BIND-PARAMETER</refentrytitle>
     </refmeta>
     <refnamediv>
-      <refname><emphasis>Function</emphasis> <emphasis role="bold">BIND-PARAMETER</emphasis></refname>
+      <refname>BIND-PARAMETER</refname>
       <refpurpose>Bind a parameter in a prepared statement.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
index 10572106c8c11a7c70302619c24ffd6850960220..fb06078c554971263fe69203f0fe57c5729d82fa 100644 (file)
             </para>
           </listitem>
         </varlistentry>              
-        <varlistentry>
-          <term><parameter>type</parameter></term>
-          <varlistentry>
-          <term><parameter>stream</parameter></term>
-          <listitem>
-            <para>
-              A stream or &t;. 
-            </para>
-          </listitem>
-        </varlistentry> 
+       <varlistentry>
+         <term><parameter>stream</parameter></term>
+         <listitem>
+           <para>
+             A stream or &t;. 
+           </para>
+         </listitem>
+       </varlistentry> 
+       <varlistentry>
+         <term><parameter>type</parameter></term>
         <listitem>
           <para>
             One of the following keyword symbols:
index da28038a03db73c881a5d06b153c1bf6913d3140..787b4a3b08b28d1c09672447ad171a28e7286984 100644 (file)
       </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>, 
+        </function></member> 
       </simplelist> 
       <para>
         as well as the pseudo-operator <function>function</function>. 
       <simplelist> 
         <!-- CLSQL Extensions --> 
         <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>, 
-        <member><function>view-class.
+        </function></member> 
+        <member><function>view-class
         </function></member> 
       </simplelist>
       </para>
index 77a690d634dce6e84f1f4b8385c4633f1bee2135..5731c466da3783a0589683effe72f3d952c0d19c 100644 (file)
       transaction blocks, committing or rolling back changes made and
       controlling autocommit behaviour.
     </para>
-    <note> 
+    <note>
+      <para>
       In contrast to &commonsql;, &clsql;, by default, starts in
       transaction AUTOCOMMIT mode (see <link
       linkend="set-autocommit"><function>set-autocommit</function></link>).
       To begin a transaction in autocommit mode, <link
       linkend="start-transaction"><function>start-transaction</function></link>
       has to be called explicitly.
+      </para>
     </note> 
   </partintro>
 
             object</glossterm>. This will default to the value
             of <symbol>*default-database*</symbol>.</para>
           </listitem>
-<varlistentry>
-          <term><parameter>body</parameter></term>
+       </varlistentry>
+       <varlistentry>
+         <term><parameter>body</parameter></term>
           <listitem>
             <para>
               A body of Lisp code. 
             <para>The result of executing <parameter>body</parameter>.</para>
           </listitem>
         </varlistentry>
-        </varlistentry>
       </variablelist>
     </refsect1>
     <refsect1>
index beacaf07da88e4f16e87f9b7043c7e162d66d819..018eb6f450aa4c13aa1e508a7a1311477a090cf2 100644 (file)
@@ -1,11 +1,24 @@
 <?xml version="1.0"?>
 <locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
+  <uri resource="ref-fddl.xml" uri="/usr/share/emacs/site-lisp/nxml-mode/schema/docbook.rnc"/>
   <uri resource="appendix.xml" typeId="DocBook"/>
   <uri resource="bookinfo.xml" typeId="DocBook"/>
   <uri resource="clsql.xml" typeId="DocBook"/>
   <uri resource="glossary.xml" typeId="DocBook"/>
   <uri resource="intro.xml" typeId="DocBook"/>
   <uri resource="preface.xml" typeId="DocBook"/>
-  <uri resource="ref_clsql_sys.xml" typeId="DocBook"/>
-  <uri resource="ref_clsql.xml" typeId="DocBook"/>
+  <uri resource="ref-clsql-sys.xml" typeId="DocBook"/>
+  <uri resource="ref-clsql.xml" typeId="DocBook"/>
+  <uri resource="ref-fddl.xml" typeId="DocBook"/>
+  <uri resource="ref-fdml.xml" typeId="DocBook"/>
+  <uri resource="ref-ooddl.xml" typeId="DocBook"/>
+  <uri resource="ref-oodml.xml" typeId="DocBook"/>
+  <uri resource="ref-connect.xml" typeId="DocBook"/>
+  <uri resource="ref-lob.xml" typeId="DocBook"/>
+  <uri resource="ref-prepared.xml" typeId="DocBook"/>
+  <uri resource="ref-conditions.xml" typeId="DocBook"/>
+  <uri resource="ref-transaction.xml" typeId="DocBook"/>
+  <uri resource="ref-syntax.xml" typeId="DocBook"/>
+  <uri resource="ref-recording.xml" typeId="DocBook"/>
+  <uri resource="global-index.xml" typeId="DocBook"/>
 </locatingRules>