Changeset 1841 in products for quintagroup.catalogupdater/trunk/README.txt

Timestamp:

Mar 3, 2010 9:45:21 AM (14 years ago)

Author:

olha

Message:

Documentation files prepared for initial public release.

File:

• quintagroup.catalogupdater/trunk/README.txt (modified) (3 diffs)

quintagroup.catalogupdater/trunk/README.txt

@@ -1 @@
-Introduction
-============
+quintagroup.catalogupdater
+==========================
 
-This package is intended for extending ZCatalog API with possiblity to
-update selected columns only. This package registers 'catalog_updater'
-utility for that.
+quintagroup.catalogupdater package is intended for extending ZCatalog API
+with possiblity to update selected columns only. This package registers
+'catalog_updater' utility for that.
 
-To simplify usage of the utility, it extends GenericSetup's ZCatalog
-XMLAdapter handler, which allows to *update* attribute usage in *column*
-tag of *catalog.xml* file.
+To simplify usage of the utility, quintagroup.catalogupdater extends GenericSetup's ZCatalog XMLAdapter handler, which allows to *update* attribute usage in *column* tag of *catalog.xml* file.
 
 So, when you add a new column to the catalog, you add catalog.xml file
-in some profile with following part:
+in some profile with following part::
 
 ...
@@ -21 +19 @@
 this step you can add 'update="True"' attribute to the tag. And this
 will lead to column update after adding. Thus, result usage should look
-like this:
+like this::
 
 ...
@@ -27 +25 @@
 ...
 
-Also supports subtransactions, based on threshold property of ZCatalog.
+It also supports subtransactions, based on threshold property of ZCatalog.
+
+Installation
+------------
+
+See docs/INSTALL.txt for instructions
+
+Requirements
+------------
+
+* Plone 3.x
+
+Author
+------
+
+* Andriy Mylenkyi
+
+Copyright (c) "Quintagroup": http://quintagroup.com, 2004-2010