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

Last change on this file since 2151 was 2151, checked in by mylan, 14 years ago

#148: Update readme with canonical link usage explanation

  • Property svn:eol-style set to native
File size: 941 bytes
Line 
1quintagroup.canonicalpath Package Readme
2========================================
3
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).
9
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.
14
15Also package register *canonical_path* and *canonical_link* indexers
16for possible usage in catalog (ZCatalog).
17
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 TracBrowser for help on using the repository browser.