From 6be46e38c9a7e08ed5c974c66bfdbd4dfad9a34d Mon Sep 17 00:00:00 2001
From: "Kevin M. Rosenberg" <kevin@rosenberg.net>
Date: Tue, 26 Mar 2002 20:31:58 +0000
Subject: [PATCH] r1665: *** empty log message ***

---
 ChangeLog           |  2 ++
 doc/clsql.sgml      |  6 ++---
 doc/dsssl/COPYRIGHT |  5 ++++
 doc/glossary.sgml   |  6 +++++
 doc/ref.sgml        | 63 +++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 79 insertions(+), 3 deletions(-)
 create mode 100644 doc/dsssl/COPYRIGHT

diff --git a/ChangeLog b/ChangeLog
index 4029419..cd3d796 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,8 @@
 26 Mar 2002 Kevin Rosenberg (kevin@rosenberg.net)
 	* interfaces/postgresql-socket/postgresql-socket-api.cl
 	Implemented direct socket reading for field type :double
+
+	* Added usage information for :types to documentation
 	
 25 Mar 2002 Kevin Rosenberg (kevin@rosenberg.net)
 
diff --git a/doc/clsql.sgml b/doc/clsql.sgml
index 52a10a8..90117ac 100644
--- a/doc/clsql.sgml
+++ b/doc/clsql.sgml
@@ -15,10 +15,10 @@
 <!ENTITY lw "<application>Lispworks</application>">
 <!ENTITY acl "<application>AllegroCL</application>">
 <!ENTITY cl "<application>ANSI Common Lisp</application>">
-<!ENTITY t "<constant>T</constant>">
-<!ENTITY nil "<constant>NIL</constant>">
+<!ENTITY t "<symbol>T</symbol>">
+<!ENTITY nil "<symbol>NIL</symbol>">
 <!ENTITY null "<constant>NULL</constant>">
-<!ENTITY c "<computeroutput>C</computeroutput>">
+<!ENTITY c "<symbol>C</symbol>">
 <!ENTITY defsystem "<application>defsystem</application>">
 <!ENTITY bookinfo SYSTEM "bookinfo.sgml">
 <!ENTITY preface SYSTEM "preface.sgml">
diff --git a/doc/dsssl/COPYRIGHT b/doc/dsssl/COPYRIGHT
new file mode 100644
index 0000000..871b60b
--- /dev/null
+++ b/doc/dsssl/COPYRIGHT
@@ -0,0 +1,5 @@
+These stylesheets are written and Copyright (c) 1999-2002 by Pierre
+R. Mai.
+
+He has graciously placed them in the public domain without
+restrictions.
diff --git a/doc/glossary.sgml b/doc/glossary.sgml
index 9c6153b..68a09d5 100644
--- a/doc/glossary.sgml
+++ b/doc/glossary.sgml
@@ -50,6 +50,12 @@
       <para>An object of type <type>database</type>.</para>
     </glossdef>
   </glossentry>
+  <glossentry id="gloss-field-types">
+    <glossterm>Field Types Specifier</glossterm>
+    <glossdef>
+      <para>A value that specifies the type of each field in a query.</para>
+    </glossdef>
+  </glossentry>
   <glossentry id="gloss-sql">
     <glossterm>Structured Query Language
       (<acronym>SQL</acronym>)
diff --git a/doc/ref.sgml b/doc/ref.sgml
index a0334ea..8551e11 100644
--- a/doc/ref.sgml
+++ b/doc/ref.sgml
@@ -1803,6 +1803,47 @@
 		of <symbol>*default-database*</symbol>.</para>
 	    </listitem>
 	  </varlistentry>
+	  <varlistentry>
+	    <term><parameter>types</parameter></term>
+	    <listitem>
+	      <para>A 
+		<glossterm linkend="gloss-field-types">field type
+		  specififier</glossterm>. The default is &nil;.
+		</para>
+		<para>
+		  The purpose of this argument is cause &clsql; to
+		  import SQL numeric fields into numeric Lisp objects
+		  rather than strings. This reduces the cost of
+		  allocating a temporary string and the &clsql; users'
+		  inconvenience of converting number strings into number
+		  objects.
+		</para>
+		<para>
+		  A value of <symbol>:auto</symbol> causes &clsql;
+		  to automatically convert the SQL field into a
+		  numeric format where applicable. The default value of
+		  &nil; causes all fields to be returned as strings
+		  regardless of the SQL type. Otherwise a list is expected
+		  which has a element for each field that specifies the
+		  conversion. If the list is shorter than the number
+		  of fields, the a value of <symbol>t</symbol> is
+		  assumed for the field.  If the list is longer than
+		  the number of fields, the extra elements are
+		  ignored.
+		  <simplelist type="vert">
+		    <member><symbol>:int</symbol> Field is imported as a
+		      32-bit signed integer.
+		    </member>
+		    <member><symbol>:double</symbol> Field is imported as a
+		      double-float number.
+		    </member>
+		    <member><symbol>t</symbol> Field is imported as a
+		      string.
+		    </member>
+		  </simplelist>
+		</para>
+	    </listitem>
+	  </varlistentry>
 	  <varlistentry>
 	    <term><returnvalue>result</returnvalue></term>
 	    <listitem>
@@ -1929,6 +1970,17 @@
 		of <symbol>*default-database*</symbol>.</para>
 	    </listitem>
 	  </varlistentry>
+	  <varlistentry>
+	    <term><parameter>types</parameter></term>
+	    <listitem>
+	      <para>
+		A <glossterm linkend="gloss-field-types">field type specififier</glossterm>. 
+		The default is &nil;. See <link
+		linkend="query"><function>query</function></link>
+		for the semantics of this argument.  
+	      </para>
+	    </listitem>
+	  </varlistentry>
 	  <varlistentry>
 	    <term><returnvalue>result</returnvalue></term>
 	    <listitem>
@@ -2079,6 +2131,17 @@
 		<symbol>*default-database*</symbol>.</para>
 	    </listitem>
 	  </varlistentry>
+	  <varlistentry>
+	    <term><parameter>types</parameter></term>
+	    <listitem>
+	      <para>
+		A <glossterm linkend="gloss-field-types">field type specififier</glossterm>. 
+		The default is &nil;. See <link
+		linkend="query"><function>query</function></link>
+		for the semantics of this argument.  
+	      </para>
+	    </listitem>
+	  </varlistentry>
 	  <varlistentry>
 	    <term><parameter>body</parameter></term>
 	    <listitem>
-- 
2.34.1