rwaldhoff 02/01/14 17:20:53
Modified: pool build.xml
Added: pool/xdocs contributors.xml downloads.xml index.xml
pool/xdocs/images jakarta-logo.gif logo.jpg
pool/xdocs/stylesheets project.xml
Log:
steps toward site docs for pool
Revision Changes Path
1.5 +72 -1 jakarta-commons/pool/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/pool/build.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- build.xml 11 Dec 2001 07:38:02 -0000 1.4
+++ build.xml 15 Jan 2002 01:20:52 -0000 1.5
@@ -1,4 +1,4 @@
-<!-- $Id: build.xml,v 1.4 2001/12/11 07:38:02 sanders Exp $ -->
+<!-- $Id: build.xml,v 1.5 2002/01/15 01:20:52 rwaldhoff Exp $ -->
<project name="commons-pool" default="test" basedir=".">
<!-- patternset describing files to be copied from the doc directory -->
@@ -20,6 +20,10 @@
<include name="**/*"/>
<exclude name="**/Test*.java"/>
</patternset>
+
+ <!-- Anakia props -->
+ <property name="docs.src" value="./xdocs"/>
+ <property name="docs.dest" value="./docs"/>
<!-- ######################################################### -->
@@ -233,5 +237,72 @@
</target>
<!-- ######################################################### -->
+
+ <target name="xdoc.fetch-stylesheet" unless="localstylesheet">
+ <echo>
+ ####################################################################
+ #
+ # Fetching the latest stylesheet from jakarta-site2
+ #
+ # NOTE : As this build target is meant for developers, this requires
+ # a properly setup CVS. But you are encouraged to use this to
+ # experiment with Anakia - if the fetch fails, it may be because
+ # you haven't yet logged into CVS. The way to do it, assuming you
+ # have a resonable CVS client setup is
+ #
+ # $ cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic login
+ # password: anoncvs
+ #
+ # and that should solve it.
+ #
+ # See http://jakarta.apache.org/site/cvsindex.html for more
+ # information, or http://www.cvshome.org/
+ #
+ # Ant really is the bee's knees. http://jakarta.apache.org/ant/
+ #
+ ######################################################################
+ </echo>
+
+ <cvs cvsRoot=":pserver:[EMAIL PROTECTED]:/home/cvspublic"
+ command="checkout -p jakarta-site2/xdocs/stylesheets/site.vsl"
+ output="${docs.src}/stylesheets/site.vsl"
+ />
+ </target>
+
+ <target name="xdoc" depends="xdoc.fetch-stylesheet"
+ description="Generates HTML documentation from XML source">
+ <taskdef name="anakia" classname="org.apache.velocity.anakia.AnakiaTask">
+ <classpath location="${velocity.jar}"/>
+ <classpath location="${jdom.jar}"/>
+ <classpath location="${xerces.jar}"/>
+ </taskdef>
+
+ <echo>
+ #######################################################
+ #
+ # Now using Anakia to transform our XML documentation
+ # to HTML.
+ #
+ #######################################################
+ </echo>
+
+ <anakia basedir="${docs.src}" destdir="${docs.dest}/"
+ extension=".html" style="./site.vsl"
+ projectFile="stylesheets/project.xml"
+ excludes="**/stylesheets/** empty.xml"
+ includes="**/*.xml"
+ lastModifiedCheck="true"
+ templatePath="xdocs/stylesheets">
+ </anakia>
+
+ <copy todir="${docs.dest}/images" filtering="no">
+ <fileset dir="${docs.src}/images">
+ <include name="**/*.gif"/>
+ <include name="**/*.jpeg"/>
+ <include name="**/*.jpg"/>
+ </fileset>
+ </copy>
+ </target>
+
</project>
1.1 jakarta-commons/pool/xdocs/contributors.xml
Index: contributors.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Contributors</title>
<author email="[EMAIL PROTECTED]">Commons Documentation
Team</author>
<author email="[EMAIL PROTECTED]">Rodney Waldhoff</author>
<revision>$Id: contributors.xml,v 1.1 2002/01/15 01:20:52 rwaldhoff Exp
$</revision>
</properties>
<body>
<section name="Contributors">
<p>
The following volunteers have contributed code, documentation, testing
and support to <em>Pool</em>.
</p>
<!-- alphabetical by last name please -->
<ul>
<li>Morgan Delagrange</li>
<li>Geir Magnusson Jr.</li>
<li>Craig R. McClanahan</li>
<li>Rodney Waldhoff</li>
<li>David Weinrich</li>
</ul>
</section>
</body>
</document>
1.1 jakarta-commons/pool/xdocs/downloads.xml
Index: downloads.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Downloads</title>
<author email="[EMAIL PROTECTED]">Commons Documentation
Team</author>
<author email="[EMAIL PROTECTED]">Rodney Waldhoff</author>
<revision>$Id: downloads.xml,v 1.1 2002/01/15 01:20:52 rwaldhoff Exp
$</revision>
</properties>
<body>
<section name="Downloads">
<p>
The following releases are available for download:
</p>
<ul>
<i>none yet</i>
</ul>
<p>
The CVS repository for <em>Pool</em> can be
<a href="http://cvs.apache.org/viewcvs/jakarta-commons/pool/";>browsed
online</a>
or
<a href="http://jakarta.apache.org/site/cvsindex.html";>downloaded using
a CVS client</a>.
</p>
</section>
</body>
</document>
1.1 jakarta-commons/pool/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Home</title>
<author email="[EMAIL PROTECTED]">Commons Documentation
Team</author>
<author email="[EMAIL PROTECTED]">Rodney Waldhoff</author>
<revision>$Id: index.xml,v 1.1 2002/01/15 01:20:52 rwaldhoff Exp $</revision>
</properties>
<body>
<section name="The Pool Component">
<!-- this is something of a place-holder, borrowed from
org.apache.commons.pool's package.html -->
<p>
The <code>org.apache.commons.pool</code> package defines a simple
interface for a pool of object instances, and a handful of base
classes that may be useful when creating pool implementations.
</p>
<p>
The <code>pool</code> package itself doesn't define a specific object
pooling implementation, but rather a contract that implementations may
support in order to be fully interchangeable.
</p>
<p>
The <code>pool</code> package separates the way in which instances are
pooled from the way in which they are created, resulting in a pair of
interfaces:
</p>
<dl>
<dt><code>ObjectPool</code></dt>
<dd>
defines a simple object pooling interface, with methods for
borrowing instances from and returning them to the pool.
</dd>
<dt><code>PoolableObjectFactory</code></dt>
<dd>
defines lifecycle methods for object instances contained within a pool.
By associating a factory with a pool, the pool can create new object
instances as needed.
</dd>
</dl>
<p>
<code>ObjectPoolFactory</code>
defines a simple factory for <code>ObjectPool</code>s, which may be
useful for some applications.
</p>
<p>
The <code>pool</code> package also provides a keyed pool interface,
which pools instances of multiple types, accessed according to an
arbitrary key. See
<code>KeyedObjectPool</code>,
<code>KeyedPoolableObjectFactory</code>,
and
<code>KeyedObjectPoolFactory</code>.
</p>
</section>
</body>
</document>
1.1 jakarta-commons/pool/xdocs/images/jakarta-logo.gif
<<Binary file>>
1.1 jakarta-commons/pool/xdocs/images/logo.jpg
<<Binary file>>
1.1 jakarta-commons/pool/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Commons - Pool" href="http://jakarta.apache.org/commons/pool";>
<title>HTTP Client</title>
<logo href="/images/logo.jpg">Commons</logo>
<!--
Note: Per the .vsl file, "/site" links will be prefixed with
"http://jakarta.apache.org/site";
Other links starting with "/" become "./...".
-->
<body>
<menu name="Home">
<item name="Jakarta Commons"
href="http://jakarta.apache.org/commons/index.html"; />
<item name="Pool" href="/index.html" />
</menu>
<menu name="Information">
<!--
<item name="Overview" href="/overview.html"/>
<item name="News"
href="http://jakarta.apache.org/commons/pool/news.html"/>
-->
<item name="API Documentation"
href="./dist/docs/api/index.html"/>
</menu>
<menu name="Project Files">
<item name="Status"
href="http://cvs.apache.org/viewcvs/~checkout~/jakarta-commons/pool/STATUS.html?content-type=text/html"/>
<item name="Downloads" href="/downloads.html"/>
<item name="CVS"
href="http://cvs.apache.org/viewcvs/jakarta-commons/pool/"/>
<item name="Original Proposal"
href="http://cvs.apache.org/viewcvs/~checkout~/jakarta-commons/pool/PROPOSAL.html?content-type=text/html"/>
</menu>
<menu name="About Us">
<item name="Contributors" href="/contributors.html"/>
<item name="License"
href="http://jakarta.apache.org/commons/license.html"/>
</menu>
<menu name="Jakarta Community">
<item name="Get Involved"
href="http://jakarta.apache.org/site/getinvolved.html"/>
<item name="Mailing Lists"
href="http://jakarta.apache.org/site/mail.html"/>
<item name="CVS Repositories"
href="http://jakarta.apache.org/site/cvsindex.html"/>
</menu>
</body>
</project>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
