Integrating Compass with AppFuse and the Display Tag
ChenRanHow has written up a detailed tutorial on how to integrate Compass with AppFuse and the Display Tag. From his mailing list post:
- Part 0. Overview of the practice
- Part 1. Setup env, add Compass and related library to AppFuse
- Part 2. Create ant tasks for create and delete index
- Part 3. Use annotation to make Compass resource mapping
- Part 4. Create Struts action to perform search
- Part 5. Make DisplayTag work with Compass
Thanks ChenRanHow!
Another great tutorial was recently written by Luciano Fiandesio. If you're looking to use Quartz, checkout Luciano's (well styled) AppFuse and Quartz tutorial.
In other AppFuse news, FanYang has started translating the documentation to Japanese, Mike McMahon has converted the appfuse-hibernate module to annotations, CruiseControl is continually testing, Mike Horwitz has solved most of the "Maven doesn't read a WARs dependencies" issue, and Scott Ryan is still hard at work on the code generation plugin. Even better - we've asked Scott to come aboard as a committer and he's accepted. Welcome aboard Scott - we appreciate all the work you're doing.
As far as progress on AppFuse 2.0, we're almost done with the Maven 2 conversion. The only thing left is figuring out how to get Mike's maven-warpath-plugin to hook into the Eclipse and IDEA plugins to they generate project files correctly. After that, it's time to start on documentation. I'm still torn on if we should use Confluence or DocBook. However, after looking at Spring's documentation for the past week, I think DocBook is probably the better choice. Then again, Stripes' Confluence Wiki looks nice and organized.
What do you think? What's the best way to write documentation for an open source project? Which system do you prefer to read? From experience, I prefer reading Spring's documentation over trying to find stuff in WebWork's wiki.
We've had great success with AppFuse users contributing to the documentation via a wiki, and I'd hate to create a documentation system that gets away from that. Maybe a DocBook/Confluence combination is the way to go? It looks like the CeltiXFire folks are having a similar debate.
Posted by Luciano Fiandesio on September 09, 2006 at 03:48 PM MDT #
Posted by Matt Raible on September 09, 2006 at 03:55 PM MDT #
I'd strongly suggest confluence. I took a while to settle on going that route, I had a lot of concerns about using a wiki to write doco. But I've found that with fairly rigid control (i.e. it's a documentation site that happens to be built on a wiki, not a wiki that's open to everyone) and some fore-thought it's been fairly easy to keep the doco well organized.
On the plus front it doesn't get much easier to maintain. One of the reasons I went against docbook was because it looked like more effort. I don't know about you but I like coding, not documentation. So I figure, the easier I can make it to keep the documentation up to date, the better :)
Posted by Tim Fennell on September 09, 2006 at 04:28 PM MDT #
stripes documentation was very useful compared to other projects (wicket and tapestry comes to mind).
and one of the reasons i picked the framework :)
i think that going beyond the intrisic qualities of a framework, documentation is a "make or break" feature.
wicket and tapestry are very good frameworks, but for me was very dificult to make the switch, and good and "not-hello-world" examples are very important.
thanks and keep up the good work, both of you.
edi.
Posted by edward on September 10, 2006 at 02:59 AM MDT #
Posted by dulanov on September 10, 2006 at 05:50 AM MDT #
Posted by Chen Ran How on January 01, 2007 at 09:50 PM MST #