- Allow keywords to be used unquoted as search terms.

[cql-java-moved-to-github.git] / README

diff --git a/README b/README
index ccf57cf..08a76a5 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-$Id: README,v 1.12 2002-11-04 23:42:30 mike Exp $
+$Id: README,v 1.18 2002-11-14 22:04:16 mike Exp $
 
 cql-java - a free CQL compiler, and other CQL tools, for Java
 
@@ -15,7 +15,7 @@ cql-java is a Free Software project that provides:
 * A selection of compiler back-ends to render out the parse tree as:
        * XCQL (the standard XML representation)
        * CQL (i.e. decompiling the parse-tree)
-       * PQF (Yaz-style Prefix Query Format) [### NOT YET]
+       * PQF (Yaz-style Prefix Query Format)
 * A random query generator, useful for testing.
 
 CQL is "Common Query Language", a new query language designed under
@@ -43,7 +43,7 @@ What's what in this distribution?
        etc     Other files: CQL Grammar, generator properties, etc.
 
 "Installation" of this package would consist of putting the bin
-directory on your PATH and the lib directory on your CLASSPATH.
+directory on your PATH and lib/cql-java.jar on your CLASSPATH.
 
 
 SYNOPSIS
@@ -73,15 +73,15 @@ Using the library in your own applications:
        CQLNode root = parser.parse("title=dinosaur");
        System.out.print(root.toXCQL(0));
        System.out.println(root.toCQL());
-       System.out.println(root.toPQF(qualSet));
-       // ... where `qualSet' specifies CQL-qualfier => Z-attr mapping
+       System.out.println(root.toPQF(config));
+       // ... where `config' specifies CQL-qualfier => Z-attr mapping
 
 
 DESCRIPTION
 -----------
 
 See the automatically generated class documentation in the "doc"
-subdirectory.  (It's not all there yet, but it's coming.)
+subdirectory.
 
 
 AUTHOR
@@ -114,36 +114,5 @@ All the other free CQL compilers everyone's going to write  :-)
 THINGS TO DO
 ------------
 
-* ### Fix bug where "9x" is parsed as two tokens, a TT_NUMBER followed
-  by a TT_WORD.  The problem here is that I don't think it's actually
-  possible to fix this without throwing out StreakTokenizer and
-  rolling our own, which we absolutely _don't_ want to do.
-
-* Allow keywords to be used unquoted as search terms.
-
-* Some niceties for the cql-decompiling back-end:
-       * don't emit redundant parentheses.
-       * don't put spaces around relations that don't need them.
-
-* Write the PQN-generating back-end.  This will need to be driven from
-  a configuation file specifying how to represent the qualifiers,
-  relations, relation modifiers and wildcard characters as z39.50
-  attributes.  I think Ray has such a thing, though perhaps not yet in
-  a form sufficiently rigorous to be computer-readable.
-
-* Consider the utility of yet another back-end that translates a
-  CQLNode tree into a Type-1 query tree using the JZKit data
-  structures.  That would be nice so that CQL could become a JZKit
-  query-type; but you could achieve the same effect by generating PQN,
-  and running that through JZKit's existing PQN-to-Type-1 compiler.
-
-* Many refinements to the random query generator:
-       * Generate relation modifiers
-       * Proximity support
-       * Don't always generate qualifier/relation for terms
-       * Better selection of qualifier (configurable?)
-       * Better selection of terms (from a dictionary file?)
-       * Introduce wildcard characters into generated terms
-       * Generate multi-word terms
-
-* Write fuller "javadoc" comments.
+[See the final "Still to do" section of the "Changes" file.]
+