Menu
▾
▴
springframework-developer
|
From: Alef A. \(JTeam\) <al...@jt...> - 2003-11-04 00:46:41
|
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) 1. Do we agree on having documentation based on DocBook? 2. Are we going to aggregate all documentation in one sort of reference-manual (docbook allows us to publish it in HTML as well). 3. What about the coWiki approach we suggested a couple of days ago? 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 :) |
|
From: <tri...@tr...> - 2003-11-04 01:27:42
|
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 > |
|
From: Alef A. \(JTeam\) <al...@jt...> - 2003-11-04 12:56:03
|
> What did you use to write this - a plain editor or something wysiwyg? I usually do this kind of stuff in a plain editor, but there are quite some editors out there... Also wysiwyg ones... > > > 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. Yup, there's some extra targets included in my local build.xml (docpdf, dochtml, dochtml-single), basically I ripped them from Hibernate. Works quite well... About the images and code-listings, I hjaven't had a look at that yet, will see if that works! > > 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. That seems reasonble. > 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. Agree. Hibernate uses coWiki, which is quite powerful and can be used to maintain the website as well (the complete hib website is coWiki-based). Could be an option. Also to get more interaction with users, having to subscribe to a mailinglist gives people the creeps sometimes... But, we don't have to do this right now (or at all). I think we just have to keeps things like that in the back of our heads... > Could that be beacause you were doing accounting the week before this one. :-) Well, that's finished now, a couple of more shitty jobs to do, then back to development :) |
|
From: Darren D. <da...@da...> - 2003-11-05 00:24:39
|
On Tuesday 04 November 2003 12:55, Alef Arendsen (JTeam) wrote: > Yup, there's some extra targets included in my local build.xml (docpdf, > dochtml, dochtml-single), basically I ripped them from Hibernate. Works > quite well... About the images and code-listings, I hjaven't had a look > at that yet, will see if that works! the example pdf in the docs folder shows the code in the velocity chapter overlapping the shaded region. I like the docBook idea though - one source, many end-formats. -- Darren Davison Public Key: http://www.davison.uk.net/key.jsp |
