Actually thanks for the tip of lemma :) I was looking for something like that. Would be nice having the code and documentation automagically uptodate.
Ron I Haven't Lost My Mind - It's Backed Up On Disk Somewhere On Sun, Aug 21, 2011 at 17:41, Martijn Dashorst <[email protected]>wrote: > On Sun, Aug 21, 2011 at 5:02 PM, Martin Grigorov <[email protected]> > wrote: > > Lemma's docs look the same: > > http://teleal.org/projects/lemma/manual/lemma-manual.html > > I think those are xhtml files using the same stylesheet. Would create > a chicken-egg problem generating your own docs with yourself... > > Martijn > > > > > On Sun, Aug 21, 2011 at 5:49 PM, Martijn Dashorst > > <[email protected]> wrote: > >> It appears that the cling manual is generated using lemma. > >> > >> http://teleal.org/projects/cling/core/manual/cling-core-manual.html > >> > >> I found the lemma plugin in the parent pom for cling. > >> > >> Martijn > >> > >> On Sun, Aug 21, 2011 at 4:19 PM, Martin Grigorov <[email protected]> > wrote: > >>> It sound good for me. > >>> Do you know whether their site is generated with this tool ? I want to > >>> see how such generated documentation actually looks like. > >>> > >>> On Sun, Aug 21, 2011 at 4:01 PM, Martijn Dashorst > >>> <[email protected]> wrote: > >>>> All, > >>>> > >>>> One of the things that has been bothering me (us?) is the lack of a > >>>> reference manual available from our own website. The biggest issues > >>>> that plagues me in starting to develop one are: > >>>> - docbook: reading, writing and maintaining XML is a drag > >>>> - impossible to keep up to date: very hard to maintain on our open > >>>> source budget (examples get out of date, code doesn't compile etc) > >>>> > >>>> I discussed this at some conference with Dan Allen from Seam and he > >>>> pointed me to Lemma: http://teleal.org/projects/lemma > >>>> > >>>> Lemma is a documentation generator from JavaDoc and example source > >>>> code. This way we should be able to leverage wicket examples and our > >>>> unit tests to generate a reference manual. It would be more > >>>> maintainable (example code gets refactored, etc). > >>>> > >>>> Now before we start using it (it has a AGPL license, not sure how that > >>>> pans out), I'd like to ask if this is something we would like to > >>>> use—apart from the license. If so, I'll ask legal@ if this is usable > >>>> at Apache and start an experiment. > >>>> > >>>> Another option would be to use pandoc to generate a manual from > >>>> markdown, but then we run the risk of out-of-date examples. > >>>> > >>>> Martijn > >>>> > >>>> -- > >>>> Become a Wicket expert, learn from the best: > http://wicketinaction.com > >>>> > >>> > >>> > >>> > >>> -- > >>> Martin Grigorov > >>> jWeekend > >>> Training, Consulting, Development > >>> http://jWeekend.com > >>> > >> > >> > >> > >> -- > >> Become a Wicket expert, learn from the best: http://wicketinaction.com > >> > > > > > > > > -- > > Martin Grigorov > > jWeekend > > Training, Consulting, Development > > http://jWeekend.com > > > > > > -- > Become a Wicket expert, learn from the best: http://wicketinaction.com >
