[Checkins] SVN: Produts.RecentItemsIndex/trunk/ Move overview into docs.
Tres Seaver
tseaver at palladion.com
Tue Mar 16 18:21:06 EDT 2010
Log message for revision 110003:
Move overview into docs.
Changed:
U Produts.RecentItemsIndex/trunk/README.txt
U Produts.RecentItemsIndex/trunk/docs/index.rst
-=-
Modified: Produts.RecentItemsIndex/trunk/README.txt
===================================================================
--- Produts.RecentItemsIndex/trunk/README.txt 2010-03-16 22:20:55 UTC (rev 110002)
+++ Produts.RecentItemsIndex/trunk/README.txt 2010-03-16 22:21:06 UTC (rev 110003)
@@ -1,20 +1,4 @@
Products.RecentItemsIndex README
================================
-This product provides a ZCatalog index designed to optimize queries which
-ask for the most recent objects that match a certain value for an attribute.
-The designed usage is a query for the most recent objects of a particular
-portal type.
-
-The index only retains up to a fixed number of items for each field
-value which means that the performance of queries using the index
-are independant of the size of the catalog.
-
-The index also has a custom query interface so that applications
-may query it directly for greatest efficiency since it handles both
-the result selection and sorting simultaneously.
-
-At the moment the index is not searchable through the standard ZCatalog
-``searchResults()`` API. This is because the catalog does not yet support
-indexes that can do searching and sorting simultaneously as this one
-does.
+Please see ``docs/index.rst`` for the product documentation.
Modified: Produts.RecentItemsIndex/trunk/docs/index.rst
===================================================================
--- Produts.RecentItemsIndex/trunk/docs/index.rst 2010-03-16 22:20:55 UTC (rev 110002)
+++ Produts.RecentItemsIndex/trunk/docs/index.rst 2010-03-16 22:21:06 UTC (rev 110003)
@@ -1,16 +1,31 @@
-.. Projects.RecentItemsIndex documentation master file, created by
- sphinx-quickstart on Tue Mar 16 18:05:54 2010.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
+Products.RecentItemsIndex
+=========================
-Welcome to Projects.RecentItemsIndex's documentation!
-=====================================================
+This product provides a ZCatalog index designed to optimize queries which
+ask for the most recent objects that match a certain value for an attribute.
+The designed usage is a query for the most recent objects of a particular
+portal type.
+The index only retains up to a fixed number of items for each field
+value which means that the performance of queries using the index
+are independant of the size of the catalog.
+
+The index also has a custom query interface so that applications
+may query it directly for greatest efficiency since it handles both
+the result selection and sorting simultaneously.
+
+At the moment the index is not searchable through the standard ZCatalog
+``searchResults()`` API. This is because the catalog does not yet support
+indexes that can do searching and sorting simultaneously as this one
+does.
+
Contents:
.. toctree::
:maxdepth: 2
+ CHANGES
+
Indices and tables
==================
More information about the checkins
mailing list