You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by do...@apache.org on 2002/06/23 08:30:49 UTC
cvs commit: jakarta-avalon-excalibur/io/src/xdocs/stylesheets project.xml
donaldp 2002/06/22 23:30:49
Modified: io build.xml default.properties
io/src/xdocs index.xml
Added: io/src/xdocs/stylesheets project.xml
Removed: io/src/xdocs book.xml io.uris
io/src/xdocs/dtd changes-v10.dtd characters.ent
document-v10.dtd faq-v10.dtd specification-v10.dtd
todo-v10.dtd
io/src/xdocs/images build.gif code.gif design.gif update.gif
Log:
Update to use Anakia and update toi include src in distribution.
Revision Changes Path
1.51 +54 -183 jakarta-avalon-excalibur/io/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/io/build.xml,v
retrieving revision 1.50
retrieving revision 1.51
diff -u -r1.50 -r1.51
--- build.xml 22 Jun 2002 16:35:01 -0000 1.50
+++ build.xml 23 Jun 2002 06:30:48 -0000 1.51
@@ -21,6 +21,7 @@
<pathelement location="${tools.jar}"/>
<fileset dir="${tools.dir}/lib"/>
<fileset dir="${tools.dir}/ext"/>
+ <fileset dir="${jakarta-site.dir}/lib"/>
</path>
<path id="test.class.path">
@@ -259,116 +260,32 @@
</target>
- <!-- Common actions shared between the source and binary dist targets -->
- <target name="dist-common" depends="dist-jar, test-reports, checkstyle-report, javadocs, docs">
-
- <!-- Clean out old stuff. We don't want src if building a binary distro -->
- <delete dir="${dist.dir}" />
- <mkdir dir="${dist.dir}" />
-
- <!-- Copy jars -->
- <copy todir="${dist.dir}">
- <fileset dir="${build.lib}">
- <include name="*.jar"/>
- </fileset>
- </copy>
-
- <!-- Copy docs -->
- <copy todir="${dist.docs}">
- <fileset dir="${build.docs}"/>
- </copy>
-
- <!-- Javadocs already there -->
- <!--
- <copy todir="${dist.javadocs}">
- <fileset dir="${dist.javadocs}"/>
- </copy>
- -->
-
- <copy todir="${dist.dir}">
- <fileset dir="..">
- <include name="KEYS"/>
- </fileset>
- </copy>
- <copy todir="${dist.dir}">
- <fileset dir=".">
- <include name="LICENSE.txt"/>
- </fileset>
- </copy>
-
- <chmod dir="${dist.dir}" perm="go-rwx" />
-
- </target>
-
- <!-- Create the distribution -->
- <target name="dist" depends="dist-common"
- description="Creates a distribution (jar + src + docs + javadocs)">
+ <target name="dist"
+ depends="dist-jar, test-reports, checkstyle-report, javadocs, docs"
+ description="Generates a distribution (jar + javadocs + unit tests + checkstyle reports)">
+ <copy file="${build.conf}/LICENSE.txt" todir="${dist.dir}"/>
+ <copy file="../KEYS" todir="${dist.dir}"/>
+ <copy file="README.txt" todir="${dist.dir}"/>
- <!-- Copy source -->
- <copy todir="${dist.src}">
- <fileset dir="${src.dir}"/>
- </copy>
- <fixcrlf srcdir="${dist.src}/java" includes="**/*.java" eol="lf"/>
+ <zip zipfile="${dist.dir}/src.zip" compress="false">
+ <zipfileset dir="src/java"/>
+ </zip>
- <!-- Copy build paraphernalia -->
<copy todir="${dist.dir}">
- <fileset dir="..">
- <include name="depchecker.xml"/>
- </fileset>
- </copy>
- <copy todir="${dist.dir}">
- <fileset dir=".">
- <include name="BUILDING.txt"/>
- <include name="build.xml"/>
- <include name="default.properties"/>
- <include name="ant.properties.sample"/>
- </fileset>
+ <fileset dir="." includes="examples/**" />
</copy>
<mkdir dir="${dist.base}"/>
- <zip zipfile="${dist.base}/${dist.name}.zip" compress="true">
- <zipfileset dir="${dist.dir}" prefix="${dist.name}"/>
- </zip>
-
- </target>
-
- <!-- Creates the distribution -->
- <target name="bin-dist"
- depends="dist-common"
- description="Generates a binary distribution (jar + docs + javadocs)">
-
- <mkdir dir="${dist.base}"/>
<zip zipfile="${dist.base}/${dist.name}-bin.zip" compress="true">
- <zipfileset dir="${dist.dir}" prefix="${dist.name}-bin"/>
+ <zipfileset dir="${dist.dir}" prefix="${dist.name}"/>
</zip>
-
- <!--
- Not supported by released ant but when it is we should enable this across
- all of the products
- <tar longfile="gnu" tarfile="${dist.base}/${dist.name}-bin.tar">
- <tarfileset dir="${dist.dir}"
- prefix="${dist.name}"
- username="avalon"
- group="avalon"/>
- </tar>
-
- <gzip zipfile="${dist.base}/${dist.name}-bin.tar.gz"
- src="${dist.name}-bin.tar"/>
- <bzip2 zipfile="${dist.base}/${dist.name}-bin.tar.gz"
- src="${dist.name}-bin.tar"/>
-
- <delete file="${dist.base}/${dist.name}-bin.tar"/>
-
- <checksum fileext=".md5">
- <fileset dir="${dist.base}" />
- </checksum>
<delete dir="${dist.dir}" />
- -->
</target>
+
<!-- Creates a mini jar-only distribution -->
<target name="dist-jar" depends="jar">
<mkdir dir="${dist.dir}"/>
@@ -379,94 +296,48 @@
</copy>
</target>
- <!-- Creates a minimal distribution -->
- <target name="dist.lite"
- depends="dist-jar, test, javadocs"
- description="Generates a minimal distribution (jar + javadocs)">
-
- <copy file="../LICENSE.txt" todir="${dist.dir}"/>
- <copy file="../KEYS" todir="${dist.dir}"/>
-
- </target>
-
- <!-- Setup the filters -->
- <target name="setup-filters">
- <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}"/>
-
- <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>
-
-
- <!-- Prepares the documentation directory -->
- <target name="docs" depends="setup-filters"> <!-- depends="javadocs" description="Generates the Docs" -->
- <mkdir dir="${docs.dir}"/>
-
- <mkdir dir="${build.context}"/>
- <mkdir dir="${build.xdocs}"/>
- <mkdir dir="${build.docs}"/>
- <mkdir dir="${build.dir}/work"/>
-
- <!-- Base pointers for non-xdocs documentation. Override these in .ant.properties to link to local docs -->
- <copy todir="${build.context}" filtering="on">
- <fileset dir="${context.dir}">
- <exclude name="diagrams/**"/>
- <exclude name="resources/**"/>
- <exclude name="xdocs"/>
- </fileset>
- </copy>
-
- <copy todir="${build.context}/xdocs" filtering="on" overwrite="yes">
- <fileset dir="${xdocs.dir}"/>
- </copy>
-
- <copy todir="${build.context}/resources" filtering="off" overwrite="yes">
- <fileset dir="${context.dir}/resources"/>
- <fileset dir="${xdocs.dir}">
- <include name="**/images/**"/>
- </fileset>
- </copy>
-
- <java classname="org.apache.cocoon.Main" fork="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="-uINFO"/>
- <arg value="-f${xdocs.dir}/${dir-name}.uris"/>
- <classpath>
- <path refid="tools.class.path"/>
- <fileset dir="${tools.dir}/ext"/>
- </classpath>
- </java>
-
- <copy todir="${docs.dir}">
- <fileset dir="${build.docs}">
- <include name="**"/>
- </fileset>
- </copy>
-
- <!-- hack for stupid transport on api link -->
- <replace file="${docs.dir}/index.html" token="index.html.xml" value="index.html"/>
+ <target name="anakia-avail">
+ <available classname="org.apache.velocity.anakia.AnakiaTask"
+ property="AnakiaTask.present">
+ <classpath refid="tools.class.path"/>
+ </available>
+ </target>
+
+ <target name="anakia-check" depends="anakia-avail" unless="AnakiaTask.present">
+ <echo>
+ AnakiaTask is not present! Please check to make sure that
+ velocity.jar is in your classpath. The easiest way to build
+ the documentation is to checkout jakarta-site CVS and specify
+ jakarta-site.dir property.
+ </echo>
+ </target>
+
+ <target name="docs" depends="anakia-check" description="Generate documentation and website">
+ <taskdef name="anakia"
+ classname="org.apache.velocity.anakia.AnakiaTask">
+ <classpath refid="tools.class.path"/>
+ </taskdef>
+ <anakia basedir="${xdocs.dir}"
+ destdir="${docs.dir}"
+ style="docs.vsl"
+ projectfile="stylesheets/project.xml"
+ includes="**/*.xml"
+ excludes="stylesheets/**"
+ velocitypropertiesfile="../site/src/stylesheets/velocity.properties"
+ />
+
+ <copy todir="${docs.dir}" filtering="off">
+ <fileset dir="../site/src" includes="css/*.css" />
+ <fileset dir="${xdocs.dir}">
+ <include name="**/images/**"/>
+ <include name="**/*.gif"/>
+ <include name="**/*.jpg"/>
+ <include name="**/*.png"/>
+ <include name="**/*.css"/>
+ <include name="**/*.js"/>
+ </fileset>
+ </copy>
</target>
<target name="site" depends="javadocs, docs" description=" Places Docs ready for hosting on website">
1.9 +3 -2 jakarta-avalon-excalibur/io/default.properties
Index: default.properties
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/io/default.properties,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- default.properties 1 May 2002 11:30:35 -0000 1.8
+++ default.properties 23 Jun 2002 06:30:48 -0000 1.9
@@ -42,7 +42,7 @@
context.dir = ../../jakarta-avalon/src/documentation
tools.dir = ../../jakarta-avalon/tools
tools.jar = ${java.home}/../lib/tools.jar
-docs.dir = docs
+
xdocs.dir = ${src.dir}/xdocs
# Set the properties for distribution directories
@@ -50,7 +50,8 @@
dist.src= ${dist.dir}/src
dist.lib= ${dist.dir}/lib
dist.docs= ${dist.dir}/docs
-dist.javadocs= ${dist.docs}/apidocs
+docs.dir = ${dist.docs}
+dist.javadocs= ${dist.docs}/api
# name of .zip/.tar.gz/.bz2 files and their top-level directory
dist.name = ${name}-${version}
1.4 +26 -41 jakarta-avalon-excalibur/io/src/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/io/src/xdocs/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 5 Apr 2002 08:21:04 -0000 1.3
+++ index.xml 23 Jun 2002 06:30:48 -0000 1.4
@@ -1,45 +1,30 @@
<?xml version="1.0"?>
-
-<!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
-
<document>
- <header>
- <title>Excalibur I/O Extensions - Overview</title>
- <authors>
- <person name="Berin Loritsch" email="bloritsch@apache.org"/>
- <person name="Leo Simons" email="mail@leosimons.com"/>
- <person name="Jeff Turner" email="jefft@apache.org"/>
- </authors>
- </header>
- <body>
- <s1 title="Introduction">
- <p>Avalon Excalibur's Input/Output utilities are in package
- <code>org.apache.avalon.excalibur.io</code>.</p>
+ <properties>
+ <title>Excalibur I/O Extensions - Overview</title>
+ <author email="avalon-dev@jakarta.apache.org">Avalon Documentation Team</author>
+ </properties>
+ <body>
+ <section name="Introduction">
+ <p>Avalon Excalibur's Input/Output utilities are in package
+ <code>org.apache.avalon.excalibur.io</code>.</p>
- <s2 title="Copy methods">
- <p>Excalibur's IO package contains a comprehensive set of routines for
- copying bytes and chars. Routines exist for copying from:
- <code>String</code>, <code>byte[]</code>, <code>Reader</code> and
- <code>InputStream</code>,
- to:
- <code>String</code>, <code>byte[]</code>, <code>Writer</code> and
- <code>OutputStream</code>.
- </p>
- </s2>
+ <subsection name="Copy methods">
+ <p>Excalibur's IO package contains a comprehensive set of routines for
+ copying bytes and chars. Routines exist for copying from:
+ <code>String</code>, <code>byte[]</code>, <code>Reader</code> and
+ <code>InputStream</code>, to:<code>String</code>, <code>byte[]</code>,
+ <code>Writer</code> and <code>OutputStream</code>.
+ </p>
+ </subsection>
- <s2 title="Useful java.io.FileFilters">
- <p>
- Excalibur includes a number of FileFilters that you can use for your
- own purposes. This fills a gap in the Java runtime because the
- interface was specified but no implementations were given.
- </p>
- </s2>
- </s1>
- </body>
- <footer>
- <legal>
- Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision$ $Date$
- </legal>
- </footer>
-</document>
+ <subsection name="Useful java.io.FileFilters">
+ <p>
+ Excalibur includes a number of FileFilters that you can use for your
+ own purposes. This fills a gap in the Java runtime because the
+ interface was specified but no implementations were given.
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
1.1 jakarta-avalon-excalibur/io/src/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<project
name="Excalibur IO"
href="http://jakarta.apache.org/avalon/io">
<title>Excalibur IO</title>
<body>
<item href="@AVALON_BASE@" name="Back to Avalon"/>
<item href="/../index.html" name="Back to Excalibur"/>
<menu name="About">
<item name="Overview" href="/index.html"/>
<item name="Excalibur Home" href="http://jakarta.apache.org/avalon/excalibur/index.html"/>
<item name="Download" href="http://jakarta.apache.org/builds/jakarta-avalon-excalibur/release/io"/>
<item name="API Docs" href="/api/index.html"/>
</menu>
</body>
</project>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>