X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref-oodml.xml;h=76df3ec4db0f075f04561ec4a5f9f7ab45f6359f;hb=4413405fd38eaba7ba6d6d8b844fef118e326c9a;hp=4fbf5651ee29a5cc9319dc4f2f0ac14e7b4d22f5;hpb=e087af7ef2e07195b7dea8821b9048d5826cac5a;p=clsql.git

diff --git a/doc/ref-oodml.xml b/doc/ref-oodml.xml
index 4fbf565..76df3ec 100644
--- a/doc/ref-oodml.xml
+++ b/doc/ref-oodml.xml
@@ -16,10 +16,31 @@
       written with the OODML.
     </para>
     <para>
-      The main function for reading data with the OODML is the
-      <link linkend="select"><function>select</function></link> function. The
-      <function>select</function> is also used in the FDML. However, when <function>select</function>
-      is given a view class name, it returns a list of instances of view classes.
+      The main function for reading data with the OODML is the <link
+      linkend="select"><function>select</function></link>
+      function. The <function>select</function> is also used in the
+      FDML. However, when <function>select</function> is given a view
+      class name, it returns a list of instances of view classes.
+    </para>
+    <para>
+      View class instances can be updated to reflect any changes in
+      the database with the functions <link
+      linkend="update-slot-from-record"><function>update-slot-from-record</function></link>
+      and <link
+      linkend="update-instance-from-records"><function>update-instance-from-records</function></link>.
+    </para>
+    <para>To update the database to reflect changes made to instances of view classes, use the functions <link
+      linkend="update-records-from-instance"><function>update-records-from-instance</function></link>,
+      <link
+      linkend="update-record-from-slot"><function>update-record-from-slot</function></link>, and
+      <link
+      linkend="update-record-from-slots"><function>update-record-from-slots</function></link>.
+    </para>
+    <para>
+      The function <link
+      linkend="delete-instance-records"><function>delete-instance-records</function></link>
+      deletes the records corresponding to an instance of a view
+      class.
     </para>
   </partintro>
 
@@ -40,12 +61,17 @@
       <para>&nil;</para>
     </refsect1>
     <refsect1>
-      <title>Description</title>
-      When this variable is &t; an instance is stored in the SQL database when the instance is created
-      by <function>make-instance</function>. When this variable is &nil;, which is the default value, &clsql;
-      behaves like &commonsql;: instances of view classes are stored to the SQL database only when
-      <link linkend="update-record-from-slots"><function>update-record-from-slots</function></link>
-      is called.
+      <title>Description</title> 
+      <para>
+	When this variable is &t; an instance is stored in the SQL
+	database when the instance is created by
+	<function>make-instance</function>. When this variable is
+	&nil;, which is the default value, &clsql; behaves like
+	&commonsql;: instances of view classes are stored to the SQL
+	database only when <link
+	linkend="update-record-from-slots"><function>update-record-from-slots</function></link>
+	is called.
+      </para>
     </refsect1>
     <refsect1>
       <title>Examples</title>
@@ -96,7 +122,7 @@
       <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>
@@ -111,7 +137,9 @@
     </refsect1>
     <refsect1>
       <title>See Also</title>
-      <para>None.</para>
+      <simplelist>
+	<member><link linkend="update-objects-joins"><function>update-object-joins</function></link></member>
+      </simplelist>
     </refsect1>
     <refsect1>
       <title>Notes</title>
@@ -122,7 +150,8 @@
   <refentry id="delete-instance-records">
     <refnamediv>
       <refname>DELETE-INSTANCE-RECORDS</refname>
-      <refpurpose>Delete SQL records represented by a view class object.</refpurpose>
+      <refpurpose>Delete SQL records represented by a view class
+      object.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
     <refsect1>
@@ -306,7 +335,7 @@
       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>
@@ -327,7 +356,7 @@
       <title>Affected by</title>
       <para>
         <simplelist>
