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

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

doc files updated.

  • Property svn:eol-style set to native
File size: 1.2 KB
Line 
1Introduction
2============
3
4quintagroup.canonicalpath package brings canonical path calculation
5functionality to Plone. The package allows to define path and/or link
6to the object, which may differ from standard physical path or its URL
7in portal.
8
9It's used by such products as quintagroup.seoptimizer (for defining
10canonical link of the object) and quintagroup.plonegooglesitemaps (on
11google sitemaps generation).
12
13This package is intended for bringing *canonical_path* and/or
14*canonical_link* property to any traversable object. For that purpose
15it defines ICanonicalPath and ICanonicalLink interfaces, and registers
16basic adapters for ITraversable objects.
17
18This package also registers *canonical_path* and *canonical_link* indexes
19for possible usage in catalog (ZCatalog).
20
21Default adapters behaviour:
22
23- *canonical_path* returns path from portal root, i.e. for
24    `/plone/front-page` *canonical_path* will be `/front-page`.
25
26- *canonical_link* returns absoulute url of the object.
27
28
29Supported Plone version
30-----------------------
31
32* 3.x
33
34
35Authors
36-------
37
38The product was developed by Quintagroup.com team:
39
40* Andriy Mylenkyi
41* Taras Melnychuk
42* Volodymyr Cherepanyak
43
44Copyright (c) "Quintagroup": http://quintagroup.com, 2004-2010
Note: See TracBrowser for help on using the repository browser.