README for the CMFFSContent product

  The CMFFSContent product aims to provide CMF content types representing
  filesystem-based CMFish content. There are filesystem equivalents for
  various CMF content types, such as Folders, Documents, Images and more.

  These content types are read-only. They cannot be changed through the 
  CMS-interface at all. No writes to disk will occur at all.

  This product is handy if you have folder structures in your portal that
  contain content items only edited by the site administrators, because
  now you can put them on the file system and into source control systems
  like CVS or SVN alongside with your code.

  **How to use it**

    First of all, you need to install the CMFFSContent setup profile. If you
    are creating a new portal, simply check the 'CMFFSContent' checkbox 
    under 'Optional extensions'. If you have an existing CMF site, simply
    visit the 'Properties' tab in the 'portal_setup' tool. Select
    'CMFFSContent' on the select box and press 'Update'. Then move to the
    'Import' tab and press 'Import all steps'.

    You can now add folders of type 'FSFolder', but they are not very useful
    until at least one directory on the file system has been registered as a 
    provider for filesystem content. The mechanism for doing so is similar 
    to the registration of skins directories from your product code::

      from Products.CMFFSContent.FSFolder import registerContentDirectory
      registerContentDirectory(directory_name, globals())

    In this case, 'directory_name' is the name of the filesystem directory
    you are registering. See the __init__.py file in this directory for a
    commented example which you may uncomment to register some sample
    content inside the 'content' directory in this product.

    Once you have registered a directory on the file system, the edit form
    for 'FSFolder' objects will show the registered paths in their 
    'Filesystem Folder' selection. Once you select a path and press either
    'Change' or 'Change and View', the properties will be filled in for you
    if they have been defined in a suitable '.metadata' file, and when you
    click on 'Folder contents', you will see the usable filesystem content
    found in the directory.


  **Cataloging**

    FSContent content items do not catalog themselves automatically, but on
    demand. See the 'Cataloging' action, available on all FSContent content
    types.


  **Workflow and editing**

    CMFFSContent content has no workflow. Everything is published by default.
    The reason is simple: Changing workflow state requires changing the
    object. The read-only state prevents this. The same is true for editing
    the content or metadata associated with the content item.

    CMFFSContent items are edited on the file system. Metadata values and, if 
    desired, security restrictions can be associated using so-called 
    '.metadata' files. 


  **Dependencies**

    CMFFSContent depends on the following Zope products:

      - CMFCore
      - CMFDefault
      - CMFSetup

    The product relies on changes added to CMFCore and CMFSetup in late March
    2005. These changes are not available in the CMF 1.5.x series, only on 
    releases after that (or CVS HEAD).