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/07/06 07:57:04 UTC

cvs commit: jakarta-avalon-excalibur/extension/src/xdocs/stylesheets project.xml

donaldp     2002/07/05 22:57:04

  Modified:    extension build.xml default.properties
               extension/src/xdocs index.xml
  Added:       extension/src/xdocs/stylesheets project.xml
  Removed:     extension README.txt
               extension/src/xdocs book.xml extension.uris
               extension/src/xdocs/dtd changes-v10.dtd characters.ent
                        document-v10.dtd faq-v10.dtd specification-v10.dtd
                        todo-v10.dtd
               extension/src/xdocs/images build.gif code.gif design.gif
                        update.gif
  Log:
  Update to use anakia.
  
  Revision  Changes    Path
  1.47      +44 -82    jakarta-avalon-excalibur/extension/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/extension/build.xml,v
  retrieving revision 1.46
  retrieving revision 1.47
  diff -u -r1.46 -r1.47
  --- build.xml	6 Jul 2002 05:44:26 -0000	1.46
  +++ build.xml	6 Jul 2002 05:57:04 -0000	1.47
  @@ -18,9 +18,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">
  @@ -259,12 +257,11 @@
   
       <!-- 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)">
   
           <copy file="${build.conf}/LICENSE.txt" todir="${dist.dir}"/>
           <copy file="../KEYS" todir="${dist.dir}"/>
  -        <copy file="README.txt" todir="${dist.dir}"/>
   
           <zip zipfile="${dist.dir}/src.zip" compress="false">
               <zipfileset dir="src/java"/>
  @@ -297,88 +294,52 @@
   
           <copy file="../LICENSE.txt" todir="${dist.dir}"/>
           <copy file="../KEYS" todir="${dist.dir}"/>
  -        <copy file="README.txt" 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>    
  +    <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>
   
  -      <!-- hack for stupid transport on api link -->
  -      <replace file="${docs.dir}/index.html" token="index.html.xml" value="index.html"/>
  -     
  +        <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">  
  @@ -399,6 +360,7 @@
           <delete dir="${dist.dir}" />
           <delete dir="test" /> <!-- unit testing output directory -->
           <delete>
  +            <fileset dir="." includes="velocity.*"/>
               <fileset dir="." includes="**/*~" defaultexcludes="no"/>
           </delete>
       </target>
  
  
  
  1.6       +1 -1      jakarta-avalon-excalibur/extension/default.properties
  
  Index: default.properties
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/extension/default.properties,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- default.properties	16 Apr 2002 12:00:40 -0000	1.5
  +++ default.properties	6 Jul 2002 05:57:04 -0000	1.6
  @@ -42,11 +42,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.4       +20 -38    jakarta-avalon-excalibur/extension/src/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/extension/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	6 Jul 2002 05:57:04 -0000	1.4
  @@ -1,40 +1,22 @@
   <?xml version="1.0"?>
  -
  -<!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
  -
   <document>
  -  <header>
  -    <title>Excalibur Extension - Overview</title>
  -    <authors>
  -      <person name="????" email="???"/>
  -    </authors>
  -  </header>
  -  <body>
  -    <s1 title="Introduction">
  -      <warn>
  -        This package is under development, and the API is not
  -        guaranteed to be the same when it is ready for release.
  -        You can find this in the Scratchpad.jar file if you want
  -        to play with it.  Do not blame us if the next release of
  -        Excalibur breaks your code if you use this package.
  -      </warn>
  -      <p>
  -        Utility classes that contains methods to scan a manifest
  -        and return an array of either available or required optional packages
  -        documented in that manifest.
  -      </p>
  -      <p>
  -        For more information about optional packages, see the document
  -        <em>Optional Package Versioning</em> in the documentation bundle
  -        for your Java2 Standard Edition package, in the file
  -        <code>guide/extensions/versioning.html</code>.
  -      </p>
  -    </s1>
  -  </body>
  -  <footer>
  -    <legal>
  -      Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
  -      $Revision$ $Date$
  -    </legal>
  -  </footer>
  -</document>
  +    <properties>
  +        <title>Excalibur Extension - Overview</title>
  +        <author email="peter@apache.org">Peter Donald</author>
  +    </properties>
  +    <body>
  +        <section name="Introduction">
  +            <p>
  +              Utility classes that contains methods to scan a manifest
  +              and return an array of either available or required optional packages
  +              documented in that manifest.
  +            </p>
  +            <p>
  +              For more information about optional packages, see the document
  +                <em>Optional Package Versioning</em> in the documentation bundle
  +              for your Java2 Standard Edition package, in the file
  +                <code>guide/extensions/versioning.html</code>.
  +            </p>
  +        </section>
  +    </body>
  +</document>
  \ No newline at end of file
  
  
  
  1.1                  jakarta-avalon-excalibur/extension/src/xdocs/stylesheets/project.xml
  
  Index: project.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
   <project
       name="Excalibur Extension"
       href="http://jakarta.apache.org/avalon/excalibur/extension">
  
       <title>Excalibur Extension</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:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>