Changeset 1709 in products


Ignore:
Timestamp:
Feb 11, 2010 12:50:38 PM (14 years ago)
Author:
mylan
Message:

Add some description text in README file

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r782 r1709  
    11quintagroup.canonicalpath Package Readme 
    2 ========================= 
     2======================================== 
    33 
    4 Overview 
    5 -------- 
     4Canonical path serves for possibility to define path, which may be 
     5different from standard Physical path in portal. It's uses by such 
     6products as quintagroup.seoptimizer (for defining canonical url of the 
     7object), quintagroup.plonegooglesitemaps (on google sitemap 
     8generation). 
    69 
    7 Bring canonical path calculation functionality 
     10This package intended for bring *canonical_path* property to any 
     11traversable object.  For that it defines ICanonicalPath interface, and 
     12register basic adapter for ITraversable. 
    813 
     14Also package register canonical_path indexer for possible usage in 
     15catalog (ZCatalog). 
    916 
    10 Your tests here 
    11 --------------- 
    12  
    13     >>> 1 + 1 
    14     3 
     17Default adapter return path from portal root, i.e. for 
     18`/plone/front-page` *canonical_path* will be `/front-page`. 
Note: See TracChangeset for help on using the changeset viewer.