Package README (CVS ver. 1.1)

What is CMFContentList?
=======================

  CMFContentList was designed to fill the needs of a tool that is able
  to make listings of objects, and is flexible enough to allow you to
  fine tune the way your objects are going to be presented. It has the
  following features:

  - Allows you to set one or more macros to render the header of your
  content listing view.

  - Allows you to set one or more macros to render the footer of your
  content listing view.

  - Has multiple sources of results (Container, Catalog, Python Script).

  - Allows you to sort the results by a key.

  - Allows ordering in ascending or descending order.

  - Can constrain the results to a given limit.

  - Can set the size of batches, for batch listing.

  - Can choose the set of content types that will appear on the
  listing.

  - Can set a default macro to be rendered for each object.

  - Can set a macro per content type to be used instead of the default
  macro.

How to configure a instance of ContentList?
===========================================

  1. Set one or more macros for the header (eg:
  here/header/macros/portal_header). You can leave this field blank if
  you wish.

  2. Set one or more macros for the footer (eg:
  here/footer/macros/portal_footer). You can leave this field blank if
  you wish.

  3. Select the source for results.

  4. Select the key to sort by. Note that if you use Catalog as a
  result source, you cant sort by a key that is a TextIndex.

  5. Select the sort order.

  6. Choose a limit for the resultset. 0 means no limit.

  7. Choose at least one content type to show.

  8. Make sure that the default macro is what you want.

  9. Optionally, choose a different macro for your content type (eg:
  here/my_template/macros/user_with_photo)

  10. Enjoy :)