==========
README.txt
==========

``And they were all filled with the Holy Ghost, and began to speak
with other tongues, as the Spirit gave them utterance.''

							Acts 2:4


Overview
--------

With Zope 3, it has become almost (almost!) trivial to make a web
application i18n-aware.  The ``utilities/i18nextract.py`` script
extracts i18n message strings from Python code, Page Templates and
ZCML files.  If the message strings are only half decently tagged, the
message catalog template can be handed to a translator and, voila!,
you have a translated application.

Yet, content often needs to be made available in different languages,
too.  Thanks to a simple language negotiator API, content objects that
need to provide data in different languages can be created with
limited, but still existant effort.  This effort turns into an
inconvenience when content components that provide the functionality
you need already exist but lack i18n-awareness.  You would now have to
reimplement them.

This is where Pentecost comes in.  Instead of making content
components i18n-aware, they are wrapped in a Pentecost object, which
is really a container that can contain an instance of your content
component for every language.  To the outside, a Pentecost object
tries to behave like your content component and always serves the
version of your content component that the user prefers according to
his/her language settings.

Pentecost is to be designed to be as modular as possible.  It works
with

  * any type of content component

  * any container implementation (IContainer)

That means, Pentecost can theoretically work with containers that
store their data in different places than the ZODB, such as SQL.  To
make Pentecost work with your container, only ZCML configuration is
needed, no Python code.

Pentecost comes with a default container configuration using Zope's
BTreeContainer in ``btreecontainer.zcml``.  To keep Pentecost itself
as independent as possible, it is not loaded by default.  A good place
to load it is in the ZCML slug that is placed in the
``package-includes`` directory of your Zope instance.


Copyright
---------

Pentecost is copyrighted (c) 2004 by Philipp "philiKON" von
Weitershausen.  It is freely distributable under the terms of the Zope
Public License Version 2.1 (ZPL), as distributed with Zope 3.