RE: hello everyone (regarding documentation)
BTW, I didn't recall there was a vote on the list to decide if we should use DocBook or Anakia to produce documentation ? Not yet. Another reason why nobody should jump the gun with a complicated format that might end up having to be ported to XHTML. :) My advice for potential authors is to use text or very simple HTML (h1, code, p, pre, and a) so it'll be easy to shift to a common format once we do decide. Also it'll mean you don't waste time making it pretty, and focus on the text itself. I agree. The DocBook format is certainly complex but since there is a free GUI editor for it, AbiWord, I was thinking it a good choice. I've allready used Anakia and jakarta build-site and we're not in a real-time WYSIWYG :) But I'll use the format the list will vote for ;)
RE: hello everyone (regarding documentation)
hello u r right.. the vote counts, i will use wotever the vote says, and in the meantime, i will adjust myself with Anakia and XHTML, thanx Gomez Henri thanx in advance, hiten pandya [EMAIL PROTECTED] _ Get Your Private, Free E-mail from MSN Hotmail at http://www.hotmail.com.
RE: hello everyone (regarding documentation)
Pier: A nice way to duplicate the job, indeed... Why not joining Alex et. al and Each contribution is good to have. If he feel more confortable using docbook, why not let him start some docs with it. write the documentation with them? Just because you want to do it with the DocBook DTD? A ridiculous excuse, as with a very simple XSLT stylesheet you can convert the Anakia DTD in DocBook with no fuzz... If an XSLT exist for converting Anakia to DocBook, it should be possible to do the reverse. Could you provide us, Pier, the XLST file to convert from Anakia to DocBook ? BTW, I didn't recall there was a vote on the list to decide if we should use DocBook or Anakia to produce documentation ?
Re: hello everyone (regarding documentation)
GOMEZ Henri wrote: Pier: A nice way to duplicate the job, indeed... Why not joining Alex et. al and Each contribution is good to have. If he feel more confortable using docbook, why not let him start some docs with it. write the documentation with them? Just because you want to do it with the DocBook DTD? A ridiculous excuse, as with a very simple XSLT stylesheet you can convert the Anakia DTD in DocBook with no fuzz... If an XSLT exist for converting Anakia to DocBook, it should be possible to do the reverse. Could you provide us, Pier, the XLST file to convert from Anakia to DocBook ? Docbook is a *huge* file format. I've heard it described as SGML in XML. There are probably features in DocBook that would be very difficult to automatically port back to XHTML. BTW, I didn't recall there was a vote on the list to decide if we should use DocBook or Anakia to produce documentation ? Not yet. Another reason why nobody should jump the gun with a complicated format that might end up having to be ported to XHTML. My advice for potential authors is to use text or very simple HTML (h1, code, p, pre, and a) so it'll be easy to shift to a common format once we do decide. Also it'll mean you don't waste time making it pretty, and focus on the text itself. -- Alex Chaffee mailto:[EMAIL PROTECTED] jGuru - Java News and FAQs http://www.jguru.com/alex/ Creator of Gamelan http://www.gamelan.com/ Founder of Purple Technology http://www.purpletech.com/ Curator of Stinky Art Collective http://www.stinky.com/
Suggestions (was Re: hello everyone (regarding documentation))
Hi Hiten! hiten pandya wrote: i am planning to start my own documentation project for Tomcat 3.3 and 4.0. The different thing about this project is that, i am going to port all of the tomcat documentation to XML Docbook format. Not speaking officially, I'm not a committer: if you want to document Tomcat, then go ahead and good luck! Your focused work can do lots for the docs: you will probably end before the committee decides the right format for Tomcat docs :) Just a suggestion: Though i am not very good at docbook but i think i can cope. Once the documentation is complete, I will submit it to the main tomcat development team. Don't wait till everything is ready; send your updates regularly to the dev list, so folks can criticize your work and point possible mistakes. That way, you can change course in a timely manner; otherwise you might find at the end that a chapter is unnecessary and another one is missing :) Un saludo, Alex.
Re: Suggestions (was Re: hello everyone (regarding documentation))
On Tue, Jul 10, 2001 at 10:39:12AM +0200, Alex Fernández wrote: Hi Hiten! hiten pandya wrote: i am planning to start my own documentation project for Tomcat 3.3 and 4.0. The different thing about this project is that, i am going to port all of the tomcat documentation to XML Docbook format. Not speaking officially, I'm not a committer: if you want to document Tomcat, then go ahead and good luck! Your focused work can do lots for the docs: you will probably end before the committee decides the right format for Tomcat docs :) OK, I appreciate the :-) but... that's not *quite* fair. We're closing in on a decision, and if you want to write new stuff now you should just go ahead and do it. Use text or HTML or even Word. I think using DocBook is premature. I don't think a wholesale conversion of existing docs to DocBook will be a good use of anyone's time right now. Maybe in a week or two we'll be converting them to Anakia or DocBook but not just yet. Just a suggestion: Though i am not very good at docbook but i think i can cope. Once the documentation is complete, I will submit it to the main tomcat development team. Don't wait till everything is ready; send your updates regularly to the dev list, so folks can criticize your work and point possible mistakes. That way, you can change course in a timely manner; otherwise you might find at the end that a chapter is unnecessary and another one is missing :) Before you write a chapter (or article or HOWTO or whatever you want to call it), please take a look at (a) the existing docs, and more importantly (b) the Table of Contents and see if it fits in anywhere. Then let the list know what you're working on. We're trying to organize the docs so there's no redundant information. (For instance, there's lots of information on configuring Apache scattered among half a dozen howtos and FAQs right now. Most of it is now out of date, and it'll be impossible to bring it all current. I'd like there to be one chapter on integrating with Apache, with subsections for mod_jk, mod_webapp, mod_jserv, and so on -- and since the subsections can rely on the introduction of the Apache chapter, they won't have to duplicate information that's already been covered above, and won't confuse anybody. On the Tomcat Forum I regularly get questions where people have read a mod_jserv howto instead of a mod_jk howto and they don't even realize there's a difference, since they're both called Configuring Apache without mentioning the name of the connector.) -- Alex Chaffee mailto:[EMAIL PROTECTED] jGuru - Java News and FAQs http://www.jguru.com/alex/ Creator of Gamelan http://www.gamelan.com/ Founder of Purple Technology http://www.purpletech.com/ Curator of Stinky Art Collective http://www.stinky.com/
Re: Suggestions (was Re: hello everyone (regarding documentation))
Alex Fernández wrote: Hi Hiten! hiten pandya wrote: i am planning to start my own documentation project for Tomcat 3.3 and 4.0. The different thing about this project is that, i am going to port all of the tomcat documentation to XML Docbook format. Not speaking officially, I'm not a committer: if you want to document Tomcat, then go ahead and good luck! Your focused work can do lots for the docs: you will probably end before the committee decides the right format for Tomcat docs :) LLAMF! True that. Just a suggestion: Though i am not very good at docbook but i think i can cope. Once the documentation is complete, I will submit it to the main tomcat development team. Don't wait till everything is ready; send your updates regularly to the dev list, so folks can criticize your work and point possible mistakes. [snip] Am I the only one that initially read that as send your updates regularly so that folks can criticize you and your pointless mistakes? Alex deals some very sage advice here, but when I first hit Reply he was about to get some even higher praise for the funniest pointed sarcasm I had heard in quite some time. ... Uhhh ... I guess you had to be there. In any event, Alex's advice is quite sound, FWIW.
hello everyone (regarding documentation)
hi everyone, i am planning to start my own documentation project for Tomcat 3.3 and 4.0. The different thing about this project is that, i am going to port all of the tomcat documentation to XML Docbook format. Though i am not very good at docbook but i think i can cope. Once the documentation is complete, I will submit it to the main tomcat development team. I dont really know if this is the rite approach for writing documentation, but i am open for suggestions. It will be a funtime for my summer holidays as well. Hiten Pandya United Kingdom. If anyone would like to help me write the documentation, please submit the sections u will be working on to me at [EMAIL PROTECTED] But first i am waiting for enough good votes and bad votes about the starting of this project. Put [SUGGESTIONS] in the subject header so it is easier for me to fetch them out of my mailbox. Thanks in advance. The following are the details. Document Language: XML Format: DocBook 4.x(stable) Binary Formats: - Portable Document Format (PDF) - HTML - Latex - PostScript - Etc... - Windows Help Format. (text formats) - ASCII - Thanks in advance hiten pandya 15 [EMAIL PROTECTED] united Kingdom. _ Get Your Private, Free E-mail from MSN Hotmail at http://www.hotmail.com.
Re: hello everyone (regarding documentation)
Quoting hiten pandya [EMAIL PROTECTED]: hi everyone, i am planning to start my own documentation project for Tomcat 3.3 and 4.0. The different thing about this project is that, i am going to port all of the tomcat documentation to XML Docbook format. Though i am not very good at docbook but i think i can cope. Once the documentation is complete, I will submit it to the main tomcat development team. I dont really know if this is the rite approach for writing documentation, but i am open for suggestions. It will be a funtime for my summer holidays as well. Hiten Pandya United Kingdom. If anyone would like to help me write the documentation, please submit the sections u will be working on to me at [EMAIL PROTECTED] But first i am waiting for enough good votes and bad votes about the starting of this project. Put [SUGGESTIONS] in the subject header so it is easier for me to fetch them out of my mailbox. Thanks in advance. A nice way to duplicate the job, indeed... Why not joining Alex et. al and write the documentation with them? Just because you want to do it with the DocBook DTD? A ridiculous excuse, as with a very simple XSLT stylesheet you can convert the Anakia DTD in DocBook with no fuzz... Pier
