You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@tomcat.apache.org by Rudolf Nottrott <rn...@alexandria.UCSB.edu> on 2004/03/23 18:31:14 UTC
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:rnott@alexandria.UCSB.edu]
> >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: tomcat-user-unsubscribe@jakarta.apache.org
>For additional commands, e-mail: tomcat-user-help@jakarta.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: tomcat-user-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tomcat-user-help@jakarta.apache.org
Re: Tomcat documentation in "book format" (in contrast to the myriad
files in a Web documentation)
Posted by Chong Yu Meng <ch...@cymulacrum.net>.
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:rnott@alexandria.UCSB.edu]
>> >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: tomcat-user-unsubscribe@jakarta.apache.org
>> For additional commands, e-mail: tomcat-user-help@jakarta.apache.org
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: tomcat-user-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: tomcat-user-help@jakarta.apache.org
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: tomcat-user-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tomcat-user-help@jakarta.apache.org