I might just take you up on that, Ben. Documentation is probably the source of all evil. It seems to be at my project, but that's another story. But, I do think that solid well-written documentation is often the discriminator between a good project/product and an excellent one.
--Todd -----Original Message----- From: Ben Walding [mailto:[EMAIL PROTECTED] Sent: Thursday, July 03, 2003 6:11 PM To: Maven Users List Subject: Re: Werkz Documentation Of course it is documented! http://wiki.codehaus.org/maven/MailingListSupport Your (Todd Feather) job is to reformat the information such that it is semi legible :) http://wiki.codehaus.org/maven/WerkzTagDocumentation Jason van Zyl wrote: >On Thu, 2003-07-03 at 20:31, Todd Feather wrote: > > >>Hi All, >> >>I was just wondering if there is documentation anywhere on the base werkz >>tag library from Jelly that seems to form the basis for a lot of functions >>in Maven. >> >> > >In Maven the only tags used are: > ><project/> ><goal/> ><attainGoal/> ><preGoal/> ></postGoal/> > >The first, <project/> represents a Werkz project though internally all >the Jelly scripts encountered by Maven are merged and layered in strange >ways to allow for inheritance. The only attribute is 'default' which >specifies the default goal within the <project/>. > >The second, <goal/> is a little blob of Jelly script that is stored >internally as the action to be executed when the goal is attained. It >has a 'name' attribute and can also take a CSV list of prereqs which are >the names of goals. > >The third, <attainGoal/>, is a way to manually invoke the attainment of >a <goal/>. The only attribute is 'name'. > >The fourth and fifth, <preGoal/> and <postGoal/>, are decorators for a >given goal. You specify the name of the goal to decorate with the 'name' >attribute. There is no way for one decorator to dominate another, they >get executed in whatever order they are found so you can't expect any >decorators to execute in a specific order. > > > >>Being a new user, I was trying to get my weblogic ejb compile to work with >>my build and I knew what I wanted to accomplish and I even had some idea of >>how having heard Vincent's talk at TSSS in Boston. However, it was only >>after a lot of interactive activity with Maven: >>* Does this work >>* Build >>* Bomb (or expected result did not occur) >>* Try something else >> >>that I finally got the compile and stub generation to work together. >> >>I'm pretty sure I browsed every page on the Maven site and looked through >>the Jelly site as well. >> >> > >Yes, the Werkz tags have moved around a bit. But what's above is it as >far as Maven is concerned. I don't see the need for any other tags. > > > >>I noticed that there were some other folks on the mailing list that seemed >>to have had this difficulty too. Is there more documentation that is >>forth-coming for Maven? >> >> > >Yes, for the 1.0 release there will be full documentation. > > > >>I realize that Maven is still in its early stages, however I think more >>solid documentation (sooner rather than later) would really help it's usage >>to grow. >> >> > >Most of us realize that. I realize that, but much easier said than done. > > > >>I'm pretty patient and was interested in getting the product to >>work. Other folks that might be interested in adopting it may not have the >>time or inclination to spend the time on it without better documentation. >> >> > >I'm perfectly fine with that myself. I always hoped that people would >hold off until the 1.0. > > > >>One last note to the development team, it only took me about a day to get up >>to speed with Maven and get it to build some reasonably complex stuff with >>very few lines of code. Great job on abstracting the build process above ANT >>and building an easy to use product! Keep up the good work. >> >> > >Thanks, much appreciated. > > > >>--Todd >>__________________ >>Todd Feather >> >> >> >> >>______________________________________________________________________ >> >>--------------------------------------------------------------------- >>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] --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
