Home
Products.ExtendedPathIndex (2.8)
by
Ihor Berehulyak
—
last modified
2010-05-07
Released on 2010-05-01 by Jarn, Helge Tesdal under Zope Public License (ZPL) available for All platforms.
Software development stage: stable
- Products.ExtendedPathIndex download link: http://plone.org/products/extendedpathindex/releases
- Homepage of Products.ExtendedPathIndex: http://plone.org/products/extendedpathindex/
- Products.ExtendedPathIndex repository: https://svn.plone.org/svn/plone/ExtendedPathIndex
- Description source: http://svn.plone.org/svn/plone/Products.ExtendedPathIndex/trunk/README.txt
Extended Path Index is an extended index type based on the Zope index type that has additional query methods that are especially suited to generating navigation trees, site maps - and also supports querying a single folder, something the standard PathIndex can't do.
This is an index that supports depth limiting, and the ability to build a structure usable for navtrees and sitemaps. The actual navtree implementations are not (and should not) be in this Product, this is the index implementation only.
Assumptions
EPI makes an assumption about the catalog and index being in the same container as all the content. This makes a lot of sense in a Plone setting, but might not work as expected in other scenarios.
A query like /plonesite/folder, level=0 is transformed internally to /folder, level=1. This avoids touching the rather large plonesite set which contains reference to all content in your site.
Features
- Can construct a site map with a single catalog query
- Can construct a navigation tree with a single catalog query
Usage
- catalog(path='some/path')
- search for all objects below some/path (recursive, equivalent to depth = -1)
- catalog(path=dict(query='some/path', depth=0))
- search for the object with the given path.
- catalog(path=dict(query='some/path', depth=2))
- search for all objects below some/path but only down to a depth of 2
- catalog(path=dict(query='some/path', navtree=True))
- search for all objects below some/path for rendering a navigation tree. This includes all objects below some/path up to a depth of 1 and all parent objects.
- catalog(path=dict(query='some/path', navtree=True, depth=0))
- search for all objects below some/path for rendering a breadcrumb trail. This includes only the parent objects themselves.
- catalog(path=dict(query='some/path', navtree=True, navtree_start=1))
- search for all objects below some/path for rendering a partial navigation tree. This includes all objects below the path but stops 1 level above the root. The given path is included, even if it is at a shorter path in the portal than the level parameter would allow.
- catalog(path=dict(query='some/path', navtree=True, depth=0, navtree_start=1))
- search for all objects below some/path for rendering a partial breadcrumb trail. This includes all parents below the path but stops 1 level above the root. The given path is included, even if it is at a lower level in the portal than the start parameter would allow.
- catalog(path=dict(query='some/path', level=2))
- search for all objects whose path contains some/path at level 2. This includes paths like /foo/bar/some/path and /spam/eggs/some/path, plus all children of those paths.
- catalog(path=dict(query='some/path', level=-1, depth=0))
- search for all objects whose path contains some/path at any level. This includes paths like /spam/some/path as well as /foo/bar/baz/some/path, but only those exact matches are included in the result because depth is set to 0.
- catalog(path=dict(query=(('foo/bar', 2), ('bar/baz'), 1), depth=0))
- search for multiple paths, each at different levels (foo/bar at level 2, and bar/baz at level 1), and return exact matches only.
