These are in the XML format that Craig's adopted, using the specified subset
of tags. I've also attached the rendered versions to this email w/a
modified extension (to get past the HTML filters) so I can hopefully get
some feedback! ;) They're both in ok shape, enough is there for some
constructive criticism, but they aren't nearly ready for prime time.
(1) introduction.xml - The type of information that we repeated in a lot of
3.x docs. Things like where to look for help, what certain terms, files,
and folders are (Context being the only example I could come up with for
terms =)
(2) reverse-lookup.xml - Reverse-links to the various parts of the
documentation. Kind of empty since there's not much documentation to link
to ;) I'm not sure if there's a need for this kind of thing, or maybe there
is but in a different form. I figure it would be a centralized place to
answer questions about files and directories w/out having to hunt and peck.
Feedback anyone? Am I headed in the right direction what what's written,
etc. Thx =)
Oh yeah, while writing the reverse lookup doc, I uncovered a Scooby typo in
/bin/jspc.bat:
rem jspc.bat - Script ro run the Jasper "offline JSP compiler"
-------------------> ^^^^
hahah =)
- r
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Robert Slifka</author>
<title>Reverse Lookup ??? Choose a better title ??? </title>
</properties>
<body>
<section name="Introduction">
<p>If you're wondering what configuration or development aspect a specific element of the Tomcat distribution pertains to, then this is the place for you. This document contains reverse-lookups of various parts of the container, and should help you answer questions like:
<ul>
<li>What purpose does this file or directory serve?</li>
<li>Can I relocate these files or directories?</li>
<li>While trying to accomplish X, Y, or Z, do I need to configure this as well?</li>
</ul>
</p>
</section>
<section name="Directories and Files">
<p>First check README.txt for the complete list of directories contained in the distribution. That will give each directory a general context so you should be able to find out more information just by navigating to related topics.</p>
<p>
<ul>
<li><strong>/bin</strong> - Contains the startup, shutdown, and Jasper-related scripts. Basic usage of the startup and shutdown scripts is covered in the <a href="README.txt">README.txt</a> file while enhancing them is covered <a href="#">HERE</a>. For information on offline JSP compilation with Jasper (roughly the j* files), look <a href="#">HERE</a>.</li>
<li><strong>/conf</strong>
<ul>
<li><strong>catalina.policy</strong> - Security settings. Read about them right over <a href="#">HERE</a>.</li>
<li><strong>server.xml</strong> - Covered below.</li>
<li><strong>tomcat-users.xml</strong> - JDBC Realm stuff. Look left, right, up, down, and over <a href="#">HERE</a> for blah blah.</li>
<li><strong>web.xml</strong> - You'll want to check <a href="#">this</a> out.</li>
<li><strong>*.dtd</strong> - <strong>D</strong>ocument <strong>T</strong>ype <strong>D</strong>efinitions for the *.xml files of the same name. Are they validated against? Read about it at <a href="#">this</a> location.</li>
</ul>
</li>
<li><strong>And so on</strong> - and so forth.</li>
</ul>
</p>
</section>
<section name="server.xml">
<p>For general discussion, see the <a href="#">Administrator's Guide</a>.</p>
<p>
<ul>
<li>Stuff - Stuff here</li>
<li>Stuff - Stuff here</li>
<li>Stuff - Stuff here</li>
</ul>
</p>
</section>
</body>
</document>
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Robert Slifka</author>
<title>Introduction to the Tomcat Container</title>
</properties>
<body>
<section name="Introduction">
<p>For administrators and web developers alike, there are some important bits of information you should familiarize yourself with before starting out. This document serves as a brief introduction to some of the concepts and terminology behind the Tomcat container. As well, where to go when you need help.</p>
</section>
<section name="Terminology">
<p>In the course of reading these documents, you'll run across a number of terms; some specific to Tomcat, and others defined by the <a href="http://java.sun.com/products/servlet/";>Servlet</a> or <a href="http://java.sun.com/products/jsp/";>JSP</a> specifications.</p>
<p>Context: In a nutshell, a Context is a web application.</p>
<p>Term2: This is it.</p>
<p>Term3: This is it!</p>
</section>
<section name="Directories and Files">
<p>Throughout the docs, you'll notice there are numerous references to <strong>$CATALINA_HOME</strong>. This represents the root of your Tomcat installation. When we say, "This information can be found in your $CATALINA_HOME/README.txt file" we mean to look at the README.txt file at the root of your Tomcat install.</p>
<p>For the complete description of the Tomcat distribution, each folder can be found in the <a href="">README.txt</a> file, residing in the root directory of your Tomcat installation. Here, we will cover the ones where you'll be spending the majority of your time.</p>
<p>
<ul>
<li><strong>/bin</strong> - Startup, shutdown, and other scripts. The *.sh files are functional duplicates of the *.bat files. Roughly, the .bat files are for Win32 platforms, and the .sh files are for *nix platforms. Since the Win32 command-line lacks certain functionality, there are some additional files in here.</li>
<li><strong>/conf</strong> - Configuration files and related DTDs. The most important file in here is server.xml. It is the main configuration file for the container.</li>
<li><strong>/logs</strong> - Log files are here by default.</li>
<li><strong>/webapps</strong> - This is where your webapps are.</li>
</ul>
</p>
</section>
<section name="Configuring Tomcat">
<p>This section will acquaint you with the basic information used during the configuration of the container.</p>
<p>All of the information in the configuration files is read at startup, meaning that any change to the files necessitates a restart of the container.</p>
</section>
<section name="Where to Go for Help">
<p>While we've done our best to ensure that these documents are clearly written and easy to understand, we may have missed something. Provided below are various web sites and mailing lists in case you get stuck.</p>
<p>As Tomcat 4 is a new release of Tomcat, Keep in mind that some of the issues and solutions vary between the major versions of Tomcat (3.x versus 4.x). keep in mind that as you search around the web, there will be some documentation that is not relevant to Tomcat 4, but 3.x. Doing 3.x things to 4.0 will probably not work in most cases as the server.xml files are very different.</p>
<p>
<ul>
<li>Current document - most documents will list potential hangups. Be sure to fully read the relevant documentation as it will save you much time and effort. There's nothing like scouring the web only to find out that the answer was right in front of you all along!</li>
<li>Jakarta <a href="http://jakarta.apache.org:8080/jyve-faq/Turbine/screen/MainMenu/action/SetAll/screen/DisplayTopics/faq_id/12/project_id/2;jsessionid=36lqy9k9x1";>FAQ-o-matic</a> - a repository of FAQs for the various Jakarta subprojects, including Tomcat of course.</li>
<li>Tomcat FAQ at <a href="http://www.jguru.com/faq/home.jsp?topic=Tomcat";>jGuru</a></li>
<li>Tomcat mailing list archives - numerous sites archive the Tomcat mailing lists. Since the links change over time, clicking here will search <a href="http://www.google.com/search?q=tomcat+mailing+list+archives";>Google</a>.</li>
<li>The tomcat-user mailing list, which you can subscribe to <a href="http://jakarta.apache.org/site/mail.html";>here</a>. If you don't get a reply, then there's a good chance that your question was probably answered in the list archives or one of the FAQs.</li>
</ul>
</p>
<p>And if you think something should be in the docs, by all means let us know on the tomcat-dev list, or send one of the doc authors email.</p>
<p>Some questions are about Tomcat, some questions are <strong>really</strong> about web application development in general. That being the case, in addition to the</p>
<p>Most documents containAt the end of most documents, you'll find.</p>
<p>If you find yourself stuck, first make sure. For the most common problems, first see the appendix of the each document in this bundle relays all</p>
<p>The less overall traffic on the mailing lists, the greater the chance your question will be answered promptly. If you can find the answer to a question without posting it to a list, you're increasing the chances that when you do have a tough question, someone knowledgeable</p>
</section>
</body>
</document>
<html><head><META http-equiv="Content-Type" content="text/html;
charset=iso-8859-1"><title>The Tomcat 4 Servlet/JSP Container - Reverse Lookup ???
Choose a better title ??? </title><meta value="Robert Slifka" name="author"><meta
value="[EMAIL PROTECTED]" name="email"></head><body vlink="#525D76" alink="#525D76"
link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="4" width="100%"
border="0"><!--PAGE HEADER--><tr><td colspan="2"><!--JAKARTA LOGO--><a
href="http://jakarta.apache.org/";><img border="0" alt="The Jakarta Project"
align="left" src="http://jakarta.apache.org/images/jakarta-logo.gif";></a><!--PROJECT
LOGO--><a href="http://jakarta.apache.org/tomcat/";><img border="0" alt="
The Tomcat Servlet/JSP Container
" align="right"
src="http://jakarta.apache.org/tomcat/images/tomcat.gif";></a></td></tr><!--HEADER
SEPARATOR--><tr><td colspan="2"><hr size="1" noshade=""></td></tr><tr><!--LEFT SIDE
NAVIGATION--><td nowrap="true" valign="top" width="20%"><p><strong>Getting
Started</strong></p><ul><li><a href="./index.html">Docs Home</a></li><li><a
href="./README.txt">READ ME</a></li><li><a href="./RUNNING.txt">Install and
Run</a></li><li><a href="./BUILDING.txt">Building from
Source</a></li></ul><p><strong>Administrators</strong></p><ul><li><a
href="./config/index.html">Config. Reference</a></li></ul><p><strong>App
Developers</strong></p><ul><li><a href="./appdev/index.html">App Developer
Guide</a></li><li><a href="./servletapi/index.html">Servlet/JSP
Javadocs</a></li></ul><p><strong>Tomcat Developers</strong></p><ul><li><a
href="./catalina/docs/api/index.html">Catalina Javadocs</a></li><li><a
href="./jasper/docs/api/index.html">Jasper Javadocs</a></li></ul></td><!--RIGHT SIDE
MAIN BODY--><td align="left" valign="top" width="80%"><table width="100%"
cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font
face="arial,helvetica.sanserif" color="#ffffff"><a
name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote>
<p>If you're wondering what configuration or development aspect a specific element
of the Tomcat distribution pertains to, then this is the place for you. This document
contains reverse-lookups of various parts of the container, and should help you answer
questions like:
<ul>
<li>What purpose does this file or directory serve?</li>
<li>Can I relocate these files or directories?</li>
<li>While trying to accomplish X, Y, or Z, do I need to configure this as
well?</li>
</ul>
</p>
</blockquote></td></tr></table><table width="100%" cellpadding="2" cellspacing="0"
border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif"
color="#ffffff"><a name="Directories%20and%20Files"><strong>Directories and
Files</strong></a></font></td></tr><tr><td><blockquote>
<p>First check README.txt for the complete list of directories contained in the
distribution. That will give each directory a general context so you should be able
to find out more information just by navigating to related topics.</p>
<p>
<ul>
<li><strong>/bin</strong> - Contains the startup, shutdown, and Jasper-related
scripts. Basic usage of the startup and shutdown scripts is covered in the <a
href="README.txt">README.txt</a> file while enhancing them is covered <a
href="#">HERE</a>. For information on offline JSP compilation with Jasper (roughly the
j* files), look <a href="#">HERE</a>.</li>
<li><strong>/conf</strong>
<ul>
<li><strong>catalina.policy</strong> - Security settings. Read about them
right over <a href="#">HERE</a>.</li>
<li><strong>server.xml</strong> - Covered below.</li>
<li><strong>tomcat-users.xml</strong> - JDBC Realm stuff. Look left, right,
up, down, and over <a href="#">HERE</a> for blah blah.</li>
<li><strong>web.xml</strong> - You'll want to check <a href="#">this</a>
out.</li>
<li><strong>*.dtd</strong> - <strong>D</strong>ocument <strong>T</strong>ype
<strong>D</strong>efinitions for the *.xml files of the same name. Are they validated
against? Read about it at <a href="#">this</a> location.</li>
</ul>
</li>
<li><strong>And so on</strong> - and so forth.</li>
</ul>
</p>
</blockquote></td></tr></table><table width="100%" cellpadding="2" cellspacing="0"
border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif"
color="#ffffff"><a
name="server.xml"><strong>server.xml</strong></a></font></td></tr><tr><td><blockquote>
<p>For general discussion, see the <a href="#">Administrator's Guide</a>.</p>
<p>
<ul>
<li>Stuff - Stuff here</li>
<li>Stuff - Stuff here</li>
<li>Stuff - Stuff here</li>
</ul>
</p>
</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td
colspan="2"><hr size="1" noshade=""></td></tr><!--PAGE FOOTER--><tr><td
colspan="2"><div align="center"><font size="-1" color="#525D76"><em>
Copyright © 1999-2001, Apache Software Foundation
</em></font></div></td></tr></table></body></html>
<html><head><META http-equiv="Content-Type" content="text/html;
charset=iso-8859-1"><title>The Tomcat 4 Servlet/JSP Container - Introduction to the
Tomcat Container</title><meta value="Robert Slifka" name="author"><meta
value="[EMAIL PROTECTED]" name="email"></head><body vlink="#525D76" alink="#525D76"
link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="4" width="100%"
border="0"><!--PAGE HEADER--><tr><td colspan="2"><!--JAKARTA LOGO--><a
href="http://jakarta.apache.org/";><img border="0" alt="The Jakarta Project"
align="left" src="http://jakarta.apache.org/images/jakarta-logo.gif";></a><!--PROJECT
LOGO--><a href="http://jakarta.apache.org/tomcat/";><img border="0" alt="
The Tomcat Servlet/JSP Container
" align="right"
src="http://jakarta.apache.org/tomcat/images/tomcat.gif";></a></td></tr><!--HEADER
SEPARATOR--><tr><td colspan="2"><hr size="1" noshade=""></td></tr><tr><!--LEFT SIDE
NAVIGATION--><td nowrap="true" valign="top" width="20%"><p><strong>Getting
Started</strong></p><ul><li><a href="./index.html">Docs Home</a></li><li><a
href="./README.txt">READ ME</a></li><li><a href="./RUNNING.txt">Install and
Run</a></li><li><a href="./BUILDING.txt">Building from
Source</a></li></ul><p><strong>Administrators</strong></p><ul><li><a
href="./config/index.html">Config. Reference</a></li></ul><p><strong>App
Developers</strong></p><ul><li><a href="./appdev/index.html">App Developer
Guide</a></li><li><a href="./servletapi/index.html">Servlet/JSP
Javadocs</a></li></ul><p><strong>Tomcat Developers</strong></p><ul><li><a
href="./catalina/docs/api/index.html">Catalina Javadocs</a></li><li><a
href="./jasper/docs/api/index.html">Jasper Javadocs</a></li></ul></td><!--RIGHT SIDE
MAIN BODY--><td align="left" valign="top" width="80%"><table width="100%"
cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font
face="arial,helvetica.sanserif" color="#ffffff"><a
name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote>
<p>For administrators and web developers alike, there are some important bits of
information you should familiarize yourself with before starting out. This document
serves as a brief introduction to some of the concepts and terminology behind the
Tomcat container. As well, where to go when you need help.</p>
</blockquote></td></tr></table><table width="100%" cellpadding="2" cellspacing="0"
border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif"
color="#ffffff"><a
name="Terminology"><strong>Terminology</strong></a></font></td></tr><tr><td><blockquote>
<p>In the course of reading these documents, you'll run across a number of terms;
some specific to Tomcat, and others defined by the <a
href="http://java.sun.com/products/servlet/";>Servlet</a> or <a
href="http://java.sun.com/products/jsp/";>JSP</a> specifications.</p>
<p>Context: In a nutshell, a Context is a web application.</p>
<p>Term2: This is it.</p>
<p>Term3: This is it!</p>
</blockquote></td></tr></table><table width="100%" cellpadding="2" cellspacing="0"
border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif"
color="#ffffff"><a name="Directories%20and%20Files"><strong>Directories and
Files</strong></a></font></td></tr><tr><td><blockquote>
<p>Throughout the docs, you'll notice there are numerous references to
<strong>$CATALINA_HOME</strong>. This represents the root of your Tomcat installation.
When we say, "This information can be found in your $CATALINA_HOME/README.txt file" we
mean to look at the README.txt file at the root of your Tomcat install.</p>
<p>For the complete description of the Tomcat distribution, each folder can be found
in the <a href="">README.txt</a> file, residing in the root directory of your Tomcat
installation. Here, we will cover the ones where you'll be spending the majority of
your time.</p>
<p>
<ul>
<li><strong>/bin</strong> - Startup, shutdown, and other scripts. The *.sh files
are functional duplicates of the *.bat files. Roughly, the .bat files are for Win32
platforms, and the .sh files are for *nix platforms. Since the Win32 command-line
lacks certain functionality, there are some additional files in here.</li>
<li><strong>/conf</strong> - Configuration files and related DTDs. The most
important file in here is server.xml. It is the main configuration file for the
container.</li>
<li><strong>/logs</strong> - Log files are here by default.</li>
<li><strong>/webapps</strong> - This is where your webapps are.</li>
</ul>
</p>
</blockquote></td></tr></table><table width="100%" cellpadding="2" cellspacing="0"
border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif"
color="#ffffff"><a name="Configuring%20Tomcat"><strong>Configuring
Tomcat</strong></a></font></td></tr><tr><td><blockquote>
<p>This section will acquaint you with the basic information used during the
configuration of the container.</p>
<p>All of the information in the configuration files is read at startup, meaning
that any change to the files necessitates a restart of the container.</p>
</blockquote></td></tr></table><table width="100%" cellpadding="2" cellspacing="0"
border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif"
color="#ffffff"><a name="Where%20to%20Go%20for%20Help"><strong>Where to Go for
Help</strong></a></font></td></tr><tr><td><blockquote>
<p>While we've done our best to ensure that these documents are clearly written and
easy to understand, we may have missed something. Provided below are various web
sites and mailing lists in case you get stuck.</p>
<p>As Tomcat 4 is a new release of Tomcat, Keep in mind that some of the issues and
solutions vary between the major versions of Tomcat (3.x versus 4.x). keep in mind
that as you search around the web, there will be some documentation that is not
relevant to Tomcat 4, but 3.x. Doing 3.x things to 4.0 will probably not work in most
cases as the server.xml files are very different.</p>
<p>
<ul>
<li>Current document - most documents will list potential hangups. Be sure to
fully read the relevant documentation as it will save you much time and effort.
There's nothing like scouring the web only to find out that the answer was right in
front of you all along!</li>
<li>Jakarta <a
href="http://jakarta.apache.org:8080/jyve-faq/Turbine/screen/MainMenu/action/SetAll/screen/DisplayTopics/faq_id/12/project_id/2;jsessionid=36lqy9k9x1";>FAQ-o-matic</a>
- a repository of FAQs for the various Jakarta subprojects, including Tomcat of
course.</li>
<li>Tomcat FAQ at <a
href="http://www.jguru.com/faq/home.jsp?topic=Tomcat";>jGuru</a></li>
<li>Tomcat mailing list archives - numerous sites archive the Tomcat mailing
lists. Since the links change over time, clicking here will search <a
href="http://www.google.com/search?q=tomcat+mailing+list+archives";>Google</a>.</li>
<li>The tomcat-user mailing list, which you can subscribe to <a
href="http://jakarta.apache.org/site/mail.html";>here</a>. If you don't get a reply,
then there's a good chance that your question was probably answered in the list
archives or one of the FAQs.</li>
</ul>
</p>
<p>And if you think something should be in the docs, by all means let us know on the
tomcat-dev list, or send one of the doc authors email.</p>
<p>Some questions are about Tomcat, some questions are <strong>really</strong> about
web application development in general. That being the case, in addition to the</p>
<p>Most documents containAt the end of most documents, you'll find.</p>
<p>If you find yourself stuck, first make sure. For the most common problems, first
see the appendix of the each document in this bundle relays all</p>
<p>The less overall traffic on the mailing lists, the greater the chance your
question will be answered promptly. If you can find the answer to a question without
posting it to a list, you're increasing the chances that when you do have a tough
question, someone knowledgeable</p>
</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td
colspan="2"><hr size="1" noshade=""></td></tr><!--PAGE FOOTER--><tr><td
colspan="2"><div align="center"><font size="-1" color="#525D76"><em>
Copyright © 1999-2001, Apache Software Foundation
</em></font></div></td></tr></table></body></html>
![http://jakarta.apache.org/images/jakarta-logo.gif"](http://jakarta.apache.org/images/jakarta-logo.gif"){kind=link}
![http://jakarta.apache.org/tomcat/images/tomcat.gif"](http://jakarta.apache.org/tomcat/images/tomcat.gif"){kind=link}