Document the event model, and the supported events, more thoroughly

Description

We have the beginning of some documentation around the event system:
http://wiki.fluidproject.org/display/fluid/The+Fluid+Event+System
but we need more developer-centric api docs explaining the events supported by each component, when they fire, and what kinds of things you might want to do with them. A page has been started for this:
http://wiki.fluidproject.org/display/fluid/Events

dev-iteration46

Environment

None

Activity

Show:

Anastasia Cheetham February 11, 2009 at 4:51 PM

I have addressed all of Michelle's comments.

Anastasia Cheetham February 11, 2009 at 3:31 PM

I've taken care of points 1, 2 and 4 in Michelle's comments. I need to clarify #3 with her before proceeding.

Anastasia Cheetham January 6, 2009 at 8:41 PM
Edited

Bug Parade 0.8 release

Michelle D'Souza January 5, 2009 at 4:50 PM

The event documentation was in fairly good shape for the 0.6 release. There are a couple of things that could still be done.

1. Create an 'Events' landing page: http://wiki.fluidproject.org/display/fluid/Events or rework http://wiki.fluidproject.org/display/fluid/The+Fluid+Event+System into the landing page
2. Remove the duplication of the Event Type table - pull it in from a single source. It currently exists in 3 places and each is slightly different.
3. Move the Event Firer table to the component developer docs page.
4. Remove the warnings

Anastasia Cheetham November 12, 2008 at 3:36 PM
Edited

I've drafted something, at
http://wiki.fluidproject.org/display/fluid/Events+for+Component+Developers
and
http://wiki.fluidproject.org/display/fluid/Events+for+Component+Users
and have asked Michelle to 'beta test' it.

One thing that is still needed is for the individual component pages to better document the parameters supported by the event listeners.

Fixed

Details

Assignee

Reporter

Original estimate

Time tracking

No time logged1d remaining

Fix versions

Affects versions

Priority

Created October 10, 2008 at 2:57 PM
Updated June 3, 2009 at 5:46 PM
Resolved February 11, 2009 at 4:51 PM

Flag notifications