Bug fix: target names couldn't contain blanks.
[ir-tcl-moved-to-github.git] / doc / ir-tcl.sgml
index 8768fdd..593940d 100644 (file)
@@ -1,13 +1,13 @@
 <!doctype linuxdoc system>
 
 <!--
-  $Id: ir-tcl.sgml,v 1.3 1995-05-30 09:44:22 adam Exp $
+  $Id: ir-tcl.sgml,v 1.6 1995-06-01 16:36:56 adam Exp $
 -->
 
 <article>
 <title>IrTcl User's Guide and Reference
 <author>Index Data, <tt/info@index.ping.dk/
-<date>$Date: 1995-05-30 09:44:22 $
+<date>$Revision: 1.6 $
 <abstract>
 This document describes IrTcl &mdash an information retrieval toolkit for
 Tcl and Tk that provides access to the Z39.50/SR protocol.
@@ -401,7 +401,7 @@ operators. They are:
 <tag><tt>@not </tt><em>op1 op2</em></tag>
  Boolean <em/not/ on op1 and op2
 <tag><tt>@prox </tt><em>list op1 op2</em></tag>
- Proximity operation on op1 and op2 
+ Proximity operation on op1 and op2. Not implemented yet.
 <tag><tt>@set </tt><em>name</em></tag>
  Result set reference
 </descrip>
@@ -538,7 +538,7 @@ The first part of the <tt/search-response/ looks like:
 proc search-response {assoc rset} {
     set status [$rset responseStatus]
     set type [lindex $status 0]
-    if {$type == NSD} {
+    if {$type == "NSD"} {
         set code [lindex $status 1]
         set msg [lindex $status 2]
         set addinfo [lindex $status 3]
@@ -546,7 +546,7 @@ proc search-response {assoc rset} {
         return
     } 
     set hits [$rset resultCount]
-    if {$type == DBOSD} {
+    if {$type == "DBOSD"} {
         set ret [$rset numberOfRecordsReturned]
         ...
     }
@@ -621,7 +621,7 @@ surrogate diagnostics (<tt/DBOSD/). The individual
 records, indexed by an integer position, should be 
 inspected.
 
-The action <tt/Type/ followed by an integer returns information 
+The action <tt/type/ followed by an integer returns information 
 about a given position in an ir set. There are three possiblities:
 
 <descrip>
@@ -660,18 +660,18 @@ Recall that the ir set name was passed to the
 search-response handler as argument <tt/rset/.
 
 <tscreen><verb>
-    if {$type == DBOSD} {
+    if {$type == "DBOSD"} {
         set ret [$rset numberOfRecordsReturned]
         for {set i 1} {$i<=$ret} {incr i} {
-            set itype [$rset Type $i]
-            if {$itype == SD} {
+            set itype [$rset type $i]
+            if {$itype == "SD"} {
                 set diag [$rset Diag $i]
                 set code [lindex $diag 0]
                 set msg [lindex $diag 1]
                 set addinfo [lindex $diag 2]
                 puts "$i: NSD $code: $msg: $addinfo"
-            } else if {$itype == DB} {
-                set rtype [$rset RecordType $i]
+            } else if {$itype == "DB"} {
+                set rtype [$rset recordType $i]
                 puts "$i: type is $rtype"
             }
         }
@@ -825,6 +825,64 @@ record.
 <p>
 <em/To be written/
 
+<sect>License
+
+<p>
+Copyright (c) 1995, Index Data.
+
+Permission to use, copy, modify, distribute, and sell this software and
+its documentation, in whole or in part, for any purpose, is hereby granted,
+provided that:
+
+1. This copyright and permission notice appear in all copies of the
+software and its documentation. Notices of copyright or attribution
+which appear at the beginning of any file must remain unchanged.
+
+2. The names of Index Data or the individual authors may not be used to
+endorse or promote products derived from this software without specific
+prior written permission.
+
+THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
+EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
+WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
+INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
+NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
+LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+OF THIS SOFTWARE.
+
+<sect>About Index Data
+
+<p>
+Index Data is a consulting and software-development enterprise that
+specialises in library and information management systems. Our
+interests and expertise span a broad range of related fields, and one
+of our primary, long-term objectives is the development of a powerful
+information management
+system with open network interfaces and hypermedia capabilities.
+
+We make this software available free of charge, on a fairly unrestrictive
+license; as a service to the networking community, and to further the
+development of quality software for open network communication.
+
+We'll be happy to answer questions about the software, and about ourselves
+in general.
+
+<tscreen>
+Index Data&nl
+Ryesgade 3&nl
+2200 K&oslash;benhavn N&nl
+DENMARK
+</tscreen>
+
+<p>
+<tscreen><verb>
+Phone: +45 3536 3672
+Fax  : +45 3536 0449
+Email: info@index.ping.dk
+</verb></tscreen>
+
 <sect>References
 
 <p>