Changeset 2151 in products


Ignore:
Timestamp:
Apr 19, 2010 1:34:01 PM (14 years ago)
Author:
mylan
Message:

#148: Update readme with canonical link usage explanation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • quintagroup.canonicalpath/trunk/quintagroup/canonicalpath/README.txt

    r1709 r2151  
    22======================================== 
    33 
    4 Canonical path serves for possibility to define path, which may be 
    5 different from standard Physical path in portal. It's uses by such 
    6 products as quintagroup.seoptimizer (for defining canonical url of the 
    7 object), quintagroup.plonegooglesitemaps (on google sitemap 
    8 generation). 
     4The package serves for possibility to define path and/or link for the 
     5object, which may differ from standard Physical path or URL in portal. 
     6It's uses by such products as quintagroup.seoptimizer (for defining 
     7canonical link of the object), quintagroup.plonegooglesitemaps (on 
     8google sitemaps generation). 
    99 
    10 This package intended for bring *canonical_path* property to any 
    11 traversable object.  For that it defines ICanonicalPath interface, and 
    12 register basic adapter for ITraversable. 
     10This package intended for bring *canonical_path* and/or 
     11*canonical_link* property to any traversable object. For that it 
     12defines ICanonicalPath and ICanonicalLink interfaces, and register 
     13basic adapters for ITraversable objects. 
    1314 
    14 Also package register canonical_path indexer for possible usage in 
    15 catalog (ZCatalog). 
     15Also package register *canonical_path* and *canonical_link* indexers 
     16for possible usage in catalog (ZCatalog). 
    1617 
    17 Default adapter return path from portal root, i.e. for 
    18 `/plone/front-page` *canonical_path* will be `/front-page`. 
     18Default adapters behaviour: 
     19 
     20  - *canonical_path* return path from portal root, i.e. for 
     21    `/plone/front-page` *canonical_path* will be `/front-page`. 
     22  - *canonical_link* return absoulute url of the object. 
Note: See TracChangeset for help on using the changeset viewer.