craigmcc 01/08/06 13:24:07
Modified: webapps/tomcat-docs index.xml project.xml
Added: webapps/tomcat-docs introduction.xml
Log:
Add Rob Slifka's "introduction.xml" document to the tree, with a few
cleanups. Quick review comments:
- Please use an editor that wraps lines at <= 80 characters. Otherwise
it is difficult to edit this file in many editors.
- There were several incomplete paragraphs at the bottom, so I took a
few liberties at completing them.
- Given the way that the overall document tree takes shape, the content
of this file needs to be reviewed. For example, the "terminology"
section will probably deserve its own page, while the rehash of the
directory structure is probably redundant with the contents of the
"README.txt" file.
Revision Changes Path
1.5 +2 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/index.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.xml 2001/08/06 19:08:51 1.4
+++ index.xml 2001/08/06 20:24:07 1.5
@@ -36,6 +36,8 @@
Tomcat 4, and (if you wish to) building a distribution from the source code.
</p>
<ul>
+<li><a href="introduction.html"><strong>Introduction</strong></a> - A
+ brief, high level, overview of Tomcat.</li>
<li><a href="README.txt"><strong>README.txt</strong></a> - Describes the
contents and directory structure of a Tomcat 4 binary distribution.</li>
<li><a href="RUNNING.txt"><strong>RUNNING.txt</strong></a> - Documents the
1.5 +5 -1 jakarta-tomcat-4.0/webapps/tomcat-docs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/project.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- project.xml 2001/08/06 19:08:51 1.4
+++ project.xml 2001/08/06 20:24:07 1.5
@@ -11,8 +11,12 @@
<body>
- <menu name="Getting Started">
+ <menu name="Links">
<item name="Docs Home" href="index.html"/>
+ </menu>
+
+ <menu name="Getting Started">
+ <item name="Introduction" href="introduction.html"/>
<item name="READ ME" href="README.txt"/>
<item name="Install and Run" href="RUNNING.txt"/>
<item name="Building from Source" href="BUILDING.txt"/>
1.1 jakarta-tomcat-4.0/webapps/tomcat-docs/introduction.xml
Index: introduction.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document>
&project;
<properties>
<author email="[EMAIL PROTECTED]">Robert Slifka</author>
<title>Introduction</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>
<ul>
<li><strong>Context</strong> - In a nutshell, a Context is a
web application.</li>
<li><strong>Term2</strong> - This is it.</li>
<li><strong>Term3</strong> - This is it!</li>
</ul>
</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">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>
<ul>
<li><strong>/bin</strong> - Startup, shutdown, and other scripts. The
<code>*.sh</code> files (for Unix systems) are functional duplicates of
the <code>*.bat</code> files (for Windows systems). 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 go.</li>
</ul>
</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). 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>
<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. Although questions
about web application development in general are sometimes asked and
answered, please focus your questions on Tomcat-specific issues.</li>
<li>The TOMCAT-DEV mailing list, which you can subscribe to
<a href="http://jakarta.apache.org/site/mail.html";>here</a>. This list is
<strong>reserved</strong> for discussions about the development of Tomcat
itself. Questions about Tomcat configuration, and the problems you run
into while developing and running applications, will normally be more
appropriate on the TOMCAT-USER list instead.</li>
</ul>
<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>
</section>
</body>
</document>
