donaldp 2002/07/07 01:00:57
Modified: xmlutil build.xml default.properties
xmlutil/src/xdocs index.xml
Added: xmlutil/src/xdocs/stylesheets project.xml
Removed: xmlutil/src/xdocs book.xml
Log:
Update doc building and add a few words about product.
Revision Changes Path
1.24 +42 -79 jakarta-avalon-excalibur/xmlutil/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/xmlutil/build.xml,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- build.xml 6 Jul 2002 05:44:27 -0000 1.23
+++ build.xml 7 Jul 2002 08:00:56 -0000 1.24
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
-<project name="Excalibur XMLBundle" default="main" basedir=".">
+<project name="Excalibur XMLUtil" default="main" basedir=".">
<property file="${user.home}/build.properties"/>
<property file="${basedir}/../ant.properties"/>
@@ -32,9 +32,7 @@
<path id="tools.class.path">
<pathelement location="${junit.jar}"/>
- <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">
@@ -311,7 +309,7 @@
<!-- Creates the distribution -->
<target name="dist"
- depends="dist-jar, test-reports, checkstyle-report, javadocs"
+ depends="dist-jar, test-reports, checkstyle-report, javadocs, docs"
description="Generates a distribution (jar + javadocs + unit tests +
checkstyle reports)">
@@ -352,84 +350,49 @@
</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>
+ <target name="anakia-avail">
+ <available classname="org.apache.velocity.anakia.AnakiaTask"
+ property="AnakiaTask.present">
+ <classpath refid="tools.class.path"/>
+ </available>
+ </target>
- <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>
+ <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>
- <!-- hack for stupid transport on api link -->
- <replace file="${docs.dir}/index.html" token="index.html.xml"
value="index.html"/>
+ <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.13 +3 -3 jakarta-avalon-excalibur/xmlutil/default.properties
Index: default.properties
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/xmlutil/default.properties,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- default.properties 11 Jun 2002 00:04:23 -0000 1.12
+++ default.properties 7 Jul 2002 08:00:56 -0000 1.13
@@ -5,8 +5,8 @@
# Overridden by ../default.properties and all ant.properties
# Not user-editable; use ant.properties files instead
-name=excalibur-xmlbundle
-Name=Excalibur XMLBundle
+name=excalibur-xmlutil
+Name=Excalibur XMLUtil
dir-name=xmlbundle
version=1.0
package-version=0.99
@@ -88,11 +88,11 @@
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
dist.dir = dist
+docs.dir = ${dist.dir}/docs
dist.javadocs = ${dist.dir}/docs/api
# name of .zip/.tar.gz/.bz2 files and their top-level directory
1.3 +13 -37 jakarta-avalon-excalibur/xmlutil/src/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/xmlutil/src/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 6 Jul 2002 04:56:17 -0000 1.2
+++ index.xml 7 Jul 2002 08:00:57 -0000 1.3
@@ -1,42 +1,18 @@
-<?xml version="1.0"?>
-
+<?xml version="1.0" encoding="UTF-8"?>
<document>
- <header>
- <title>Excalibur XML Resource Bundles - Overview</title>
- <authors>
- <person name="Berin Loritsch" email="[EMAIL PROTECTED]"/>
- <person name="Leo Simons" email="[EMAIL PROTECTED]"/>
- </authors>
- </header>
+ <properties>
+ <title>Excalibur XML Utilities - Overview</title>
+ <author email="[EMAIL PROTECTED]">Carsten Ziegeler</author>
+ </properties>
<body>
- <s1 title="Introduction">
+ <section name="Introduction">
<p>
- Excalibur's Internationalization package is found in
- <code>org.apache.avalon.excalibur.i18n</code> (in the
- Scratchpad jar). The XML ResourceBundle code is functional,
- but the method to access the bundles will change in the
- near future.
+ Excalibur's XML Utilities provide simplified wrappers
+ for XML parsers, transformers and XPath evaluators. It
+ also provides interfaces and classes useful for
+ constructing a pipeline of XML components by defining interfaces
+ for consuming and producing XML in either SAX or DOM formats.
</p>
- <p>
- This package is under development, and the API is not
- guaranteed to be the same when it is ready for release.
- Do not blame us if the next release of Excalibur breaks
- your code if you use this package.
- </p>
- <p>
- The Avalon team recognizes the importance of good
- internationalization packages, and as a result, will do
- our best to provide this functionality officially as
- soon as we can. We also recognize the importance of
- good design, so we do not want to rush this any more
- than we have to.
- </p>
- </s1>
+ </section>
</body>
- <footer>
- <legal>
- Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision$ $Date$
- </legal>
- </footer>
-</document>
+</document>
\ No newline at end of file
1.1
jakarta-avalon-excalibur/xmlutil/src/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
<?xml version="1.0"?>
<project
name="Excalibur XMLUtil"
href="http://jakarta.apache.org/avalon/excalibur/xmlutil";>
<title>Excalibur XMLUtil</title>
<body>
<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"/>
<item name="API Docs" href="/api/index.html"/>
</menu>
</body>
</project>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
