Menu

#6 Integrate component help.

open
nobody
None
5
2004-11-07
2004-11-07
No

The plugin can display the component and component
parameter descriptions extracted from component
specification files in a library. The online
component library for the Tapestry core and contrib
library components can be access by clicking on a button.

This solution is not ideal, it requires an Internet
connection and there is no standard method for
third-party component developers to integrate their own
component reference documentation.

Ideally component reference documentation should be
shipped with the component library, either as HTML or
some form (XML, xdoc, etc.) that can be processed by
the plugin into end-user doumentation.

Another idea would be to provide executable component
examples in the library jar file. The plugin could
embed Jetty to launch the Tapestry servlet, load the
examples and display them,, perhaps with the SWT
browser widget. The examples would include standard
controls (perhaps the plugin can provide these as a
page-border) to display the source code for the example.

With this in place the user can browse the palette tree
view, and try out examples of the component usage, and
look at source code and then use the component all
without breaking their stride.

Discussion


Log in to post a comment.