Integrating Tapestry component documentation
I've started using the SF project tracker for my
own feature requests, one of the features I feel that is most important is
access to documentation.
I've started using the SourceForge Tracker (use
the button on this page) to keep track of my development ideas and come up with
a roadmap. One of the goals in starting the Palette was to make it easier to
find out just "what's out there" in the component
libraries.
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 would 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 documentation.
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.
Posted: Sun - November 7, 2004 at 09:27 AM :
:
: : : :
:
:
news : documentation : development : archives
Tracker
Forums
Doc Manager
Mailing Lists
CVS Tree
Released Files