root/CPS3/examples/MyProject/trunk/README.txt

MyProject
=========

This directory and its subdirectories are an add-on `Product` for Nuxeo
CPS, providing an example of how to customize the settings of a default CPS 3.4
portal.

To illustrate how a CPS portal can get customized, the following sample
components are provided:

- a new widget type to edit and display vogon content
- two new document types: VogonPoem and VogonPoemCollection with their
  respective workflows
- a new portlet that displays random Vogon poetry.
- a new tool `portal_vogon` that is used by the portlet to generate or grab
  Vogon poetry from an external source at:
  http://wellstyled.com/tools/dummy-cz/vogon.php
- a new CPSSkins theme with a gimp mock-up that was used to build it


What is a Vogon?
----------------

Vogons are an alien species well-known for it's poetry:
http://en.wikipedia.org/wiki/Vogon_poetry

The purpose of this product is to build a portal for the Vogon community to
produce and publish premium Vogon poetry.

Test it!
--------

To test this product on a CPS 3.4 portal, add it to the `Products` folder
of your zope instance, restart Zope, create a brand new CPS instance for test
purpose, go into the `portal_setup` tool in the ZMI, select the `MyProject`
profile in the `Properties` tab and finally import all steps on the `Import`
tab.

Read the source!
----------------

This product aims at being as pedagogical as possible. Python source code files
try to get extensively documented to explain what they do and why they do it
that way.

They also are other `README.txt` files scattered in the subfolders of this
product: please consult them.

If anything remains unclear, please fell free to ask the cps-users mailing list
after having googled a bit for existing answers to your questions.

There is also a handy gmane based search engine to easily dig the mailing list
archives:

  http://www.cps-project.org/sections/documentation

You can also access the per-component documentation here (warning: some of this
might be outdated or incomplete):

  http://www.cps-project.org/sections/documentation/cps-dev-center

Content of this product
-----------------------

- doc/

  Instructions to help you build your own customization product for CPS.

- __init__.py

  python initialization of the product (registers the GenericStup profiles
  and the new widget for the product).

- configure.zcml
  Zope3-like initialization of the product (thanks to Five)

- widgets.py

  python code that define our new widget types behavior.

- tool.py

  python code for our poetry generator system.

- skins/

  hold python scripts, page templates, images and CSS files that are used by
  other components. These files can then be easily accessed thanks to the
  `portal_skins` tool defined in the CMFCore product.
  Please see http://www.zope.org/Products/CMF/docs/devel/writing_skins/view for
  more details on the CMF skins machinery.

- i18n/

  hold the message translations for the i18n of UI

- tests/

  gather the suite of automated tests to check the validity of the code in
  written in this products

- profiles/default/

  hold the XML files for the GenericSetup configuration of the previous
  components + custom documents schemas, layout, types, workflows, and the
  CPSSkins theme.

  To get more info on how to use GenericSetup please refer to this blog:

    http://blogs.nuxeo.com/sections/blogs/florent_guillaume/2006_01_24_genericsetup-for-cps-cmf

- exportimport.py

  hosts the XML adapter that handles the GenericSetup support for the vogon tool
  defined in tool.py

- gimp/

  some gimp files used to design the CPSSkins theme of the product. These files
  are not actually used by the product, they are only provided for reference.
  The actual theme data is located in the profile/default/ folder with the
  remaining configuration files.