rwaldhoff 01/08/31 18:27:51 Modified: xdocs/stylesheets project.xml xdocs index.xml Added: xdocs components.xml Log: (You may want to take a look at these) * Removing mention of and links to "directory", which doesn't exist, and doesn't seem like it will for quite some time. * Adding document enumerating the components, a brief description of each, and indicating their current status. * I *think* that component.xml document supercedes the old sandbox.xml and commons.xml documents, so I removed the links to them from the index and project files Anyone mind these changes? Revision Changes Path 1.12 +8 -1 jakarta-commons/xdocs/stylesheets/project.xml Index: project.xml =================================================================== RCS file: /home/cvs/jakarta-commons/xdocs/stylesheets/project.xml,v retrieving revision 1.11 retrieving revision 1.12 diff -u -r1.11 -r1.12 --- project.xml 2001/08/17 23:00:26 1.11 +++ project.xml 2001/09/01 01:27:51 1.12 @@ -18,9 +18,15 @@ <menu name="Information"> <item name="Overview" href="/index.html"/> + <item name="Components" href="/components.html"/> + <!-- Yet to come? + <item name="Guidelines" href="/guidelines.html"/> + <item name="News" href="/news.html"/> + --> + <!-- deprecated? <item name="Commons Proper" href="/commons.html"/> - <item name="Directory" href="/directory.html"/> <item name="Sandbox" href="/sandbox.html"/> + --> </menu> <menu name="Components Repository"> @@ -30,6 +36,7 @@ <item name="Digester" href="http://cvs.apache.org/viewcvs/jakarta-commons/digester/"/> <item name="DBCP" href="http://cvs.apache.org/viewcvs/jakarta-commons/dbcp/"/> <item name="HTTP Client" href="http://cvs.apache.org/viewcvs/jakarta-commons/httpclient/"/> + <item name="JXPath" href="http://cvs.apache.org/viewcvs/jakarta-commons/jxpath/"/> <item name="Pool" href="http://cvs.apache.org/viewcvs/jakarta-commons/pool/"/> </menu> 1.8 +86 -112 jakarta-commons/xdocs/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/jakarta-commons/xdocs/index.xml,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- index.xml 2001/08/04 23:18:14 1.7 +++ index.xml 2001/09/01 01:27:51 1.8 @@ -1,4 +1,4 @@ -<?xml version="1.0" ?> +<?xml version="1.0" ?> <document> <properties> <title>Commons</title> @@ -7,129 +7,103 @@ <body> <section name="The Jakarta Commons"> <b>Welcome to the Commons!</b> - <p> - The Commons is a new Jakarta subproject focused on all aspects of - reusable Java components. - </p> - <p>The Jakarta Commons project is composed of three parts:</p> + <p> + The Commons is a new Jakarta subproject focused on all aspects of + reusable Java components. + </p> + <p>The Jakarta Commons project is composed of two parts:</p> <ul> - <li> - <a href="#The Commons Proper">The Commons Proper</a> - - A repository of reusable Java components. - </li> - <li> - <a href="#The Directory">The Directory</a> - - A catalog of Java components in other projects. - </li> - <li> - <a href="#The Sandbox">The Sandbox</a> - - A workspace for Java component development. - </li> + <li> + <a href="#The Commons Proper">The Commons Proper</a> - + A repository of reusable Java components. + </li> + <li> + <a href="#The Sandbox">The Sandbox</a> - + A workspace for Java component development. + </li> </ul> - <p>You may also read our <a href="charter.html">charter</a>, which spells out - the goals of the project in even greater detail.</p> + <p> + The <a href="components.html">components</a> page + lists the components currently available in both the + Sandbox and Commons Proper. + </p> + <p> + You may also read our <a href="charter.html">charter</a>, + which spells out the goals of the project in greater detail. + </p> </section> <section name="The Commons Proper"> - <p> - The Commons Proper is dedicated to one principal - goal: creating and maintaining reusable Java components. The Commons - Proper is a place for collaboration and sharing, where - developers from throughout the Jakarta community can work together - on projects to be shared by the Jakarta projects and Jakarta users. -</p> - <p> - Commons developers will make an effort to ensure that their - components have minimal dependencies on other libraries, so that - these components can be deployed easily. In addition, Commons components - will keep their interfaces as stable as possible, so that Jakarta users - (including other Jakarta subprojects) can implement these - components without having to worry about changes in the future. -</p> - <p> - We welcome participation from all that are interested, at all skill levels. - Coding, documentation and testing are all critical parts of the software - development process. If you are interested in participating in any of - these aspects, please join us! -</p> - <p> - Click <a href="commons.html">here</a> to enter the Commons Proper, - or choose a specific Commons component from the list to the left. -</p> + <p> + The Commons Proper is dedicated to one principal + goal: creating and maintaining reusable Java components. The Commons + Proper is a place for collaboration and sharing, where + developers from throughout the Jakarta community can work together + on projects to be shared by the Jakarta projects and Jakarta users. + </p> + <p> + Commons developers will make an effort to ensure that their + components have minimal dependencies on other libraries, so that + these components can be deployed easily. In addition, Commons components + will keep their interfaces as stable as possible, so that Jakarta users + (including other Jakarta subprojects) can implement these + components without having to worry about changes in the future. + </p> + <p> + We welcome participation from all that are interested, at all skill levels. + Coding, documentation and testing are all critical parts of the software + development process. If you are interested in participating in any of + these aspects, please join us! + </p> </section> - <section name="The Directory"> - <p> - In addition to our repository of reusable components (Commons), - we also maintain a dynamic catalog of components and resources called - the Directory. The Directory lists components in other Jakarta and - ASF projects that are also designed for reuse in a manner similar to - Commons components. We also accept nominations for components outside - of Apache. -</p> - <p> - If you would like to nominate a component for inclusion in the - Directory, send a note to the <a href="http://jakarta.apache.org/getinvolved/mail.html">Commons mailing - list</a>. -</p> - <p>Click <a href="directory.html">here</a> to enter the Directory.</p> - </section> <section name="The Sandbox"> - <p> - This project also contains a workspace that is open to all - Jakarta committers. It's a place to try out new ideas and prepare - for inclusion into the Commons portion of the project or into another - Jakarta project. Users are free to experiment with the components - developed in the sandbox, but sandbox components will not necessarily - be maintained, particularly in their current state. -</p> - <p> - Click <a href="sandbox.html">here</a> to enter the sandbox and view - components currently in development. -</p> + <p> + This project also contains a workspace that is open to all + Jakarta committers. It's a place to try out new ideas and prepare + for inclusion into the Commons portion of the project or into another + Jakarta project. Users are free to experiment with the components + developed in the sandbox, but sandbox components will not necessarily + be maintained, particularly in their current state. + </p> </section> <section name="Where do I get releases?"> - <p> - The individual components will have independent releases. The releases - currently available are listed here: -</p> - <ul> - <li><a href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-beanutils/v1.0/">Beanutils</a> (Version 1.0)</li> - <li><a href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-cactus/v1.1/">Cactus</a> (Version 1.1)</li> - <li><a href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-collections/v1.0/">Collections</a> (Version 1.0)</li> - <li><a href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-digester/v1.0/">Digester</a> (Version 1.0)</li> - </ul> - </section> + <p> + The individual components have independent releases. The releases + currently available can be seen on the + <a href="components.html">components</a> page. + </p> + </section> <section name="Where do I get nightly snapshots?"> - <p> - Nightly snapshots of the Commons CVS can be found at - <a href="http://jakarta.apache.org/builds/jakarta-commons/nightly/">here</a>. -</p> - <p> - These are meant to provide easy access to the actual project CVS tree. - As this is our live development workspace, there are - no guarantees as to what you will find there,although we do our best to maintain - a buildable source tree. -</p> + <p> + Nightly snapshots of the Commons CVS can be found + <a href="http://jakarta.apache.org/builds/jakarta-commons/nightly/">here</a>. + </p> + <p> + These are meant to provide easy access to the actual project CVS tree. + As this is our live development workspace, there are + no guarantees as to what you will find there, although we do our + best to maintain a buildable source tree. + </p> </section> <section name="How do I contribute, give feedback, fix bugs and so on?"> - <p> - The Commons project really needs and appreciates any contributions, - including documentation help, source code and feedback. -</p> + <p> + The Commons project really needs and appreciates any contributions, + including documentation help, source code and feedback. + </p> <ul> - <li> - Discussion occurs on the <a href="http://jakarta.apache.org/getinvolved/mail.html">Commons mailing - list</a>. - </li> - <li> - Access to the CVS <strong>jakarta-commons</strong> repository is available both - <a href="http://cvs.apache.org/viewcvs/jakarta-commons/">online</a> - and with a <a href="http://jakarta.apache.org/getinvolved/cvsindex.html">cvs client</a>. - </li> - <li> - Access to the CVS <strong>jakarta-commons-sandbox</strong> repository is available both - <a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/">online</a> - and with a <a href="http://jakarta.apache.org/getinvolved/cvsindex.html">cvs client</a>. - </li> + <li> + Discussion occurs on the + <a href="http://jakarta.apache.org/getinvolved/mail.html">Commons mailing list</a>. + </li> + <li> + Access to the CVS <strong>jakarta-commons</strong> repository is available both + <a href="http://cvs.apache.org/viewcvs/jakarta-commons/">online</a> + and with a <a href="http://jakarta.apache.org/getinvolved/cvsindex.html">cvs client</a>. + </li> + <li> + Access to the CVS <strong>jakarta-commons-sandbox</strong> repository is available both + <a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/">online</a> + and with a <a href="http://jakarta.apache.org/getinvolved/cvsindex.html">cvs client</a>. + </li> </ul> </section> </body> 1.1 jakarta-commons/xdocs/components.xml Index: components.xml =================================================================== <?xml version="1.0"?> <document> <properties> <title>Components</title> <author email="[EMAIL PROTECTED]">Commons Documentation Team</author> </properties> <body> <section name="Introduction"> <p> The <em>Jakarta Commons</em> project differs from many other Jakarta hosted projects because it is comprised of multiple, independently released packages. This page provides an overview of the <em>Commons</em> components that are currently available. </p> </section> <section name="Released Components"> <!-- alpha by name --> <dl> <!-- BeanUtils --> <dt><b><big><a href="beanutils.html">BeanUtils</a></big></b></dt> <dd> Commons-BeanUtils provides easy-to-use wrappers around the Java reflection and introspection APIs. <br/> Releases: <ul> <li><a href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-beanutils/v1.0/">Release 1.0</a> - 14 July 2001</li> </ul> </dd> <!-- /BeanUtils --> <!-- Cactus --> <dt><b><big><a href="cactus/">Cactus</a></big></b></dt> <dd> Commons-Cactus is a framework for testing server-side (J2EE) Java code using in-container extensions to <a href="http://junit.org/">JUnit</a>. <br/> Releases: <ul> <li><a href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-cactus/v1.1/">Release 1.1</a> - 18 June 2001</li> <li><a href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-cactus/v1.0/">Release 1.0</a> - 2 May 2001</li> </ul> </dd> <!-- /Cactus --> <!-- Collections --> <dt><b><big><a href="collections.html">Collections</a></big></b></dt> <dd> Commons-Collections provides a suite of classes that extend or augment the <a href="http://java.sun.com/products/jdk/1.2/docs/guide/collections/">Java Collections Framework</a>. <br/> Releases: <ul> <li><a href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-collections/v1.0/">Release 1.0</a> - 14 July 2001</li> </ul> </dd> <!-- /Collections --> <!-- Digester --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons/digester/">Digester</a></big></b></dt> <dd> Commons-Digester is an XML-to-Java-object mapping utility commonly used for parsing XML configuration files. <br/> Releases: <ul> <li><a href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-digester/v1.0/">Release 1.0</a> - 14 July 2001</li> </ul> </dd> <!-- /Digester --> </dl> </section> <section name="Beta Released Components"> <p><i>None, currently.</i></p> <!-- alpha by name --> </section> <section name="Pre-Release Components"> <!-- alpha by name --> <dl> <!-- DBCP --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons/dbcp/">DBCP</a></big></b></dt> <dd> Commons-DBCP provides database connection and object pooling services. </dd> <!-- /DBCP --> <!-- HTTP Client --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons/httpclient/">HTTP Client</a></big></b></dt> <dd> Commons-HTTP Client provides a framework for working with the client-side of the HTTP protocol. </dd> <!-- /HTTP Client --> <!-- JXPath --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons/jxpath/">JXPath</a></big></b></dt> <dd> Commons-JXPath provides utilities for manipulating Java classes that conform to the JavaBeans naming conventions using the XPath syntax. </dd> <!-- /JXPath --> <!-- Latka --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons/latka/">Latka</a></big></b></dt> <dd> Commons-Latka is an HTTP functional testing suite for automated QA, acceptance and regression testing. </dd> <!-- /Latka --> <!-- Pool --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons/pool/">Pool</a></big></b></dt> <dd> Commons-Pool provides generic object pooling services. </dd> <!-- /Pool --> </dl> </section> <section name="Sandbox (Not-Yet-Proposed) Components"> <!-- alpha by name --> <dl> <!-- Betwixt --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/betwixt/">Betwixt</a></big></b></dt> <dd> Betwixt provides services for mapping JavaBeans to XML documents, and vice versa. </dd> <!-- /Betwixt --> <!-- Cache --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/cache/">Cache</a></big></b></dt> <dd> Cache provides object caching services. </dd> <!-- /Cache --> <!-- CJAN --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/cjan/">CJAN</a></big></b></dt> <dd> CJAN provides CPAN like services for Java libraries. </dd> <!-- /CJAN --> <!-- Email --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/email/">Mail</a></big></b></dt> <dd> Mail provides a simple library for sending e-mail from Java. </dd> <!-- /Email --> <!-- JJar --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/jjar/">JJar</a></big></b></dt> <dd> Jakarta JAR Archive Repository </dd> <!-- /JJar --> <!-- Messenger --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/messenger/">Messenger</a></big></b></dt> <dd> Messenger provides a simple facade over the JMS API. </dd> <!-- /Messenger --> <!-- Resources --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/resources/">Resources</a></big></b></dt> <dd> Resources provides a lightweight framework for defining and looking up internationalized message strings keyed by a java.util.Locale and a message key. </dd> <!-- /Resources --> <!-- Threading --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/threading/">Threading</a></big></b></dt> <dd> Threading provides utility interfaces and classes that aid in coordinating and communication between multiple threads in a single Java Virtual Machine. </dd> <!-- /Threading --> <!-- Util --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/util/">Util</a></big></b></dt> <dd> <i>Someone please describe Util here.</i> </dd> <!-- /Util --> <!-- Workflow --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/workflow/">Workflow</a></big></b></dt> <dd> Workflow provides a framework for building workflow management systems. </dd> <!-- /Workflow --> <!-- XMLUnit --> <dt><b><big><a href="http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/xmlunit/">XMLUnit</a></big></b></dt> <dd> XMLUnit is a JUnit extension for unit testing applications that generate or manipulate XML. </dd> <!-- /XMLUnit --> </dl> </section> </body> </document>