avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From leosim...@apache.org
Subject cvs commit: jakarta-avalon-excalibur/tweety/src/xdocs avalon-container-howto.xml avalon-for-beginners.xml book.xml index.xml
Date Thu, 27 Jun 2002 16:57:18 GMT
leosimons    2002/06/27 09:57:18

  Modified:    tweety   README.txt
               tweety/src/xdocs book.xml index.xml
  Added:       tweety/src/xdocs avalon-container-howto.xml
                        avalon-for-beginners.xml
  Log:
  start on a little better documentation for Tweety. Not checked if it builds as it didn't
before. Work in progress.
  
  Revision  Changes    Path
  1.2       +2 -3      jakarta-avalon-excalibur/tweety/README.txt
  
  Index: README.txt
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/tweety/README.txt,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- README.txt	22 Jun 2002 15:18:12 -0000	1.1
  +++ README.txt	27 Jun 2002 16:57:18 -0000	1.2
  @@ -9,8 +9,8 @@
   has worked there: "Want to learn how to program unix? Start with it's
   tiny brother - minix."
   
  -I think it'd be a good idea if we provide a minimalist container
  -explicitly designed around educational value.
  +Tweety is a minimalist container explicitly designed for educational
  +purposes.
   
   Goals
   -----
  @@ -42,4 +42,3 @@
   and source then it is recomended you look over the documentation
   in docs/index.html - and then look into the examples/ directory
   for examples of the component in action.
  -
  
  
  
  1.2       +9 -2      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.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- book.xml	22 Jun 2002 15:18:13 -0000	1.1
  +++ book.xml	27 Jun 2002 16:57:18 -0000	1.2
  @@ -1,7 +1,7 @@
   <?xml version="1.0"?>
   
  -<book software="Excalibur ???"
  -      title="Avalon Excalibur Documentation - ???"
  +<book software="Avalon Excalibur's Tweety"
  +      title="Avalon Excalibur Documentation - Tweety"
         copyright="@year@ The Apache Software Foundation">
   
     <project label="Back to Avalon" href="@AVALON_BASE@" />
  @@ -15,6 +15,13 @@
   
     </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.2       +45 -6     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.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	22 Jun 2002 15:18:13 -0000	1.1
  +++ index.xml	27 Jun 2002 16:57:18 -0000	1.2
  @@ -2,17 +2,56 @@
   
   <document>
     <header>
  -    <title>Excalibur ??? - Overview</title>
  +    <title>Avalon Excalibur's Tweety - Overview</title>
       <authors>
  -      <person name="????" email="???"/>
  +      <person name="Leo Simons" email="leosimons@apache.org"/>
       </authors>
     </header>
     <body>
       <s1 title="Introduction">
  -      <p>
  -        Blah Blah
  -      </p>
  +		<p>Tweety is a minimalist container explicitly designed for educational purposes,
and
  +		educational purposes only.</p>
  +
  +		<p>In other words, if you want to learn the concepts behind avalon,	and see some
examples
  +		of how to apply them, tweety is your starting point. If you need to actually write really
  +		cool components for a production environment, look elsewhere.</p>
  +
  +		<p>Tweety is currently in an alpha stage (though it works just fine!). You can
only get
  +		it from CVS at this point. Expect downloadables in two weeks or so.</p>
  +
  +		<note>We can use a lot of help with tweety, especially in the form of simple tweetified
  +		components and documentation patches. Chirp!</note>
       </s1>
  +
  +	<s1 title="The available documentation">
  +		<s2 title="The Tweety FAQ">
  +		    <p>TBD</p>
  +		</s2>
  +	    <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>
  +		</s2>
  +
  +		<s2 title="Avalon for beginners">
  +			<p>This is a hands-on, example-based tutorial for people that are new to avalon.
It
  +			will eventually migrate to the main avalon site. It introduces avalon framework and
its
  +			concepts, using Tweety for the example code.</p>
  +
  +			<p><link href="avalon-for-beginners.html">Start the tutorial</link></p>
  +		</s2>
  +
  +		<s2 title="The Avalon Container HOWTO">
  +			<p>This is a tutorial for the advanced avalon user who wants to write his own
container.
  +			It is assumed you are familiar with all the avalon framework definitions, interfaces,
  +			and contracts.</p>
  +
  +			<p><link href="avalon-container-howto.html">Start the tutorial</link></p>
  +		</s2>
  +	</s1>
     </body>
     <footer>
       <legal>
  
  
  
  1.1                  jakarta-avalon-excalibur/tweety/src/xdocs/avalon-container-howto.xml
  
  Index: avalon-container-howto.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <header>
      <title>The Avalon Container HOWTO - Overview</title>
      <authors>
        <person name="Leo Simons" email="leosimons@apache.org"/>
      </authors>
    </header>
    <body>
      <s1 title="Introduction">
  		<p>TBD</p>
      </s1>
  
  	<s1 title="Table of Contents">
  		<p>TBD</p>
  	</s1>
    </body>
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2002/06/27 16:57:18 $
      </legal>
    </footer>
  </document>
  
  
  
  1.1                  jakarta-avalon-excalibur/tweety/src/xdocs/avalon-for-beginners.xml
  
  Index: avalon-for-beginners.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <header>
      <title>Avalon for Beginners - Overview</title>
      <authors>
        <person name="Leo Simons" email="leosimons@apache.org"/>
      </authors>
    </header>
    <body>
      <s1 title="Introduction">
  		<p>TBD</p>
      </s1>
  
  	<s1 title="Table of Contents">
  		<p>TBD</p>
  	</s1>
    </body>
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2002/06/27 16:57:18 $
      </legal>
    </footer>
  </document>
  
  
  

--
To unsubscribe, e-mail:   <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@jakarta.apache.org>


Mime
View raw message