Skip to content

Commit

Permalink
Update documentation a bit
Browse files Browse the repository at this point in the history
svn path=/plone.app.tiles/trunk/; revision=32550
  • Loading branch information
optilude committed Dec 20, 2009
1 parent 61605b6 commit c36ada0
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.txt
Expand Up @@ -9,8 +9,10 @@ This package contains the following things:
new tile based on the tile's schema. For transient tiles, this merely
redirects to a URL with an appropriate query string. For persistent tiles,
it will also save the necessary data. This will fire an
``IObjectCreatedEvent`` for the newly created tile (a transient object)
when successfully submitted.
``IObjectCreatedEvent`` as well as an ``IObjectAddedEvent`` for the newly
created tile (a transient object) when successfully submitted. In the case
of the ``IObjectAddedEvent``, the ``newParent`` attribute will be the tile's
context, and the ``newName`` attribute will be the tile's id.

* The ``@@add-tile`` view, when accessed directly, allows the user to choose
from all available tiles (subject to the tile's add permission) and
Expand All @@ -28,6 +30,11 @@ This package contains the following things:
``oldParent`` attribute will be the tile's context, and the ``oldName``
attribute will be the tile's id.

* An interface ``ITileBookeeping``. Adapt a content object to this interface
to obtain information about the tiles which have been added in that context.
Event handlers for ``IObjectAddedEvent`` and ``IObjectRemovedEvent`` keep
the bookkeeping information in sync as tiles are added and removed.

The default add and edit forms should suffice for most use cases. You can use
`plone.autoform <http://pypi.python.org/pypi/plone.autoform>`_ to configure
alternative widgets, either by hand or via `plone.directives.form
Expand Down

0 comments on commit c36ada0

Please sign in to comment.