Re: [Springframework-developer] Documentation based on DocBook: call for decision :)

[<tri...@tr...>]

Quoting "Alef Arendsen (JTeam)" <al...@jt...>:

> All,
> 
> I've spent some more time in front of the TV and organizing some docs
> together during the commercials (I hate those!). The result can be found
> in the docs directory in the spring-reference.pdf file. I've prepared a
> basic structure and did some work on the beanfactory chapter to get some
> impression how things would look (so have a look at that chapter
> specifically).
> 
> Before I go on (if even), a couple of questions (the sources for the
> docbook xml can be found in a zip located at www.jteam.nl/docbook.zip)
> 

What did you use to write this - a plain editor or something wysiwyg? 

> 1. Do we agree on having documentation based on DocBook?
> 

It seems to be a good choice if since we can generate both pdf and html.  I 
assume there is an ant task so we can make this part of the build.  Have you 
tried generating both pdf and html with a document that includes graphics and 
source code listings.  Sometimes it's hard to get it to look good in several 
formats.

> 2. Are we going to aggregate all documentation in one sort of
> reference-manual (docbook allows us to publish it in HTML as well).
> 

I'd like to see a "Spring Users Guide" and separate tutorials for "Bean 
Container", MVC, JDBC, AOP etc.

> 3. What about the coWiki approach we suggested a couple of days ago?
> 

Wiki does not seem to very popular - maybe it's beacuse the one we have is not 
that great.  Somehow we should make it clear though what the preferred channel 
for support is - wiki, forums or mailing lists.

> I'd like us to decide on this soon so I can either go on (and add it to
> CVS so other people can do whatever they want) or leave it :-).
> 
> Alef
> 
> P.s. __sometimes__ I actually like documenting stuff, like this week :)
> 

Could that be beacause you were doing accounting the week before this one. :-)

> 
> 
> 
> 
> -------------------------------------------------------
> This SF.net email is sponsored by: SF.net Giveback Program.
> Does SourceForge.net help you be more productive?  Does it
> help you create better code?   SHARE THE LOVE, and help us help
> YOU!  Click Here: http://sourceforge.net/donate/
> _______________________________________________
> Springframework-developer mailing list
> Spr...@li...
> https://lists.sourceforge.net/lists/listinfo/springframework-developer
>