RE: Tomcat documentation in book format (in contrast to the myriad files in a Web documentation)
Hi, You know, that would make for an EXCELLENT ant task or maven plugin. Feel like writing it? ;) Yoav Shapira Millennium Research Informatics -Original Message- From: Rudolf Nottrott [mailto:[EMAIL PROTECTED] Sent: Monday, March 22, 2004 5:57 PM To: Tomcat Users List Subject: Tomcat documentation in book format (in contrast to the myriad files in a Web documentation) Hi, I know the Tomcat documentation at http://jakarta.apache.org/tomcat/tomcat-5.0-doc/index.html it's excellent in content and complete, but I still vastly prefer the kind of documentation that I can read like a book, rather than navigating a myriad of file pieces linked together in Web fashion. My question is, does something like this exist for Tomcat? I mean the documentation as a single file (PDF, html, or whatever), that I could download and then read beginning to end? Thanks Rudolf - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] This e-mail, including any attachments, is a confidential business communication, and may contain information that is confidential, proprietary and/or privileged. This e-mail is intended only for the individual(s) to whom it is addressed, and may not be saved, copied, printed, disclosed or used by anyone else. If you are not the(an) intended recipient, please immediately delete this e-mail from your computer system and notify the sender. Thank you. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Tomcat documentation in book format (in contrast to the myriad files in a Web documentation)
I'm not really sure what this involves. It didn't occur to me that documentation might be written as an Ant task. What would be the benefits of that? Any examples of that kind of thing somebody else might have done for other documentation? Rudolf At 09:40 AM 3/23/2004 -0500, you wrote: Hi, You know, that would make for an EXCELLENT ant task or maven plugin. Feel like writing it? ;) Yoav Shapira Millennium Research Informatics -Original Message- From: Rudolf Nottrott [mailto:[EMAIL PROTECTED] Sent: Monday, March 22, 2004 5:57 PM To: Tomcat Users List Subject: Tomcat documentation in book format (in contrast to the myriad files in a Web documentation) Hi, I know the Tomcat documentation at http://jakarta.apache.org/tomcat/tomcat-5.0-doc/index.html it's excellent in content and complete, but I still vastly prefer the kind of documentation that I can read like a book, rather than navigating a myriad of file pieces linked together in Web fashion. My question is, does something like this exist for Tomcat? I mean the documentation as a single file (PDF, html, or whatever), that I could download and then read beginning to end? Thanks Rudolf - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Tomcat documentation in book format (in contrast to the myriad files in a Web documentation)
Hi, I suppose some background information is in order. All of tomcat's documentation (and a vast majority of Apache documentation in general, so this will have wide applicability) is in XML format. Much of that for tomcat is visible at http://cvs.apache.org/viewcvs.cgi/jakarta-tomcat-catalina/webapps/docs/. There are Ant and Maven tasks (you can use either one, we use Ant for tomcat as we're not mavenized) that will transform this XML docs to HTML using XSLT. Some transformers use Ant's style (aka xslt) task, some use Anakia (http://jakarta.apache.org/velocity/anakia.html), some use Maven's XDoc (http://maven.apache.org/reference/plugins/xdoc/). The XDoc plugin is probably the most full-featured one. The end result is at least one HTML file for each XML file. I say at least because some of these transformers generate menus and top pages. Yoav Shapira Millennium Research Informatics -Original Message- From: Rudolf Nottrott [mailto:[EMAIL PROTECTED] Sent: Tuesday, March 23, 2004 12:31 PM To: Tomcat Users List Cc: Shapira, Yoav Subject: RE: Tomcat documentation in book format (in contrast to the myriad files in a Web documentation) I'm not really sure what this involves. It didn't occur to me that documentation might be written as an Ant task. What would be the benefits of that? Any examples of that kind of thing somebody else might have done for other documentation? Rudolf At 09:40 AM 3/23/2004 -0500, you wrote: Hi, You know, that would make for an EXCELLENT ant task or maven plugin. Feel like writing it? ;) Yoav Shapira Millennium Research Informatics -Original Message- From: Rudolf Nottrott [mailto:[EMAIL PROTECTED] Sent: Monday, March 22, 2004 5:57 PM To: Tomcat Users List Subject: Tomcat documentation in book format (in contrast to the myriad files in a Web documentation) Hi, I know the Tomcat documentation at http://jakarta.apache.org/tomcat/tomcat-5.0-doc/index.html it's excellent in content and complete, but I still vastly prefer the kind of documentation that I can read like a book, rather than navigating a myriad of file pieces linked together in Web fashion. My question is, does something like this exist for Tomcat? I mean the documentation as a single file (PDF, html, or whatever), that I could download and then read beginning to end? Thanks Rudolf - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] This e-mail, including any attachments, is a confidential business communication, and may contain information that is confidential, proprietary and/or privileged. This e-mail is intended only for the individual(s) to whom it is addressed, and may not be saved, copied, printed, disclosed or used by anyone else. If you are not the(an) intended recipient, please immediately delete this e-mail from your computer system and notify the sender. Thank you. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Tomcat documentation in book format (in contrast to the myriad files in a Web documentation)
I use Docbook to write my documentation, and the same docbook XML file can be used to generate a single PDF document. Problem is, when you use it to generate HTML, the filenames are sometimes randomly generated. This can play havoc on search engines, like Google, because the location can change arbitrarily. And for just-released products, the amount of doc changes can sometimes make the documentation unsearchable (if the document is updated frequently). On the plus side: - Docbook is easy to learn - you get consistent formatting - you only need to code the document once to be able to generate it into HTML and PDF format (and it even looks like one of those authoritative manuals published by commercial software companies) Regards, pascal chong Rudolf Nottrott wrote: I'm not really sure what this involves. It didn't occur to me that documentation might be written as an Ant task. What would be the benefits of that? Any examples of that kind of thing somebody else might have done for other documentation? Rudolf At 09:40 AM 3/23/2004 -0500, you wrote: Hi, You know, that would make for an EXCELLENT ant task or maven plugin. Feel like writing it? ;) Yoav Shapira Millennium Research Informatics -Original Message- From: Rudolf Nottrott [mailto:[EMAIL PROTECTED] Sent: Monday, March 22, 2004 5:57 PM To: Tomcat Users List Subject: Tomcat documentation in book format (in contrast to the myriad files in a Web documentation) Hi, I know the Tomcat documentation at http://jakarta.apache.org/tomcat/tomcat-5.0-doc/index.html it's excellent in content and complete, but I still vastly prefer the kind of documentation that I can read like a book, rather than navigating a myriad of file pieces linked together in Web fashion. My question is, does something like this exist for Tomcat? I mean the documentation as a single file (PDF, html, or whatever), that I could download and then read beginning to end? Thanks Rudolf - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Tomcat documentation in book format (in contrast to the myriad files in a Web documentation)
Hi, I know the Tomcat documentation at http://jakarta.apache.org/tomcat/tomcat-5.0-doc/index.html it's excellent in content and complete, but I still vastly prefer the kind of documentation that I can read like a book, rather than navigating a myriad of file pieces linked together in Web fashion. My question is, does something like this exist for Tomcat? I mean the documentation as a single file (PDF, html, or whatever), that I could download and then read beginning to end? Thanks Rudolf - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
