PortalContentFolder (for CMF) is a mix of both PortalContent and SkinnedFolder, so that you can have a folder-like object that gets catalogged and is subject to the workflow.

If you need an object that has to be catalogged (because it has to be found in a Search, or is to be displayed using searchResults) or workflowed, and at the same time have subobjects, then you should use this.

PortalContentFolder is a base class that can be used as a Factory-based Type in the Types Tool. It can also be used as a base ZClass.

PortalContentFolder derives from SkinnedFolder so the index_html method is predefined and automatically calls the view action.

Important note about the workflow

The worklfow is not aware of any special relationship between the folder and its children, this means for instance that the folder can be private while its children are published.

In some situations this will not be what you want, but PortalContentFolder aims first at simplicity. Doing anything more complex will need redesigning parts of the WorkflowTool (and is on my todo-list but it's another story).

How to use it in the Portal Types

Go to portal_types and add a new Factory-based Type Information, select PortalContentFolder: PortalContentFolder as a default, and use a suitable id.

Go to you new Type, in the Actions tab you can modify the actions, especially the one with id view which will be called by the PortalContentFolder when its index_html method is called.

You should give the view action a Category of object and it will appear in the action box with the other object actions. The default is to call folder_contents but of course you will likely call you own skin method here.

Note that because PortalContentFolder is folderish, CMF will always display a "Folder contents" action pointing to the method folder_contents, this is hardcoded in CMF 1.2.

You can now use it like any other Portal Type.