You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by le...@apache.org on 2002/07/14 18:43:32 UTC
cvs commit: jakarta-avalon-apps/db/src/xdocs book.xml
leosimons 2002/07/14 09:43:31
Modified: xcommander build.xml readme.txt
xcommander/src/xdocs book.xml
site build.xml
site/src/xdocs book.xml
ftpserver build.xml
demo build.xml
db build.xml readme.txt
db/src/xdocs book.xml
Added: . cocoonbuild.xml cocoon.properties
xcommander default.properties
site default.properties
ftpserver default.properties
demo default.properties
db default.properties
Log:
fix doc generation for about half of avalon-apps, using the new setup for cocoon nicola introduced in excalibur CVS (ie tweety). The other half still needs to be updated.
Revision Changes Path
1.1 jakarta-avalon-apps/cocoonbuild.xml
Index: cocoonbuild.xml
===================================================================
<!-- buildfile for generation of html documentation using cocoon.
We assume that this file is always called from a buildfile
located in a subdirectory of the current dir, so file
locations are prefixed with ../ in many places. -->
<project default="cocoon:html-docs">
<!-- Setup the filters -->
<target name="cocoon:setup-filters">
<property file="../cocoon.properties"/>
<filter token="Name" value="Avalon ${Name}"/>
<filter token="name" value="${dir-name}"/>
<filter token="version" value="${version}"/>
<filter token="year" value="${year}"/>
<filter token="status" value="${status}"/>
<filter token="release" value="${release}"/>
<filter token="short-version" value="${short.version}"/>
<!-- Skin filters -->
<filter token="skin" value="${use.skin}"/>
<filter token="link1" value="apache"/>
<filter token="link1.href" value="http://www.apache.org"/>
<filter token="link2" value="jakarta"/>
<filter token="link2.href" value="http://jakarta.apache.org"/>
<filter token="link3" value="avalon"/>
<filter token="link3.href" value="http://jakarta.apache.org/avalon/"/>
<filter token="group-logo.src" value="images/jakarta-logo.gif"/>
<filter token="group-logo.href" value="http://jakarta.apache.org/"/>
<filter token="project-logo.src" value="images/header.gif"/>
<filter token="project-logo.href" value="http://jakarta.apache.org/avalon/"/>
<filter token="year" value="2002"/>
<filter token="vendor" value="Apache Software Foundation"/>
<!-- Base pointers for non-xdocs documentation. Override these in .ant.properties to link to local docs -->
<property name="avalon.base" value="http://jakarta.apache.org/avalon"/>
<property name="framework.base" value="http://jakarta.apache.org/avalon/framework"/>
<property name="excalibur.base" value="http://jakarta.apache.org/avalon/excalibur"/>
<property name="phoenix.base" value="http://jakarta.apache.org/avalon/phoenix"/>
<property name="cornerstone.base" value="http://jakarta.apache.org/avalon/cornerstone"/>
<property name="logkit.base" value="http://jakarta.apache.org/avalon/logkit"/>
<property name="apps.base" value="http://jakarta.apache.org/avalon/apps"/>
<property name="testlet.base" value="http://jakarta.apache.org/avalon/testlet"/>
<filter token="year" value="${year}"/>
<filter token="AVALON_BASE" value="${avalon.base}"/>
<filter token="FRAMEWORK_BASE" value="${framework.base}"/>
<filter token="EXCALIBUR_BASE" value="${excalibur.base}"/>
<filter token="PHOENIX_BASE" value="${phoenix.base}"/>
<filter token="CORNERSTONE_BASE" value="${cornerstone.base}"/>
<filter token="LOGKIT_BASE" value="${logkit.base}"/>
<filter token="TESTLET_BASE" value="${testlet.base}"/>
<filter token="APPS_BASE" value="${apps.base}"/>
</target>
<target name="cocoon:setup-html-docs" depends="cocoon:setup-filters" description="generates the xdocs-based documentation">
<mkdir dir="${build.dir}"/>
<mkdir dir="${cocoon.build.context}"/>
<mkdir dir="${cocoon.build.docs}"/>
<mkdir dir="${cocoon.build.xdocs}"/>
<mkdir dir="${cocoon.work}"/>
<copy todir="${cocoon.build.context}" overwrite="true" filtering="on">
<fileset dir="${cocoon.main.context.dir}">
<exclude name="**/*.gif"/>
<exclude name="**/*.jpg"/>
<exclude name="**/*.png"/>
</fileset>
</copy>
<copy todir="${cocoon.build.context}" filtering="off">
<fileset dir="${cocoon.main.context.dir}">
<include name="**/*.gif"/>
<include name="**/*.jpg"/>
<include name="**/*.png"/>
</fileset>
</copy>
<copy todir="${cocoon.build.xdocs}" filtering="on" overwrite="true">
<fileset dir="${cocoon.xdocs.dir}"/>
</copy>
<copy file="${cocoon.main.context.dir}/resources/schema/CatalogManager.properties"
todir="${cocoon.build.context}/resources/schema" filtering="off"/>
</target>
<target name="cocoon:html-listed-docs" depends="cocoon:setup-html-docs" description="generates the xdocs-based documentation">
<echo message="-------------------------------------------------------------"/>
<echo message=" Building docs from list, please stand by ..."/>
<java classname="org.apache.cocoon.Main" fork="true" maxmemory="128m" failonerror="true">
<arg value="-c${cocoon.build.context}/"/>
<arg value="-d${cocoon.build.docs}"/>
<arg value="-w${cocoon.work}"/>
<arg value="-l${cocoon.work}/cocoon.log"/>
<arg value="-b${build.dir}/brokenlinks.txt"/>
<arg value="-uERROR"/>
<arg value="-f./build/content/xdocs/doc.uris"/>
<arg value="-rno"/>
<classpath>
<path refid="tools.class.path"/>
<fileset dir="${tools.dir}/ext"/>
</classpath>
</java>
<echo message=" ...docs generated succesfully in ./build/docs dir."/>
<echo message="-------------------------------------------------------------"/>
</target>
<target name="cocoon:html-docs" depends="cocoon:setup-html-docs" description="generates the xdocs-based documentation">
<echo message="-------------------------------------------------------------"/>
<echo message=" Crawling docs, please stand by ..."/>
<java classname="org.apache.cocoon.Main" fork="true" maxmemory="128m" failonerror="true">
<arg value="-c${cocoon.build.context}/"/>
<arg value="-d${cocoon.build.docs}"/>
<arg value="-w${cocoon.work}"/>
<arg value="-l${cocoon.work}/cocoon.log"/>
<arg value="-b${build.dir}/brokenlinks.txt"/>
<arg value="-uERROR"/>
<arg value="index.html"/>
<classpath>
<path id="tools.class.path">
<pathelement location="${junit.jar}"/>
<pathelement location="${tools.jar}"/>
<fileset dir="${tools.dir}/lib"/>
<fileset dir="${tools.dir}/ext"/>
</path>
</classpath>
</java>
<echo message=" ...docs generated succesfully in ./build/docs dir."/>
<echo message="-------------------------------------------------------------"/>
</target>
</project>
1.1 jakarta-avalon-apps/cocoon.properties
Index: cocoon.properties
===================================================================
# --------------------------------------------------
# DOC GENERATION CONFIGURATION
# --------------------------------------------------
# locations of required materials for documentation generation with Cocoon.
#
# it implies that jakarta-avalon module is in the same dir
# as the apps module. We assume we are called from a subdirectory of
# the current directory, and that the build.dir and src.dir properties
# are set
# location of the jakarta-avalon CVS module.
framework.dir = ../../jakarta-avalon
# temporary files are stored here
cocoon.work=${build.dir}/work
# generated docs go here
cocoon.build.docs = ${build.dir}/docs
# documentation sources are copied here prior to generation
cocoon.build.context = ${build.dir}
cocoon.build.xdocs = ${cocoon.build.context}/content/xdocs
# where the documentation source files reside
cocoon.xdocs.dir = ${src.dir}/xdocs
# not used?
skins.dir = ${src.dir}/skins
# where the DTDs and related stuff reside
cocoon.context.dir = ${src.dir}/xdocs
# where the main DTDs and related stuff reside
cocoon.main.context.dir = ${framework.dir}/src/documentation
# where we keep the stylesheets
cocoon.stylesheets.dir = ${skins.dir}
# where we keep the tools and jars
tools.dir = ${framework.dir}/tools/
# look and feel to use
use.skin=avalon-tigris
1.14 +140 -223 jakarta-avalon-apps/xcommander/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/xcommander/build.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- build.xml 6 Jun 2002 20:48:40 -0000 1.13
+++ build.xml 14 Jul 2002 16:43:31 -0000 1.14
@@ -2,103 +2,84 @@
<project name="XCommander" default="main" basedir=".">
- <!--
- Give user a chance to override without editing this file
- (and without typing -D each time they compile it)
- -->
- <property file=".ant.properties"/>
- <property file="${user.home}/.ant.properties"/>
-
- <property name="name" value="xcommander"/>
- <property name="Name" value="XCommander"/>
- <property name="version" value="0.7"/>
- <property name="year" value="2000-2001"/>
-
- <property name="build.debug" value="on"/>
- <property name="build.optimize" value="off"/>
- <property name="build.deprecation" value="off"/>
-
- <!-- Set the installation variables for Cornerstone/Phoenix -->
- <property name="phoenix.home" value="../../jakarta-avalon-phoenix/dist"/>
- <property name="install.dir" value="${phoenix.home}/apps"/>
-
- <!-- Set the properties for intermediate directory -->
- <property name="build.dir" value="build"/>
- <property name="build.lib" value="${build.dir}/lib"/>
- <property name="build.xdoclet" value="${build.dir}/xdoclet"/>
- <property name="build.src" value="${build.dir}/src"/>
- <property name="build.classes" value="${build.dir}/classes"/>
- <property name="build.javadocs" value="${build.dir}/javadocs"/>
- <property name="build.docs" value="${build.dir}/docs"/>
- <property name="build.context" value="${build.dir}/documentation"/>
- <property name="build.xdocs" value="${build.context}/content/xdocs"/>
-
- <!-- Set the properties for source directories -->
- <property name="src.dir" value="src"/>
- <property name="java.dir" value="${src.dir}/java"/>
- <property name="manifest.dir" value="${src.dir}/manifest"/>
- <property name="conf.dir" value="${src.dir}/conf"/>
- <property name="context.dir" value="../../jakarta-avalon/src/documentation"/>
- <property name="xdocs.dir" value="${src.dir}/xdocs"/>
- <property name="tools.dir" location="../../jakarta-avalon/tools"/>
-
- <property name="dist.base" value="distributions"/>
-
- <path id="project.class.path">
- <pathelement path="${java.class.path}" />
- <pathelement path="${build.classes}" />
- <fileset dir="../common/lib">
- <include name="*.jar" />
- </fileset>
- <fileset dir="lib">
- <include name="*.jar" />
- </fileset>
- </path>
-
-
- <path id="tools.class.path">
- <path refid="project.class.path"/>
- <pathelement location="${xerces.jar}"/>
- <pathelement location="${xalan.jar}"/>
- <pathelement location="${tools.jar}"/>
- <fileset dir="${tools.dir}/lib">
- <exclude name="ant.jar" />
- </fileset>
- </path>
-
- <taskdef name="sar" classname="org.apache.avalon.phoenix.tools.tasks.Sar">
- <classpath refid="project.class.path" />
- </taskdef>
-
- <!-- Setup the filters -->
- <target name="setup-filters">
- <filter token="Name" value="Avalon Apps - XCommander"/>
- <filter token="name" value="xcommander"/>
- <filter token="version" value="${version}"/>
- <filter token="year" value="${year}"/>
- <filter token="status" value="${status}"/>
- <filter token="release" value="${release}"/>
- <filter token="short-version" value="${short.version}"/>
-
- <property name="avalon.base" value="http://jakarta.apache.org/avalon"/>
- <property name="framework.base" value="http://jakarta.apache.org/avalon/framework"/>
- <property name="phoenix.base" value="http://jakarta.apache.org/avalon/phoenix"/>
- <property name="excalibur.base" value="http://jakarta.apache.org/avalon/excalibur"/>
- <property name="cornerstone.base" value="http://jakarta.apache.org/avalon/cornerstone"/>
- <property name="logkit.base" value="http://jakarta.apache.org/avalon/logkit"/>
- <property name="testlet.base" value="http://jakarta.apache.org/avalon/testlet"/>
- <property name="apps.base" value="http://jakarta.apache.org/avalon/apps"/>
-
- <filter token="year" value="${year}"/>
- <filter token="AVALON_BASE" value="${avalon.base}"/>
- <filter token="FRAMEWORK_BASE" value="${framework.base}"/>
- <filter token="EXCALIBUR_BASE" value="${excalibur.base}"/>
- <filter token="PHOENIX_BASE" value="${phoenix.base}"/>
- <filter token="CORNERSTONE_BASE" value="${cornerstone.base}"/>
- <filter token="LOGKIT_BASE" value="${logkit.base}"/>
- <filter token="TESTLET_BASE" value="${testlet.base}"/>
- <filter token="APPS_BASE" value="${apps.base}"/>
- </target>
+<!-- ==========================================================================================
+ PROPERTY SETUP
+ ========================================================================================== -->
+
+ <!-- give user chance to override properties -->
+ <property file="${user.home}/build.properties"/>
+ <property file="${basedir}/../ant.properties"/>
+ <property file="${basedir}/ant.properties"/>
+ <property file="${user.home}/.ant.properties"/>
+ <property file="${basedir}/../default.properties"/>
+ <property file="${basedir}/default.properties"/>
+
+ <!-- Set the installation variables for Cornerstone/Phoenix -->
+ <property name="phoenix.home" value="../../jakarta-avalon-phoenix/dist"/>
+ <property name="install.dir" value="${phoenix.home}/apps"/>
+
+ <!-- Set the properties for intermediate directory -->
+ <property name="build.dir" value="build"/>
+ <property name="build.lib" value="${build.dir}/lib"/>
+ <property name="build.xdoclet" value="${build.dir}/xdoclet"/>
+ <property name="build.src" value="${build.dir}/src"/>
+ <property name="build.classes" value="${build.dir}/classes"/>
+ <property name="build.javadocs" value="${build.dir}/javadocs"/>
+ <property name="build.docs" value="${build.dir}/docs"/>
+ <property name="build.context" value="${build.dir}/documentation"/>
+ <property name="build.xdocs" value="${build.context}/content/xdocs"/>
+
+ <!-- Set the properties for source directories -->
+ <property name="src.dir" value="src"/>
+ <property name="java.dir" value="${src.dir}/java"/>
+ <property name="manifest.dir" value="${src.dir}/manifest"/>
+ <property name="conf.dir" value="${src.dir}/conf"/>
+ <property name="context.dir" value="../../jakarta-avalon/src/documentation"/>
+ <property name="xdocs.dir" value="${src.dir}/xdocs"/>
+ <property name="tools.dir" location="../../jakarta-avalon/tools"/>
+
+ <property name="dist.base" value="distributions"/>
+
+
+<!-- ==========================================================================================
+ CLASSPATH SETUP
+ ========================================================================================== -->
+
+ <path id="project.class.path">
+ <pathelement path="${java.class.path}" />
+ <pathelement path="${build.classes}" />
+ <fileset dir="../common/lib">
+ <include name="*.jar" />
+ </fileset>
+ <fileset dir="lib">
+ <include name="*.jar" />
+ </fileset>
+ </path>
+
+ <path id="tools.class.path">
+ <path refid="project.class.path"/>
+ <pathelement location="${xerces.jar}"/>
+ <pathelement location="${xalan.jar}"/>
+ <pathelement location="${tools.jar}"/>
+ <fileset dir="${tools.dir}/lib">
+ <exclude name="ant.jar" />
+ </fileset>
+ </path>
+
+ <taskdef name="sar" classname="org.apache.avalon.phoenix.tools.tasks.Sar">
+ <classpath refid="project.class.path" />
+ </taskdef>
+
+<!-- ==========================================================================================
+ DEFAULT TARGETS
+ ========================================================================================== -->
+
+ <target name="main" depends="sars" description="Default target to generate build products minus docs"/>
+ <target name="all" depends="main,docs" description="Generate build products including docs"/>
+
+<!-- ==========================================================================================
+ COMPILE TARGETS
+ ========================================================================================== -->
<!-- Compiles project -->
<target name="compile">
@@ -111,7 +92,7 @@
optimize="${build.optimize}"
deprecation="${build.deprecation}">
<classpath refid="project.class.path" />
-
+
</javac>
<copy todir="${build.classes}">
@@ -123,15 +104,15 @@
</target>
- <target name="test-xdoclet">
- <available classname="xdoclet.XDocletMain" classpathref="project.class.path" property="xdoclet.present"/>
+ <target name="test-xdoclet">
+ <available classname="xdoclet.XDocletMain" classpathref="project.class.path" property="xdoclet.present"/>
</target>
<!-- Make .xinfo and manifest automatically for blocks -->
<target name="phoenix-xdoclet" depends="compile" if="xdoclet.present">
-
+
<mkdir dir="${build.xdoclet}"/>
-
+
<taskdef name="phoenix-blocks"
classname="org.apache.avalon.phoenix.tools.xdoclet.PhoenixXDoclet"
classpathref="project.class.path"/>
@@ -150,13 +131,21 @@
<!-- Make .xinfo and manifest automatically for blocks -->
<target name="no-phoenix-xdoclet" depends="compile" unless="xdoclet.present">
-
+
<mkdir dir="${build.xdoclet}"/>
-
+
<unzip src="${src.dir}/generated-by-xdoclet.zip" dest="${build.xdoclet}" />
</target>
+ <!-- Performs unit tests -->
+ <target name="check" depends="compile" description="Perform any built in tests">
+ </target>
+
+
+<!-- ==========================================================================================
+ DISTRIBUTION TARGETS
+ ========================================================================================== -->
<!-- Jars up project -->
<target name="jars" depends="test-xdoclet, phoenix-xdoclet, no-phoenix-xdoclet">
@@ -175,9 +164,6 @@
</target>
- <target name="main" depends="sars" description="Default target to generate build products minus docs"/>
- <target name="all" depends="main,docs" description="Generate build products including docs"/>
-
<target name="sars" depends="jars">
<sar sarfile="${build.lib}/xcommander.sar"
@@ -187,135 +173,24 @@
<lib dir="${build.lib}/">
<include name="*.jar"/>
- </lib>
+ </lib>
<lib dir="../common/lib">
<include name="cornerstone.jar"/>
</lib>
-
+
</sar>
-
+
<mkdir dir="dist"/>
<copy todir="dist">
<fileset dir="${build.lib}">
<include name="**"/>
</fileset>
- </copy>
-
- </target>
+ </copy>
-
- <!-- Performs unit tests -->
- <target name="check" depends="compile" description="Perform any built in tests">
</target>
- <!-- Create the API documentation -->
- <target name="javadocs" description="Generates the Java Docs">
-
- <delete dir="${build.docs}/api"/>
- <mkdir dir="${build.docs}/api"/>
-
- <javadoc packagenames="org.apache.*"
- sourcepath="${java.dir}"
- destdir="${build.docs}/api">
- <classpath refid="project.class.path" />
- <doclet name="com.sun.tools.doclets.standard.Standard">
- <param name="-author"/>
- <param name="-version"/>
- <param name="-doctitle" value="${Name}"/>
- <param name="-windowtitle" value="${Name} API"/>
- <param name="-bottom"
- value=""Copyright © 2001 Apache Jakarta Project. All Rights Reserved.""/>
- </doclet>
- </javadoc>
- </target>
-
- <!-- Prepares the documentation directory -->
- <target name="docs" depends="html-docs, javadocs" description="generates all the Avalon documentation"/>
-
-
- <target name="html-docs" depends="setup-filters" description="generates the xdocs-based documentation">
-
- <property name="use.skin" value="avalon-site"/>
-
- <!-- Skin filters -->
- <filter token="skin" value="${use.skin}"/>
- <filter token="link1" value="apache"/>
- <filter token="link1.href" value="http://www.apache.org"/>
- <filter token="link2" value="jakarta"/>
- <filter token="link2.href" value="http://jakarta.apache.org"/>
- <filter token="link3" value="avalon"/>
- <filter token="link3.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="group-logo.src" value="images/jakarta-logo.gif"/>
- <filter token="group-logo.href" value="http://jakarta.apache.org/"/>
- <filter token="project-logo.src" value="images/header.gif"/>
- <filter token="project-logo.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="year" value="2002"/>
- <filter token="vendor" value="Apache Software Foundation"/>
-
- <mkdir dir="${build.context}"/>
- <mkdir dir="${build.docs}"/>
- <mkdir dir="${build.xdocs}"/>
- <mkdir dir="${build.dir}/work"/>
-
- <copy todir="${build.context}" overwrite="true" filtering="on">
- <fileset dir="${context.dir}">
- <exclude name="**/*.gif"/>
- <exclude name="**/*.jpg"/>
- <exclude name="**/*.png"/>
- </fileset>
- </copy>
-
- <copy todir="${build.context}" filtering="off">
- <fileset dir="${context.dir}">
- <include name="**/*.gif"/>
- <include name="**/*.jpg"/>
- <include name="**/*.png"/>
- </fileset>
- </copy>
- <copy todir="${build.xdocs}" filtering="on" overwrite="true">
- <fileset dir="${xdocs.dir}"/>
- </copy>
-
- <echo message="-------------------------------------------------------------"/>
- <echo message=" Building docs, please stand by ..."/>
-
- <java classname="org.apache.cocoon.Main" fork="true" maxmemory="128m" failonerror="true">
- <arg value="-c${build.context}/"/>
- <arg value="-d${build.docs}"/>
- <arg value="-w${build.dir}/work"/>
- <arg value="-l${build.dir}/work/cocoon.log"/>
- <arg value="-uWARN"/>
- <arg value="index.html"/>
- <classpath>
- <path refid="tools.class.path"/>
- <fileset dir="${tools.dir}/ext"/>
- </classpath>
- </java>
-
- <!-- hack for stupid transport on api link -->
- <replace dir="${build.docs}" token="http://hack.hack" value="api/index.html">
- <include name="*.html"/>
- </replace>
-
- <echo message=" ...docs generated succesfully in ./build/docs dir."/>
- <echo message="-------------------------------------------------------------"/>
-
- </target>
-
-
- <target name="site" depends="docs" description=" Places Docs ready for hosting on website">
-
- <mkdir dir="../site/docs/apps/${name}"/>
- <copy todir="../site/docs/apps/${name}">
- <fileset dir="${build.docs}">
- <include name="**"/>
- </fileset>
- </copy>
-
- </target>
-
<!-- Completely build all dists -->
<target name="dist" depends="sars" description="Generates the distribution">
@@ -416,7 +291,7 @@
<zip zipfile="${src.dist.src}/generated-by-xdoclet.zip"
basedir="${build.xdoclet}"/>
-
+
<copy todir="${src.dist.dir}">
<fileset dir=".">
<include name="build.xml"/>
@@ -461,4 +336,46 @@
<delete dir="${dist.base}" />
</target>
+<!-- ==========================================================================================
+ DOCUMENTATION GENERATION
+========================================================================================== -->
+
+ <!-- Creates all docs -->
+ <target name="docs" depends="html-docs, javadocs" description="generates all the Avalon documentation"/>
+
+ <!-- copy docs to site dir -->
+ <target name="site" depends="docs" description=" Places Docs ready for hosting on website">
+ <mkdir dir="../site/build/docs/apps/${dir-name}"/>
+ <copy todir="../site/build/docs/apps/${dir-name}">
+ <fileset dir="${build.docs}">
+ <include name="**"/>
+ </fileset>
+ </copy>
+ </target>
+
+ <!-- Creates javadocs -->
+ <target name="javadocs" depends="compile" description="Generates the javadocs" unless="skip.javadocs">
+ <mkdir dir="${build.javadocs}"/>
+ <javadoc packagenames="org.apache.*"
+ sourcepath="${java.dir}"
+ destdir="${build.javadocs}">
+ <classpath refid="project.class.path" />
+ <doclet name="com.sun.tools.doclets.standard.Standard">
+ <param name="-author"/>
+ <param name="-version"/>
+ <param name="-doctitle" value="${Name}"/>
+ <param name="-windowtitle" value="${Name} API"/>
+ <param name="-link" value="http://java.sun.com/j2se/1.4/docs/api/"/>
+ <param name="-link" value="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/"/>
+ <param name="-link" value="http://jakarta.apache.org/avalon/api/"/>
+ <param name="-bottom"
+ value=""Copyright © ${year} Apache Jakarta Project. All Rights Reserved.""/>
+ </doclet>
+ </javadoc>
+ </target>
+
+ <target name="html-docs" description="generates the xdocs-based documentation">
+ <!-- we call the cocoonbuild.xml target common to all of excalibur. This builds our html site -->
+ <ant antfile="${basedir}/../cocoonbuild.xml"/>
+ </target>
</project>
1.2 +38 -0 jakarta-avalon-apps/xcommander/readme.txt
Index: readme.txt
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/xcommander/readme.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- readme.txt 4 Mar 2002 12:45:37 -0000 1.1
+++ readme.txt 14 Jul 2002 16:43:31 -0000 1.2
@@ -0,0 +1,38 @@
+ Avalons Applications XCommander
+ -------------------------------
+
+What is XCommander?
+-------------------
+XCommander is a server program which is used to listen for and execute
+java commands which are given in xml format.
+It is possible to use XCommander to give any command which can be given
+using standard code, using its lightweight xml over TCP/IP protocol.
+
+How do I use it?
+----------------
+Please take a look at the example socketTester.fla for a sample client.
+You can simply drop the generated .sar into your phoenix apps directory
+to run the server. Also see the documentation in the docs/ directory
+for more information.
+
+What are the plans for XCommander?
+----------------------------------
+XCommander is intended more as a demo avalon application that runs
+within phoenix than as a production-level server. We are not planning
+to expand on it, though contributions are very welcome.
+
+Who wrote it?
+-------------
+that'd be me, Leo Simons.
+
+Can I get support?
+------------------
+If you have trouble getting it running, try the avalon-user list and
+we'll try and help you out. As XCommander is untested for any kind of
+elaborate application, we do not offer any kind of support in that
+direction.
+
+Isn't there any more documentation?
+-----------------------------------
+Have you seen the javadocs? They're quite extensive. Other than that,
+nope. This is just a demo, remember?
\ No newline at end of file
1.1 jakarta-avalon-apps/xcommander/default.properties
Index: default.properties
===================================================================
# -------------------------------------------------------------------
# B U I L D P R O P E R T I E S
# -------------------------------------------------------------------
# Specifies default property values
# Overridden by ../default.properties and all ant.properties
# Not user-editable; use ant.properties files instead
# --------------------------------------------------
# DOC GENERATION CONFIGURATION
# --------------------------------------------------
name=xcommander
Name=Avalon Apps XCommander
dir-name=xcommander
version=0.7
package-version=1.0
year=2000-2002
# --------------------------------------------------
# REQUIRED LIBRARIES
# --------------------------------------------------
# ----- Avalon Framework -----
avalon-framework.home=${basedir}/../../jakarta-avalon
avalon-framework.lib=${avalon-framework.home}/build/lib
avalon-framework.jar=${avalon-framework.lib}/avalon-framework.jar
# --------------------------------------------------
# COMPILATION ENVIRONMENT
# --------------------------------------------------
# Settings used to configure compile environment
build.debug = on
build.optimize = off
build.deprecation = on
build.compress = false
junit.failonerror = false
# location of intermediate products
build.dir = build
build.testsrc = ${build.dir}/testsrc
build.testclasses = ${build.dir}/testclasses
build.lib = ${build.dir}/lib
build.conf = ${build.dir}/conf
build.classes = ${build.dir}/classes
build.tests = ${build.dir}/tests
build.reports = ${build.dir}/reports
build.docs = ${build.dir}/docs
build.javadocs = ${build.docs}/api
# Set the properties for source directories
src.dir = src
java.dir = ${src.dir}/java
conf.dir = ${src.dir}/conf
test.dir = ${src.dir}/test
# Set the properties for distribution directories
dist.dir = dist
dist.javadocs = ${dist.dir}/docs/api
# name of .zip/.tar.gz/.bz2 files and their top-level directory
dist.name = ${name}-${version}
# name of jar file
jar.name = ${name}-${version}.jar
# property indicating directory where all distribution archives are placed
dist.base = distributions
depchecker.prefix=.
1.7 +2 -2 jakarta-avalon-apps/xcommander/src/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/xcommander/src/xdocs/book.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- book.xml 30 Jun 2002 09:08:45 -0000 1.6
+++ book.xml 14 Jul 2002 16:43:31 -0000 1.7
@@ -9,8 +9,8 @@
<menu label="About">
<menu-item label="Overview" href="index.html"/>
- <menu-item type="external" label="API Docs" href="http://hack.hack"/>
- <menu-item type="external" id="downloads" label="Download" href="http://jakarta.apache.org/builds/jakarta-avalon-apps/"/>
+ <menu-item type="external" label="API Docs" href="api/"/>
+ <menu-item type="external" id="downloads" label="Download" href="http://jakarta.apache.org/builds/jakarta-avalon-apps/"/>
</menu>
</book>
1.10 +59 -159 jakarta-avalon-apps/site/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/site/build.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- build.xml 30 Jun 2002 09:08:45 -0000 1.9
+++ build.xml 14 Jul 2002 16:43:31 -0000 1.10
@@ -2,17 +2,17 @@
<project default="docs" basedir=".">
- <!--
- Give user a chance to override without editing this file
- (and without typing -D each time he compiles it)
- -->
- <property file=".ant.properties"/>
- <property file="${user.home}/.ant.properties"/>
-
- <property name="name" value="apps"/>
- <property name="Name" value="Apps"/>
- <property name="version" value="0.6"/>
- <property name="year" value="1999-2002"/>
+<!-- ==========================================================================================
+ PROPERTY SETUP
+ ========================================================================================== -->
+
+ <!-- give user chance to override properties -->
+ <property file="${user.home}/build.properties"/>
+ <property file="${basedir}/../ant.properties"/>
+ <property file="${basedir}/ant.properties"/>
+ <property file="${user.home}/.ant.properties"/>
+ <property file="${basedir}/../default.properties"/>
+ <property file="${basedir}/default.properties"/>
<!-- Set the properties for intermediate directory -->
<property name="build.dir" value="build"/>
@@ -57,159 +57,49 @@
<echo message="Run ant -projecthelp to get a list of targets to run"/>
</target>
- <!-- Setup the filters -->
- <target name="setup-filters">
- <filter token="Name" value="Avalon Applications"/>
- <filter token="name" value="apps"/>
- <filter token="version" value="${version}"/>
- <filter token="year" value="${year}"/>
- <filter token="status" value="${status}"/>
- <filter token="release" value="${release}"/>
- <filter token="short-version" value="${short.version}"/>
-
- <property name="avalon.base" value="http://jakarta.apache.org/avalon"/>
- <property name="framework.base" value="http://jakarta.apache.org/avalon/framework"/>
- <property name="phoenix.base" value="http://jakarta.apache.org/avalon/phoenix"/>
- <property name="excalibur.base" value="http://jakarta.apache.org/avalon/excalibur"/>
- <property name="cornerstone.base" value="http://jakarta.apache.org/avalon/cornerstone"/>
- <property name="logkit.base" value="http://jakarta.apache.org/avalon/logkit"/>
- <property name="testlet.base" value="http://jakarta.apache.org/avalon/testlet"/>
- <property name="apps.base" value="http://jakarta.apache.org/avalon/apps"/>
-
- <filter token="year" value="${year}"/>
- <filter token="AVALON_BASE" value="${avalon.base}"/>
- <filter token="FRAMEWORK_BASE" value="${framework.base}"/>
- <filter token="EXCALIBUR_BASE" value="${excalibur.base}"/>
- <filter token="PHOENIX_BASE" value="${phoenix.base}"/>
- <filter token="CORNERSTONE_BASE" value="${cornerstone.base}"/>
- <filter token="LOGKIT_BASE" value="${logkit.base}"/>
- <filter token="TESTLET_BASE" value="${testlet.base}"/>
- <filter token="APPS_BASE" value="${apps.base}"/>
- </target>
-
-
<target name="clean" description="Cleans up artifacts from build process">
<delete dir="${build.dir}" />
<delete>
<fileset dir="." includes="**/*~" defaultexcludes="no"/>
</delete>
</target>
-
- <!-- Prepares the documentation directory -->
- <target name="docs" depends="html-docs" description="generates all the Avalon documentation"/>
-
- <target name="html-docs" depends="setup-filters" description="generates the xdocs-based documentation">
+ <target name="site" depends="docs" description="Places Docs ready for hosting on website">
- <property name="use.skin" value="avalon-site"/>
+ <ant dir="../db/" target="site" inheritAll="false"/>
+ <ant dir="../demo/" target="site" inheritAll="false"/>
+ <ant dir="../ftpserver/" target="site" inheritAll="false"/>
+ <ant dir="../hsql/" target="site" inheritAll="false"/>
+ <ant dir="../httpproxy/" target="site" inheritAll="false"/>
+ <ant dir="../overlord/" target="site" inheritAll="false"/>
+ <ant dir="../simpleserver/" target="site" inheritAll="false"/>
+ <ant dir="../sevak/" target="site" inheritAll="false"/>
+ <ant dir="../xcommander/" target="site" inheritAll="false"/>
- <!-- Skin filters -->
- <filter token="skin" value="${use.skin}"/>
- <filter token="link1" value="apache"/>
- <filter token="link1.href" value="http://www.apache.org"/>
- <filter token="link2" value="jakarta"/>
- <filter token="link2.href" value="http://jakarta.apache.org"/>
- <filter token="link3" value="avalon"/>
- <filter token="link3.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="group-logo.src" value="images/jakarta-logo.gif"/>
- <filter token="group-logo.href" value="http://jakarta.apache.org/"/>
- <filter token="project-logo.src" value="images/header.gif"/>
- <filter token="project-logo.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="year" value="2002"/>
- <filter token="vendor" value="Apache Software Foundation"/>
-
- <mkdir dir="${build.context}"/>
- <mkdir dir="${build.docs}"/>
- <mkdir dir="${build.xdocs}"/>
- <mkdir dir="${build.dir}/work"/>
-
- <copy todir="${build.context}" overwrite="true" filtering="on">
- <fileset dir="${context.dir}">
- <exclude name="**/*.gif"/>
- <exclude name="**/*.jpg"/>
- <exclude name="**/*.png"/>
- </fileset>
- </copy>
-
- <copy todir="${build.context}" filtering="off">
- <fileset dir="${context.dir}">
- <include name="**/*.gif"/>
- <include name="**/*.jpg"/>
- <include name="**/*.png"/>
- </fileset>
- </copy>
- <copy todir="${build.xdocs}" filtering="on" overwrite="true">
- <fileset dir="${xdocs.dir}"/>
- </copy>
-
- <echo message="-------------------------------------------------------------"/>
- <echo message=" Building docs, please stand by ..."/>
-
- <java classname="org.apache.cocoon.Main" fork="true" maxmemory="128m" failonerror="true">
- <arg value="-c${build.context}/"/>
- <arg value="-d${build.docs}"/>
- <arg value="-w${build.dir}/work"/>
- <arg value="-l${build.dir}/work/cocoon.log"/>
- <arg value="-uWARN"/>
- <arg value="index.html"/>
- <classpath>
- <path refid="tools.class.path"/>
- <fileset dir="${tools.dir}/ext"/>
- </classpath>
- </java>
- <!-- hack for stupid transport on api link -->
- <replace dir="${build.docs}" token="http://hack.hack/" value="">
- <include name="appsincvs.html"/>
- </replace>
-
-
- <echo message=" ...docs generated succesfully in ./build/docs dir."/>
- <echo message="-------------------------------------------------------------"/>
-
- <mkdir dir="docs"/>
- <copy todir="docs">
- <fileset dir="${build.docs}" />
- </copy>
+ </target>
- </target>
+ <target name="dists" description="Generates the distributables for apps projects">
-
- <target name="site" depends="docs" description="Places Docs ready for hosting on website">
-
- <ant dir="../db/" target="site" inheritAll="false"/>
- <ant dir="../demo/" target="site" inheritAll="false"/>
- <ant dir="../ftpserver/" target="site" inheritAll="false"/>
- <ant dir="../hsql/" target="site" inheritAll="false"/>
- <ant dir="../httpproxy/" target="site" inheritAll="false"/>
- <ant dir="../overlord/" target="site" inheritAll="false"/>
- <ant dir="../simpleserver/" target="site" inheritAll="false"/>
- <ant dir="../sevak/" target="site" inheritAll="false"/>
- <ant dir="../xcommander/" target="site" inheritAll="false"/>
-
- </target>
-
- <target name="dists" description="Generates the distributables for apps projects">
-
- <ant dir="../db/" target="dist" inheritAll="false"/>
- <ant dir="../demo/" target="dist" inheritAll="false"/>
- <ant dir="../ftpserver/" target="dist" inheritAll="false"/>
- <ant dir="../hsql/" target="dist" inheritAll="false"/>
- <ant dir="../httpproxy/" target="dist" inheritAll="false"/>
- <ant dir="../overlord/" target="dist" inheritAll="false"/>
- <ant dir="../sevak/" target="dist" inheritAll="false"/>
- <ant dir="../simpleserver/" target="dist" inheritAll="false"/>
- <ant dir="../xcommander/" target="dist" inheritAll="false"/>
-
- <mkdir dir="dist"/>
+ <ant dir="../db/" target="dist" inheritAll="false"/>
+ <ant dir="../demo/" target="dist" inheritAll="false"/>
+ <ant dir="../ftpserver/" target="dist" inheritAll="false"/>
+ <ant dir="../hsql/" target="dist" inheritAll="false"/>
+ <ant dir="../httpproxy/" target="dist" inheritAll="false"/>
+ <ant dir="../overlord/" target="dist" inheritAll="false"/>
+ <ant dir="../sevak/" target="dist" inheritAll="false"/>
+ <ant dir="../simpleserver/" target="dist" inheritAll="false"/>
+ <ant dir="../xcommander/" target="dist" inheritAll="false"/>
+
+ <mkdir dir="dist"/>
<copy todir="dist" flatten="true">
<fileset dir=".." >
<include name="*/distributions/*.zip"/>
<include name="*/distributions/*.tar.gz"/>
- </fileset>
- </copy>
-
- </target>
-
+ </fileset>
+ </copy>
+
+ </target>
+
<!-- Update the www directory -->
<target name="site-copy" depends="site" description="Copy prepared website docs to dir under CVS control">
@@ -228,11 +118,11 @@
<fileset dir="docs" />
</copy>
- </target>
-
+ </target>
+
<!-- Create the announcements and HEADER.html -->
<target name="announcement">
-
+
<filter token="Name" value="${Near}"/>
<filter token="name" value="${near}"/>
<filter token="version" value="${version}"/>
@@ -240,17 +130,17 @@
<filter token="status" value="${status}"/>
<filter token="release" value="${release}"/>
<filter token="short-version" value="${short.version}"/>
-
+
<mkdir dir="${build.dir}" />
<mkdir dir="${dist.base}" />
-
+
<copy todir="${build.dir}" filtering="on">
<fileset dir="${xdocs.dir}">
<include name="announcement.xml"/>
<include name="changes.xml"/>
</fileset>
</copy>
-
+
<style style="${announce2txt}" in="${build.dir}/announcement.xml" out="Announcement.txt"/>
<style style="${announce2header}" in="${build.dir}/announcement.xml"
out="dist/HEADER.html"/>
@@ -258,9 +148,19 @@
out="dist/README.html"/>
<style style="${announce2site}" in="${build.dir}/announcement.xml"
out="jakarta-news.xml"/>
-
+
</target>
-
-
-
+
+
+<!-- ==========================================================================================
+ DOCUMENTATION GENERATION
+========================================================================================== -->
+
+ <!-- Creates all docs -->
+ <target name="docs" depends="html-docs" description="generates all the Avalon documentation"/>
+
+ <target name="html-docs" description="generates the xdocs-based documentation">
+ <!-- we call the cocoonbuild.xml target common to all of excalibur. This builds our html site -->
+ <ant antfile="${basedir}/../cocoonbuild.xml"/>
+ </target>
</project>
1.1 jakarta-avalon-apps/site/default.properties
Index: default.properties
===================================================================
# -------------------------------------------------------------------
# B U I L D P R O P E R T I E S
# -------------------------------------------------------------------
# Specifies default property values
# Overridden by ../default.properties and all ant.properties
# Not user-editable; use ant.properties files instead
# --------------------------------------------------
# DOC GENERATION CONFIGURATION
# --------------------------------------------------
name=apps
Name=Apps
dir-name=./
version=0.6
package-version=1.0
year=2000-2002
# most of the below is unused but I'm too lazy to remove it
# --------------------------------------------------
# REQUIRED LIBRARIES
# --------------------------------------------------
# ----- Avalon Framework -----
avalon-framework.home=${basedir}/../../jakarta-avalon
avalon-framework.lib=${avalon-framework.home}/build/lib
avalon-framework.jar=${avalon-framework.lib}/avalon-framework.jar
# --------------------------------------------------
# COMPILATION ENVIRONMENT
# --------------------------------------------------
# Settings used to configure compile environment
build.debug = on
build.optimize = off
build.deprecation = on
build.compress = false
junit.failonerror = false
# location of intermediate products
build.dir = build
build.testsrc = ${build.dir}/testsrc
build.testclasses = ${build.dir}/testclasses
build.lib = ${build.dir}/lib
build.conf = ${build.dir}/conf
build.classes = ${build.dir}/classes
build.tests = ${build.dir}/tests
build.reports = ${build.dir}/reports
build.docs = ${build.dir}/docs
build.javadocs = ${build.docs}/api
# Set the properties for source directories
src.dir = src
java.dir = ${src.dir}/java
conf.dir = ${src.dir}/conf
test.dir = ${src.dir}/test
# Set the properties for distribution directories
dist.dir = dist
dist.javadocs = ${dist.dir}/docs/api
# name of .zip/.tar.gz/.bz2 files and their top-level directory
dist.name = ${name}-${version}
# name of jar file
jar.name = ${name}-${version}.jar
# property indicating directory where all distribution archives are placed
dist.base = distributions
depchecker.prefix=.
1.5 +27 -5 jakarta-avalon-apps/site/src/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/site/src/xdocs/book.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- book.xml 2 Apr 2002 11:50:34 -0000 1.4
+++ book.xml 14 Jul 2002 16:43:31 -0000 1.5
@@ -6,13 +6,35 @@
<project label="Back to Avalon" href="@AVALON_BASE@" />
- <menu label="About">
+ <menu label="Essentials">
<menu-item label="Overview" href="index.html"/>
- <menu-item label="Avalon Apps" href="appsincvs.html"/>
- <menu-item label="Apps elsewhere" href="appselsewhere.html"/>
- <menu-item label="Apps yet to do" href="todo.html"/>
+ <menu-item label="Downloads" href="http://jakarta.apache.org/builds/jakarta-avalon-apps/"/>
+ <menu-item label="Wishlist" href="todo.html"/>
</menu>
-
+
+ <menu label="Apps hosted here">
+ <menu-item label="Overview" href="appsincvs.html"/>
+ <menu-item label="AvalonDB" href="@AVALON_BASE@/apps/apps/db/index.html"/>
+ <menu-item label="Demo" href="@AVALON_BASE@/apps/apps/demo/index.html"/>
+ <menu-item label="FTP Server" href="@AVALON_BASE@/appsapps//ftpserver/index.html"/>
+ <menu-item label="HTTP Proxy" href="@AVALON_BASE@/apps/apps/httpproxy/index.html"/>
+ <menu-item label="Hypersonic SQL" href="@AVALON_BASE@/apps/apps/hsql/index.html"/>
+ <menu-item label="Overlord" href="@AVALON_BASE@/apps/apps/overlord/index.html"/>
+ <menu-item label="Sevak" href="@AVALON_BASE@/apps/apps/sevak/index.html"/>
+ <menu-item label="SimpleServer" href="@AVALON_BASE@/apps/apps/simpleserver/index.html"/>
+ <menu-item label="XCommmander" href="@AVALON_BASE@/apps/apps/xcommander/index.html"/>
+ </menu>
+
+ <menu label="Apps hosted elsewhere">
+ <menu-item label="Overview" href="appselsewhere.html"/>
+ <menu-item label="JAMES" href="http://jakarta.apache.org/james"/>
+ <menu-item label="Jo! Web Server" href="http://www.tagtraum.com/jo.html"/>
+ <menu-item label="JabaServer" href="http://www.javajabber.net/"/>
+ <menu-item label="Enterprise Object Broker" href="http://eob.sourceforge.net"/>
+ <menu-item label="Jesktop" href="http://www.jesktop.com"/>
+ <menu-item label="PhoenixJMS" href="http://sourceforge.net/projects/phoenixjms"/>
+ </menu>
+
</book>
1.39 +55 -155 jakarta-avalon-apps/ftpserver/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/ftpserver/build.xml,v
retrieving revision 1.38
retrieving revision 1.39
diff -u -r1.38 -r1.39
--- build.xml 29 Jun 2002 15:40:44 -0000 1.38
+++ build.xml 14 Jul 2002 16:43:31 -0000 1.39
@@ -2,21 +2,17 @@
<project name="FTP Server" default="main" basedir=".">
- <!--
- Give user a chance to override without editing this file
- (and without typing -D each time he compiles it)
- -->
- <property file=".ant.properties"/>
- <property file="${user.home}/.ant.properties"/>
-
- <property name="name" value="ftp-server"/>
- <property name="Name" value="FtpServer"/>
- <property name="version" value="1.0"/>
- <property name="year" value="2001-2002"/>
-
- <property name="build.debug" value="on"/>
- <property name="build.optimize" value="off"/>
- <property name="build.deprecation" value="on"/>
+<!-- ==========================================================================================
+ PROPERTY SETUP
+ ========================================================================================== -->
+
+ <!-- give user chance to override properties -->
+ <property file="${user.home}/build.properties"/>
+ <property file="${basedir}/../ant.properties"/>
+ <property file="${basedir}/ant.properties"/>
+ <property file="${user.home}/.ant.properties"/>
+ <property file="${basedir}/../default.properties"/>
+ <property file="${basedir}/default.properties"/>
<!-- Set the installation variables for Cornerstone/Phoenix -->
<property name="phoenix.home" value="../../jakarta-avalon-phoenix/dist"/>
@@ -39,7 +35,7 @@
<property name="manifest.dir" value="${src.dir}/manifest"/>
<property name="conf.dir" value="${src.dir}/conf"/>
<property name="context.dir" value="../../jakarta-avalon/src/documentation"/>
- <property name="xdocs.dir" value="${src.dir}/xdocs"/>
+ <property name="xdocs.dir" value="${src.dir}/xdocs"/>
<property name="tools.dir" location="../../jakarta-avalon/tools"/>
<property name="dist.name" value="${Name}-${version}"/>
@@ -74,36 +70,9 @@
<classpath refid="project.class.path" />
</taskdef>
- <!-- Setup the filters -->
- <target name="setup-filters">
- <filter token="Name" value="Avalon Apps - FtpServer"/>
- <filter token="name" value="ftpserver"/>
- <filter token="version" value="${version}"/>
- <filter token="year" value="${year}"/>
- <filter token="status" value="${status}"/>
- <filter token="release" value="${release}"/>
- <filter token="short-version" value="${short.version}"/>
-
- <property name="avalon.base" value="http://jakarta.apache.org/avalon"/>
- <property name="framework.base" value="http://jakarta.apache.org/avalon/framework"/>
- <property name="phoenix.base" value="http://jakarta.apache.org/avalon/phoenix"/>
- <property name="cornerstone.base" value="http://jakarta.apache.org/avalon/cornerstone"/>
- <property name="logkit.base" value="http://jakarta.apache.org/avalon/logkit"/>
- <property name="testlet.base" value="http://jakarta.apache.org/avalon/testlet"/>
-
- <filter token="year" value="${year}"/>
- <filter token="AVALON_BASE" value="${avalon.base}"/>
- <filter token="FRAMEWORK_BASE" value="${framework.base}"/>
- <filter token="PHOENIX_BASE" value="${phoenix.base}"/>
- <filter token="CORNERSTONE_BASE" value="${cornerstone.base}"/>
- <filter token="LOGKIT_BASE" value="${logkit.base}"/>
- <filter token="TESTLET_BASE" value="${testlet.base}"/>
- </target>
-
-
<!-- Compiles project -->
<target name="compile">
-
+
<mkdir dir="${build.dir}"/>
<mkdir dir="${build.classes}"/>
@@ -235,116 +204,6 @@
<target name="check" depends="compile" description="Perform any built in tests">
</target>
- <!-- Create the API documentation -->
- <target name="javadocs" description="Generates the Java Docs">
-
- <delete dir="${build.docs}/api"/>
- <mkdir dir="${build.docs}/api"/>
-
- <javadoc packagenames="org.apache.*"
- sourcepath="${java.dir}"
- destdir="${build.docs}/api">
- <classpath refid="project.class.path" />
- <doclet name="com.sun.tools.doclets.standard.Standard">
- <param name="-author"/>
- <param name="-version"/>
- <param name="-doctitle" value="${Name}"/>
- <param name="-windowtitle" value="${Name} API"/>
- <param name="-bottom"
- value=""Copyright © 2001 Apache Jakarta Project. All Rights Reserved.""/>
- </doclet>
- </javadoc>
- </target>
-
- <!-- prepares printer friendly documentation -->
- <target name="printerdocs" depends="javadocs" description="Generates the printer-friendly Docs">
- <echo message="Printer friendly docs are not yet implemented"/>
- </target>
-
- <!-- Prepares the documentation directory -->
- <target name="docs" depends="html-docs, javadocs" description="generates all the Avalon documentation"/>
-
-
- <target name="html-docs" depends="setup-filters" description="generates the xdocs-based documentation">
-
- <property name="use.skin" value="avalon-site"/>
-
- <!-- Skin filters -->
- <filter token="skin" value="${use.skin}"/>
- <filter token="link1" value="apache"/>
- <filter token="link1.href" value="http://www.apache.org"/>
- <filter token="link2" value="jakarta"/>
- <filter token="link2.href" value="http://jakarta.apache.org"/>
- <filter token="link3" value="avalon"/>
- <filter token="link3.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="group-logo.src" value="images/jakarta-logo.gif"/>
- <filter token="group-logo.href" value="http://jakarta.apache.org/"/>
- <filter token="project-logo.src" value="images/header.gif"/>
- <filter token="project-logo.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="year" value="2002"/>
- <filter token="vendor" value="Apache Software Foundation"/>
-
- <mkdir dir="${build.context}"/>
- <mkdir dir="${build.docs}"/>
- <mkdir dir="${build.xdocs}"/>
- <mkdir dir="${build.dir}/work"/>
-
- <copy todir="${build.context}" overwrite="true" filtering="on">
- <fileset dir="${context.dir}">
- <exclude name="**/*.gif"/>
- <exclude name="**/*.jpg"/>
- <exclude name="**/*.png"/>
- </fileset>
- </copy>
-
- <copy todir="${build.context}" filtering="off">
- <fileset dir="${context.dir}">
- <include name="**/*.gif"/>
- <include name="**/*.jpg"/>
- <include name="**/*.png"/>
- </fileset>
- </copy>
- <copy todir="${build.xdocs}" filtering="on" overwrite="true">
- <fileset dir="${xdocs.dir}"/>
- </copy>
-
- <echo message="-------------------------------------------------------------"/>
- <echo message=" Building docs, please stand by ..."/>
-
- <java classname="org.apache.cocoon.Main" fork="true" maxmemory="128m" failonerror="true">
- <arg value="-c${build.context}/"/>
- <arg value="-d${build.docs}"/>
- <arg value="-w${build.dir}/work"/>
- <arg value="-l${build.dir}/work/cocoon.log"/>
- <arg value="-uWARN"/>
- <arg value="index.html"/>
- <classpath>
- <path refid="tools.class.path"/>
- <fileset dir="${tools.dir}/ext"/>
- </classpath>
- </java>
-
- <!-- hack for stupid transport on api link -->
- <replace dir="${build.docs}" token="http://hack.hack" value="api/index.html">
- <include name="*.html"/>
- </replace>
-
- <echo message=" ...docs generated succesfully in ./build/docs dir."/>
- <echo message="-------------------------------------------------------------"/>
-
- </target>
-
- <target name="site" depends="docs" description=" Places Docs ready for hosting on website">
-
- <mkdir dir="../site/docs/apps/ftpserver"/>
- <copy todir="../site/docs/apps/ftpserver">
- <fileset dir="${build.docs}">
- <include name="**"/>
- </fileset>
- </copy>
-
- </target>
-
<!-- Completely build all dists -->
<target name="dist" description="Generates the distribution">
@@ -520,5 +379,46 @@
-->
<target name="test" depends="check"/>
-
+<!-- ==========================================================================================
+ DOCUMENTATION GENERATION
+========================================================================================== -->
+
+ <!-- Creates all docs -->
+ <target name="docs" depends="html-docs, javadocs" description="generates all the Avalon documentation"/>
+
+ <!-- copy docs to site dir -->
+ <target name="site" depends="docs" description=" Places Docs ready for hosting on website">
+ <mkdir dir="../site/build/docs/apps/${dir-name}"/>
+ <copy todir="../site/build/docs/apps/${dir-name}">
+ <fileset dir="${build.docs}">
+ <include name="**"/>
+ </fileset>
+ </copy>
+ </target>
+
+ <!-- Creates javadocs -->
+ <target name="javadocs" depends="compile" description="Generates the javadocs" unless="skip.javadocs">
+ <mkdir dir="${build.javadocs}"/>
+ <javadoc packagenames="org.apache.*"
+ sourcepath="${java.dir}"
+ destdir="${build.javadocs}">
+ <classpath refid="project.class.path" />
+ <doclet name="com.sun.tools.doclets.standard.Standard">
+ <param name="-author"/>
+ <param name="-version"/>
+ <param name="-doctitle" value="${Name}"/>
+ <param name="-windowtitle" value="${Name} API"/>
+ <param name="-link" value="http://java.sun.com/j2se/1.4/docs/api/"/>
+ <param name="-link" value="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/"/>
+ <param name="-link" value="http://jakarta.apache.org/avalon/api/"/>
+ <param name="-bottom"
+ value=""Copyright © ${year} Apache Jakarta Project. All Rights Reserved.""/>
+ </doclet>
+ </javadoc>
+ </target>
+
+ <target name="html-docs" description="generates the xdocs-based documentation">
+ <!-- we call the cocoonbuild.xml target common to all of excalibur. This builds our html site -->
+ <ant antfile="${basedir}/../cocoonbuild.xml"/>
+ </target>
</project>
1.1 jakarta-avalon-apps/ftpserver/default.properties
Index: default.properties
===================================================================
# -------------------------------------------------------------------
# B U I L D P R O P E R T I E S
# -------------------------------------------------------------------
# Specifies default property values
# Overridden by ../default.properties and all ant.properties
# Not user-editable; use ant.properties files instead
# --------------------------------------------------
# DOC GENERATION CONFIGURATION
# --------------------------------------------------
name=ftp-server
Name=Avalon Apps FtpServer
dir-name=xcommander
version=1.0
package-version=1.0
year=2001-2002
# --------------------------------------------------
# REQUIRED LIBRARIES
# --------------------------------------------------
# ----- Avalon Framework -----
avalon-framework.home=${basedir}/../../jakarta-avalon
avalon-framework.lib=${avalon-framework.home}/build/lib
avalon-framework.jar=${avalon-framework.lib}/avalon-framework.jar
# --------------------------------------------------
# COMPILATION ENVIRONMENT
# --------------------------------------------------
# Settings used to configure compile environment
build.debug = on
build.optimize = off
build.deprecation = on
build.compress = false
junit.failonerror = false
# location of intermediate products
build.dir = build
build.testsrc = ${build.dir}/testsrc
build.testclasses = ${build.dir}/testclasses
build.lib = ${build.dir}/lib
build.conf = ${build.dir}/conf
build.classes = ${build.dir}/classes
build.tests = ${build.dir}/tests
build.reports = ${build.dir}/reports
build.docs = ${build.dir}/docs
build.javadocs = ${build.docs}/api
# Set the properties for source directories
src.dir = src
java.dir = ${src.dir}/java
conf.dir = ${src.dir}/conf
test.dir = ${src.dir}/test
# Set the properties for distribution directories
dist.dir = dist
dist.javadocs = ${dist.dir}/docs/api
# name of .zip/.tar.gz/.bz2 files and their top-level directory
dist.name = ${name}-${version}
# name of jar file
jar.name = ${name}-${version}.jar
# property indicating directory where all distribution archives are placed
dist.base = distributions
depchecker.prefix=.
1.58 +60 -165 jakarta-avalon-apps/demo/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/demo/build.xml,v
retrieving revision 1.57
retrieving revision 1.58
diff -u -r1.57 -r1.58
--- build.xml 6 Jun 2002 20:48:39 -0000 1.57
+++ build.xml 14 Jul 2002 16:43:31 -0000 1.58
@@ -1,23 +1,14 @@
<?xml version="1.0"?>
<project name="Demo Apps" default="main" basedir=".">
-
- <!--
- Give user a chance to override without editing this file
- (and without typing -D each time he compiles it)
- -->
- <property file=".ant.properties"/>
- <property file="${user.home}/.ant.properties"/>
-
- <property name="name" value="demo"/>
- <property name="Name" value="Demo"/>
- <property name="version" value="0.7"/>
- <property name="year" value="1999-2001"/>
-
- <property name="build.debug" value="on"/>
- <property name="build.optimize" value="off"/>
- <property name="build.deprecation" value="off"/>
-
+ <!-- give user chance to override properties -->
+ <property file="${user.home}/build.properties"/>
+ <property file="${basedir}/../ant.properties"/>
+ <property file="${basedir}/ant.properties"/>
+ <property file="${user.home}/.ant.properties"/>
+ <property file="${basedir}/../default.properties"/>
+ <property file="${basedir}/default.properties"/>
+
<!-- Set the installation variables for Cornerstone/Phoenix -->
<property name="phoenix.home" value="../../jakarta-avalon-phoenix/dist"/>
<property name="install.dir" value="${phoenix.home}/apps"/>
@@ -25,13 +16,13 @@
<!-- Set the properties for intermediate directory -->
<property name="build.dir" value="build"/>
<property name="build.lib" value="${build.dir}/lib"/>
- <property name="build.xdoclet" value="${build.dir}/xdoclet"/>
+ <property name="build.xdoclet" value="${build.dir}/xdoclet"/>
<property name="build.src" value="${build.dir}/src"/>
<property name="build.classes" value="${build.dir}/classes"/>
<property name="build.javadocs" value="${build.dir}/javadocs"/>
<property name="build.docs" value="${build.dir}/docs"/>
<property name="build.context" value="${build.dir}/documentation"/>
- <property name="build.xdocs" value="${build.context}/content/xdocs"/>
+ <property name="build.xdocs" value="${build.context}/content/xdocs"/>
<!-- Set the properties for source directories -->
<property name="src.dir" value="src"/>
@@ -74,36 +65,6 @@
<classpath refid="project.class.path" />
</taskdef>
- <!-- Setup the filters -->
- <target name="setup-filters">
- <filter token="Name" value="Avalon Apps - Demos"/>
- <filter token="name" value="demos"/>
- <filter token="version" value="${version}"/>
- <filter token="year" value="${year}"/>
- <filter token="status" value="${status}"/>
- <filter token="release" value="${release}"/>
- <filter token="short-version" value="${short.version}"/>
-
- <property name="avalon.base" value="http://jakarta.apache.org/avalon"/>
- <property name="framework.base" value="http://jakarta.apache.org/avalon/framework"/>
- <property name="phoenix.base" value="http://jakarta.apache.org/avalon/phoenix"/>
- <property name="excalibur.base" value="http://jakarta.apache.org/avalon/excalibur"/>
- <property name="cornerstone.base" value="http://jakarta.apache.org/avalon/cornerstone"/>
- <property name="logkit.base" value="http://jakarta.apache.org/avalon/logkit"/>
- <property name="testlet.base" value="http://jakarta.apache.org/avalon/testlet"/>
- <property name="apps.base" value="http://jakarta.apache.org/avalon/apps"/>
-
- <filter token="year" value="${year}"/>
- <filter token="AVALON_BASE" value="${avalon.base}"/>
- <filter token="FRAMEWORK_BASE" value="${framework.base}"/>
- <filter token="EXCALIBUR_BASE" value="${excalibur.base}"/>
- <filter token="PHOENIX_BASE" value="${phoenix.base}"/>
- <filter token="CORNERSTONE_BASE" value="${cornerstone.base}"/>
- <filter token="LOGKIT_BASE" value="${logkit.base}"/>
- <filter token="TESTLET_BASE" value="${testlet.base}"/>
- <filter token="APPS_BASE" value="${apps.base}"/>
- </target>
-
<!-- Compiles project -->
<target name="compile">
@@ -115,7 +76,7 @@
<mkdir dir="${build.dir}/genjava"/>
<mkdir dir="${build.dir}/genclasses"/>
<mkdir dir="${build.dir}/genjava2"/>
- <mkdir dir="${build.dir}/genclasses2"/>
+ <mkdir dir="${build.dir}/genclasses2"/>
<javac srcdir="${java.dir}"
destdir="${build.classes}"
@@ -126,7 +87,7 @@
<exclude name="org/apache/avalon/apps/demos/soaphelloworldserver/**.java"
unless="glue.present" />
-
+
</javac>
<rmic base="${build.classes}"
@@ -157,7 +118,7 @@
</target>
<target name="test-xdoclet">
- <available classname="xdoclet.XDocletMain" classpathref="project.class.path" property="xdoclet.present"/>
+ <available classname="xdoclet.XDocletMain" classpathref="project.class.path" property="xdoclet.present"/>
</target>
<!-- Make .xinfo and manifest automatically for blocks -->
@@ -213,7 +174,7 @@
<!-- Make .xinfo and manifest automatically for blocks -->
<target name="no-phoenix-xdoclet" depends="compile" unless="xdoclet.present">
-
+
<mkdir dir="${build.xdoclet}"/>
<unzip src="${src.dir}/generated-by-xdoclet.zip" dest="${build.xdoclet}" />
@@ -241,7 +202,7 @@
<include name="org/apache/avalon/apps/demos/soaphelloworldserver/*"/>
<fileset dir="${build.xdoclet}">
<include name="org/apache/avalon/apps/demos/soaphelloworldserver/*.xinfo"/>
- </fileset>
+ </fileset>
</jar>
<jar jarfile="${build.lib}/demo-rmihelloworld.jar"
@@ -258,7 +219,7 @@
manifest="${build.xdoclet}/altrmihelloworld-demo.mf">
<fileset dir="${build.classes}">
<include name="org/apache/avalon/apps/demos/altrmihelloworldserver/*"/>
- </fileset>
+ </fileset>
<fileset dir="${build.xdoclet}">
<include name="org/apache/avalon/apps/demos/altrmihelloworldserver/*.xinfo"/>
</fileset>
@@ -434,122 +395,14 @@
<java classname="org.apache.avalon.apps.demos.altrmihelloworldserver.AltrmiHelloWorldServerTester">
<classpath>
<pathelement location="build/lib/avalon-altrmidemo-tester.jar"/>
- </classpath>
+ </classpath>
</java>
</target>
-
+
<!-- Performs unit tests -->
<target name="rmi-demo-test" depends="check-rmi" description="Change the HelloWorld message via the RMI API (a test aid)"/>
- <!-- Create the API documentation -->
- <target name="javadocs" description="Generates the Java Docs">
-
- <delete dir="${build.docs}/api"/>
- <mkdir dir="${build.docs}/api"/>
-
- <javadoc packagenames="org.apache.*"
- sourcepath="${java.dir}"
- destdir="${build.docs}/api">
- <classpath refid="project.class.path" />
- <doclet name="com.sun.tools.doclets.standard.Standard">
- <param name="-author"/>
- <param name="-version"/>
- <param name="-doctitle" value="${Name}"/>
- <param name="-windowtitle" value="${Name} API"/>
- <param name="-bottom"
- value=""Copyright © 2001 Apache Jakarta Project. All Rights Reserved.""/>
- </doclet>
- </javadoc>
- </target>
-
- <!-- Prepares the documentation directory -->
- <target name="docs" depends="html-docs, javadocs" description="generates all the Avalon documentation"/>
-
-
- <target name="html-docs" depends="setup-filters" description="generates the xdocs-based documentation">
-
- <property name="use.skin" value="avalon-site"/>
-
- <!-- Skin filters -->
- <filter token="skin" value="${use.skin}"/>
- <filter token="link1" value="apache"/>
- <filter token="link1.href" value="http://www.apache.org"/>
- <filter token="link2" value="jakarta"/>
- <filter token="link2.href" value="http://jakarta.apache.org"/>
- <filter token="link3" value="avalon"/>
- <filter token="link3.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="group-logo.src" value="images/jakarta-logo.gif"/>
- <filter token="group-logo.href" value="http://jakarta.apache.org/"/>
- <filter token="project-logo.src" value="images/header.gif"/>
- <filter token="project-logo.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="year" value="2002"/>
- <filter token="vendor" value="Apache Software Foundation"/>
-
- <mkdir dir="${build.context}"/>
- <mkdir dir="${build.docs}"/>
- <mkdir dir="${build.xdocs}"/>
- <mkdir dir="${build.dir}/work"/>
-
- <copy todir="${build.context}" overwrite="true" filtering="on">
- <fileset dir="${context.dir}">
- <exclude name="**/*.gif"/>
- <exclude name="**/*.jpg"/>
- <exclude name="**/*.png"/>
- </fileset>
- </copy>
-
- <copy todir="${build.context}" filtering="off">
- <fileset dir="${context.dir}">
- <include name="**/*.gif"/>
- <include name="**/*.jpg"/>
- <include name="**/*.png"/>
- </fileset>
- </copy>
- <copy todir="${build.xdocs}" filtering="on" overwrite="true">
- <fileset dir="${xdocs.dir}"/>
- </copy>
-
- <echo message="-------------------------------------------------------------"/>
- <echo message=" Building docs, please stand by ..."/>
-
- <java classname="org.apache.cocoon.Main" fork="true" maxmemory="128m" failonerror="true">
- <arg value="-c${build.context}/"/>
- <arg value="-d${build.docs}"/>
- <arg value="-w${build.dir}/work"/>
- <arg value="-l${build.dir}/work/cocoon.log"/>
- <arg value="-uWARN"/>
- <arg value="index.html"/>
- <classpath>
- <path refid="tools.class.path"/>
- <fileset dir="${tools.dir}/ext"/>
- </classpath>
- </java>
-
- <!-- hack for stupid transport on api link -->
- <replace dir="${build.docs}" token="http://hack.hack" value="api/index.html">
- <include name="*.html"/>
- </replace>
-
-
- <echo message=" ...docs generated succesfully in ./build/docs dir."/>
- <echo message="-------------------------------------------------------------"/>
-
- </target>
-
-
- <target name="site" depends="docs" description=" Places Docs ready for hosting on website">
-
- <mkdir dir="../site/docs/apps/${name}"/>
- <copy todir="../site/docs/apps/${name}">
- <fileset dir="${build.docs}">
- <include name="**"/>
- </fileset>
- </copy>
-
- </target>
-
-
<!-- Completely build all dists -->
<target name="dist" depends="sars" description="Generates the distribution">
@@ -705,4 +558,46 @@
<delete dir="${dist.base}" />
</target>
+<!-- ==========================================================================================
+ DOCUMENTATION GENERATION
+========================================================================================== -->
+
+ <!-- Creates all docs -->
+ <target name="docs" depends="html-docs, javadocs" description="generates all the Avalon documentation"/>
+
+ <!-- copy docs to site dir -->
+ <target name="site" depends="docs" description=" Places Docs ready for hosting on website">
+ <mkdir dir="../site/build/docs/apps/${dir-name}"/>
+ <copy todir="../site/build/docs/apps/${dir-name}">
+ <fileset dir="${build.docs}">
+ <include name="**"/>
+ </fileset>
+ </copy>
+ </target>
+
+ <!-- Creates javadocs -->
+ <target name="javadocs" depends="compile" description="Generates the javadocs" unless="skip.javadocs">
+ <mkdir dir="${build.javadocs}"/>
+ <javadoc packagenames="org.apache.*"
+ sourcepath="${java.dir}"
+ destdir="${build.javadocs}">
+ <classpath refid="project.class.path" />
+ <doclet name="com.sun.tools.doclets.standard.Standard">
+ <param name="-author"/>
+ <param name="-version"/>
+ <param name="-doctitle" value="${Name}"/>
+ <param name="-windowtitle" value="${Name} API"/>
+ <param name="-link" value="http://java.sun.com/j2se/1.4/docs/api/"/>
+ <param name="-link" value="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/"/>
+ <param name="-link" value="http://jakarta.apache.org/avalon/api/"/>
+ <param name="-bottom"
+ value=""Copyright © ${year} Apache Jakarta Project. All Rights Reserved.""/>
+ </doclet>
+ </javadoc>
+ </target>
+
+ <target name="html-docs" description="generates the xdocs-based documentation">
+ <!-- we call the cocoonbuild.xml target common to all of excalibur. This builds our html site -->
+ <ant antfile="${basedir}/../cocoonbuild.xml"/>
+ </target>
</project>
1.1 jakarta-avalon-apps/demo/default.properties
Index: default.properties
===================================================================
# -------------------------------------------------------------------
# B U I L D P R O P E R T I E S
# -------------------------------------------------------------------
# Specifies default property values
# Overridden by ../default.properties and all ant.properties
# Not user-editable; use ant.properties files instead
# --------------------------------------------------
# DOC GENERATION CONFIGURATION
# --------------------------------------------------
name=demo
Name=Demo
dir-name=demo
version=0.7
package-version=1.0
year=2000-2002
# --------------------------------------------------
# REQUIRED LIBRARIES
# --------------------------------------------------
# ----- Avalon Framework -----
avalon-framework.home=${basedir}/../../jakarta-avalon
avalon-framework.lib=${avalon-framework.home}/build/lib
avalon-framework.jar=${avalon-framework.lib}/avalon-framework.jar
# --------------------------------------------------
# COMPILATION ENVIRONMENT
# --------------------------------------------------
# Settings used to configure compile environment
build.debug = on
build.optimize = off
build.deprecation = on
build.compress = false
junit.failonerror = false
# location of intermediate products
build.dir = build
build.testsrc = ${build.dir}/testsrc
build.testclasses = ${build.dir}/testclasses
build.lib = ${build.dir}/lib
build.conf = ${build.dir}/conf
build.classes = ${build.dir}/classes
build.tests = ${build.dir}/tests
build.reports = ${build.dir}/reports
build.docs = ${build.dir}/docs
build.javadocs = ${build.docs}/api
# Set the properties for source directories
src.dir = src
java.dir = ${src.dir}/java
conf.dir = ${src.dir}/conf
test.dir = ${src.dir}/test
# Set the properties for distribution directories
dist.dir = dist
dist.javadocs = ${dist.dir}/docs/api
# name of .zip/.tar.gz/.bz2 files and their top-level directory
dist.name = ${name}-${version}
# name of jar file
jar.name = ${name}-${version}.jar
# property indicating directory where all distribution archives are placed
dist.base = distributions
depchecker.prefix=.
1.55 +55 -119 jakarta-avalon-apps/db/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/db/build.xml,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- build.xml 29 Jun 2002 15:41:32 -0000 1.54
+++ build.xml 14 Jul 2002 16:43:31 -0000 1.55
@@ -2,17 +2,17 @@
<project name="AvalonDB" default="main" basedir=".">
- <!--
- Give user a chance to override without editing this file
- (and without typing -D each time he compiles it)
- -->
- <property file=".ant.properties"/>
- <property file="${user.home}/.ant.properties"/>
-
- <property name="name" value="avalon-db"/>
- <property name="Name" value="AvalonDB"/>
- <property name="version" value="0.3"/>
- <property name="year" value="2001-2002"/>
+<!-- ==========================================================================================
+ PROPERTY SETUP
+ ========================================================================================== -->
+
+ <!-- give user chance to override properties -->
+ <property file="${user.home}/build.properties"/>
+ <property file="${basedir}/../ant.properties"/>
+ <property file="${basedir}/ant.properties"/>
+ <property file="${user.home}/.ant.properties"/>
+ <property file="${basedir}/../default.properties"/>
+ <property file="${basedir}/default.properties"/>
<property name="build.debug" value="on"/>
<property name="build.optimize" value="off"/>
@@ -296,7 +296,7 @@
</lib>
</sar>
-
+
<mkdir dir="dist"/>
<copy todir="dist">
@@ -306,117 +306,11 @@
</copy>
</target>
-
+
<!-- Performs unit tests -->
<target name="check" depends="compile" description="Perform any built in tests">
</target>
- <!-- Create the API documentation -->
- <target name="javadocs" description="Generates the Java Docs">
-
- <delete dir="${build.docs}/api"/>
- <mkdir dir="${build.docs}/api"/>
-
- <javadoc packagenames="org.apache.*"
- sourcepath="${java.dir}"
- destdir="${build.docs}/api">
- <classpath refid="project.class.path" />
- <doclet name="com.sun.tools.doclets.standard.Standard">
- <param name="-author"/>
- <param name="-version"/>
- <param name="-doctitle" value="${Name}"/>
- <param name="-windowtitle" value="${Name} API"/>
- <param name="-bottom"
- value=""Copyright © 2001 Apache Jakarta Project. All Rights Reserved.""/>
- </doclet>
- </javadoc>
- </target>
-
- <!-- Prepares the documentation directory -->
- <target name="docs" depends="html-docs, javadocs" description="generates all the Avalon documentation"/>
-
-
- <target name="html-docs" depends="setup-filters" description="generates the xdocs-based documentation">
-
- <property name="use.skin" value="avalon-site"/>
-
- <!-- Skin filters -->
- <filter token="skin" value="${use.skin}"/>
- <filter token="link1" value="apache"/>
- <filter token="link1.href" value="http://www.apache.org"/>
- <filter token="link2" value="jakarta"/>
- <filter token="link2.href" value="http://jakarta.apache.org"/>
- <filter token="link3" value="avalon"/>
- <filter token="link3.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="group-logo.src" value="images/jakarta-logo.gif"/>
- <filter token="group-logo.href" value="http://jakarta.apache.org/"/>
- <filter token="project-logo.src" value="images/header.gif"/>
- <filter token="project-logo.href" value="http://jakarta.apache.org/avalon/"/>
- <filter token="year" value="2002"/>
- <filter token="vendor" value="Apache Software Foundation"/>
-
- <mkdir dir="${build.context}"/>
- <mkdir dir="${build.docs}"/>
- <mkdir dir="${build.xdocs}"/>
- <mkdir dir="${build.dir}/work"/>
-
- <copy todir="${build.context}" overwrite="true" filtering="on">
- <fileset dir="${context.dir}">
- <exclude name="**/*.gif"/>
- <exclude name="**/*.jpg"/>
- <exclude name="**/*.png"/>
- </fileset>
- </copy>
-
- <copy todir="${build.context}" filtering="off">
- <fileset dir="${context.dir}">
- <include name="**/*.gif"/>
- <include name="**/*.jpg"/>
- <include name="**/*.png"/>
- </fileset>
- </copy>
- <copy todir="${build.xdocs}" filtering="on" overwrite="true">
- <fileset dir="${xdocs.dir}"/>
- </copy>
-
- <echo message="-------------------------------------------------------------"/>
- <echo message=" Building docs, please stand by ..."/>
-
- <java classname="org.apache.cocoon.Main" fork="true" maxmemory="128m" failonerror="true">
- <arg value="-c${build.context}/"/>
- <arg value="-d${build.docs}"/>
- <arg value="-w${build.dir}/work"/>
- <arg value="-l${build.dir}/work/cocoon.log"/>
- <arg value="-uWARN"/>
- <arg value="index.html"/>
- <classpath>
- <path refid="tools.class.path"/>
- <fileset dir="${tools.dir}/ext"/>
- </classpath>
- </java>
-
- <!-- hack for stupid transport on api link -->
- <replace dir="${build.docs}" token="http://hack.hack" value="api/index.html">
- <include name="*.html"/>
- </replace>
-
-
- <echo message=" ...docs generated succesfully in ./build/docs dir."/>
- <echo message="-------------------------------------------------------------"/>
-
- </target>
-
- <target name="site" depends="docs" description=" Places Docs ready for hosting on website">
-
- <mkdir dir="../site/docs/apps/db"/>
- <copy todir="../site/docs/apps/db">
- <fileset dir="${build.docs}">
- <include name="**"/>
- </fileset>
- </copy>
-
- </target>
-
<!-- Completely build all dists -->
<target name="dist" depends="sars" description="Generates the distribution">
@@ -604,4 +498,46 @@
</java>
</target>
+<!-- ==========================================================================================
+ DOCUMENTATION GENERATION
+ ========================================================================================== -->
+
+ <!-- Creates all docs -->
+ <target name="docs" depends="html-docs, javadocs" description="generates all the Avalon documentation"/>
+
+ <!-- copy docs to site dir -->
+ <target name="site" depends="docs" description=" Places Docs ready for hosting on website">
+ <mkdir dir="../site/build/docs/apps/${dir-name}"/>
+ <copy todir="../site/build/docs/apps/${dir-name}">
+ <fileset dir="${build.docs}">
+ <include name="**"/>
+ </fileset>
+ </copy>
+ </target>
+
+ <!-- Creates javadocs -->
+ <target name="javadocs" depends="compile" description="Generates the javadocs" unless="skip.javadocs">
+ <mkdir dir="${build.javadocs}"/>
+ <javadoc packagenames="org.apache.*"
+ sourcepath="${java.dir}"
+ destdir="${build.javadocs}">
+ <classpath refid="project.class.path" />
+ <doclet name="com.sun.tools.doclets.standard.Standard">
+ <param name="-author"/>
+ <param name="-version"/>
+ <param name="-doctitle" value="${Name}"/>
+ <param name="-windowtitle" value="${Name} API"/>
+ <param name="-link" value="http://java.sun.com/j2se/1.4/docs/api/"/>
+ <param name="-link" value="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/"/>
+ <param name="-link" value="http://jakarta.apache.org/avalon/api/"/>
+ <param name="-bottom"
+ value=""Copyright © ${year} Apache Jakarta Project. All Rights Reserved.""/>
+ </doclet>
+ </javadoc>
+ </target>
+
+ <target name="html-docs" description="generates the xdocs-based documentation">
+ <!-- we call the cocoonbuild.xml target common to all of excalibur. This builds our html site -->
+ <ant antfile="${basedir}/../cocoonbuild.xml"/>
+ </target>
</project>
1.3 +29 -2 jakarta-avalon-apps/db/readme.txt
Index: readme.txt
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/db/readme.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- readme.txt 28 Mar 2002 20:14:31 -0000 1.2
+++ readme.txt 14 Jul 2002 16:43:31 -0000 1.3
@@ -1,2 +1,29 @@
-To build AvalonDB you will need to have your own Ant 1.4.1:
-http://jakarta.apache.org/builds/jakarta-ant/release/v1.4.1/bin/
\ No newline at end of file
+ Avalons Applications AvalonDB
+ -----------------------------
+
+What is AvalonDB?
+-----------------
+ AvalonDB is a multiple implementation RDBMS. The idea is that there are
+ multiple implementations for persistence, parsing, optimization, caching.
+ The work is very much in progress and nowhere near ready for deployment.
+
+How do I use it?
+----------------
+TBD
+
+What are the plans for AvalonDB?
+--------------------------------
+TBD
+
+Who wrote it?
+-------------
+The current maintainer is Paul Hammant.
+
+Can I get support?
+------------------
+Try the avalon-user list and we'll try and help you out.
+As AvalonDB is very much alpha, don't expect miracles.
+
+Isn't there any more documentation?
+-----------------------------------
+nope. Contributions are welcome =)
\ No newline at end of file
1.1 jakarta-avalon-apps/db/default.properties
Index: default.properties
===================================================================
# -------------------------------------------------------------------
# B U I L D P R O P E R T I E S
# -------------------------------------------------------------------
# Specifies default property values
# Overridden by ../default.properties and all ant.properties
# Not user-editable; use ant.properties files instead
# --------------------------------------------------
# DOC GENERATION CONFIGURATION
# --------------------------------------------------
name=avalon-db
Name=AvalonDB
dir-name=db
version=0.3
package-version=1.0
year=2000-2002
# --------------------------------------------------
# REQUIRED LIBRARIES
# --------------------------------------------------
# ----- Avalon Framework -----
avalon-framework.home=${basedir}/../../jakarta-avalon
avalon-framework.lib=${avalon-framework.home}/build/lib
avalon-framework.jar=${avalon-framework.lib}/avalon-framework.jar
# --------------------------------------------------
# COMPILATION ENVIRONMENT
# --------------------------------------------------
# Settings used to configure compile environment
build.debug = on
build.optimize = off
build.deprecation = on
build.compress = false
junit.failonerror = false
# location of intermediate products
build.dir = build
build.testsrc = ${build.dir}/testsrc
build.testclasses = ${build.dir}/testclasses
build.lib = ${build.dir}/lib
build.conf = ${build.dir}/conf
build.classes = ${build.dir}/classes
build.tests = ${build.dir}/tests
build.reports = ${build.dir}/reports
build.docs = ${build.dir}/docs
build.javadocs = ${build.docs}/api
# Set the properties for source directories
src.dir = src
java.dir = ${src.dir}/java
conf.dir = ${src.dir}/conf
test.dir = ${src.dir}/test
# Set the properties for distribution directories
dist.dir = dist
dist.javadocs = ${dist.dir}/docs/api
# name of .zip/.tar.gz/.bz2 files and their top-level directory
dist.name = ${name}-${version}
# name of jar file
jar.name = ${name}-${version}.jar
# property indicating directory where all distribution archives are placed
dist.base = distributions
depchecker.prefix=.
1.8 +1 -1 jakarta-avalon-apps/db/src/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-apps/db/src/xdocs/book.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- book.xml 30 Jun 2002 09:08:44 -0000 1.7
+++ book.xml 14 Jul 2002 16:43:31 -0000 1.8
@@ -9,7 +9,7 @@
<menu label="About">
<menu-item label="Overview" href="index.html"/>
- <menu-item type="external" label="API Docs" href="http://hack.hack"/>
+ <menu-item type="external" label="API Docs" href="api/"/>
<menu-item type="external" id="downloads" label="Download" href="http://jakarta.apache.org/builds/jakarta-avalon-apps/"/>
</menu>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>