I've been thinking instead about integrating the component reference into the standard JavaDoc; enhancing the default JavaDoc doclet to understand the Tapestry annotations and read the optional .xdoc file and merge it all together.
On Tue, Dec 28, 2010 at 9:00 PM, Taha Hafeez <[email protected]>wrote: > Hi, > > It would be great if we have component reference with multiple tabs > > Demo | Source Code For Demo | Reference | API | More Examples | Related > Components > > ------------------------------------------------------------------------------------------------------------------------------------ > > It would be even better if in source code we have cross-reference links to > other components > > We may even allow user comments like PHP reference has > > regards > Taha > > > On Wed, Dec 29, 2010 at 7:20 AM, Bob Harner <[email protected]> wrote: > > > Hi everybody, > > > > I think one of the biggest remaining shortcomings of the documentation > > is the component reference. The automated generation of the component > > reference is nice, but it has certain drawbacks. > > > > For example, in the new documentation, the > > http://tapestry.apache.org/documentation.html page links to the > > Component Reference at > > http://tapestry.apache.org/tapestry5.2-dev/tapestry-core/ref/, but the > > latter is really part of the *old* documentation set. And once people > > follow links into it, they are "stuck" there, with plenty of > > navigation links to the old (non-Confluence) documentation but none > > back to the new (Confluence) documentation. > > > > Beyond this, I think the component reference documentation needs to be > > more browseable (e.g. related components grouped together) and it > > needs screen shots, more examples, links to other component libraries > > like Tapx and ChenilleKit, and maybe even an interactive demo for each > > visual component (should that be built into Hotel Booking? > > > > How do we make the component documentation better? Should each > > component have its own page in the User Guide, like already exists for > > BeanEditForm (http://tapestry.apache.org/beaneditform-guide.html)? Or > > is there some better approach? > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail: [email protected] > > For additional commands, e-mail: [email protected] > > > > > -- Howard M. Lewis Ship Creator of Apache Tapestry The source for Tapestry training, mentoring and support. Contact me to learn how I can get you up and productive in Tapestry fast! (971) 678-5210 http://howardlewisship.com
