You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by re...@apache.org on 2003/05/15 00:08:02 UTC
cvs commit: jakarta-tomcat-catalina/webapps/docs index.xml project.xml
remm 2003/05/14 15:08:02
Modified: webapps/docs index.xml project.xml
Log:
- Update documentation index.
Revision Changes Path
1.7 +67 -103 jakarta-tomcat-catalina/webapps/docs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/webapps/docs/index.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- index.xml 3 Feb 2003 23:17:08 -0000 1.6
+++ index.xml 14 May 2003 22:08:02 -0000 1.7
@@ -8,6 +8,7 @@
<properties>
<author email="craigmcc@apache.org">Craig R. McClanahan</author>
+ <author email="remm@apache.org">Remy Maucherat</author>
<title>Documentation Index</title>
</properties>
@@ -29,29 +30,69 @@
</section>
-<section name="Getting Started">
+<section name="Tomcat User Guide">
-<p>The following documents will assist you in downloading and installing
-Tomcat 5, and (if you wish to) building a distribution from the source code.
-</p>
-<ul>
+<p>The following documents will assist you in downloading, installing
+Tomcat 5, and using many of the Tomcat features.</p>
+
+<ol>
<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 5 binary distribution.</li>
-<li><a href="RUNNING.txt"><strong>RUNNING.txt</strong></a> - Documents the
- steps necessary to download, install, start, and stop a Tomcat 5 server.
- </li>
-<li><a href="BUILDING.txt"><strong>BUILDING.txt</strong></a> - Details the
- steps necessary to download Tomcat 5 source code (and the other packages
- that it depends on), and build a binary distribution from those sources.
+<li><a href="setup.html"><strong>Setup</strong></a> - How to install and run
+ Tomcat on a variety of platforms.</li>
+<li><a href="appdev/index.html"><strong>First web application</strong></a>
+ - An introduction to the concepts of a <em>web application</em> as defined
+ in the <a href="http://java.sun.com/products/servlet/download.html">Servlet
+ 2.3 Specification</a>. Covers basic organization of your web application
+ source tree, the structure of a web application archive, and an
+ introduction to the web application deployment descriptor
+ (<code>/WEB-INF/web.xml</code>).</li>
+<li><a href="deployer-howto.html"><strong>Deployer</strong></a> -
+ Operating the Tomcat Deployer to deploy, precompile, and validate web
+ applications.</li>
+<li><a href="manager-howto.html"><strong>Manager</strong></a> -
+ Operating the <code>Manager</code> web app to deploy, undeploy, and
+ redeploy applications while Tomcat is running.</li>
+<li><a href="realm-howto.html"><strong>Realms and Access Control</strong></a>
+ - Description of how to configure <em>Realms</em> (databases of users,
+ passwords, and their associated roles) for use in web applications that
+ utilize <em>Container Managed Security</em>.</li>
+<li><a href="security-manager-howto.html"><strong>Security Manager</strong></a>
+ - Configuring and using a Java Security Manager to
+ support fine-grained control over the behavior of your web applications.
</li>
-</ul>
+<li><a href="jndi-resources-howto.html"><strong>JNDI Resources</strong></a>
+ - Configuring standard and custom resources in the JNDI naming context
+ that is provided to each web application.</li>
+<li><a href="jndi-datasource-examples-howto.html">
+ <strong>JDBC DataSource</strong></a>
+ - Configuring a JNDI DataSoure with a DB connection pool.
+ Examples for many popular databases.</li>
+<li><a href="class-loader-howto.html"><strong>Classloading</strong></a>
+ - Information about class loading in Tomcat 5, including where to place
+ your application classes so that they are visible.</li>
+<li><a href="jasper-howto.html"><strong>JSPs</strong></a>
+ - Information about Jasper configuration, as well as the JSP compiler
+ usage.</li>
+<li><a href="ssl-howto.html"><strong>SSL</strong></a> -
+ Installing and
+ configuring SSL support so that your Tomcat will serve requests using
+ the <code>https</code> protocol.</li>
+<li><a href="ssi-howto.html"><strong>SSI</strong></a> -
+ Using Server Side Includes in Tomcat.</li>
+<li><a href="cgi-howto.html"><strong>CGI</strong></a> -
+ Using CGIs with Tomcat.</li>
+<li><a href="proxy-howto.html"><strong>Proxy Support</strong></a> -
+ Configuring Tomcat 5 to run behind a proxy server (or a web server
+ functioning as a proxy server).</li>
+<li><a href="mbeans-descriptor-howto.html"><strong>MBean Descriptor</strong></a> -
+ Configuring MBean descriptors files for custom components.</li>
+</ol>
</section>
-<section name="Administrators">
+<section name="Reference">
<p>The following documents are aimed at <em>System Administrators</em> who
are responsible for installing, configuring, and operating a Tomcat 5 server.
@@ -61,117 +102,40 @@
- Reference manual that documents all available elements and attributes
that may be placed into a Tomcat 5 <code>conf/server.xml</code> file.
</li>
-<li><a href="class-loader-howto.html"><strong>Class Loader HOW-TO</strong></a>
- - Information about class loading in Tomcat 5, including where to place
- your application classes so that they are visible.</li>
-<li><a href="html-manager-howto.html"><strong>HTML Manager App HOW-TO</strong></a> -
- Operating the <code>HTML Manager</code> web app to deploy, undeploy, and
- redeploy applications while Tomcat is running.</li>
<li><a href="jk2/index.html"><strong>JK Documenation</strong></a>
- Complete documentation and HOWTOs on the JK native webserver connector,
used to interface Tomcat with servers like Apache HTTPd, IIS
and others.</li>
-<li><a href="jndi-datasource-examples-howto.html">
- <strong>JNDI DataSource HOW-TO</strong></a>
- - Configuring a JNDI DataSoure with a dB connection pool.
- Examples for many popular databases.</li>
-<li><a href="jndi-resources-howto.html"><strong>JNDI Resources HOW-TO</strong></a>
- - Configuring standard and custom resources in the JNDI naming context
- that is provided to each web application.</li>
-<li><a href="manager-howto.html"><strong>Manager App HOW-TO</strong></a> -
- Operating the <code>Manager</code> web app to deploy, undeploy, and
- redeploy applications while Tomcat is running.</li>
-<li><a href="mbeans-descriptor-howto.html"><strong>MBean Descriptor HOW-TO</strong></a> -
- Configuring MBean descriptors files for custom components.</li>
-<li><a href="proxy-howto.html"><strong>Proxy Support HOW-TO</strong></a> -
- Configuring Tomcat 5 to run behind a proxy server (or a web server
- functioning as a proxy server).</li>
-<li><a href="realm-howto.html"><strong>Realm Configuration HOW-TO</strong></a>
- - Description of how to configure <em>Realms</em> (databases of users,
- passwords, and their associated roles) for use in web applications that
- utilize <em>Container Managed Security</em> (FIXME - hyperlink to
- background info on this).</li>
-<li><a href="security-manager-howto.html"><strong>Security Manager
- HOW-TO</strong></a> - Configuring and using a Java Security Manager to
- support fine-grained control over the behavior of your web applications.
- </li>
-<li><a href="ssl-howto.html"><strong>SSL Configuration HOW-TO</strong></a> -
- Installing and
- configuring SSL support so that your Tomcat will serve requests using
- the <code>https</code> protocol.</li>
+<li><a href="servletapi/index.html"><strong>Servlet API Javadocs</strong></a> -
+ The Servlet 2.4 API Javadocs.</li>
+<li><a href="jspapi/index.html"><strong>JSP API Javadocs</strong></a> -
+ The JSP 2.0 API Javadocs.</li>
</ul>
</section>
-<section name="Application Developers">
-
-<p>The following documents are aimed at <em>Application Developers</em> who
-are constructing web applications or web services that will run on Tomcat.</p>
-<ul>
-<li><a href="appdev/index.html"><strong>Application Developer's Guide</strong></a>
- - An introduction to the concepts of a <em>web application</em> as defined
- in the <a href="http://java.sun.com/products/servlet/download.html">Servlet
- 2.3 Specification</a>. Covers basic organization of your web application
- source tree, the structure of a web application archive, and an
- introduction to the web application deployment descriptor
- (<code>/WEB-INF/web.xml</code>).</li>
-<li><a href="servletapi/index.html"><strong>Servlet/JSP Javadocs</strong></a> -
- The Servlet 2.4 and JSP 2.0 API Javadocs.</li>
-</ul>
-
-</section>
-
-
-<section name="Catalina Developers">
+<section name="Tomcat Developers">
<p>The following documents are for Java developers who wish to contribute to
-the development of the <em>Catalina</em> servlet container portion of Tomcat
-itself, or to better understand its internal architecture and operation.</p>
+the development of the <em>Tomcat</em> project.</p>
<ul>
+<li><a href="BUILDING.txt"><strong>Building from Source</strong></a> - Details the
+ steps necessary to download Tomcat 5 source code (and the other packages
+ that it depends on), and build a binary distribution from those sources.
+ </li>
<li><a href="catalina/funcspecs/index.html"><strong>Functional Specifications</strong></a>
- Requirements specifications for features of the <em>Catalina</em> servlet
container portion of Tomcat 5.</li>
-<li><a href="catalina/docs/api/index.html"><strong>Javadocs</strong></a>
+<li><a href="catalina/docs/api/index.html"><strong>Catalina Javadocs</strong></a>
- Javadoc API documentation for the <em>Catalina</em> servlet container
portion of Tomcat 5.</li>
-</ul>
-
-</section>
-
-
-<section name="Coyote Developers">
-
-<p>Coyote includes a low level connector API, a set of low level utility
-objects, as well as high performance implementations for the HTTP/1.1, AJP 1.3
-and JNI protocols. Catalina is based on the Coyote API.</p>
-
-<p>The following documents are for Java developers who wish to contribute to
-the development of the <em>Coyote</em> connector portion of Tomcat
-itself, or to better understand its internal architecture and operation.</p>
-
-<ul>
<li><a href="coyote/api/org/apache/coyote/package-summary.html"><strong>Coyote API Javadocs</strong></a>
- Javadoc API documentation for the <em>Coyote</em> API.</li>
<li><a href="coyote/http11/api/index.html"><strong>Coyote HTTP/1.1 Javadocs</strong></a>
- Javadoc API documentation for the <em>Coyote HTTP/1.1</em> connector.</li>
<li><a href="coyote/util/index.html"><strong>Util API Javadocs</strong></a>
- Javadoc API documentation for the <em>Coyote Utilties</em> API.</li>
-</ul>
-
-</section>
-
-
-<section name="Jasper Developers">
-
-<p>The following documents are for Java developers who wish to contribute to
-the development of the <em>Jasper</em> JSP container portion of Tomcat
-itself, or to better understand its internal architecture and operation.</p>
-<ul>
-<!--
-<li><a href="jasper-requirements.html"><strong>Jasper Overall Requirements</strong></a>
- - High level Jasper development requirements For Tomcat 5.</li>
--->
<li><a href="jasper/docs/api/index.html"><strong>Javadocs</strong></a>
- Javadoc API documentation for the <em>Jasper</em> JSP container
portion of Tomcat 5.</li>
1.11 +15 -16 jakarta-tomcat-catalina/webapps/docs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/webapps/docs/project.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- project.xml 11 May 2003 20:02:39 -0000 1.10
+++ project.xml 14 May 2003 22:08:02 -0000 1.11
@@ -17,24 +17,23 @@
<menu name="User Guide">
<item name="1) Introduction" href="introduction.html"/>
- <item name="2) Installing" href="installing.html"/>
- <item name="3) Running" href="installing.html"/>
- <item name="4) My first webapp" href="appdev/index.html"/>
- <item name="5) Deployer" href="deployer-howto.html"/>
- <item name="6) Manager" href="manager-howto.html"/>
- <item name="7) Realms and AAA" href="realm-howto.html"/>
- <item name="8) Security Manager"
+ <item name="2) Setup" href="setup.html"/>
+ <item name="3) First webapp" href="appdev/index.html"/>
+ <item name="4) Deployer" href="deployer-howto.html"/>
+ <item name="5) Manager" href="manager-howto.html"/>
+ <item name="6) Realms and AAA" href="realm-howto.html"/>
+ <item name="7) Security Manager"
href="security-manager-howto.html"/>
- <item name="9) JNDI Resources" href="jndi-resources-howto.html"/>
- <item name="10) JDBC DataSources"
+ <item name="8) JNDI Resources" href="jndi-resources-howto.html"/>
+ <item name="9) JDBC DataSources"
href="jndi-datasource-examples-howto.html"/>
- <item name="11) Classloading" href="class-loader-howto.html"/>
- <item name="12) JSPs" href="jasper-howto.html"/>
- <item name="13) SSL" href="ssl-howto.html"/>
- <item name="14) SSI" href="ssi-howto.html"/>
- <item name="15) CGI" href="cgi-howto.html"/>
- <item name="16) Proxy Support" href="proxy-howto.html"/>
- <item name="17) MBean Descriptor"
+ <item name="10) Classloading" href="class-loader-howto.html"/>
+ <item name="11) JSPs" href="jasper-howto.html"/>
+ <item name="12) SSL" href="ssl-howto.html"/>
+ <item name="13) SSI" href="ssi-howto.html"/>
+ <item name="14) CGI" href="cgi-howto.html"/>
+ <item name="15) Proxy Support" href="proxy-howto.html"/>
+ <item name="16) MBean Descriptor"
href="mbeans-descriptor-howto.html"/>
</menu>
---------------------------------------------------------------------
To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org