You are viewing a plain text version of this content. The canonical link for it is here.
Posted to alexandria-dev@jakarta.apache.org by jo...@apache.org on 2001/04/22 23:17:56 UTC

cvs commit: jakarta-alexandria/xdocs doc_flow.xml javadoc.xml license.xml

jon         01/04/22 14:17:56

  Modified:    .        build.xml
               xdocs    doc_flow.xml javadoc.xml license.xml
  Log:
  patches by jason van zyl for better Anakia support
  
  Revision  Changes    Path
  1.14      +18 -10    jakarta-alexandria/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-alexandria/build.xml,v
  retrieving revision 1.13
  retrieving revision 1.14
  diff -u -r1.13 -r1.14
  --- build.xml	2001/04/13 18:54:15	1.13
  +++ build.xml	2001/04/22 21:17:55	1.14
  @@ -153,15 +153,12 @@
       </target>
   
       <!-- =================================================================== -->
  -    <!-- Creates the web site                                                -->
  +    <!-- Creates the HTML documentation                                      -->
       <!-- =================================================================== -->
  -    <target name="site" depends="prepare-error,javadocs">
  -      <property name="project.name"   value="site"/>
  +    <target name="docs">
         <property name="docs.src" value="./xdocs"/>
  -
  -
         <taskdef name="anakia" classname="org.apache.velocity.anakia.AnakiaTask"/>
  -      <anakia basedir="${docs.src}" destdir="${doc.dir}/"
  +      <anakia basedir="${docs.src}" destdir="${doc.dir}"
           extension=".html" style="./site.vsl"
           projectFile="stylesheets/project.xml"
           excludes="**/stylesheets/** empty.xml"
  @@ -169,12 +166,23 @@
           lastModifiedCheck="true"
           templatePath="../jakarta-site2/xdocs/stylesheets"
         />
  -
  -      <copy toDir="${doc.dir}">
  -        <fileset dir="${docs.src}">
  -          <include name="images/*.png"/>
  +    
  +      <copy todir="${doc.dir}/images" filtering="no">
  +        <fileset dir="${docs.src}/images">
  +          <include name="**/*.gif"/>
  +          <include name="**/*.jpeg"/>
  +          <include name="**/*.jpg"/>
  +          <include name="**/*.png"/>
           </fileset>
         </copy>
  +    
  +    </target>
  +
  +    <!-- =================================================================== -->
  +    <!-- Creates the web site                                                -->
  +    <!-- =================================================================== -->
  +    <target name="site" depends="prepare-error,javadocs,docs">
  +      <property name="project.name"   value="site"/>
   
         <!-- Generate Raster Version of SVG figures -->
         <!--
  
  
  
  1.4       +1 -1      jakarta-alexandria/xdocs/doc_flow.xml
  
  Index: doc_flow.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-alexandria/xdocs/doc_flow.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- doc_flow.xml	2001/04/13 18:52:59	1.3
  +++ doc_flow.xml	2001/04/22 21:17:56	1.4
  @@ -12,7 +12,7 @@
   <p>Alexandria makes heavy use of XSL transformations in it's build process.
   Starting from the global.xml file it will perform multiple XSL transformations
   and Ant builds to produce a each Alexandria page.</p>
  -<img src="/images/flow.png" alt="Document Flow Diagram"/>
  +<img src="/images/flow.png" alt="Document Flow"/>
   
   </section>
   <section name="Build Files">
  
  
  
  1.2       +14 -16    jakarta-alexandria/xdocs/javadoc.xml
  
  Index: javadoc.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-alexandria/xdocs/javadoc.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- javadoc.xml	2000/09/16 00:01:31	1.1
  +++ javadoc.xml	2001/04/22 21:17:56	1.2
  @@ -1,26 +1,24 @@
   <?xml version="1.0"?>
   
  -<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
  -
   <document>
  - <header>
  + <properties>
     <title>Javadoc Documentation in XML</title>
     <authors>
  -   <person name="Kenneth Murphy" email="murphyk@umsystem.edu"/>
  -   <person name="Stefano Mazzocchi" email="stefano@apache.org"/>
  +   <author email="murphyk@umsystem.edu">Kenneth Murphy</author>
  +   <author email="stefano@apache.org">Stefano Mazzocchi</author>
     </authors>
  - </header>
  + </properties>
   
    <body>
  -  <s1 title="Introduction">
  +  <section name="Introduction">
      <p>We are currently working on enhancing the documentation provided for the
      Cocoon XML publishing framework by converting javadoc commented source code into
      XML for use within Cocoon.</p>
  -  </s1>
  +  </section>
   
  -  <s1 title="The plan">
  +  <section name="The plan">
      <p>In order to do this we are currently planning to implement the following
  -phases:</p>
  +    phases:</p>
   
     <ol>
     <li>Develop a JavaDoc XML DTD that acts as a data structure representing the
  @@ -62,9 +60,9 @@
     <li>Finally, we can incorporate XML versions of UML vector diagrams to further enhance the
         source code documentation.</li>
     </ol>
  -  </s1>
  +  </section>
   
  -  <s1 title="Progress to date">
  +  <section name="Progress to date">
      <p>
         The first phase has been complete and a complete javadoc DTD was
         created. We feel confortable with the solidity of that DTD and we plan
  @@ -74,16 +72,16 @@
         The XML Doclet code (consider it alpha at this point) is included in the
         Cocoon distribution under <code>/src/org/apache/tools/doclet/xml/XMLDoclet.java</code>.
      </p>
  -  </s1>
  +  </section>
   
  -  <s1 title="To do">
  +  <section name="To do">
      <p>
         Being the first two phases complete (the DTD is still in working-draft phase,
         but it's complete and usable), we need to write the stylesheets that
         generate HTML out of the javadoc XML files. <strong>Any help is
         always welcome</strong>.
      </p>
  -  </s1>
  +  </section>
   
    </body>
  -</document>
  \ No newline at end of file
  +</document>
  
  
  
  1.2       +5 -7      jakarta-alexandria/xdocs/license.xml
  
  Index: license.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-alexandria/xdocs/license.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- license.xml	2000/03/28 07:12:23	1.1
  +++ license.xml	2001/04/22 21:17:56	1.2
  @@ -1,15 +1,13 @@
   <?xml version="1.0"?>
   
   <document>
  - <header>
  + <properties>
     <title>Alexandria Public License</title>
  -  <authors>
  -   <person name="Kevin A Burton" email="burton@apache.org"/>
  -  </authors>
  - </header>
  +   <author email="burton@apache.org">Kevin A Burton"</author>
  + </properties>
   
   <body>
  -<s1 title="Alexandria Public License">
  +<section name="Alexandria Public License">
   <source><![CDATA[
   
   Copyright (c) 1998 The Java Apache Project.  All rights reserved.
  @@ -61,7 +59,7 @@
   
   
   ]]></source>
  -</s1>
  +</section>
   </body>
   </document>
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: alexandria-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: alexandria-dev-help@jakarta.apache.org