mturk 2004/11/18 10:27:48
Modified: jk/xdocs .cvsignore faq.xml index.xml
Added: jk/xdocs build.xml project.xml style.css style.xsl
Log:
Add new style documents
Revision Changes Path
1.4 +0 -3 jakarta-tomcat-connectors/jk/xdocs/.cvsignore
Index: .cvsignore
===================================================================
RCS file: /home/cvs/jakarta-tomcat-connectors/jk/xdocs/.cvsignore,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- .cvsignore 18 Nov 2004 18:16:41 -0000 1.3
+++ .cvsignore 18 Nov 2004 18:27:48 -0000 1.4
@@ -1,5 +1,2 @@
-style.css
-style.xsl
-menu.idx
jk
jk2
1.11 +30 -29 jakarta-tomcat-connectors/jk/xdocs/faq.xml
Index: faq.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-connectors/jk/xdocs/faq.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- faq.xml 4 Mar 2004 04:46:33 -0000 1.10
+++ faq.xml 18 Nov 2004 18:27:48 -0000 1.11
@@ -1,5 +1,10 @@
<?xml version="1.0"?>
-<document>
+<!DOCTYPE document [
+ <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="faq.html">
+
+ &project;
<copyright>
Copyright 1999-2004 The Apache Software Foundation
@@ -20,7 +25,7 @@
<author email="[EMAIL PROTECTED]">Henri Gomez</author>
<date>$Date$</date>
</properties>
-
+<body>
<section name="General">
<p>
General Informations and FAQ about JK
@@ -67,17 +72,17 @@
</p>
<p>
-<a href="jk/domhowto.html">Domino webserver</a> support is implemented on
JK, using a redirector
+<a href="howto/domino.html">Domino webserver</a> support is implemented on
JK, using a redirector
called <b>dsapi redirector</b>.
</p>
<p>
-<a href="jk/iishowto.html">IIS webserver</a>support is implemented on JK,
using a redirector
+<a href="howto/iis.html">IIS webserver</a>support is implemented on JK,
using a redirector
called <b>isapi redirector</b>.
</p>
<p>
-<a href="jk/neshowto.html">Netscape/iPlanet webserver</a>webserver support
is implemented on JK, using a redirector
+<a href="howto/nes.html">Netscape/iPlanet webserver</a>webserver support is
implemented on JK, using a redirector
called <b>nsapi redirector</b>.
</p>
@@ -91,43 +96,39 @@
<ul>
<li>
-<a href="jk/quickhowto.html">For the impatients</a>
+<a href="howto/quick.html">For the impatients</a>
</li>
<li>
-<a href="jk/aphowto.html">Apache and JK</a>
+<a href="howto/apache.html">Apache and JK</a>
</li>
<li>
-<a href="jk/domhowto.html">Domino and JK</a>
+<a href="howto/domino.html">Domino and JK</a>
</li>
<li>
-<a href="jk/iishowto.html">IIS and JK</a>
+<a href="howto/iis.html">IIS and JK</a>
</li>
<li>
-<a href="jk/neshowto.html">Netscape/iPlanet and JK</a>
+<a href="howto/nes.html">Netscape/iPlanet and JK</a>
</li>
<li>
-<a href="jk/workershowto.html">Workers configuration</a>
+<a href="howto/workers.html">Workers configuration</a>
</li>
</ul>
-<p>
-For <b>JK 2.0.x</b> the <a href="jk2/configtc.html">
-config tomcat</a> and <a href="jk2/configweb.html">config webserver</a>
-documents have considerably more in-depth information.
-It's worth a look.
+<p>
You could also try searching the mailing list archives for "JK" or look at
the source.
</p>
</subsection>
<subsection name="Which protocol should I use? Ajp12 or Ajp13?">
<p>
-<a href="common/AJPv13.html">Ajp13</a> is a newer protocol, it's faster, and
it works better with SSL.
-You almost certainly want to use it now that ajp12 is deprecated.
+<a href="common/ajpv13.html">Ajp13</a> is a newer protocol, it's faster, and
it works better with SSL.
+You almost certainly want to use it now that <strong>ajp12 is
deprecated</strong>.
</p>
<p>
Also ajp13 is supported by all Apache Tomcat including 3.2.x , 3.3.x, 4.0.x,
4.1.x and the new tomcat 5.
@@ -145,7 +146,7 @@
</p>
<p>
Starting with JK 1.2.0, a <b>socket_keepalive</b> property as been added to
ajp13 settings, and you should take a look at
-it in <a href="jk/workershowto.html">Workers HowTo</a>.
+it in <a href="howto/workers.html">Workers HowTo</a>.
</p>
</subsection>
@@ -158,8 +159,8 @@
even if they are no more used.
</p>
<p>
-Since JK 1.2.0, <b>cache_timeout</b> and <b>socket_timeout</b> properties as
been added to close
-connections after some time of inactivity, for more informations refer to <a
href="jk/workershowto.html">Workers HowTo</a>.
+Since JK 1.2.0, <b>cache_timeout</b> and <b>recycle_timeout</b> properties
as been added to close
+connections after some time of inactivity, for more informations refer to <a
href="howto/workers.html">Workers HowTo</a>.
</p>
</subsection>
@@ -259,10 +260,10 @@
the pthreads library to your <b>httpd.conf</b> file.
</p>
-<screen>
-<note># Add pthread to Apache in httpd.conf</note>
-<read>LoadModule "/usr/lib/libpthreads.so"</read>
-</screen>
+<source>
+ # Add pthread to Apache in httpd.conf
+ LoadModule "/usr/lib/libpthreads.so"
+</source>
<p>
Also keep in mind that JNI is suited for multi-threaded servers and you
should consider upgrading
@@ -322,7 +323,7 @@
Informations and FAQ about JK and IIS Web Servers.
</p>
<todo>
-More informations to be added, Nacho ?
+More informations to be added.
</todo>
</section>
@@ -331,9 +332,9 @@
Informations and FAQ about JK and NES/iPlanet Web Servers.
</p>
<todo>
-More informations to be added, Mike ?
+More informations to be added.
</todo>
</section>
-
+</body>
</document>
1.20 +81 -128 jakarta-tomcat-connectors/jk/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-connectors/jk/xdocs/index.xml,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- index.xml 5 Oct 2004 10:01:04 -0000 1.19
+++ index.xml 18 Nov 2004 18:27:48 -0000 1.20
@@ -1,155 +1,108 @@
<?xml version="1.0"?>
-<document>
-<copyright>
- Copyright 1999-2004 The Apache Software Foundation
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-</copyright>
-<properties>
-<title>Overview</title>
-<author email="[EMAIL PROTECTED]">Jean-Frederic Clere</author>
-<author email="[EMAIL PROTECTED]">Henri Gomez</author>
-<author email="[EMAIL PROTECTED]">Yoav Shapira</author>
-<date>$Date$</date>
-</properties>
-
-<section name="What's JK?">
-<p>
-<b>JK</b> is a replacement to the elderly mod_jserv.
-It was a completely new Tomcat-Apache plug-in that handles the communication
between Tomcat and Apache.
-</p>
-<p>
-The newest <b>JK2</b> is a refactoring of <b>JK</b>.
-The native part has been completly
-restructured and the configuration has been simplified a lot.
-</p>
+<!DOCTYPE document [
+ <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="index.html">
+
+ &project;
+
+ <properties>
+ <author email="[EMAIL PROTECTED]">Mladen Turk</author>
+ <title>Documentation Index</title>
+ </properties>
+
+<body>
+
+<section name="Introduction">
+
+<p>This is the top-level entry point of the documentation bundle for the
+<strong>Apache Jakarta Tomcat Connectors</strong>
-<p>
-JK is more than just an apache module, since it could be used with majors
WebServer :
</p>
+<p>Select one of the links from the navigation menu (to the left) to drill
+down to the more detailed documenation that is available. Each available
+manual is described in more detail below.</p>
+
+</section>
+<section name="Headlines">
+<br />
<ul>
-<li>
-<a href="jk/aphowto.html">mod_jk</a> is an Apache module to be used with
<b>Apache 1.3</b> and <b>2.0</b> Webservers.
-</li>
-<li>
-<a href="jk/iishowto.html">isapi</a> is a redirector to be used with
<b>IIS</b>.
-</li>
-<li>
-<a href="jk/neshowto.html">nsapi</a> is a redirector to be used with
<b>Netscape/iPlanet</b>.
-</li>
-<li>
-<a href="jk/domhowto.html">dsapi</a> is a redirector to to be used with
<b>Domino</b>.
+<li><a href="news/20041100.html#20041115.1">15 November 2004 - <b>JK2 is
officially unsupported!</b></a>
+<p>JK2 has been put in maintainer mode and no further development will take
place.
+The reason for shutting down JK2 development was the lack of developers
interest.
+Other reason was lack of users interest in adopting JK2, caused by
configuration
+complexity when compared to JK.
+</p>
+<p>JK2 will have it's successor within core Apache2.1/2.2 distribution.
+We have developed new <b>proxy_ajp</b> that is an addition to
+the mod_proxy and uses Tomcat's AJP protocol stack. It is developped in
httpd-2.1
+and integrated in it. We have also developed a new <b>proxy_balancer</b>
module
+for load balancing http and ajp protocol stacks.
+</p>
+<p>JK will be fully supported for all other web servers. The next JK release
is
+planned for the end of November. Lots of code from JK2 has been ported to JK
+</p>
</li>
</ul>
-
</section>
-<section name="Why should I use the JK?">
-<p>
-JK was develop to overcome many limitations of its ancestor,
<b>mod_jserv</b>.
+<section name="Configuration">
+<br />
+<ul>
+<li><a href="config/workers.html"><b>Workers.properties Documentation</b></a>
+<p>To be done! This section contains detail description of all
workers.properties
+directives.
</p>
+</li>
-<p>
-<b>mod_jserv</b> was too complex and because it was ported from
Apache/JServ,
-it brought with it lots of JServ specific bits that aren't needed by Apache.
+<li><a href="config/apache1.html"><b>Apache Documentation</b></a>
+<p>To be done! This section contains detail description of all Aapache
directives.
</p>
-
-<p>
-Where <b>mod_jserv</b> supported only Apache webservers on Unix OS,
-<b>JK</b> supports much more web servers and operating systems through
-via a compatibility layer named the <b>JK library</b>.
-The layered approach provided by the JK library makes it easier to
-support many different webservers and OS.
+</li>
+<li><a href="config/apache1.html"><b>IIS Documentation</b></a>
+<p>To be done! This section contains detail description of all IIS
directives.
</p>
+</li>
-<p>
-JK offer better support for SSL, that's was a problem with mod_jserv which
couldn't
-reliably identify whether a request was made via HTTP or HTTPS.
+</ul>
+</section>
+
+<section name="Installation">
+<br />
+<ul>
+<li><a href="install/apache1.html"><b>Apache 1.3.x installation
documentation</b></a>
+<p>To be done! This section contains detail description of how to build and
+install mod_jk for Apache 1.3.x web server.
</p>
-<p>
-JK can, using the newer Ajpv13 protocol which relay many SSL informations
required by servlet 2.2 and 2.3 specs.
+</li>
+<li><a href="install/apache2.html"><b>Apache 2.0.x installation
documentation</b></a>
+<p>To be done! This section contains detail description of how to build and
+install mod_jk for Apache 2.0.x web server.
</p>
+</li>
-<p>
-JK offers a lot of different and flexible communications between a Web
Server
-and the Tomcat Servlet Engine and could be used today with all of the ASF
Tomcat Engines,
-<b>3.2.x</b>, <b>3.3.x</b>, <b>4.0.x</b>, <b>4.1.x</b> and <b>5.x</b>
+<li><a href="install/iis.html"><b>IIS installation documentation</b></a>
+<p>To be done! This section contains detail description of how to build and
+install isapi_redirector for IIS web server.
</p>
+</li>
-</section>
-
-<section name="What's the difference between JK and JK2?">
-<p>
-JK2 is a refactoring of JK and is much more powerfull.
-</p>
-<p>
-Even if it works with Apache 1.3, JK2 has been developed with Apache 2.0 in
mind,
-and is better suited for multi-threaded servers like IIS, NES/iPlanet. It
can also
-be embeded in other applications and used from java.
-</p>
-<p>
-JK2 improves the modularity and has a better separation between protocol and
physical layer.
-As such JK2 support fast unix-socket, and could be extended to support
others communications
-channels. It is better suited for JNI and may use (in a future version) JDK
1.4 NIO.
-</p>
-<p>
-There is additional support for monitoring, similar with JMX in java. A
module similar
-with mod_status is provided, and additional adapters can be used to
interface and
-provide status and runtime configuration. .
-</p>
-<p>
-The configuration has been changed to follow the component models. Multiple
configuration
-sources can be supported ( in additon to file ) providing better integration
with
-the embeding application. The config layer uses the management layer APIs
and it can
-support persistence for changes done via runtime configuration.
-</p>
-<p>
-Another feature is the JNI mode. Jk2 can be used as a JNI library and
provide access to
-native features to java. For example it provides access to shared memory (
used for
-config and monitoring in a multiprocess environment ), unix domain sockets.
It can
-also provide access to signals, chuid, win registry. All using the same
communication
-mechansim, and supporting both in-process and out-of process modes.
-</p>
+</ul>
</section>
-<section name="Are there alternative ways to connect Apache and Tomcat?">
-<p>
-<b>Tomcat's AJP stack and httpd-2.1 AJP proxy</b> that is an addition to the
mod_proxy of http. It is developped in httpd-2.1 and integrated in it.
-(See <a href="proxy.xml">AJP proxy</a>).
-</p>
-<p>
-<b>Tomcat's internal HTTP stack and mod_proxy</b> which is not that bad, but
slow,
-well, of course Tomcat didn't have 10/11 years of C routine optimization like
-the Apache Web Server, but it's quite good. The only disadvantage is that it
-looks pretty ridiculous to parse an HTTP request to generate it again
-(exactly the same), and to parse again the response to send it back
unchanged...
-</p>
-<p>
-<a href="http://jakarta.apache.org/~jfclere/webapp_docs/";>mod_webapp</a>
which is very easy to configure, has a well defined protocol named
-<a href="http://jakarta.apache.org/~jfclere/webapp_docs/warp.html";>WARP</a>
but it is no longer developped.
-BTW: It would be possible to implement the <b>WARP</b> protocol in
-<b>JK2</b> ;-))
+<section name="Documentation">
+<br />
+<ul>
+<li><a href="howto/index.html"><b>HowTo Documentation</b></a>
+<p>This section contains various howto documents
</p>
-</section>
+</li>
+</ul>
-<section name="Additional References">
-<p>
-Please note that we maintain a list of references to external documentation
-on connector usage and configuration in various environments as part of
-the Tomcat wiki <a
href="http://wiki.apache.org/jakarta-tomcat/Tomcat_2fLinks";>Useful Links</a>
page.
-</p>
</section>
+
+</body>
</document>
1.1 jakarta-tomcat-connectors/jk/xdocs/build.xml
Index: build.xml
===================================================================
<project name="tomcat-docs" default="build-main" basedir=".">
<!-- ===================== Initialize Property Values ===================
-->
<!-- See "build.properties.sample" in the top level directory for all
-->
<!-- property values you must customize for successful building!!!
-->
<property file="build.properties"/>
<property file="../build.properties"/>
<property file="../../build.properties"/>
<property file="${user.home}/build.properties"/>
<property name="build.compiler" value="modern"/>
<property name="build.dir" value="../build"/>
<property name="dist.dir" value="../dist"/>
<property name="dist.name" value="docs"/>
<!-- =================== BUILD: Create Directories ======================
-->
<target name="build-prepare">
<mkdir dir="${build.dir}"/>
<mkdir dir="${build.dir}/${dist.name}"/>
</target>
<!-- ================ BUILD: Copy Static Files ==========================
-->
<target name="build-static" depends="build-prepare">
<!-- Top Level Static Files -->
<copy todir="${build.dir}/${dist.name}">
<fileset dir=".">
<include name="BUILDING.txt"/>
<include name="README.txt"/>
<include name="RUNNING.txt"/>
<include name="style.css"/>
</fileset>
</copy>
<copy todir="${build.dir}/${dist.name}">
<fileset dir="." includes="**/*.html"/>
</copy>
<!-- Images Subdirectory -->
<mkdir dir="${build.dir}/${dist.name}/images"/>
<copy todir="${build.dir}/${dist.name}/images">
<fileset dir="images"/>
</copy>
<mkdir dir="${build.dir}/${dist.name}/printer"/>
<!-- Top Level Static Files -->
<copy todir="${build.dir}/${dist.name}/printer">
<fileset dir=".">
<include name="BUILDING.txt"/>
<include name="README.txt"/>
<include name="RUNNING.txt"/>
</fileset>
</copy>
<style basedir="."
destdir="${build.dir}/${dist.name}/printer"
extension=".html"
style="style.xsl"
excludes="build.xml project.xml"
includes="*.xml">
<param name="relative-path" expression="./.."/>
<param name="project-menu" expression="nomenu"/>
</style>
<!-- News -->
<style basedir="news"
destdir="${build.dir}/${dist.name}/news"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression=".."/>
</style>
<mkdir dir="${build.dir}/${dist.name}/news/printer"/>
<style basedir="news"
destdir="${build.dir}/${dist.name}/news/printer"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression="../.."/>
<param name="project-menu" expression="nomenu"/>
</style>
<!-- Common -->
<style basedir="common"
destdir="${build.dir}/${dist.name}/common"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression=".."/>
</style>
<mkdir dir="${build.dir}/${dist.name}/common/printer"/>
<style basedir="common"
destdir="${build.dir}/${dist.name}/common/printer"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression="../.."/>
<param name="project-menu" expression="nomenu"/>
</style>
<!-- Howto -->
<style basedir="howto"
destdir="${build.dir}/${dist.name}/howto"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression=".."/>
</style>
<mkdir dir="${build.dir}/${dist.name}/howto/printer"/>
<style basedir="howto"
destdir="${build.dir}/${dist.name}/howto/printer"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression="../.."/>
<param name="project-menu" expression="nomenu"/>
</style>
<!-- Config -->
<style basedir="config"
destdir="${build.dir}/${dist.name}/config"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression=".."/>
</style>
<mkdir dir="${build.dir}/${dist.name}/config/printer"/>
<style basedir="config"
destdir="${build.dir}/${dist.name}/config/printer"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression="../.."/>
<param name="project-menu" expression="nomenu"/>
</style>
<!-- Install -->
<style basedir="install"
destdir="${build.dir}/${dist.name}/install"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression=".."/>
</style>
<mkdir dir="${build.dir}/${dist.name}/install/printer"/>
<style basedir="install"
destdir="${build.dir}/${dist.name}/install/printer"
extension=".html"
style="style.xsl"
excludes="project.xml"
includes="*.xml">
<param name="relative-path" expression="../.."/>
<param name="project-menu" expression="nomenu"/>
</style>
</target>
<!-- ================= BUILD: XML-HTML Generation =======================
-->
<target name="build-main" depends="build-static">
<!-- Top Level Directory -->
<style basedir="."
destdir="${build.dir}/${dist.name}"
extension=".html"
style="style.xsl"
excludes="build.xml project.xml"
includes="*.xml">
<param name="relative-path" expression="."/>
</style>
</target>
<!-- ==================== BUILD: Rebuild Everything =====================
-->
<target name="all" depends="build-clean,build-main"
description="Clean and build documentation"/>
<!-- ======================= BUILD: Clean Directory =====================
-->
<target name="build-clean">
<delete dir="${build.dir}/${dist.name}"/>
</target>
<!-- ======================= DIST: Create Directories ===================
-->
<target name="dist-prepare">
<mkdir dir="${dist.dir}"/>
</target>
<!-- ======================= DIST: Create Distribution Files ============
-->
<target name="dist" depends="build-main,dist-prepare"
description="Create documentation binary distribution">
<jar jarfile="${dist.dir}/${dist.name}.war"
basedir="${build.dir}/${dist.name}" includes="**"/>
</target>
<!-- ======================= DIST: Clean Directory ======================
-->
<target name="dist-clean">
<delete dir="${dist.dir}/${dist.name}"/>
</target>
<!-- ====================== Convenient Synonyms =========================
-->
<target name="clean" depends="build-clean,dist-clean"
description="Clean build and dist directories"/>
</project>
1.1 jakarta-tomcat-connectors/jk/xdocs/project.xml
Index: project.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Apache Jakarta Tomcat Connector Documentation - Top Level
Directory"
href="http://jakarta.apache.org/tomcat/";>
<title>The Apache Jakarta Tomcat Connector</title>
<logo href="/images/tomcat.gif">
The Apache Jakarta Tomcat Connector
</logo>
<body>
<menu name="Links">
<item name="Docs Home" href="index.html"/>
</menu>
<menu name="Configuration">
<item name="Workers.properties" href="config/workers.html"/>
<item name="Apache" href="config/apache.html"/>
<item name="IIS" href="config/iis.html"/>
</menu>
<menu name="Installation">
<item name="Apache 1.3" href="install/apache1.html"/>
<item name="Apache 2.0" href="install/apache2.html"/>
<item name="IIS" href="install/iis.html"/>
</menu>
<menu name="Documentation">
<item name="AJPv13 Protocol" href="common/ajpv13a.html"/>
<item name="HowTo" href="howto/index.html"/>
<item name="Frequently asked questions" href="faq.html"/>
</menu>
</body>
</project>
1.3 +37 -140 jakarta-tomcat-connectors/jk/xdocs/style.css
1.3 +466 -407 jakarta-tomcat-connectors/jk/xdocs/style.xsl
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
