Reference

Reference#

This part of the documentation describes the machinery. It states what each part is, not how to use it. For directions toward a result, see How-to guides.

Python API

Every public name in the Python package, generated from the source.

Python API
ZCML directive

The <plone:additionalworkflows /> directive: its attributes, its validation, and the errors it raises.

ZCML directive
Catalog index

The workflow_states index: the values it holds, the order it holds them in, and how review_state queries are rewritten onto it.

Catalog index
REST API

The additions to the @workflow and @history endpoints, with generated request and response examples.

REST API
Volto add-on

The components, helpers, actions, and types the Volto add-on exports.

Volto add-on
Profiles

The GenericSetup profiles this package ships, and what each one applies.

GenericSetup profiles
Compatibility

The release status, the Plone, Python, and Volto versions tested, Classic UI, and the changelogs.

Compatibility