Hi, tomcat committers.
I have made a patch to improve some tomcat documents.
Could anyone apply it?
Changes:
- Fixes some typos.
- Fixes broken links, Commons DBCP javadoc and
Tyrex site, in jndi-datasource-examples-howto.xml.
- Writes "utf-8" encoding values into a sample xsl file of
directory listings in default-servlet.xml.
--
Kan Ogawa
[EMAIL PROTECTED]
Index: jakarta-tomcat-catalina/webapps/docs/default-servlet.xml
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat-catalina/webapps/docs/default-servlet.xml,v
retrieving revision 1.1
diff -u -w -r1.1 default-servlet.xml
--- jakarta-tomcat-catalina/webapps/docs/default-servlet.xml 19 Jun 2003 21:41:48
-0000 1.1
+++ jakarta-tomcat-catalina/webapps/docs/default-servlet.xml 22 Oct 2003 02:59:21
-0000
@@ -37,7 +37,7 @@
<section name="Where is it declared?">
<a name="where"></a>
It is declared globally in <i>$CATALINA_HOME/conf/web.xml</i>.
-By default here is it's declaration:
+By default here is its declaration:
<source>
<servlet>
<servlet-name>default</servlet-name>
@@ -151,9 +151,9 @@
<section name="How do I customize directory listings?">
<a name="dir"></a>
-<p>You can override DefaultServlet with you own implementation and use that
+<p>You can override DefaultServlet with your own implementation and use that
in your web.xml declaration. If you
-can undertand what was just said, we will assume yo can read the code
+can undertand what was just said, we will assume you can read the code
to DefaultServlet servlet and make the appropriate adjustments. (If not,
then that method isn't for you)
</p>
@@ -190,12 +190,12 @@
</p>
The following is a sample xsl file which mimics the default tomcat behavior:
<source>
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
version="1.0">
- <xsl:output method="xhtml" encoding="iso-8859-1" indent="no"/>
+ <xsl:output method="xhtml" encoding="utf-8" indent="no"/>
<xsl:template match="listing">
<html>
Index: jakarta-tomcat-catalina/webapps/docs/deployer-howto.xml
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat-catalina/webapps/docs/deployer-howto.xml,v
retrieving revision 1.5
diff -u -w -r1.5 deployer-howto.xml
--- jakarta-tomcat-catalina/webapps/docs/deployer-howto.xml 30 Jul 2003 18:37:06
-0000 1.5
+++ jakarta-tomcat-catalina/webapps/docs/deployer-howto.xml 22 Oct 2003 02:59:21
-0000
@@ -51,7 +51,7 @@
</p>
<p>Context descriptors allow defining all aspects and configuration parameters
-of a Context, such as namign resources and session manager configuration.
+of a Context, such as naming resources and session manager configuration.
It should be noted that the docBase specified in the Context element can
refer to either the .WAR or the directory which will be created when the
.WAR is expanded or the .WAR itself.</p>
Index: jakarta-tomcat-catalina/webapps/docs/jndi-datasource-examples-howto.xml
===================================================================
RCS file:
/home/cvspublic/jakarta-tomcat-catalina/webapps/docs/jndi-datasource-examples-howto.xml,v
retrieving revision 1.5
diff -u -w -r1.5 jndi-datasource-examples-howto.xml
--- jakarta-tomcat-catalina/webapps/docs/jndi-datasource-examples-howto.xml 15 Jan
2003 03:40:43 -0000 1.5
+++ jakarta-tomcat-catalina/webapps/docs/jndi-datasource-examples-howto.xml 22 Oct
2003 02:59:22 -0000
@@ -50,7 +50,7 @@
JDBC 3.0 features with a 1.4 JVM.
</p>
-<p>See the <a href="http://jakarta.apache.org/commons/dbcp/api/index.html";>
+<p>See the <a href="http://jakarta.apache.org/commons/dbcp/apidocs/index.html";>
DBCP Javadocs</a> BasicDataSource class for a complete list
of configuration parameters.
</p>
@@ -521,7 +521,7 @@
<p>
Tomcat 5 provides transaction management and resource configuration support through
the use of
-<a href="http://tyrex.exolab.org/";>Tyrex</a> 1.0. This allows the user to obtain
JTA/JCA resources
+<a href="http://tyrex.sourceforge.net/";>Tyrex</a> 1.0. This allows the user to obtain
JTA/JCA resources
from the JNDI namespace, as well as the standard
<code>javax.transaction.UserTransaction</code>.
</p>
@@ -534,7 +534,7 @@
Tyrex jar, as well as the jars it requires. Here is a list of the required jars, and
where to obtain them:
</p>
<p>
-The following jars are included with Tyrex binary distribution, available at
http://tyrex.exolab.org.
+The following jars are included with Tyrex binary distribution, available at
http://tyrex.sourceforge.net.
<ul>
<li>tyrex-1.0.jar</li>
@@ -551,13 +551,13 @@
</ul>
</p>
<p>
-All six of these jar files need to be placed on $TOMCAT_HOME/common/lib so that both
Tomcat and your web application will see them.
+All six of these jar files need to be placed on $CATALINA_HOME/common/lib so that
both Tomcat and your web application will see them.
</p>
</subsection>
<subsection name="Configuring Tyrex">
<p>
-The Tyrex documentation (http://tyrex.exolab.org) provides complete details on how to
properly configure Tyrex. As an example, we will use the following Tyrex
configuration, specified in Tyrex's domain configuration XML file:
+The Tyrex documentation (http://tyrex.sourceforge.net) provides complete details on
how to properly configure Tyrex. As an example, we will use the following Tyrex
configuration, specified in Tyrex's domain configuration XML file:
</p>
<source>
@@ -585,8 +585,8 @@
<ul>
<li>You need to specify the full pathname of the JAR file (for relative paths, Tyrex
looks in the current working directory, this usually isn't what you want). You can
also specify a URL.</li>
-<li>Any elements nested inside the <config></config> elements are passed as
parameters to the datasource class, using standard setter methods.</li>
-<li>More configuration options are available, as well as a better description of how
to setup Tyrex, at <a
href="http://tyrex.exolab.org/configuration.html";>http://tyrex.exolab.org/configuration.html</a></li>
+<li>Any elements nested inside the <config></config> elements are passed
as parameters to the datasource class, using standard setter methods.</li>
+<li>More configuration options are available, as well as a better description of how
to setup Tyrex, at <a
href="http://tyrex.sourceforge.net/configuration.html";>http://tyrex.sourceforge.net/configuration.html</a></li>
</ul>
</p>
<p>
Index: jakarta-tomcat-catalina/webapps/docs/jndi-resources-howto.xml
===================================================================
RCS file:
/home/cvspublic/jakarta-tomcat-catalina/webapps/docs/jndi-resources-howto.xml,v
retrieving revision 1.5
diff -u -w -r1.5 jndi-resources-howto.xml
--- jakarta-tomcat-catalina/webapps/docs/jndi-resources-howto.xml 9 Aug 2003
18:59:22 -0000 1.5
+++ jakarta-tomcat-catalina/webapps/docs/jndi-resources-howto.xml 22 Oct 2003
02:59:22 -0000
@@ -292,7 +292,7 @@
<h3>1. Declare Your Resource Requirements</h3>
- <p>The first thing you should do is modify the web application deployment
+ <p>The first thing you should do is to modify the web application deployment
descriptor (<code>/WEB-INF/web.xml</code>) to declare the JNDI name under
which you will look up preconfigured sessions. By convention, all such
names should resolve to the <code>mail</code> subcontext (relative to the
@@ -384,7 +384,7 @@
<code>/WEB-INF/classes/SendMailServlet.java</code>.</p>
<p><strong>WARNING</strong> - The default configuration assumes that
- there is an SMTP server listing on port 25 on <code>localhost</code>.
+ there is an SMTP server listening on port 25 on <code>localhost</code>.
If this is not the case, edit the
<code>$CATALINA_HOME/conf/server.xml</code> file, and modify the
parameter value for the <code>mail.smtp.host</code> parameter to be
Index: jakarta-tomcat-catalina/webapps/docs/realm-howto.xml
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat-catalina/webapps/docs/realm-howto.xml,v
retrieving revision 1.10
diff -u -w -r1.10 realm-howto.xml
--- jakarta-tomcat-catalina/webapps/docs/realm-howto.xml 6 Oct 2003 09:43:30
-0000 1.10
+++ jakarta-tomcat-catalina/webapps/docs/realm-howto.xml 22 Oct 2003 02:59:23
-0000
@@ -18,6 +18,7 @@
<p>
<a href="#Quick Start">Quick Start</a><br />
+<a href="#Overview">Overview</a><br />
<blockquote>
<a href="#What is a Realm?">What is a Realm?</a><br />
<a href="#Configuring a Realm">Configuring a Realm</a><br />
@@ -1115,7 +1116,7 @@
<h3>User File Format</h3>
-<p>The users file (by default, <code>conf/tomcat-users.xml</code> must be an
+<p>The users file (by default, <code>conf/tomcat-users.xml</code>) must be an
XML document, with a root element <code><tomcat-users></code>. Nested
inside the root element will be a <code><user></code> element for each
valid user, consisting of the following attributes:</p>
@@ -1401,7 +1402,7 @@
within that application.</p>
<p>For security reasons, no username in the default Realm (i.e. using
-<code>conf/tomcat-users.xml</code> is assigned the "manager" role. Therfore,
+<code>conf/tomcat-users.xml</code>) is assigned the "manager" role. Therfore,
no one will be able to utilize the features of this application until the
Tomcat administrator specifically assigns this role to one or more users.</p>
Index: jakarta-tomcat-catalina/webapps/docs/ssl-howto.xml
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat-catalina/webapps/docs/ssl-howto.xml,v
retrieving revision 1.9
diff -u -w -r1.9 ssl-howto.xml
--- jakarta-tomcat-catalina/webapps/docs/ssl-howto.xml 11 Oct 2003 08:52:41 -0000
1.9
+++ jakarta-tomcat-catalina/webapps/docs/ssl-howto.xml 22 Oct 2003 02:59:24 -0000
@@ -45,7 +45,7 @@
</source>
<p></p>
and specify a password value of "changeit".</li><br/><br/>
-<li>Uncomment the "SSL HTTP/1.1 Connector" entry in
+<li>Uncomment the "SSL Coyote HTTP/1.1 Connector" entry in
<code>$CATALINA_HOME/conf/server.xml</code> and tweak as necessary.</li>
<br/><br/>
</ol>
@@ -402,7 +402,7 @@
</section>
<section name="Installing a Certificate from a Certificate Authority">
-<p>To obstain and install a Certificate from a Certificate Authority (like
verisign.com, thawte.com
+<p>To obtain and install a Certificate from a Certificate Authority (like
verisign.com, thawte.com
or trustcenter.de) you should have read the previous section and then follow these
instructions:</p>
<subsection name="Create a local Certificate Signing Request (CSR)">
@@ -423,13 +423,13 @@
</li>
</ul>
<p>Now you have a file called <code>certreq.csr</code> that you can submit to the
Certificate Authority (look at the
-documenation of the Certificate Authority website on how to do this). In return you
get a Certificate.</p>
+documentation of the Certificate Authority website on how to do this). In return you
get a Certificate.</p>
</subsection>
<subsection name="Importing the Certificate">
-<p>Now that you have your Certificate you can import it into you local keystore.
+<p>Now that you have your Certificate you can import it into your local keystore.
First of all you have to import a so called Chain Certificate or Root Certificate
into your keystore.
-After that you can procede with importing your Certificate.</p>
+After that you can proceed with importing your Certificate.</p>
<ul>
<li>Download a Chain Certificate from the Certificate Authority you obtained the
Certificate from.<br/>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
