Extended Path Index

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.

Project Description

Note: You normally don't need to install this separately, as it ships as a standard part of Plone 2.1 and up. This download is for people wanting to use it outside of Plone or in earlier releases of Plone.

ExtendedPathIndex was developed by Helge Tesdal from Jarn (Previously Plone Solutions) based on the original PathIndex from Zope Corporation. Thanks, guys!

This index 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.

Features

• Can construct a site map with a single catalog query
• Can construct a navigation tree with a single catalog query

Navigation tree feature comparison

Advantages over the current (Plone 1.0/2.0) navtree implementation

• Doesn't wake up any objects
• Much lower RAM consumption
• Massively improved performance
• Catalog based instead of traversal based

Usage

• catalog(path="some/path") - search for all objects below some/path
• catalog(path={"query":"some/path", "depth":2) - search for all objects below some/path but only down to a depth of 2
• catalog(path={"query":"some/path", "navtree":1) - 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.

Credits

• Zope Corporation for the initial PathIndex code
• Helge Tesdal from Jarn for the ExtendedPathIndex implementation

License

This software is released under the ZPL license.