Skip to main content

Provides a behavior for using CMFEditions with dexterity content types

Project description

Introduction
============

The ``IVersionable`` behavior is used for enabling the CMFEditions functionality
for dexterity contents. It adds a changeNote-field to the edit- and add-forms and
creates a new version when the content is edited, if enabled for the content type.

It's based on *Products.CMFEditions*. For listing the versions of an object use
CMFEdtions' view ``versions_history_form`` or the history viewlet (see default @@view).


Usage
-----

Just use the behavior ``plone.app.versioningbehavior.behaviors.IVersionable`` in
your dexterity content type.

In your *profiles/default/types/YOURTYPE.xml* add the behavior::

<?xml version="1.0"?>
<object name="example.conference.presenter" meta_type="Dexterity FTI"
i18n:domain="example.conference" xmlns:i18n="http://xml.zope.org/namespaces/i18n">

<!-- enabled behaviors -->
<property name="behaviors">
<element value="plone.app.versioningbehavior.behaviors.IVersionable" />
</property>

</object>


The IVersionable behavior just adds versioning support to your content type,
but it does not enable it.

You have to set the "versioning" option in the Plone types control panel
(/@@types-controlpanel) to either "Manual" or "Automatic" for activating
versioning.

If you want to automatically enable versioning for your custom content types
through generic setup you have to create a file "repositorytool.xml" in your
gs profile (e.g. "profiles/default") with the following content::

<?xml version="1.0"?>
<repositorytool>
<policymap>
<type name="MyType">
<policy name="at_edit_autoversion"/>
<policy name="version_on_revert"/>
</type>
<type name="AnotherType">
<policy name="at_edit_autoversion"/>
<policy name="version_on_revert"/>
</type>
</policymap>
</repositorytool>

See http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-4.0-to-4.1/updating-add-on-products-for-plone-4.1/use-generic-setup-for-defining-versioning-policies for more details.


More Information
----------------

For more information about how the versioning works see the documentations of
Products.CMFEdtitions:

* http://pypi.python.org/pypi/Products.CMFEditions
* http://plone.org/products/cmfeditions/


Changelog
=========

1.1.3 (2014-02-26)
------------------

- Include *.rst files in the release. 1.1.2 was a brown bag release.
[timo]


1.1.2 (2014-02-26)
------------------

- Remove plone.directives.form dependency since this fetches five.grok, which
is not allowed in Plone core.
[timo]


1.1.1 (2013-07-19)
------------------

- Merge Rafael Oliveira's (@rafaelbco) versions_history_form fixes
from collective.cmfeditionsdexteritycompat.
[rpatterson]

- danish translation added [tmog]

- Fixed an issue where a clone modifier would cause an incorrect
pickle due to an implementation detail in CPython's memory
allocation routine (exposed in Python as the object ``id``).
[malthe]

- Include grok when grok package is installed.
This makes sure the ZCML for the `grok` directive is loaded.
[lgraf]

- For dexterity 1.x compatibility grok the package if grok is installed.
[jone]

- Added Dutch translations.
[kingel]

- Fix case where versioning of blobs would cause an error if a
field was removed from a schema between revisions.
[mikerhodes]


1.1 (2012-02-20)
----------------

- Added French translations.
[jone]

- Fixed SkipRelations modifier to also work with behaviors which are storing
relations in attributes.
[buchi]

- Added Spanish translation.
[hvelarde]


1.0 (2011-11-17)
----------------

- Added pt_BR translation.
[rafaelbco, davisagli]

- Added support for versioning items with relations (plone.app.relationfield).
Relations are skipped on clone and added from the working copy on restore.
[buchi]


1.0b7 (2011-10-03)
------------------

* Fixed a bug in the CloneNamedFileBlobs modifier causing an AttributeError
when the previous version doesn't have a blob and the working copy has one.
[buchi]


1.0b6 (2011-09-25)
------------------

* Add missing dependency declaration on plone.namedfile[blobs].
[davisagli]


1.0b5 (2011-09-01)
------------------

* Fixed setuphandler to not fail with older versions of Products.CMFEditions
that do not have a Skip_z3c_blobfile modifier.
[buchi]

* Fixed CloneNamedFileBlobs modifier to handle fields with value ``None``.
[buchi]


1.0b4 (2011-08-11)
------------------

* Added generic setup profile which installs and enables the modifier for
cloning blobs and disables the Skip_z3c_blobfile modifier.
[buchi]

* Added support for versioning blobs (NamedBlobFile, NamedBlobImage).
[buchi]

1.0b3 (2011-03-01)
------------------

* Remove grok usage, tidy up and declare zope.app.container dependency.
[elro]

* Only version the modified object, not its container on modification.
[elro]

1.0b2 (2011-01-25)
------------------

* Changed the behavior so that the changeNote field is only
rendered in the Add and Edit forms.
[deo]

* Made sure to always try to catch the ArchivistUnregisteredError
exception at create_version_on_save (this mimics the original
handling from CMFEditions).
[deo]


1.0b1 (2010-11-04)
------------------

* Renamed package to `plone.app.versioningbehavior`.
[jbaumann]

* Load Products.CMFEditions before testing.
[jbaumann]

* Added some more tests.
[jbaumann]

* Renamed package to plone.versioningbehavior (see dexterity mailing list).
[jbaumann]

* Re-enabled IObjectAddedEvent-Eventhandler. The pickling error was fixed in
CMFEdition's trunk.
[jbaumann]

* Renamed the behavior marker interface IVersionOnSave to IVersioningSupport
because it depends on the "version" settings in the types control panel if
a content is automatically versioning on saving or not. The marker interface
should only indicate if the type could be versioned or not.
[jbaumann]

* Added locales directory with own domain for local translations.
[jbaumann]

* Updated README.txt, included doctests in long-description.
[jbaumann]

* Updated tests: events and version creation are now tested properly.
[jbaumann]

* Added helper method for getting the changenote from the request annotation.
[jbaumann]

* Storing changenote in an annotation on the request between the field-adapter
and the event handler which creates the version. That makes it possible to
use different form and widget manager prefixes.
[jbaumann]

* Added localization for the comment field.
[jbaumann]

* Disabled the Added-Event because it's not working due to a pickling problem.
[jbaumann]

* Added a form-field changeNote. It's content is used as comment for the
created version.
[jbaumann]

* Added a Event-Handler for creating a new version on save.
[jbaumann]

* Implemented the behavior plone.behaviors.versioning.behaviors.IVersionable.
[jbaumann]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plone.app.versioningbehavior-1.1.3.zip (51.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page