-	  Data in SQL database.
+	  <member>Data in SQL database.</member>
         </simplelist>
       </para>
     </refsect1>
@@ -340,9 +369,6 @@
     <refsect1>
       <title>See Also</title>
       <para>
-        <simplelist>
-          <!-- see also --> 
-        </simplelist>
       </para>
     </refsect1>
     <refsect1>
@@ -442,21 +468,23 @@
       <title>Affected by</title>
       <para>
         <simplelist>
-          <!-- affected by --> 
-        </simplelist>
+	  <member><link
+	  linkend="default-update-objects-max-len"><varname>*default-update-objects-max-len*</varname></link></member>
+	</simplelist>
       </para>
     </refsect1>
     <refsect1>
       <title>Exceptional Situations</title>
       <para>
-        <!-- execeptional situations -->
+	Database errors.
       </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>
@@ -482,7 +510,30 @@
     <refsect1>
       <title>Arguments and Values</title>
       <variablelist>
-        <!-- arguments and values --> 
+	<varlistentry>
+	  <term><parameter>object</parameter></term>
+	  <listitem>
+	    <para>
+	      An instance of a view class.
+	    </para>
+	  </listitem>
+	</varlistentry>
+	<varlistentry>
+	  <term><parameter>slot</parameter></term>
+	  <listitem>
+	    <para>
+	      The name of a slot in <parameter>object</parameter>.
+	    </para>
+	  </listitem>
+	</varlistentry>
+	<varlistentry>
+	  <term><parameter>database</parameter></term>
+	  <listitem>
+	    <para>
+	      A database connection.
+	    </para>
+	  </listitem>
+	</varlistentry>
       </variablelist>
     </refsect1>
     <refsect1>
@@ -502,36 +553,35 @@
       </para>
     </refsect1>
     <refsect1>
-      <title>examples</title>
+      <title>Examples</title>
       <screen>
         <!-- examples -->
       </screen>
     </refsect1>
     <refsect1>
-      <title>side effects</title>
+      <title>Side Effects</title>
       <para>
-        modifies sql database.
+	Modifies database.
       </para>
     </refsect1>
     <refsect1>
-      <title>affected by</title>
+      <title>Affected By</title>
       <para>
-        <simplelist>
-          <!-- affected by --> 
-        </simplelist>
+	Nothing.
       </para>
     </refsect1>
     <refsect1>
-      <title>exceptional situations</title>
+      <title>Exceptional Situations</title>
       <para>
-        if a database error occurs.
+	Database errors.
       </para>
     </refsect1>
     <refsect1>
-      <title>see also</title>
+      <title>See Also</title>
       <para>
         <simplelist>
-          <!-- see also --> 
+	  <member><link linkend="update-record-from-slots"><function>update-record-from-slots</function></link></member>
+	  <member><link linkend="update-records-from-instance"><function>update-records-from-instance</function></link></member>
         </simplelist>
       </para>
     </refsect1>
@@ -555,14 +605,37 @@
       <function>(update-record-from-slots object slots &amp;key (database *default-database*))</function> => <returnvalue><!-- result --></returnvalue></synopsis>
     </refsect1>
     <refsect1>
-      <title>arguments and values</title>
+      <title>Arguments and Values</title>
       <variablelist>
-        <!-- arguments and values --> 
+	<varlistentry>
+	  <term><parameter>object</parameter></term>
+	  <listitem>
+	    <para>
+	      An instance of a view class.
+	    </para>
+	  </listitem>
+	</varlistentry>
+	<varlistentry>
+	  <term><parameter>slots</parameter></term>
+	  <listitem>
+	    <para>
+	      A list of slot names in <parameter>object</parameter>.
+	    </para>
+	  </listitem>
+	</varlistentry>
+	<varlistentry>
+	  <term><parameter>database</parameter></term>
+	  <listitem>
+	    <para>
+	      A database connection.
+	    </para>
+	  </listitem>
+	</varlistentry>
       </variablelist>
     </refsect1>
     <refsect1>
