Permalink
Browse files

tidy up

git-svn-id: https://svn.apache.org/repos/asf/cocoon/tags/cocoon-22@505988 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information...
1 parent 9305608 commit c44e1532cc11281a7145ddf60bed696ae7d3d3e3 @reinhard reinhard committed Feb 11, 2007
Showing 2,183 changed files with 288,867 additions and 0 deletions.
@@ -0,0 +1,102 @@
+
+ C R E D I T S
+
+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.
+
+
+ Community Credits
+ -----------------
+
+The Cocoon project was originally created, proposed and bootstrapped by
+Stefano Mazzocchi (http://www.betaversion.org/~stefano/)
+
+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/).
+
+The initial code of the new portal framework is a donation by a joined development
+effort of BASF IT-Services (http://www.basf-it-services.com)
+and s&n AG (http://www.s-und-n.de). This initial version has been developed by
+Volker Schmitt (volker.schmitt@basf-it-services.com),
+Juergen Seitz (juergen.seitz@basf-it-services.com),
+Bjoern Luetkemeier (bluetkemeier@s-und-n.de) and Carsten Ziegeler (cziegeler@s-und-n.de).
+
+The initial code of the new ojb block and other contributions from Antonio Gallardo
+and Carlos Chávez are made posible by the time donated by AG Software, S. A.
+(http://www.agssa.net).
+
+The initial code of the official Cocoon form handling block (CForms)
+evolved from the Woody donation made by Outerthought
+(http://outerthought.org).
+
+
+ Credits of included software
+ ----------------------------
+
+This product includes software developed by the Apache Software Foundation
+(http://www.apache.org/).
+
+This product includes software developed by the XML:DB Initiative
+(http://www.xmldb.org/).
+
+This product includes software developed by the IronSmith Project
+(http://www.ironsmith.org/).
+
+This product includes software developed by the jfor Project
+(http://www.jfor.org).
+
+This product includes software developed by the JDOM Project
+(http://www.jdom.org/).
+
+This product includes software developed by the OpenORB Community Project
+(http://sourceforge.net/projects/openorb/).
+
+This product includes software developed by the Chaperon Project
+(http://www.sourceforge.net/projects/chaperon/).
+
+This product includes software developed by the Exolab Project
+(http://www.exolab.org/).
+
+This product includes software developed by ANTLR Project
+(http://www.antlr.org/)
+
+
+Portions are Copyright (c) 2001 Tivano Software GmbH
+(http://www.tivano.de). All Rights Reserved.
+
+Portions are Copyright (c) 1998-2000 World Wide Web Consortium
+(Massachusetts Institute of Technology, Institut National de Recherche en
+Informatique et en Automatique, Keio University). All Rights Reserved.
+
+Portions are Copyright (c) 2001 Scott Robert Ladd. All rights reserved.
+
+Portions are Copyright (c) 2001, 2002 Thai Open Source Software Center Ltd.
+All rights reserved.
+
+Portions are Copyright (c) Mort Bay Consulting Pty. Ltd. All rights reserved.
+
+Portions are Copyright (c) Hewlett-Packard Company 2002. All rights reserved.
+
+Schematron portions are Copyright (c) 2000,2001 Rick Jelliffe and Academia
+Sinica Computing Center, Taiwan
+
+
+
+
+ The Apache Cocoon Community
+ http://cocoon.apache.org/
@@ -0,0 +1,6 @@
+; see http://msdn.microsoft.com/library/en-us/shellcc/platform/shell/programmersguide/shell_basics/shell_basics_extending/custom.asp
+[.ShellClassInfo]
+IconFile=src\documentation\src\content\xdocs\images\cocoon.ico
+IconIndex=0
+ConfirmFileOp=0
+InfoTip=Apache Cocoon, the XML application framework!
@@ -0,0 +1,145 @@
+
+
+ +-----------------------------+
+ | I N S T A L L |
+ +-----------------------------+
+
+
+ Let me guess: you don't like to read verbose docs, right?
+
+ Great, this file is for you.
+
+ 1) Unpack the distribution
+ Obviously you've done this already, but if you got errors when unpacking
+ the archive with tar, you might need to use gnutar instead. Our archives
+ contain long paths and filenames which cause problems with some versions
+ of the tar command.
+
+ 2) Set your JAVA_HOME environment
+
+ You have to set your JAVA_HOME environment to point to the root directory of
+ the Java Virtual Machine (JDK 1.3.x or later) 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 depending on your shell, but you know how to setup
+ environments, right?
+
+ 3) Build Cocoon by typing "build" or "./build.sh"
+
+ 4) Run Cocoon by typing "cocoon servlet" or "./cocoon.sh servlet"
+
+ 5) Open http://localhost:8888/ with your browser
+
+
+That's it!
+
+
+Now, you have two choices:
+
+ a) close this file and try to hack something out by yourself
+
+ b) keep reading
+
+Go ahead and choose option a), but don't complain if you can't figure out how
+to use the cocoon build system for your needs.
+
+
+
+Still here? good. You won't regret it.
+
+
+Reading the documentation
+--------------------------
+
+This directory contains the full Cocoon documentation (as xml documents).
+You can either browse the documentation when you start Cocoon as described
+above and go to the documentation section: http://localhost:8888/docs/index.html.
+Or you can build the docs your self by running "build.bat docs" or
+"./build.sh docs". If you want to build the docs yourself, you need
+an installed version of Forrest (http://xml.apache.org/forrest).
+
+Of course you can also read the documentation at the website
+http://cocoon.apache.org/
+
+Updating
+--------
+
+If you are updating from a previous release of Cocoon, make sure
+that you read the installation instructions on updating first.
+
+
+Choosing the blocks
+-------------------
+
+Cocoon is composed by its 'core' and several 'blocks'.
+
+The core (a.k.a. naked cocoon') contains the system with services that
+are needed to all cocoon users. Blocks provide services that you might not need,
+therefore the build system allows you to remove them from the build.
+
+Now, do the following steps to configure the blocks you want in your cocoon:
+
+ 1) cp blocks.properties local.blocks.properties
+ 2) edit local.blocks.properties
+ 3) rebuild (do a "build clean" first if you deactivated some blocks)
+
+do not modify blocks.properties directly!
+
+
+Tuning the build
+----------------
+
+Ok, now that you told the build system what services you want assembled
+into your distribution, you can tune the build for your personal needs:
+
+ 1) cp build.properties local.build.properties
+ 2) edit local.build.properties
+
+do not modify build.properties directly!
+
+An example of a local.build.properties is the following:
+
+ compiler=jikes
+ compiler.debug=off
+ build.webapp=/path/to/where/to/build/the/webapp
+
+where you override default compilation parameters and tell the build system
+where to place the generated cocoon webapp. Look into build.properties to find
+out what you might want to modify for your own personal needs.
+
+
+Running Cocoon as a servlet
+---------------------------
+
+When you do 'cocoon servlet', the servlet container (jetty) is started and Cocoon
+loaded into it. By default, this is attached to port 8888, but you can change
+this by setting the "JETTY_PORT" environment property before launching cocoon.
+
+Other properties that you can change are:
+
+ JETTY_ADMIN_PORT (defaults to 8889): is the port where the jetty web
+ administration is connected to. This is available when you launch
+ "cocoon servlet-admin", otherwise its disabled.
+
+ JETTY_WEBAPP (defaults to build/webapp): is the location of the webapp
+ that jetty has to execute. modify this to match your local.build.properties
+ if you modified where the build system creates your webapp
+
+ JAVA_DEBUG_PORT (defaults to 8000): is the port where the JVM over-the-wire
+ debug interface connects to. This is available only if you launch
+ "cocoon servlet-debug", otherwise is disabled. This is used by remote
+ debuggers (for example, Eclipse's).
+
+
+Note that the "standalone-demo" build target prepares a directory that you can
+move elsewhere to run "cocoon servlet" outside of the build tree.
+
+
+
+All right, that's it for now.
+
+Happy hacking with Cocoon.
Oops, something went wrong.

0 comments on commit c44e153

Please sign in to comment.