Welcome to “djangocms-versioning“‘s documentation!

Quick Start:

• Introduction
  • Version states
  • Effect on the model’s manager
• Integrating Versioning
  • Change the model structure
  • Register the model for versioning
  • Accessing content model objects
  • Implement a custom copy function
  • Adding Versioning Entries to a Content Model Admin
  • Adding status indicators to a versioned content model
  • Adding Status Indicators and Versioning Entries to a versioned content model
  • Adding Versioning Entries to a Grouper Model Admin
  • Summary admin options
  • Additional/advanced configuration
• Permissions in djangocms-versioning
  • Understanding Permissions
  • Conclusion
• Locking versions
  • Explanation
  • Activation
  • Email notifications

API Reference:

• Advanced configuration
  • Overriding how versioning handles core cms models
  • Adding to the context of versioning admin views
  • Additional options on the VersionableItem class
• Signals
  • How to use the version publish and un-publish signal for a CMS Page
  • Handling the effect of a (un-)publish to other items via signals
• Customizing the Version Table Admin View
  • Changing breadcrumbs
  • Changing the preview url
  • Adding additional UI filters
• Management command
  • create_versions
• Settings for djangocms Versioning
  • DJANGOCMS_VERSIONING_ALLOW_DELETING_VERSIONS
  • DJANGOCMS_VERSIONING_ENABLE_MENU_REGISTRATION
  • DJANGOCMS_VERSIONING_LOCK_VERSIONS
  • DJANGOCMS_VERSIONING_USERNAME_FIELD
  • DJANGOCMS_VERSIONING_DEFAULT_USER
  • DJANGOCMS_VERSIONING_ON_PUBLISH_REDIRECT

Internals:

• The Admin with Versioning
  • The content model admin
  • The Version model admin

Release notes:

• 2.0.0 release notes (unreleased)
  • Django and Python compatibility
  • Features
  • Backwards incompatible changes in 2.0.0
  • Miscellaneous
  • Bug fixes

Glossary

version model

A model that stores information such as state (draft, published etc.), author, created and modified dates etc. about each version.

content model

A model with a one2one relationship with the version model, which stores version data specific to the content type that is being versioned. It can have relationships with other models which could also store version data (for example in the case of a poll with many answers, the answers would be kept in a separate model, but would also be part of the version).

grouper model

A model with a one2many relationship with the content model. An instance of the grouper model groups all the versions of one object. It is in effect the object being versioned. It also stores data that is not version-specific.

extra grouping field

The content model must always have a foreign key to the grouper model. However, the content model can also have additional grouping fields. This is how versioning is implemented for the cms.PageContent model, where PageContent.language is defined as an extra grouping field. This supports filtering of objects by both its grouper object and its extra grouping fields in the admin and in any other implementations (in the page example, this ensures that the latest version of a German alias would not be displayed on an English page).

copy function

When creating a new draft version, versioning will usually copy an existing version. By default it will copy the current published version, but when reverting to an old version, a specific unpublished or archived version will be used. A customizable copy function is used for this.