-      <title>description</title>
-      <para>updates the values stored in the columns represented by
+      <title>Description</title>
+      <para>Updates the values stored in the columns represented by
       the slots, specified by the clos slot names
       <parameter>slots</parameter>, of view class instance
       <parameter>object</parameter>. <parameter>database</parameter>
@@ -591,22 +664,21 @@
     <refsect1>
       <title>Affected by</title>
       <para>
-        <simplelist>
-          <!-- affected by --> 
-        </simplelist>
+	Nothing.
       </para>
     </refsect1>
     <refsect1>
       <title>Exceptional Situations</title>
       <para>
-        <!-- execeptional situations -->
+	Database errors.
       </para>
     </refsect1>
     <refsect1>
       <title>See Also</title>
       <para>
         <simplelist>
-          <!-- see also --> 
+	  <member><link linkend="update-record-from-slot"><function>update-record-from-slot</function></link></member>
+	  <member><link linkend="update-records-from-instance"><function>update-records-from-instance</function></link></member>
         </simplelist>
       </para>
     </refsect1>
@@ -633,7 +705,22 @@
     <refsect1>
       <title>Arguments and Values</title>
       <variablelist>
-        <!-- arguments and values --> 
+	<varlistentry>
+	  <term><parameter>object</parameter></term>
+	  <listitem>
+	    <para>
+	      An instance of a view class.
+	    </para>
+	  </listitem>
+	</varlistentry>
+	<varlistentry>
+	  <term><parameter>database</parameter></term>
+	  <listitem>
+	    <para>
+	      A database connection.
+	    </para>
+	  </listitem>
+	</varlistentry>
       </variablelist>
     </refsect1>
     <refsect1>
@@ -659,28 +746,27 @@
     <refsect1>
       <title>Side Effects</title>
       <para>
-        <!-- side effects --> 
+	Modifies the database.
       </para>
     </refsect1>
     <refsect1>
       <title>Affected by</title>
       <para>
-        <simplelist>
-          <!-- affected by --> 
-        </simplelist>
+	Nothing.
       </para>
     </refsect1>
     <refsect1>
       <title>Exceptional Situations</title>
       <para>
-        <!-- execeptional situations -->
+	Database errors.
       </para>
     </refsect1>
     <refsect1>
       <title>See Also</title>
       <para>
         <simplelist>
-          <!-- see also --> 
+	  <member><link linkend="update-record-from-slot"><function>update-record-from-slot</function></link></member>
+	  <member><link linkend="update-record-from-slots"><function>update-record-from-slots</function></link></member>
         </simplelist>
       </para>
     </refsect1>
@@ -706,7 +792,30 @@
     <refsect1>
       <title>Arguments and Values</title>
       <variablelist>
-        <!-- arguments and values --> 
+	<varlistentry>
+	  <term><parameter>object</parameter></term>
+	  <listitem>
+	    <para>
+	      An instance of a view class.
+	    </para>
+	  </listitem>
+	</varlistentry>
+	<varlistentry>
+	  <term><parameter>slot</parameter></term>
+	  <listitem>
+	    <para>
+	      The name of a slot in <parameter>object</parameter>.
+	    </para>
+	  </listitem>
+	</varlistentry>
+	<varlistentry>
+	  <term><parameter>database</parameter></term>
+	  <listitem>
+	    <para>
+	      A database connection.
+	    </para>
+	  </listitem>
+	</varlistentry>
       </variablelist>
     </refsect1>
     <refsect1>
@@ -718,7 +827,7 @@
       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>
@@ -746,15 +855,12 @@
     <refsect1>
       <title>Exceptional Situations</title>
       <para>
-	SQL access errors.
+	Database errors.
       </para>
     </refsect1>
     <refsect1>
       <title>See Also</title>
       <para>
-        <simplelist>
-          <!-- see also --> 
-        </simplelist>
       </para>
     </refsect1>
     <refsect1>