You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by cr...@apache.org on 2001/09/13 00:45:24 UTC
cvs commit: jakarta-tomcat-4.0/webapps/tomcat-docs/config index.xml
craigmcc 01/09/12 15:45:24
Modified: webapps/tomcat-docs/config index.xml
Log:
Remove TODOs and flesh out the overview of the Server Configuration Reference.
Revision Changes Path
1.3 +41 -6 jakarta-tomcat-4.0/webapps/tomcat-docs/config/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 2001/08/05 03:42:28 1.2
+++ index.xml 2001/09/12 22:45:24 1.3
@@ -20,14 +20,49 @@
directives that can be included in a <code>conf/server.xml</code> file to
configure the behavior of the Tomcat 4 servlet/JSP container. It does not
attempt to describe which configuration directives should be used to perform
-specific tasks - for that, see the <em>Server Configuration Guide</em> and
-related documents. (TODO - will need hyperlink(s) to this).</p>
+specific tasks - for that, see the various <em>HOW-TO</em> documents on the
+main index page.</p>
-<p>TODO - add some verbage about the overall organization of conf/server.xml
-and the valid nesting that is allowed.</p>
+<p>The configuration element descriptions are organized into the following
+major categories:</p>
+<ul>
+<li><strong>Top Level Elements</strong> - <code><Server></code> is the
+ root element of the entire configuration file, while
+ <code><Service></code> represents a group of Connectors that is
+ associated with an Engine.</li>
+<li><strong>Connectors</strong> - Represent the interface between external
+ clients sending requests to (and receiving responses from) a particular
+ Service.</li>
+<li><strong>Containers</strong> - Represent components whose function is to
+ process incoming requests, and create the corresponding responses.
+ An Engine handles all requests for a Service, a Host handles all requests
+ for a particular virtual host, and a Context handles all requests for a
+ specific web application.</li>
+<li><strong>Nested Components</strong> - Represent elements that can be
+ nested inside the element for a Container. Some elements can be nested
+ inside any Container, while others can only be nested inside a
+ Context.</li>
+</ul>
-<p>TODO - add a brief description of the categories of elements listed in
-the navigation menu (top level, connectors, containers, nested).</p>
+<p>For each element, the corresponding documentation follows this general
+outline:</p>
+<ul>
+<li><strong>Introduction</strong> - Overall description of this particular
+ component. There will be a corresponding Java <em>interface</em> (in
+ the <code>org.apache.catalina</code> pacakge) that is implemented by one
+ or more standard implementations.</li>
+<li><strong>Attributes</strong> - The set of attributes that are legal for
+ this element. Generally, this will be subdivided into <em>Common</em>
+ attributes that are supported by all implementations of the corresponding
+ Java interface, and <em>Standard Implementation</em> attributes that are
+ specific to a particular Java class that implements this interface.
+ The names of required attributes are <strong>bolded</strong>.</li>
+<li><strong>Nested Components</strong> - Enumerates which of the <em>Nested
+ Components</em> can be legally nested within this element.</li>
+<li><strong>Special Features</strong> - Describes the configuration of a large
+ variety of special features (specific to each element type) that are
+ supported by the standard implementation of this interface.</li>
+</ul>
</section>