leosimons 2002/07/02 09:30:17
Modified: tweety build.xml default.properties
tweety/src/xdocs book.xml index.xml
Added: tweety/src/xdocs faq.xml features.xml getting-started.xml
install.xml
Log:
expand documentation. Still need to fill in quite a bit.
Revision Changes Path
1.4 +7 -7 jakarta-avalon-excalibur/tweety/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/tweety/build.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- build.xml 2 Jul 2002 15:49:52 -0000 1.3
+++ build.xml 2 Jul 2002 16:30:16 -0000 1.4
@@ -5,7 +5,7 @@
]>
<project name="Avalon Excalibur's Tweety" default="main" basedir=".">
-
+
&cocoon-targets;
<property file="${user.home}/build.properties"/>
@@ -15,11 +15,11 @@
<property file="${basedir}/../default.properties"/>
<property file="${basedir}/default.properties"/>
<property file="${basedir}/../cocoon.properties"/>
-
+
<!-- Classpath for product -->
<path id="project.class.path">
<pathelement location="${build.classes}"/>
- <pathelement location="${avalon-framework.jar}"/>
+ <pathelement location="${avalon-framework.jar}"/>
<pathelement location="${checkstyle.jar}"/>
<pathelement path="${java.class.path}"/>
</path>
@@ -129,7 +129,7 @@
<mkdir dir="${build.conf}"/>
<copy todir="${build.conf}" flatten="true">
<fileset dir="../" includes="LICENSE.txt"/>
- <fileset dir="${conf.dir}" includes="MANIFEST.MF"/>
+ <fileset dir="${conf.dir}" includes="MANIFEST.MF"/>
<filterset>
<filtersfile file="default.properties"/>
</filterset>
@@ -156,10 +156,10 @@
<!-- Creates all the Javadocs -->
<target name="javadocs" depends="compile" description="Generates the javadocs"
unless="skip.javadocs">
- <mkdir dir="${dist.javadocs}"/>
+ <mkdir dir="${build.javadocs}"/>
<javadoc packagenames="org.apache.*"
sourcepath="${java.dir}"
- destdir="${dist.javadocs}">
+ destdir="${build.javadocs}">
<classpath refid="project.class.path" />
<doclet name="com.sun.tools.doclets.standard.Standard">
<param name="-author"/>
@@ -322,7 +322,7 @@
<fileset dir="${build.lib}">
<include name="*.jar"/>
</fileset>
- </copy>
+ </copy>
</target>
<!-- Creates a minimal distribution -->
1.2 +2 -0 jakarta-avalon-excalibur/tweety/default.properties
Index: default.properties
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/tweety/default.properties,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- default.properties 22 Jun 2002 15:18:12 -0000 1.1
+++ default.properties 2 Jul 2002 16:30:17 -0000 1.2
@@ -39,6 +39,8 @@
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
1.4 +30 -19 jakarta-avalon-excalibur/tweety/src/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/tweety/src/xdocs/book.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- book.xml 2 Jul 2002 15:45:02 -0000 1.3
+++ book.xml 2 Jul 2002 16:30:17 -0000 1.4
@@ -1,27 +1,38 @@
<?xml version="1.0"?>
<book software="Avalon Excalibur's Tweety"
- title="Avalon Excalibur Documentation - Tweety"
- copyright="@year@ The Apache Software Foundation">
+ title="Avalon Excalibur Documentation - Tweety"
+ copyright="@year@ The Apache Software Foundation">
- <project label="Back to Avalon" href="@AVALON_BASE@" />
- <project label="Back to Excalibur" href="../index.html" />
+ <menu label="Related">
+ <menu-item type="external" id="AvalonHome" label="Avalon Home"
href="http://jakarta.apache.org/avalon/"/>
+ <menu-item type="external" id="ExcaliburHome" label="Excalibur Home"
href="http://jakarta.apache.org/avalon/excalibur/"/>
+ <menu-item type="external" id="PhoenixHome" label="Avalon Phoenix"
href="http://jakarta.apache.org/avalon/phoenix"/>
+ <menu-item type="external" id="ECMHome" label="ECM"
href="http://jakarta.apache.org/avalon/excalibur/component"/>
+ <menu-item type="external" id="FortressHome" label="Fortress"
href="http://jakarta.apache.org/avalon/excalibur/fortress"/>
+ </menu>
+
+ <menu label="Essentials">
+ <menu-item label="Overview" id="overview" href="index.html"/>
+ <menu-item label="Features" id="features" href="features.html"/>
+ <menu-item label="Getting Started" id="getting-started"
href="getting-started.html"/>
+ <menu-item type="external" id="download" label="Download"
href="http://jakarta.apache.org/builds/jakarta-avalon-excalibur/release"/>
+ <menu-item type="external" id="install" label="Install"
href="install.html"/>
+ <menu-item label="FAQ" id="faq" href="faq.html"/>
+ </menu>
+
+ <menu label="Avalon for Beginners">
+ <menu-item label="Introduction" href="avalon-for-beginners.html"/>
+ </menu>
+
+ <menu label="Avalon Container HOWTO">
+ <menu-item label="Introduction" href="avalon-container-howto.html"/>
+ </menu>
+
+ <menu label="Reference">
+ <menu-item type="external" id="api-docs" label="API Docs" href="api/"/>
+ </menu>
- <menu label="About">
- <menu-item label="Overview" href="index.html"/>
- <menu-item type="external" id="ExcaliburHome" label="Excalibur Home"
href="http://jakarta.apache.org/avalon/excalibur/index.html"/>
- <menu-item type="external" id="downloads" label="Download"
href="http://jakarta.apache.org/builds/jakarta-avalon-excalibur/release"/>
- <menu-item type="external" id="api-docs" label="API Docs" href="api/"/>
-
- </menu>
-
- <menu label="Avalon for Beginners">
- <menu-tem label="Introduction" href="avalon-for-beginners.html"/>
- </menu>
-
- <menu label="Avalon Container HOWTO">
- <menu-tem label="Introduction" href="avalon-container-howto.html"/>
- </menu>
</book>
1.3 +17 -7 jakarta-avalon-excalibur/tweety/src/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/tweety/src/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 27 Jun 2002 16:57:18 -0000 1.2
+++ index.xml 2 Jul 2002 16:30:17 -0000 1.3
@@ -8,7 +8,7 @@
</authors>
</header>
<body>
- <s1 title="Introduction">
+ <s1 title="Introduction">
<p>Tweety is a minimalist container explicitly designed for
educational purposes, and
educational purposes only.</p>
@@ -21,19 +21,29 @@
<note>We can use a lot of help with tweety, especially in the form of
simple tweetified
components and documentation patches. Chirp!</note>
- </s1>
+
+ <note>Some of these pages describe non-existent documentation,
examples, or features.
+ We'll get to it!</note>
+ </s1>
+ <s1 title="Hello World in 2 minutes">
+ <p>Following the instructions on the <link
href="install.html">Install</link> and
+ <link href="getting-started.html">Getting Started</link> pages should
get you a working
+ Hello World demo in no time at all. If you haven't got Apache Ant
installed yet, it'll take a
+ bit longer (around 15 minutes, I guess).</p>
+ </s1>
<s1 title="The available documentation">
<s2 title="The Tweety FAQ">
- <p>TBD</p>
+ <p>Tweety has a very modest FAQ (Frequently Asked Questions
document). If your
+ question is not answered there or in the documentation, post a
detailed message to the
+ <link
href="http://jakarta.apache.org/site/mail2.html#Avalon";>Avalon User list</link>.</p>
</s2>
- <s2 title="JavaDocs">
+ <s2 title="JavaDocs">
<p>All of the Tweety code has complete javadocs. If you're an
experienced java
programmer, you can probably figure out everything that
happens when you invoke tweety
just by looking at the code.</p>
- <p>The javadocs aren't available online just yet, but are
easily built from the sources,
- and can also be found in the binary release (once we create
one).</p>
+ <p><link href="api/">API Documentation</link></p>
</s2>
<s2 title="Avalon for beginners">
1.1 jakarta-avalon-excalibur/tweety/src/xdocs/faq.xml
Index: faq.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Avalon Excalibur's Tweety - FAQ</title>
<authors>
<person name="Leo Simons" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Not written yet!">
<p>TBD</p>
</s1>
</body>
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2002/07/02 16:30:17 $
</legal>
</footer>
</document>
1.1 jakarta-avalon-excalibur/tweety/src/xdocs/features.xml
Index: features.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Avalon Excalibur's Tweety - Features</title>
<authors>
<person name="Leo Simons" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Not written yet!">
<p>TBD</p>
</s1>
</body>
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2002/07/02 16:30:17 $
</legal>
</footer>
</document>
1.1 jakarta-avalon-excalibur/tweety/src/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Avalon Excalibur's Tweety - Getting Started</title>
<authors>
<person name="Leo Simons" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Not written yet!">
<p>TBD</p>
</s1>
</body>
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2002/07/02 16:30:17 $
</legal>
</footer>
</document>
1.1 jakarta-avalon-excalibur/tweety/src/xdocs/install.xml
Index: install.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Avalon Excalibur's Tweety - Install</title>
<authors>
<person name="Leo Simons" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Not written yet!">
<p>TBD</p>
</s1>
</body>
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2002/07/02 16:30:17 $
</legal>
</footer>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
