On Tue, 10 Jul 2001, Alex Chaffee wrote:
> Rob S. wrote:
>
>
> > The tough thing about separating the docs is that the server.xml config
> > stuff is spread out among multiple files. I wonder how difficult it would
> > be to maintain an index, or even if it's necessary.
>
>
> I don't think it's a big deal. I forgot to list the appendices, but one of
> them will be a technical doc describing server.xml tag by tag. Whoever
> writes this should put links in to the relevant parts of the TOC (which will
> in turn contain links to the relevant documents).
>
For Tomcat 4 at least, you'll find that the tag-by-tag docs on server.xml
is about 90% done -- the remaining work is to document the few remaining
undocumented elements, then convert the stuff from HTML to XML. Having a
file per major element seemed to be a convenient way to organize it, but
I'm certainly open to any reasonable layout.
See directory "catalina/docs/config/" in the source repository -- or just
follow the online links if you're running Tomcat.
These docs were designed to be reference material, so they fit the concept
of an Appendix (as described above) quite well. What's also important, of
course, is the *why* I would use a particular element, and the *how* to
solve some standard problems like "I want to use a single JDBCRealm for
all the webapps on this virtual host" or "how do I set up user home
directory based web apps?".
Craig
