Default content types for Plone based on Dexterity
Project description
Introduction
plone.app.contenttypes offers default content types for Plone based on Dexterity. This package is a replacement for the types in Products.ATContenttypes.
Warning: plone.app.contenttypes is best used when creating a new site from scratch. Using it on a site with existing content is not recommended if you don’t know exactly what you’re doing!
It contains the same types as default Plone does:
Folder
Document
News item
File
Image
Link
Event (this will be replaced by plone.app.event soon)
Collection (this already replaces plone.app.collection which is no longer needed then)
The main difference from a users perspective is that these types are extendable through-the-web. This means you can go to the control-panel (.../@@dexterity-types) and add or remove fields and behaviors for the existing types.
The aim is to mimick the old default-types as closely as possible, not to change the content-creation experience for editors.
plone.app.contenttypes has been merged into the Plone 5.0 branch and will be shipped with the next Plone release: https://dev.plone.org/ticket/12344
Compatability
plone.app.contenttypes works with Plone 4.1+
Installation
Add this line in the eggs section of your buildout.cfg:
eggs =
...
plone.app.contenttypes
If you have a mixed Plone site with Archetypes content and dexterity content use the extra requirement plone.app.contenttypes['at_refs'].
Installing plone.app.contenttypes in an existing Plone-site
When you try to install plone.app.contenttypes in a existing site you might get the following error:
(...) Module Products.GenericSetup.utils, line 509, in _importBody Module Products.CMFCore.exportimport.typeinfo, line 60, in _importNode Module Products.GenericSetup.utils, line 730, in _initProperties ValueError: undefined property 'schema'
Before installing plone.app.contenttypes you have to reinstall plone.app.collection to update collections to the version that uses Dexterity.
What happens to old content?
The old Archetypes-based content still exists and can be viewed but can’t be edited. On installation plone.app.contenttypes removes the type-definitions for the old default-types like this:
<object name="Document" remove="True" />
You can also migrate the old items to the types provided by plone.app.contenttypes (see the section about migrations).
Uninstalling
To remove plone.app.contenttypes, return full functionality to old content and restore the AT-based default-types you have to install the import step “Types Tool” of the current base profile. Follow the following steps:
in the ZMI navigate to portal_setup and the tab “import”
in “Select Profile or Snapshot” leave “Current base profile (<Name of your Plonesite>)” selected. This is usually Products.CMFPlone
select the Types Tool (usually Step 44)
click “import selected steps”
Migration
Warning: Migrations are still in an very early stage and might break your site! plone.app.contenttypes is best used when creating a new site from scratch. Please proceed at your own risk!
For migrations to work you need at least Products.contentmigration = 2.1.3.
For migration sites use the extra requirement plone.app.contenttypes['migrate_atct'].
This version plone.app.contenttypes comes with migrations for the following use-cases:
from default Archetypes-based types to plone.app.contenttypes
from older versions of plone.app.contenttypes to current versions
Migrations that will be will come in the future:
from old p.a.c.-event to DX-plone.app.event
from AT-plone.app.event to DX-plone.app.event
from atct ATEvent to DX-plone.app.event
from ATTopic to DX-plone.app.collections
from AT-plone.app.collection to DX-plone.app.collections
Theres already a working migration from atct ATEvent to AT-plone.app.event in the plone.app.event package implemented as an upgrade step.
Migrating Archetypes-based content to plone.app.contenttypes
plone.app.contenttypes can migrate the following types:
Folder
Document
News item
File
Image
Link
To migrate existing content go to /@@migrate_from_atct.
TODO:
LinguaPlone
Plone-Version older tan 4.1.x need plone.app.intid
Migrating content that is translated with LinguaPlone
Warning: This use-case has not yet been thoroughly tested!*
Since LinguaPlone does not support Dexterity you need to migrate from LinguaPlone to plone.app.multilingual (http://pypi.python.org/pypi/plone.app.multilingual). The migration from Products.LinguaPlone to plone.app.multilingual should happen before the migration from Archetypes to plone.app.contenttypes. For details on the migration see http://pypi.python.org/pypi/plone.app.multilingual#linguaplone-migration
Migrating from old versions of plone.app.contenttypes
Before version 1.0a2 the content-items did not implement marker-interfaces. They will break in newer versions since the views are now registered for these interfaces (e.g. plone.app.contenttypes.interfaces.IDocument). To fix this you can call the view /@@fix_base_classes on your site-root.
Migrating content that was extended with archetypes.schemaextender
The migration should warn you if your typs are extended with archetypes.schemaextender. The data contained in these fields will be lost.
You need to implement for each schemaextender an own behavior and modify the whole migration. This is an advanced development task.
How to create a new page with only Dexterity
You have two options:
1. By hand
Installing plone.app.contenttypes remove the types automatically, you only have to remove the existing content (front-page, events, news, members).
2. Automatically
If you start from scratch you can want to try using a special branch of Products.CMFPlone that gives you the choice between Dexterity and Archetypes when creating a new site. This way you get a brand new site with
Modify your buildout to automatically pull the branch using mr.developer (http://pypi.python.org/pypi/mr.developer):
[buildout]
extensions = mr.developer
auto-checkout =
Products.CMFPlone
Products.ATContentTypes
[sources]
Products.CMFPlone = git https://github.com/plone/Products.CMFPlone.git branch=plip-12344-plone.app.contenttypes
Products.ATContentTypes = git https://github.com/plone/Products.ATContentTypes.git branch=davisagli-optional-archetypes
Differences to Products.ATContentTypes
The image of the News Item is not a field on the contenttype but a behavior that can add a image to any contenttypes (similar to http://pypi.python.org/pypi/collective.contentleadimage)
Dependencies
plone.app.dexterity. Dexterity is shipped with Plone 4.3.x. Version pinns for Dexterity are included in Plone 4.2.x. For Plone 4.1.x you need to pin the correct version for Dexterity in your buildout. See Installing Dexterity on older versions of Plone <http://developer.plone.org/reference_manuals/external/plone.app.dexterity/install.html#installing-dexterity-on-older-versions-of-plone>.
plone.app.collection.
Design descisions
TODO
Information for Addon-Developers
Differences to ATContentTypes Interfaces
How to:
extend the types ttw or with xml ()
export a extended CT into a package to overwrite the default
extend with behaviors
make types transateable
Addon-Products that are known to work with p.a.c
License
GNU General Public License, version 2
Roadmap
Contributors
Philip Bauer <bauer@starzel.de>
Michael Mulich <michael.mulich@gmail.com>
Timo Stollenwerk <contact@timostollenwerk.net>
Peter Holzer <hpeter@agitator.com>
Patrick Gerken
Steffen Lindner
Daniel Widerin
Jens Klein <jens@bluedynamics.com>
TODO: add all contributors
Thanks to
The organizers of the Plone-Conference 2011 in San Francisco for a great conference!
The organizers of the Wine-and-Beer-Sprint in Munich and Capetown in January 2013
The creators of Dexterity
Changelog
1.0rc1 (2013-09-24)
Implement a tearDownPloneSite method in testing.py to prevent test isolation problems. [timo]
Its possible to upload non-image data into a newsitem. The view was broken then. Now it shows the uploaded file for download below the content. Its no longer broken. [jensens]
Add contributor role as default for all add permissions in order to work together with the different plone worklfows, which assume it is set this way. [jensens]
fix #60: File Type has no mimetype specific icon in catalog metadata. Also fixed for Image. [jensens]
fix #58: Migration ignores “Exclude from Navigation”. [jensens]
disable LinkIntegrityNotifications during migrations, closes #40. [jensens]
Fix Bug on SearchableText_file indexer when input stream contains characters not convertable in ASCII. Assumes now utf-8 and replaces all unknown. Even if search can not find the words with special characters in, indexer does not break completely on those items. [jensens]
Remove dependency on plone.app.referenceablebehavior, as it depends on Products.Archetypes which installs the uid_catalog. [thet]
Make collection syndicatable. [vangheem]
Include the migration module not only when Products.ATContentTypes is installed but also archetypes.schemaextender. The schemaextender might not always be available. [thet]
Add fulltext search of file objects. [do3cc]
Fix link_redirect_view: Use index instead of template class var to let customization by ZCML of the template. [toutpt]
Add a permission for each content types. [toutpt]
1.0b2 (2013-05-31)
Fix translations to the plone domain, and some translations match existing translations in the plone domain. (ported from plone.app.collection) [bosim]
Fix atct_album_view and don’t use atctListAlbum.py. [pbauer]
Add constrains for content create with the Content profile. [ericof]
Add SearchableText indexer to Folder content type. [ericof]
Fix atct_album_view. [pbauer]
Removed dependency for collective.dexteritydiff since its features were merged into Products.CMFDiffTool. [pbauer]
Add test for behavior table_of_contents. [pbauer]
Add migration for blobnewsitems as proposed in https://github.com/plone/plone.app.blob/pull/2. [pbauer]
Require cmf.ManagePortal for migration. [pbauer]
Always migrate files and images to blob (fixes #26). [pbauer]
Add table of contents-behavior for documents. [pbauer]
Add versioning-behavior and it’s dependencies. [pbauer]
Remove image_view_fullscreen from the display-dropdown. [pbauer]
Enable selecting addable types on folders by default. [pbauer]
Fix reference-migrations if some objects were not migrated. [pbauer]
Keep the order references when migrating. [pabo3000]
Move templates into their own folder. [pbauer]
Moved migration related code to specific module. [gborelli]
Added migration Collection from app.collection to app.contenttypes. [kroman0]
Add missing i18n:attributes to ‘Edit’ and ‘View’ actions of File type. [saily]
Bind ‘View’ action to ${object_url}/view instead of ${object_url} as in ATCT for File and Image type. [saily]
Fixed installation of p.a.relationfield together with p.a.contenttypes. [kroman0]
Fixed creating aggregator of events on creating Plone site. [kroman0]
Added titles for menuitems. [kroman0]
Hide uninstall profile from @@plone-addsite. [kroman0]
Fix ‘ImportError: cannot import name Counter’ for Python 2.6. http://github.com/plone/plone.app.contenttypes/issues/19 [timo]
Move XML schema definitions to schema folder. [timo]
Prevent the importContent step from being run over and over again. [pysailor]
Add build status image. [saily]
Merge plone.app.collection (Tag: 2.0b5) into plone.app.contenttypes. [timo]
Refactor p.a.collection robot framework tests. [timo]
1.0b1 (2013-01-27)
Added mime type icon for file. [loechel]
Lead image behavior added. [timo]
Make NewsItem use the lead image behavior. [timo]
SearchableText indexes added. [reinhardt]
Set the text of front-page when creating a new Plone. [pbauer]
Robot framework test added. [Gomez]
1.0a2 (unreleased)
Move all templates from skins to browser views. [timo]
User custom base classes for all content types. [timo]
Migration view (@@fix_base_classes) added to migrate content objects that were created with version 1.0a1. [timo]
Mime Type Icon added for File View. [loechel]
1.0a1 (unreleased)
Initial release.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for plone.app.contenttypes-1.0rc1.zip
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c26e312ba8dc106138a1d9e0715b83325d539a4ea716abcd04faa839419367ba |
|
| MD5 | 505b20d13f60ce4a2f4aaf154302586f |
|
| BLAKE2b-256 | 8dfdf0de2fd7035fb8055d40bc40ea3c50b7c0e67a449e6702375b77a7bb5ecb |
