tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Adam Fowler <a...@aber.ac.uk>
Subject Re: [DOC] TOC - thoughts
Date Sat, 14 Jul 2001 11:28:34 GMT
Hi

Everyone on the TomcatBook project (Hitchhiker's guide to tomcat 8o) ) are 
using DocBook too.

ATM we are only producing an appendix for tomcat 4 (Well, I am) but I would 
like to see it evolve into a separate Document.

The reason it is only an appendix ATM is that 4.0 hasn't been deployed widely 
like 3.2.x yet. So my job is detailing all of the differences in 
configuration and deployment.

There is a list of authors for TomcatBook at
http://sourceforge.net/docman/?group_id=26042

As I say, I'm the only Tomcat 4 guy ATM.

I'd be glad to work with you on this and share thoughts etc. If you'd like.

Is this documentation going to be used on the jakarta-tomcat site? If so who 
can commit the documents? Also, TomcatBook are using the GNU FDL so if 
apache's license is more restrictive that could be a problem (why 
documentation is covered by apache's software license I don't know!)

I know Alex on the tomcat-dev list is also doing documentation. My advice is 
to also go and join tomcatbook at groups.yahoo.com/group/tcbook as this is a 
good place to ask questions about such things.

Do you know of a good editor for DocBook? I know AbiWord should do it.

