On Mon, 2004-05-24 at 17:11, Rafal Krzewski wrote: > Hello world, > > I'm wondering how much of the Maven community uses Confluence as well. I > do and I certainly like that.
All of the maven2 use cases and other docs like the criteria for the first m2 alpha, repository upload applications, security docs and some other things are in Confluence. I am going to make it public when the alpha is released. > Some time ago someone Nick Minutello wrote in his blog (can't find the > link ATM, sorry) that he is working on a maven plugin that would > tranform xdocs into Confuence compatible format and push them onto a > server throgh the RPC interface. > The effect - all documentation is viewed and edited through the > confluence. Now, what about maven reports which are generated as xdocs? > Should they be be pushed up to confluence too? But my projects generates > 160 xdocs, totalling over 2.6MB of xml markup. Nah, I don't think so... I have never been a huge fan of the wiki as permanent documentation but it does serve a purpose insofar as collecting possibly useful documentation. To that end I think it would definitely be cool to be able to use Confluence as an editing machine and extract the decent documentation from confluence and make it part of the site. In part of my revulsion of having to use MS Word to write the Maven book I got to thinking about what other way I could write the chapters of the book and how it might be easier to collaborate with my editor as checking in Word documents sucks. So I started yanking out confluence docs and converting them to apt: http://www.xmlmind.com/aptconvert.html After realizing the internal format of confluence is crap I just started using apt itself which I think is a better format anyway (I was convinced by Pete Kazmier) but I still have my confluence to apt stuff. >From the apt format I can create xdocs and from there generate stuff. I'm also using apt for the book which goes from apt -> MIF which is framemaker output that gets sucked into ORA's production system. > Bob McWhirter took an opposite approach. He wrote a perls script > (allegedly called "confluenza") that pulls Confluence content down and > generates a set of static html pages. You could see the result on > http://timtam.codehaus.org/ Notice the "Edit" link at the right bottom > corner of the page. J Aaron Farr described it on his blog: > http://www.jadetower.org/muses/archives/000051.html > I pesonally like this approach better than the other on - serving static > html is simply faster - but what about my maven reports?! > > Therefore I think a combined approach would suit me best. A confluence > plugin that would be able to: > > 1) push my existing xdocs (the hand written ones of course) up to > confluence, so that I may edit them online. > This part could be assimilated from Nick's hypothetic (or not?) plugin > > 2) pull docs from Confluence and turn them into xdocs, so that they get > processed by the xdoc plugin and turned into static html. The maven's > navigation.xml should also be generated in that proces based on the page > parent-child relationships. > Actually, navigation.xml processing would need to become more flexible - > I still would like to define vertical toolbar links, and custom menus > referncing maven generated reports, the confluence docs should go into a > "Documentation" menu, or something. > This is similar to Bob's approach, but would have to be implemented in > Jelly, or preferably as a POJO for easy m2 generation, and obviously the > output grammar is different. > > Too bad that I'm swamped with other work now, so I'm just tossing ideas > around... Any takers? I'm willing to do the testing / reviews if someone > is willing to work on implementing it. I've got lots of stuff if you want to look at it. But ultimately I think I'm going to make something that uses the apt format and by pass confluence, it's format and radeox all together. Regexes are proving not to cut the mustard. I think the apt format would make an idea wiki and blog format but I'm all for using confluence for now. Pete Kazmier started the work and I finished the job of getting apt's license changed from LGPL to the MIT license. We already have full apt -> xdoc, to go the other way probably wouldn't be hard at all to create an initial import. It would probably take someone a week to whip off a simple webapp to edit apt documents online which would be very cool. > Rafal > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] -- jvz. Jason van Zyl [EMAIL PROTECTED] http://maven.apache.org happiness is like a butterfly: the more you chase it, the more it will elude you, but if you turn your attention to other things, it will come and sit softly on your shoulder ... -- Thoreau --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
