Metadata
- Source
- FLUID-1675
- Type
- Sub-task
- Priority
- Blocker
- Status
- Closed
- Resolution
- Fixed
- Assignee
- Anastasia Cheetham
- Reporter
- Anastasia Cheetham
- Created
2008-10-10T10:57:34.000-0400 - Updated
2009-06-03T13:46:27.000-0400 - Versions
-
- 0.5
- Fixed Versions
-
- 0.8
- Component
-
- Framework
- Tech. Documentation
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
Comments
-
Anastasia Cheetham commented
2008-11-12T10:36:36.000-0500 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.
-
Michelle D'Souza commented
2009-01-05T11:50:21.000-0500 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 commented
2009-01-06T15:41:46.000-0500 Bug Parade 0.8 release
-
Anastasia Cheetham commented
2009-02-11T10:31:38.000-0500 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 commented
2009-02-11T11:51:20.000-0500 I have addressed all of Michelle's comments.