I also have the task of converting our projects docs to html for our site 
(http://tomcatbook.sourceforge.net) and am using jboss. I'm having issue with 
converting someon's build.bat file to a nice build.sh file though. Any help 
is much appreciated.

I have a mandrake 8.0 machine here with tc 4 installed and am currently 
working on getting it communicating with apache 1.3.x then once that is 
working i'll switch to 2.0 and get info on that.

Drop me a line with your thoughts either on tomcat-dev or at aff9@aber.ac.uk

Regards,
Adam.

---- 
Adam Fowler 
Help Desk Live Project 
Information Services 
University of Wales, Aberystwyth 
Web guy+author on the TomcatBook Project 
http://tomcatbook.sourceforge.net 
e-mail: adamfowler@chillin.co.uk 
---- 


On Friday 13 July 2001 21:49, you wrote:
> hello adam,
>
> i am planning to use docbook,
> and i will post my first *.tar.gz file containing the tomcat documentation
> next week on tomcat-dev@jakarta.apache.org mailing list.
>
> i am currently working on making the following...
>
> - Preface
> - Authors
> (I need some info and help on this, such as who to put inc. me)
>
> - Admin Guide.
>
> Once the admin guide is done, i will start to work on the developer's
> guide, cause the admin guide is kinda more important.
>
> To just clear things off, i am working on the Tomcat 4.0 documentation,
> while other might be working on the Tomcat 3.2/.3 documentation,
>
> the reason is, that tomcat4 is going to be the next major release; so its
> better if i and a couple of others start preparing tomcat4 documentation.
> The following are the specifications of the document.
>
> 1)It is a manual, that it contains three books (part I,II,III
> respectively). The three are admin guide, dev. guide and application
> developer's guide.
>
> 2)I am making it with DocBook XML 4.1.2. I am producing two layouts at the
> moment, which are: .PDF and .HTML, including .txt as well.
>
> 3)Some people told me that to work with Anakia DTD but i have been working
> with DocBook for roun bout three years, and i am quite used to it; so if
> anyone would like to convert it to different formats, i will pass the
> Documentation source to them, so they can keep the anakia version. as well
> as i am producing an .xhtml transformation as well, so it will be easier
> for people using anakia to convert it.
>
> 4)I am very confused about how to arrange the authors and collaborators
> list because i dont want anyone who has contributed to be left out in any
> manney, nor would they like it. so i need some help on that as well.
>
> 5)Can i change the docbook stylesheet to accept my own coloring
> information?.
>
> Thanx in advance.
>
> Hiten Pandya (15)
> h_pandya5@hotmail.com
>
> Open to suggestions as always...
>
> -----------------------------------------------------------------------
> From: Adam Fowler <aff9@aber.ac.uk>
> Reply-To: tomcat-dev@jakarta.apache.org
> To: tomcat-dev@jakarta.apache.org
> Subject: Re: [DOC] TOC - thoughts
> Date: Wed, 11 Jul 2001 17:38:58 +0000
> MIME-Version: 1.0
> Received: from [64.208.42.41] by hotmail.com (3.2) with ESMTP id
> MHotMailBD17B73600734004319E40D02A29087A0; Thu, 12 Jul 2001 20:34:14 -0700
> Received: (qmail 15256 invoked by uid 500); 13 Jul 2001 03:12:01 -0000
> Received: (qmail 10554 invoked from network); 11 Jul 2001 16:39:06 -0000
> From tomcat-dev-return-24412-h_pandya5 Thu, 12 Jul 2001 20:34:56 -0700
> Mailing-List: contact tomcat-dev-help@jakarta.apache.org; run by ezmlm
> Precedence: bulk
> list-help: <mailto:tomcat-dev-help@jakarta.apache.org>
> list-unsubscribe: <mailto:tomcat-dev-unsubscribe@jakarta.apache.org>
> list-post: <mailto:tomcat-dev@jakarta.apache.org>
> Delivered-To: mailing list tomcat-dev@jakarta.apache.org
> Delivered-To: moderator for tomcat-dev@jakarta.apache.org
> X-Mailer: KMail [version 1.2]
> References: <NEBBKCJBPLLPNFMKLPAJCEDFDIAA.rslifka@home.com>
> <3B4B9633.E9F931E3@mhsoftware.com> <3B4C69B2.8050906@stinky.com>
> In-Reply-To: <3B4C69B2.8050906@stinky.com>
> Message-Id: <01071117385801.25118@gucciboy.dyndns.org>
> X-Spam-Rating: h31.sny.collab.net 1.6.2 0/1000/N
>
> Putting little notes about things like the JDK 1.3.1 linux issue are VERY
> useful. I hate it when M$ have docs that don't mention things such as "none
> of your data is encrypted, by the way"
>
> Not that I'm bitter 8o)
>
> Adam.
>
> On Wednesday 11 July 2001 14:58, you wrote:
>  > Christopher Cain wrote:
>  > > "Rob S." wrote:
>  > >
>  > > [snip]
>  > >
>  > >>First off, I think we should have an ultra-quick install guide.  If
>  > >> you're like a lot of geeks, you know your stuff.  You need to know a
>  > >> quick few steps, a quick 2-3 gotchas, and BAM that's it.  I want to
>
> make
>
>  > >> sure the quick-and-dirty "impatient" install is available to the
>
> people
>
>  > >> who can take advantage of it; admins experienced with other
>
> containers,
>
>  > >> trying Tomcat for the first time perhaps.
>  > >
>  > > +1
>  > >
>  > >>PI.2.1:  I love pictures!  Some nice diagrams in here would go a
>  > >> lllong way. Not sure about the "choose OS" or "install Java"
>  > >> sections.  I
>
> mean,
>
>  > >> there's catering to the LCD and there's catering to the LCD...
>  > >
>  > > I haven't yet had a chance to look over the TOC (planning on doing it
>  > > tonight), but one of the docs I have lying around is a step-by-step on
>  > > installing java on Linux *specifically* in preparation for a Tomcat
>  > > build/install. Granted, the README file hits the important stuff, like
>  > > what needs to be in the CLASSPATH, etc. I was actually thinking of
>  > > morphing it into a more general (and quick) guide to preping your OS
>
> for
>
>  > > a Tomcat build/install (I have some Windoze notes lying around as
>
> well).
>
>  > > I could very quickly touch on Java installation, including a few
>  > > Linux-specific tips above and beyond the rather obvious actual
>  > > install, cover the environment varibles that need to be defined for a
>  > > build, reiterate the "jakarta" directory structure that needs to be in
>  > > place, etc. Basically, everything up to the point of the actual build.
>  >
>  > That would be great, and that's pretty much what the TOC outlines
>  > (though not in that detail). The problem with having OS-specific
>  > quick-and-dirty install guides is that if one aspect changes, the
>  > separate guides get out of sync. I'd suggest you clearly divide the
>  > following three parts:
>  >
>  > - Pre-install
>  > - Standalone install
>  > - Integrating with Web server
>  >
>  > Since that's the structure I'm using in the major parts of the Install
>  > Guide of the TOC.
>  >
>  > > Well, my thoughts on the aforementioned doc I was planning are to
>  > > provide a list of the available JDKs for each platform, what else one
>  > > needs to download for certain optional functionality (SSL, etc.),
>  > > where to get each of them, and any relevant comments on software
>  > > selection. Mainly just the huge stuff, like the infamous "Sun 1.3.1
>  > > JDK for Linux completely broken under the new gcc threading
>  > > libraries." (That one really pissed me off.) This might fall under the
>  > > category of "too much information" as Rob is stating, but my feeling
>  > > is that it is easy
>
> enough
>
>  > > to skip over entire sections (assuming they're laid out logically) in
>  > > a "Preping your OS for Tomcat" doc, and those users who are planning
>  > > on building out a new box (or reformatting an existing box)
>  > > specifically for a web server will appreciate such heads-up info.
>  > > Getting Tomcat up and running on a barebones OS install is pretty rare
>  > > for us developers, but it happens quite frequently in the corporate
>  > > world. The bigger the master Tomcat documentation library, from the
>  > > essentials to the sublimely tangential steps along the way, the more
>  > > comfortable corporations will feel about choosing Tomcat over a
>  > > proprietary solution. As long as someone is willing to write such
>  > > things, which in this case I am, why not just throw it in the mix for
>  > > the few people who might benefit from it? Of course, I completely
>  > > agree that there also needs to be some short-and-sweet versions of how
>  > > to do install-type things, so maybe an abbreviated version of my
>  > > Preping doc would also be in order.
>  >
>  > I like it.  Please see how it would fit in with the proposed pre-install
>
> /
>
>  > standalone install chapters.
>
> _________________________________________________________________________
> Get Your Private, Free E-mail from MSN Hotmail at http://www.hotmail.com.

-- 


Mime
View raw message