[Zope-CVS] CVS: Products/FieldedTextIndex - README.txt:1.4
Casey Duncan
casey at zope.com
Fri Dec 12 00:25:20 EST 2003
Update of /cvs-repository/Products/FieldedTextIndex
In directory cvs.zope.org:/tmp/cvs-serv18128
Modified Files:
README.txt
Log Message:
Fix up the docs a bit
=== Products/FieldedTextIndex/README.txt 1.3 => 1.4 ===
--- Products/FieldedTextIndex/README.txt:1.3 Fri Dec 12 00:09:26 2003
+++ Products/FieldedTextIndex/README.txt Fri Dec 12 00:25:19 2003
@@ -34,12 +34,13 @@
perform searches across multiple text indexes such as
'"Casey Duncan" in [first_name, last_name]'
- FieldedTextIndex solves these problems by extending the standard TextIndex
- so that it can receive and index the textual data of an object's field
- attributes as a mapping of field name to field text. The index itself
- performs the aggregation of the fielded data and allows queries to be
- performed across all fields (like a standard text index) or any subset
- of the fields which have been encountered in the objects indexed.
+ FieldedTextIndex solves these problems by extending the standard
+ ZCTextIndex so that it can receive and index the textual data of an
+ object's field attributes as a mapping of field names to field text. The
+ index itself performs the aggregation of the fielded data and allows
+ queries to be performed across all fields (like a standard text index) or
+ any subset of the fields which have been encountered in the objects
+ indexed.
Creating a FieldedTextIndex
@@ -123,7 +124,7 @@
Queries can also be generated directly from the web request like other
indexes. A query string or post-data can provide the query data structure
by using Zope's 'record' marshaling. Here is an example which lets
- you search any combination of 'Title', 'Description' or 'Creator'::
+ you search any combination of 'Title', 'Description' or 'Creator' ::
<form action="search_results">
<input name="SearchableFields.query:record" /><br />
@@ -141,10 +142,10 @@
formatting the result set as desired.
You can also determine the names of the fields that the index has
- encountered by using ZCatalog's 'uniqueValuesFor()' method. Here is
- a variation of the form which automatically creates checkboxes for all of
- the searchable fields::
-
+ encountered by using ZCatalog's 'uniqueValuesFor()' method. Here is a
+ variation of the form which creates a multi-select box populated with
+ all of the searchable fields::
+
<form action="search_results"
tal:define="fields python:here.portal_catalog.uniqueValuesFor('SearchableFields')">
<input name="SearchableFields.query:record" /><br />
@@ -159,7 +160,7 @@
Conclusion
- I hope you find this software this software. If you have a question,
+ I hope you find this software useful. If you have a question,
comment, feature request or find a bug please contact me at casey at zope.com.
Copyright (c) 2003, Casey Duncan and Zope Corporation
More information about the Zope-CVS
mailing list