Dominique has started researching for an xml dialect for the manual. There is something in bugzilla [1] and SVN (dont know where).
If I remember right the way should be 1) analyse java sources and external (?) files 2) generate xml 3) transform to readable manual (HTML, PDF) For 2) it´s important to include examples. Maybe we could include targets from the junit testcases (mostly relying on a buildfile [2]) as an option. Base idea is: DRY (dont repeat yourself). For 3) we could also use Cocoon or Forrest. Jan [1] http://issues.apache.org/bugzilla/show_bug.cgi?id=34116 [2] /src/etc/testcases/ -----Ursprüngliche Nachricht----- Von: Erik Hatcher [mailto:[EMAIL PROTECTED] Gesendet: Samstag, 4. Juni 2005 02:05 An: Ant Developers List Betreff: Re: Google Summer of Code, Apache ANT project ideas? On Jun 3, 2005, at 3:24 PM, Daniels, Doug wrote: > Yeah I was way off on Velocity I thought it was part of XDocs but > really its that servlet engine. You weren't really far off. There is DVSL transformations in the current mix which is Velocity. Velocity isn't a bad choice necessarily. I was merely opening the door for discussion on how to craft this thing - no need to stick with the legacy way just because it's already partly there. A new and improved process may save time and be cleaner in the long run. > What's wrong with XDocs it seems like a good way to parse through > the Ant Tasks meta-data javadoc comments and extract the > information we need for documentation. Nothing is "wrong" with it per se, but it's a pretty heavy process. Maybe using one of the faster/lighter/simpler Java parsers out there would be better. Requiring XDoclet for 3rd party tasks to generate documentation may be a bit heavy handed and prohibitive. > What other types of capability were you looking for? Being able to fold examples into the documentation is a critical part of it, and being able to generate documentation in HTML, PDF, and other formats is quite desirable. > The project deliverable would most likely be an Ant Task that could > perform this document auto-generation right? I think so. > Where can I find the previous XDoc stuff that was developed? It's in Ant's CVS under proposals/xdocs. Incidentally this is what generated Appendix E of Java Development with Ant (and could have been used to write the first edition of O'Reilly's Ant: The Definitive Guide :). Erik --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
