craigmcc01/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 ChangesPath
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 conf/server.xml 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 Server Configuration Guide and
-related documents. (TODO - will need hyperlink(s) to this).
+specific tasks - for that, see the various HOW-TO documents on the
+main index page.
-TODO - add some verbage about the overall organization of conf/server.xml
-and the valid nesting that is allowed.
+The configuration element descriptions are organized into the following
+major categories:
+
+Top Level Elements - is the
+root element of the entire configuration file, while
+ represents a group of Connectors that is
+associated with an Engine.
+Connectors - Represent the interface between external
+clients sending requests to (and receiving responses from) a particular
+Service.
+Containers - 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.
+Nested Components - 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.
+
-TODO - add a brief description of the categories of elements listed in
-the navigation menu (top level, connectors, containers, nested).
+For each element, the corresponding documentation follows this general
+outline:
+
+Introduction - Overall description of this particular
+component. There will be a corresponding Java interface (in
+the org.apache.catalina pacakge) that is implemented by one
+or more standard implementations.
+Attributes - The set of attributes that are legal for
+this element. Generally, this will be subdivided into Common
+attributes that are supported by all implementations of the corresponding
+Java interface, and Standard Implementation attributes that are
+specific to a particular Java class that implements this interface.
+The names of required attributes are bolded.
+Nested Components - Enumerates which of the Nested
+Components can be legally nested within this element.
+Special Features - 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.
+