Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

pypm install collective.arboreal

How to install collective.arboreal

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install collective.arboreal
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
2.0 Available View build log
1.0 Available View build log
Windows (64-bit)
2.0 Available View build log
1.0 Available View build log
Mac OS X (10.5+)
2.0 Available View build log
1.0 Available View build log
Linux (32-bit)
2.0 Available View build log
1.0 Available View build log
Linux (64-bit)
2.0 Available View build log
1.0 Available View build log
Lastest release
version 2.0 on Jul 22nd, 2011

Arboreal is a tool which lets you manage multiple trees. These trees are stored within the portal. They can be used in Archetypes as a vocabulary for fields.


The tool comes with a GenericSetup profile. Therefore you can just install it by going to the portal setup system. It will create a configlet which you can access via the same portal setup.

Integration with Archetypes

The primary usage for Arboreal is to use it for hierarchical vocabularies. To make this a reality Arboreal has its own widget and field types.

An example of configuring a field within a schema is given below.

    storeCompletePath = True,

The tree is used as a vocabulary. You do not have to create this tree. Arboreal will create it automatically when it does not exist. The MultiTreeSelectionWidget is basically a multi selection widget which indents the tree nodes using spaces. This gives the visual appearance of a tree. And lastly we have the MultiArborealField. With this field you can get a list of all paths stored. The storeCompletePath keyword toggles parent storage. It is set to False by default. Parent storage works as follows.

Say you have a tree like given below:

  • Node - Subnode

If you select the sub node in the interface and store it the path will be stored. When storeCompletePath is set to False it will only contain the path to Subnode. If storeCompletePath is set to True the parent will be stored as well. An example of the differences:

storeCompletePath = False

path = [Node/Subnode]

storeCompletePath = True

path = [Node/Subnode, Node]

Storing the full path is useful for when you want to use the path as a filtering mechanism. You can then easily do a catalog query on a keyword index for a specific path. The reason we are not just using a path index is that you can select multiple points in the tree.


Martijn Pieters (mj@jarn.com) Jan Murre (jan.murre@pareto.nl) Jeroen Vloothuis (jeroen.vloothuis@pareto.nl)

Change History

2.0 - 2011-07-21
  • Add a new storeOnlyLeaves option on the field. [hannosch]
  • Adjust some templates for Plone 4 compatibility and allow renaming of nodes. [hannosch]
  • Adjust imports to match Plone 4 locations, avoid __implements__. [hannosch]
  • Add z3c.autoinclude entry point. [hannosch]
  • Update GS profile to Plone 4-style. [hannosch]
  • Update distribution metadata. [hannosch]
1.0 - 2008-09-18
  • Allow creation of nodes with a specific id. [mj]
  • Made XML import/export code accept a path, defaulting to old-hardcoded value. [mj]
  • Converted to an egg, renamed to collective.arboreal, updated to Z3 tech, replaced Install.py with a GS profile. [mj]
  • Initial import to the collective [jvloothuis, jjmurre]

Subscribe to package updates

Last updated Jul 22nd, 2011

Download Stats

Last month:2

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.