source: products/quintagroup.canonicalpath/trunk/quintagroup/canonicalpath/README.txt @ 3599

Last change on this file since 3599 was 2154, checked in by olha, 14 years ago

doc files updated.

  • Property svn:eol-style set to native
File size: 960 bytes
RevLine 
[2154]1quintagroup.canonicalpath package brings canonical path calculation
2functionality to Plone. The package allows to define path and/or link
3to the object, which may differ from standard physical path or its URL
4in portal.
[782]5
[2154]6It's used by such products as quintagroup.seoptimizer (for defining
7canonical link of the object) and quintagroup.plonegooglesitemaps (on
[2151]8google sitemaps generation).
[782]9
[2154]10This package is intended for bringing *canonical_path* and/or
11*canonical_link* property to any traversable object. For that purpose
12it defines ICanonicalPath and ICanonicalLink interfaces, and registers
[2151]13basic adapters for ITraversable objects.
[782]14
[2154]15This package also registers *canonical_path* and *canonical_link* indexes
[2151]16for possible usage in catalog (ZCatalog).
[782]17
[2151]18Default adapters behaviour:
19
[2154]20  - *canonical_path* returns path from portal root, i.e. for `/plone/front-page` *canonical_path* will be `/front-page`.
21  - *canonical_link* returns absoulute url of the object.
Note: See TracBrowser for help on using the repository browser.