Changeset 2154 in products for quintagroup.canonicalpath/trunk/quintagroup/canonicalpath/README.txt

Timestamp:

Apr 19, 2010 3:02:04 PM (14 years ago)

Author:

olha

Message:

doc files updated.

File:

• quintagroup.canonicalpath/trunk/quintagroup/canonicalpath/README.txt (modified) (1 diff)

quintagroup.canonicalpath/trunk/quintagroup/canonicalpath/README.txt

@@ -1 @@
-quintagroup.canonicalpath Package Readme
-========================================
+quintagroup.canonicalpath package brings canonical path calculation 
+functionality to Plone. The package allows to define path and/or link 
+to the object, which may differ from standard physical path or its URL
+in portal.
 
-The package serves for possibility to define path and/or link for the
-object, which may differ from standard Physical path or URL in portal.
-It's uses by such products as quintagroup.seoptimizer (for defining
-canonical link of the object), quintagroup.plonegooglesitemaps (on
+It's used by such products as quintagroup.seoptimizer (for defining
+canonical link of the object) and quintagroup.plonegooglesitemaps (on
 google sitemaps generation).
 
-This package intended for bring *canonical_path* and/or
-*canonical_link* property to any traversable object. For that it
-defines ICanonicalPath and ICanonicalLink interfaces, and register
+This package is intended for bringing *canonical_path* and/or
+*canonical_link* property to any traversable object. For that purpose
+it defines ICanonicalPath and ICanonicalLink interfaces, and registers
 basic adapters for ITraversable objects.
 
-Also package register *canonical_path* and *canonical_link* indexers
+This package also registers *canonical_path* and *canonical_link* indexes
 for possible usage in catalog (ZCatalog).
 
 Default adapters behaviour:
 
-  - *canonical_path* return path from portal root, i.e. for
-    `/plone/front-page` *canonical_path* will be `/front-page`.
-  - *canonical_link* return absoulute url of the object.
+  - *canonical_path* returns path from portal root, i.e. for `/plone/front-page` *canonical_path* will be `/front-page`.
+  - *canonical_link* returns absoulute url of the object.