nicolaken 2002/08/27 06:14:17
Added: . CREDITS.txt INSTALL-BIN.txt INSTALL-SRC.txt
README.txt WARNING.txt
Removed: . CREDITS INSTALL.bin INSTALL.src README WARNING
Log:
Help our Wintel users and enable simple double-click file open.
Revision Changes Path
1.1 xml-cocoon2/CREDITS.txt
Index: CREDITS.txt
===================================================================
******************
* Cocoon Credits *
******************
This is the file where major donations to the Cocoon project are listed and it
should be used to give appropriate visibility to those inviduals, organizations
or companies that donated resources to the effort. This file wants to be one of
the ways the Cocoon community pays back.
-- o --
The Cocoon project was originally created, proposed and bootstrapped by
Stefano Mazzocchi <[EMAIL PROTECTED]>
The web application framework consisting of the session handling (aka sunShine),
the authentication framework (aka sunRise) and the portal engine (aka sunSpot)
was created and developed by the Open Source Competence Center of
s&n AG (http://www.s-und-n.de), Paderborn, Germany.
The interpreted sitemap engine and other contributions from Sylvain Wallez are
made possible by the time donated by his company, Anyware Technologies
(http://www.anyware-tech.com).
The flow control layer, the SOAP and XScript logicsheets, and other
changes were contributed by Ovidiu Predescu and donated by the Hewlett
Packard Company (http://www.hp.com/).
The DELI implementation was contributed by Mark Butler, and donated to
Cocoon by the Hewlett Packard Company (http://www.hp.com/).
[FIXME: fill this as you find appropriate]
-- o --
The Apache Cocoon Community
http://xml.apache.org/cocoon/
1.1 xml-cocoon2/INSTALL-BIN.txt
Index: INSTALL-BIN.txt
===================================================================
*-----------------------------*
| I N S T A L L |
*-----------------------------*
You have downloaded the binary distribution of Cocoon and you don't like
to read verbose docs, right?
Great, this file is for you.
1) Have your Servlet 2.2 or 2.3 compatible servlet engine installed.
If you don't know how to do this, well, stop right here and move to the
Apache Tomcat project (http://jakarta.apache.org/tomcat/) then come back
when you are done.
Done? Ok, let's go on.
2) Install the WAR package in your servlet container.
There is no standard way to do this, but in most servlet engines, this is
just a matter of copying the war file in a specific directory and the
engine will take care of installing it when restarted.
For Apache Tomcat, you have to copy the WAR archive into the '/webapps'
directory, so do
[unix] cp ./cocoon.war $TOMCAT_HOME/webapps/cocoon.war
[win32] copy .\cocoon.war %TOMCAT_HOME%\webapps\cocoon.war
5) Restart the servlet engine.
6) Access the URI 'http://localhost/cocoon/' with your favorite browser
7) Wait a few seconds (Cocoon needs to compile parts of itself when launched)
8) Say hello to Cocoon :)
FAQ
---
1) Why does nothing happen when I access 'http://localhost/cocoon/'?
You might want to check a few things:
- is your server listening to port 80? if not, you have to call the right
port like in 'http://localhost:8080/cocoon/'. Note that Apache Tomcat
binds by default to port 8080, NOT 80.
- did your servlet engine install the WAR file? you can check by making
sure the WAR file was unpacked or connecting to the administration tools
of your servlet engine.
- did you restart the servlet engine? if not, do it.
2) Why does Cocoon take so long to start?
Cocoon compiles sitemaps into java classes to increase runtime performance,
this is done only at startup and only if the sitemap file is modified, for
all the other requests the compiled sitemap is executed. See question #7
for information on how to pre-compile the sitemap and the XSP's.
3) Why is cocoon.war so big?
Cocoon.war includes all the libraries that it requires to run. They are
several megabytes of Java classes and it also includes the JDK javac compiler
which must be present in the war file to allow page compilation without
classloading problems.
4) I get a java.lang.VerifyError when accessing 'http://localhost/cocoon/'.
What's wrong?
Make sure you do not have a Cocoon 1.x jar in your servlet container lib/
directory.
5) I get an Exception when accessing Cocoon the first time. What's wrong?
Cocoon requires a JAXP 1.1 compliant parser. Recent servlet engines
(like Tomcat 3.2.1) use older xml parsers. You have to replace the xml
parser with a newer one (e.g. the Xerces 1.3.0).
For Tomcat 3.2.1 simply remove the jaxp.jar and the parser.jar from the
tomcat/lib directory and copy the xerces.jar to this directory and rename
it to parser.jar. Before you restart Tomcat make sure to remove the
tomcat/work directory beforehand.
8) I want to learn more about Cocoon.
Download the source distribution from http://xml.apache.org/dist/cocoon.
The source distribution contains everything you need in order to build
Cocoon yourself.
7) I'm still stuck, what do I do?
Read the Cocoon documentation included in the distribution.
This file is just a quick and dirty way to get you started but the docs
contain much more detailed information as well as FAQs and indications
on how to contact us.
Happy hacking with Apache Cocoon.
The Apache XML Project
http://xml.apache.org/
1.1 xml-cocoon2/INSTALL-SRC.txt
Index: INSTALL-SRC.txt
===================================================================
*-----------------------------*
| I N S T A L L |
*-----------------------------*
You have downloaded the source distribution of Cocoon and you don't like
to read verbose docs, right?
Great, this file is for you.
1) Have your Servlet 2.2 or 2.3 compatible servlet engine installed.
If you don't know how to do this, well, stop right here and move to the
Apache Tomcat project (http://jakarta.apache.org/tomcat/) then come back
when you are done.
Done? Ok, let's go on.
2) Set your JAVA_HOME environment
You have to set your JAVA_HOME environment to point to the root directory of
the Java Development Kit installed on your machine. To do this simply type:
[unix] JAVA_HOME=/path/to/java/
[win32] SET JAVA_HOME=c:\path\to\java
your mileage may vary, but you know how to setup environments, right?
3) Create the Cocoon WAR package.
Due to the incompatibilities between JDK 1.3 and JDK 1.4, you have to
specify the targetted JVM for Cocoon before building. This is usually
done by setting your JAVA_HOME to the appropriate version as explained
above.
WARNING: Using a build targetted for one JVM on a different JVM
may result in runtime errors. So run Cocoon targetted for a
JVM only with this version.
The Cocoon build system automatically detects whether you are using
JDK 1.4 or a previous version.
3a) Automatic install.
To create the package and automatically install it in your servlet
container, do
[unix] ./build.sh -Dinclude.webapp.libs=yes -Dinstall.war=$TOMCAT_HOME/webapps
install
[win32] .\build.bat -Dinclude.webapp.libs=yes
-Dinstall.war=%TOMCAT_HOME%\webapps install
This creates the "cocoon.war" file in '$TOMCAT_HOME/webapps' which
is the absolute path to the location where the "cocoon.war" file
should be deployed. It also changes all references to that directory
in the included samples so that i.e. the database samples will work
properly.
Continue with 5)
3b) Manual install.
To do this you simply have to type, depending on your operating system
[unix] ./build.sh -Dinclude.webapp.libs=yes -Dinstall.war=$TOMCAT_HOME/webapps
webapp
[win32] .\build.bat -Dinclude.webapp.libs=yes
-Dinstall.war=%TOMCAT_HOME%\webapps webapp
This will create the "cocoon.war" file in the './build/cocoon'
directory. It also changes all references to that directory in the
included samples so that i.e. the database samples will work
properly.
TOMCAT_HOME points to the directory where tomcat is installed (note:
you don't need to set it in the environment, it's there only to show
you). For more information on Tomcat 3.2.1 see the FAQ below.
4) Install the WAR package in your servlet container.
There is no standard way to do this, but in most servlet engines, this is
just a matter of copying the war file in a specific directory and the
engine will take care of installing it when restarted.
For Apache Tomcat, you have to copy the WAR archive into the '/webapps'
directory, so do
[unix] cp ./build/cocoon/cocoon.war $TOMCAT_HOME/webapps/cocoon.war
[win32] copy .\build\cocoon\cocoon.war %TOMCAT_HOME%\webapps\cocoon.war
5) Restart the servlet engine.
6) Access the URI 'http://localhost/cocoon/' with your favorite browser
7) Wait a few seconds (Cocoon needs to compile parts of itself when launched)
8) Say hello to Cocoon :)
FAQ
---
1) Why does nothing happen when I access 'http://localhost/cocoon/'?
You might want to check a few things:
- is your server listening to port 80? if not, you have to call the right
port like in 'http://localhost:8080/cocoon/'. Note that Apache Tomcat
binds by default to port 8080, NOT 80.
- did your servlet engine install the WAR file? you can check by making
sure the WAR file was unpacked or connecting to the administration tools
of your servlet engine.
- did you restart the servlet engine? if not, do it.
2) Why does Cocoon take so long to start?
Cocoon compiles sitemaps into java classes to increase runtime performance,
this is done only at startup and only if the sitemap file is modified, for
all the other requests the compiled sitemap is executed. See question #7
for information on how to pre-compile the sitemap and the XSP's.
3) Can I improve startup-time by precompiling the sitemap and XSP's?
Sure, follow the instructions:
a) Set the "work-directory" parameter in web.xml as follows:
<init-param>
<param-name>work-directory</param-name>
<param-value>WEB-INF/classes</param-value>
</init-param>
b) Set the auto-reload to false in your cocoon.xconf file as follows:
<parameter name="auto-reload" value="false"/>
c) Use "-Dcompile.xsp=yes" in your build command line when you are
building your WAR file. For example:
./build.sh -Dcompile.xsp=yes -Dinclude.webapp.libs=yes
-Dinstall.war=$TOMCAT_HOME/webapps install
4) Why is cocoon.war so big?
Cocoon.war includes all the libraries that it requires to run. They are
several megabytes of Java classes and it also includes the JDK javac compiler
which must be present in the war file to allow page compilation without
classloading problems.
5) I get a java.lang.VerifyError when accessing 'http://localhost/cocoon/'.
What's wrong?
Make sure you do not have a Cocoon 1.x jar in your servlet container lib/
directory.
6) I get an Exception when accessing Cocoon the first time. What's wrong?
Cocoon requires a JAXP 1.1 compliant parser. Recent servlet engines
(like Tomcat 3.2.1) use older xml parsers. You have to replace the xml
parser with a newer one (e.g. the Xerces 1.3.0).
For Tomcat 3.2.1 simply remove the jaxp.jar and the parser.jar from the
tomcat/lib directory and copy the xerces.jar to this directory and rename
it to parser.jar. Before you restart Tomcat make sure to remove the
tomcat/work directory beforehand.
7) I don't want to build Cocoon myself.
Download the binary distribution from http://xml.apache.org/dist/cocoon.
The binary distribution contains a pre-build war file of Cocoon.
8) I'm still stuck, what do I do?
Read the Cocoon documentation included in the distribution.
This file is just a quick and dirty way to get you started but the docs
contain much more detailed information as well as FAQs and indications
on how to contact us.
Happy hacking with Apache Cocoon.
The Apache XML Project
http://xml.apache.org/
1.1 xml-cocoon2/README.txt
Index: README.txt
===================================================================
A P A C H E C O C O O N
@version@
What is it?
-----------
Apache Cocoon is an XML publishing framework that raises the usage of
XML and XSLT technologies for server applications to a new
level. Designed for performance and scalability around pipelined SAX
processing, Cocoon offers a flexible environment based on the separation
of concerns between content, logic and style. A centralized
configuration system and sophisticated caching top this all off and help
you to create, deploy and maintain rock-solid XML server applications.
Cocoon interacts with most data sources, including: filesystems, RDBMS,
LDAP, native XML databases, and network-based data sources. It adapts
content delivery to the capabilities of different devices like HTML,
WML, PDF, SVG, RTF just to name a few. Cocoon currently runs as a Servlet
or from a powerful commandline interface. The chosen design of an
abstracted environment gives you the freedom to implement your own
concrete environment to suit your required functionality.
Where is it?
------------
The home page for the Apache Cocoon project can be found in the Apache XML
Project web site (http://xml.apache.org/cocoon/). There you also find
information on how to download the latest release as well as all the other
information you might need regarding this project.
Requirements
------------
Cocoon is implemented both as a Java servlet and a Java command line
application. The following requirements exist for installing it:
o A Java 1.2 or later compatible virtual machine for your operating system.
o Server API 2.2 compatible Servlet Engine.
[optional for command line operation]
Installation Instructions and Documentation
-------------------------------------------
Read the INSTALL files in this directory for the installation instructions.
The documentation available as of the date of this release is
included in the "docs/" directory.
Look for the most updated documentation on the Apache Cocoon web site under
the Apache XML Project (http://xml.apache.org/cocoon/).
Licensing and legal issues
--------------------------
For legal and licensing issues, please read the LICENSE files in the /legal
directory.
Thanks for using Apache Cocoon.
The Apache XML Project
http://xml.apache.org/
1.1 xml-cocoon2/WARNING.txt
Index: WARNING.txt
===================================================================
***************************** W A R N I N G **********************************
Some user accessible points in this software package should be considered
"alpha". This means that the developer team is not investing _any_ effort
to provide backward compatibility between alpha releases for these parts.
This software will continue to be released as "alpha" until its code,
schemas, and APIs are considered stable.
Until then, there will be no warranty that newer versions will maintain backward
compatibility for such parts, even in the most simple cases. Of course
Cocoon will be compatible to latest release, 2.0.x release. However, once
"beta" status is reached, backward incompatible changes will be made only
when absolutely necessary to reach "final" status.
The Cocoon development team understands the importance of reliable
software as well protecting user investments through the creation of
a solid development platform that doesn't change. On the other hand,
the Cocoon project is a pioneer in many fields. Most of the technologies
it uses are at a "working draft" phase only. Thus, reliability cannot be
guaranteed before the software achieves its "final" status.
Until then, no effort will be provided to guarantee backward compatibility
for any parts considered alpha.
You have been warned.
***************************** W A R N I N G **********************************
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
