Menu
▾
▴
springframework-developer
|
From: <sk...@fe...> - 2004-03-17 19:37:27
|
I am assuming the docs are in Docbook if so I believe some people are using XMLMind which i've been using a lot lately and am loving. I'm also loving docbook which I started using after someone on the Spring mailing list mentioned. Now I just need to get our documentation dept. to learn it oi. I spent the better part of yesterday playing with docbook support in openoffice so I could get a cleaner docbook to word conversion, don't ask. It didn't go that well. I also would be interested in what other tools people are using for docbook editing. Sean Kroah FedEx Ground (412) 859-5130 sk...@fe... |
|
From: Kopylenko, D. <dko...@ac...> - 2004-03-17 19:48:08
|
Confluence should be coming soon, but I haven't heard from Atlassian folks for a while? Mike, what is the story there? Regards, Dmitriy. -----Original Message----- From: Keith Donald [mailto:kd...@cs...] Sent: Wednesday, March 17, 2004 2:08 PM To: spr...@li... Subject: [Springframework-developer] reference documentation What's the process for updating the reference documentation? Any particular tool I need to edit the .xml files? Just wonderin' because I have some content/tutorial/samples I'd like to contribute! Thanks! Keith p.s. are we going to convert our docs over to Confluence? Do we have a timeframe for the that? |
|
From: <sam...@ma...> - 2004-03-18 15:42:58
|
You can also do fancy stuff, like extract code snippets from CVS - so your example documentation will never be out of date. sam Quoting Keith Donald <kd...@cs...>: > The thing I like about confluence is I can easily create and edit content > from my browser whenever I get a bit of free time. That and people see the > edits immediately. And of course, since it is a wiki, you can easily build > links between pages/topics. > > I'm just personally a fan of wikis and Confluence looks sharp. Keith > > -----Original Message----- > From: spr...@li... > [mailto:spr...@li...] On Behalf Of > Alef Arendsen > Sent: Thursday, March 18, 2004 3:47 AM > To: spr...@li... > Subject: RE: [Springframework-developer] reference documentation > > > > People are editing the XML with XMLMind's xml editor. Updating the > documentation online for now happens manually, once every now and then. > > > > I haven't looked into Confluence yet. I don't really care what system the > documentation is written with, as long as it generates HTML and something > like PDF (I like this very much). I don't think migrating it right now makes > sense :-). > > > > Alef > > > > > _____ > > > From: spr...@li... > [mailto:spr...@li...] On Behalf Of > Keith Donald > Sent: Wednesday, March 17, 2004 8:08 PM > To: spr...@li... > Subject: [Springframework-developer] reference documentation > > > > What's the process for updating the reference documentation? Any particular > tool I need to edit the .xml files? Just wonderin' because I have some > content/tutorial/samples I'd like to contribute! > > > > Thanks! > > Keith > > > > p.s. are we going to convert our docs over to Confluence? Do we have a > timeframe for the that? > > > > > > sam http://www.magpiebrain.com/ |
|
From: <sk...@fe...> - 2004-03-18 15:55:16
|
From what I can tell Confluence can export to pdf but I see no mention of docbook. I personally like the ease of wikis and webdav like products but I don't think they are sufficient for real technical documentation that needs to be exported to many different formats. I've always done the "stream of consciousness" documentation on a day by day basis in a wiki then cut'n'pasted it into something else in the end for proper editing. So this is off topic a bit but as it involves Spring documentation I would tend to favor anything that keeps the docs in a docbook or superset of docbook like format. Now if confluence was a web based docbook editor or could export to something that I could then convert automatically to any number of formats I'd be sold right now. Sean Kroah FedEx Ground (412) 859-5130 sk...@fe... |
|
From: <sam...@ma...> - 2004-03-18 16:30:57
|
Wikis to not technical documentation make. What I mean by that is that Wikis are excellent places for discussion and storings ideas etc. My recommendation is to use the Wiki and a database of information for the project as a whole, and perhaps even for online tutorials/examples. The technical documentation (the docbook one) should remain as it is, but may well take aspects from the Wiki (confluence). Confluence seems good enough to actually host the whole Spring website if required. sam Quoting sk...@fe...: > > From what I can tell Confluence can export to pdf but I see no mention of > docbook. I personally like the ease of wikis and webdav like products but I > don't think they are sufficient for real technical documentation that needs > to be exported to many different formats. I've always done the "stream of > consciousness" documentation on a day by day basis in a wiki then > cut'n'pasted it into something else in the end for proper editing. > > So this is off topic a bit but as it involves Spring documentation I would > tend to favor anything that keeps the docs in a docbook or superset of > docbook like format. Now if confluence was a web based docbook editor or > could export to something that I could then convert automatically to any > number of formats I'd be sold right now. > > Sean Kroah > FedEx Ground > (412) 859-5130 > > sk...@fe... > > > > > > ------------------------------------------------------- > This SF.Net email is sponsored by: IBM Linux Tutorials > Free Linux tutorial presented by Daniel Robbins, President and CEO of > GenToo technologies. Learn everything from fundamentals to system > administration.http://ads.osdn.com/?ad_id=1470&alloc_id=3638&op=click > _______________________________________________ > Springframework-developer mailing list > Spr...@li... > https://lists.sourceforge.net/lists/listinfo/springframework-developer > sam http://www.magpiebrain.com/ |
|
From: Colin S. <col...@ex...> - 2004-03-19 02:51:32
|
We're not putting out an incredibly complicated manual. All things being equal, if Confluence can produce the same level of output for html and pdf, I think it'd be preferred over the existing setup. My feeling is people would be more likely to work on the docs if they can do it in an interactive fashion, and bite of little chunks at a time, as opposed to having to pull out the source, fire up something that can make docbook editing half decent (aka XmlMind), and then check stuff back in. The real question is whether it would be worth doing a move now that the existing setup is working though... I would suggest it's a no brainer to move the web site to Confluence if Atlassian is willing to act on their offer though, and take it from there, i.e. think about the main manual later. sam...@ma... wrote: >Wikis to not technical documentation make. What I mean by that is that Wikis are >excellent places for discussion and storings ideas etc. My recommendation is to >use the Wiki and a database of information for the project as a whole, and >perhaps even for online tutorials/examples. The technical documentation (the >docbook one) should remain as it is, but may well take aspects from the Wiki >(confluence). Confluence seems good enough to actually host the whole Spring >website if required. > >sam > >Quoting sk...@fe...: > > > >>From what I can tell Confluence can export to pdf but I see no mention of >>docbook. I personally like the ease of wikis and webdav like products but I >>don't think they are sufficient for real technical documentation that needs >>to be exported to many different formats. I've always done the "stream of >>consciousness" documentation on a day by day basis in a wiki then >>cut'n'pasted it into something else in the end for proper editing. >> >>So this is off topic a bit but as it involves Spring documentation I would >>tend to favor anything that keeps the docs in a docbook or superset of >>docbook like format. Now if confluence was a web based docbook editor or >>could export to something that I could then convert automatically to any >>number of formats I'd be sold right now. >> >>Sean Kroah >>FedEx Ground >>(412) 859-5130 >> >>sk...@fe... >> >> >> >> >> >>------------------------------------------------------- >>This SF.Net email is sponsored by: IBM Linux Tutorials >>Free Linux tutorial presented by Daniel Robbins, President and CEO of >>GenToo technologies. Learn everything from fundamentals to system >>administration.http://ads.osdn.com/?ad_id=1470&alloc_id=3638&op=click >> >> |
|
From: Colin S. <col...@ex...> - 2004-03-19 12:58:27
|
I haven't looked into this at all, but does anybody have an idea how we
can get the code blocks ('programlisting' elements) in the generated
docs to be highlighted in grey? In XmlMind they show up as grey, but
when generated they show up as courier text on a plain white background
list the rest of the code.
I like the look of a grey background a lot more. Here's the Hibernate
docs with some sample grey code blocks:
http://www.hibernate.org/hib_docs/reference/html/manipulating-data.html
|
