Fluid Infusion

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

Details

  • Type: Sub-task Sub-task
  • Status: Closed Closed
  • Priority: Blocker Blocker
  • Resolution: Fixed
  • Affects Version/s: 0.5
  • Fix Version/s: 0.8
  • Component/s: Framework, Tech. Documentation
  • Labels:
    None

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

Issue Links

This issue is depended on by:
FLUID-1117 Document undo functionality (API and tutorials) Blocker Closed

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Anastasia Cheetham added a comment - - 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.
Show
Anastasia Cheetham added a comment - - 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.
Hide
Permalink
Michelle D'Souza added a comment -
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
Show
Michelle D'Souza added a comment - 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
Hide
Permalink
Anastasia Cheetham added a comment - - edited
Bug Parade 0.8 release
Show
Anastasia Cheetham added a comment - - edited Bug Parade 0.8 release
Hide
Permalink
Anastasia Cheetham added a comment -
I've taken care of points 1, 2 and 4 in Michelle's comments. I need to clarify #3 with her before proceeding.
Show
Anastasia Cheetham added a comment - I've taken care of points 1, 2 and 4 in Michelle's comments. I need to clarify #3 with her before proceeding.
Hide
Permalink
Anastasia Cheetham added a comment -
I have addressed all of Michelle's comments.
Show
Anastasia Cheetham added a comment - I have addressed all of Michelle's comments.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:

Time Tracking

Estimated:
1d
Original Estimate - 1d
Remaining:
1d
Remaining Estimate - 1d
Logged:
Not Specified
Time Spent - Not Specified
Atlassian JIRA (v4.4#649-r158309) | Report a problem
Powered by a free Atlassian JIRA open source license for The FLUID Project. Try JIRA - bug tracking software for your team.