Dexterity content subsystem for Plone: info for the developers.


Dexterity is a subsystem for content objects. It is intended to replace the default Archetypes system from Plone 5 and onward and can be already used with Plone 4.

ZopeSkel templates

Please see ZopeSkel page for project skeleton templates for Dexterity.

Here is an example how to create your own add-on using the buildout below

cd src
../bin/zopeskel dexterity

Edit buildout.cfg and add:

eggs =

develop =

Then rerun buildout to get your new add-on skeleton included in the configuration

cd ..

Now you can start adding content into your add-on

cd src/
../../bin/paster # Shows availablility of addcontent command
../../bin/paster addcontent -l # Shows available templates (content, field, behavior, etc...)

Buildout example

Below is a sample example which will install

  • Plone 4.1 beta 1
  • Dexterity 1.0 beta 7
  • Paster command + Dexterity templates

Please tune the versions according the latest available releases.


parts =

extends =

# Add additional egg download sources here. contains archives
# of Plone packages.
find-links =

extensions =

sources = sources

versions = versions

# Reference any folders where you have Python egg source code under development here
# e.g.: develop = src/my.package
# If you are using the mr.developer extension and have the source code in a
# repository mr.developer will handle this automatically for you
develop =

# Create bin/instance command to manage Zope start up and shutdown
recipe = plone.recipe.zope2instance
user = admin:admin
http-address = 8080
debug-mode = off
verbose-security = on
blob-storage = var/blobstorage

eggs =

# Some pre-Plone 3.3 packages may need you to register the package name here in
# order their configure.zcml to be run (
# - this is never required for packages in the Products namespace (Products.*)
zcml =

# zopepy commands allows you to execute Python scripts using a PYTHONPATH
# including all the configured eggs
recipe = zc.recipe.egg
eggs = ${instance:eggs}
interpreter = zopepy
scripts = zopepy

# create bin/i18ndude command
unzip = true
recipe = zc.recipe.egg
eggs = i18ndude

# create bin/test command
recipe = zc.recipe.testrunner
defaults = ['--auto-color', '--auto-progress']
eggs =

recipe = zc.recipe.egg
eggs =
entry-points = paster=paste.script.command:run

# create ZopeSkel command
unzip = true
recipe = zc.recipe.egg
eggs =

# symlinks all Python source code to parts/omelette folder when buildout is run
# windows users will need to install additional software for this part to build
# correctly.  See for
# relevant details.
recipe = collective.recipe.omelette
eggs = ${instance:eggs}

# Put your mr.developer managed source code repositories here, see
# for details on format for this part
collective.developermanual = git git://

# Version pindowns for new style products go here - this section extends one provided in

Content creation permissions

By default, (global) Dexterity content types are addable to a folder if the editor has the cmf.AddPortalContent permission.

You might want to fine-tune permissions so that only certain privileged members are allowed to create certain content types.


This behavior differs from Archetypes behavior where each content type was automatically assigned a permission for controlling its creation.

Create a permission with collective.autopermission in configure.zcml

<include package="collective.autopermission" />
<permission id="" title=" Add Super Content" />

Make sure that this permission becomes available on your site by adding the following to rolemap.xml

<?xml version="1.0"?>
         name=" Add Super Content"
         <role name="Manager" />

Add in your content type GenericSetup XML

<!-- add permission -->
<property name="add_permission"></property>

Reinstall your add-on.

Confirm that the new permission appears on the Security tab in the ZMI root.

Exclusion from navigation

This must be enabled separately for Dexterity content types with a behavior.

<property name="behaviors">
    <element value="" />
    <element value=""/>
    <element value=""/>

Then you can manually also check this property:

for t in self.tabs:
    nav = None
        nav = IExcludeFromNavigation(t)
    if nav:
        if nav.exclude_from_nav == True:
            # FAQ page - do not show in tabs

Custom add form/view

Dexterity relies on traverser hook defined in Products/CMFCore/

It will look up a multi-adapter using this expression:

if ti is not None:
    add_view = queryMultiAdapter((self.context, self.request, ti),
    if add_view is None:
        add_view = queryMultiAdapter((self.context, self.request, ti))

The name parameter is the portal_types id of your content type.

You can register such an adapter in configure.zcml




Then you can inherit from the proper plone.dexterity base classes:

from plone.dexterity.browser.add import DefaultAddForm, DefaultAddView

class AddForm(DefaultAddForm):

    def update(self):

    def updateWidgets(self):
        """ """
        # Some custom code here

    def getBlockPlanJSON():
        return getBlockPlanJSON()

class AddView(DefaultAddView):
    form = AddForm

See also:

Custom edit form


from five import grok
from plone.directives import dexterity

class EditForm(dexterity.EditForm):


    def updateWidgets(self):
        """ """

        # XXX: customize widgets here

Table Of Contents

About Plone

This is documentation for Plone®. Plone is a popular, open source, content management system written in Python programming language.


This documentation page was brought you by these awesome persons:

Edit this document

The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.

  1. Go to Dexterity on GitHub.
  2. Press the Fork button. This will create your own personal copy of the documentation.
  3. Edit files using GitHub's text editor in your web browser
  4. Fill in the Commit message text box at the end of the page telling why you did the changes. Press the Propose file change button next to it when done.
  5. Then head to the Send a pull request page (you won't need to fill in any additional text). Just press Send pull request button.
  6. Your changes are now queued for review under project's Pull requests tab on Github.

For basic information about updating this manual and Sphinx format please see Writing and updating the manual guide.