You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by jv...@apache.org on 2002/02/23 21:41:21 UTC

cvs commit: jakarta-turbine-maven/xdocs/images file.gif folder.gif

jvanzyl     02/02/23 12:41:21

  Modified:    .        build-bootstrap.xml
               src/java/org/apache/maven/jxr DirectoryIndexer.java
               src/java/org/apache/maven/project Project.java
                        Repository.java
               src/templates/build build-docs.xml build.init.target
               xdocs    project.xml
  Added:       xdocs/images file.gif folder.gif
  Log:
  - the deploy-site is now fully working to create javadocs, xdocs rendered
    using dvsl and the source cross-referencing using a modified version
    of Josh Lucus' JxrTask and the bits needed from Alexandria. All the
    docs are automatically uploaded to the site in one shot, the target was
    ripped off from the cactus build file, thanks vincent!
  
    all viewable here:
  
    http://jakarta.apache.org/turbine/maven/
  
  Revision  Changes    Path
  1.9       +3 -1      jakarta-turbine-maven/build-bootstrap.xml
  
  Index: build-bootstrap.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/build-bootstrap.xml,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- build-bootstrap.xml	23 Feb 2002 16:25:30 -0000	1.8
  +++ build-bootstrap.xml	23 Feb 2002 20:41:21 -0000	1.9
  @@ -73,6 +73,7 @@
         <class name="org.apache.maven.Reactor"/>
         <class name="org.apache.maven.build.BaseProjectTask"/>
         <class name="org.apache.maven.build.ProjectProperties"/>
  +      <class name="org.apache.maven.jxr.JxrTask"/>
         <!-- The project classes have to be all list, dynamic loading -->
         <class name="org.apache.maven.project.BaseObject"/>
         <class name="org.apache.maven.project.Build"/>
  @@ -85,9 +86,10 @@
         <class name="org.apache.maven.project.Repository"/>
         <class name="org.apache.maven.project.Target"/>
         <class name="org.apache.maven.project.Workspace"/>
  -      
  +
         <classfilter>
           <include name="org.apache.stratum."/>
  +        <include name="org.apache.maven."/>
           <include name="org.apache.commons."/>
           <include name="org.apache.log4j."/>
           <include name="org.apache.velocity."/>
  
  
  
  1.2       +9 -9      jakarta-turbine-maven/src/java/org/apache/maven/jxr/DirectoryIndexer.java
  
  Index: DirectoryIndexer.java
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jxr/DirectoryIndexer.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- DirectoryIndexer.java	23 Feb 2002 20:18:08 -0000	1.1
  +++ DirectoryIndexer.java	23 Feb 2002 20:41:21 -0000	1.2
  @@ -62,7 +62,7 @@
   Handles building a directory index of files and directories.
   
   @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
  -@version $Id: DirectoryIndexer.java,v 1.1 2002/02/23 20:18:08 jvanzyl Exp $
  +@version $Id: DirectoryIndexer.java,v 1.2 2002/02/23 20:41:21 jvanzyl Exp $
   */
   public class DirectoryIndexer {
   
  @@ -70,7 +70,7 @@
       public static final int MODE_JAVA = 2;
       public static final int MODE_DEFAULT = MODE_JAVA;
       
  -    public static final String INDEX = "alexandria.index.html";
  +    public static final String INDEX = "index.html";
   
       public static final String IMAGE_DIRECTORY = "./folder.gif";
       public static final String IMAGE_FILE      = "./file.gif";
  @@ -93,7 +93,7 @@
       /**
       @see DirectoryIndexer
       @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
  -    @version $Id: DirectoryIndexer.java,v 1.1 2002/02/23 20:18:08 jvanzyl Exp $
  +    @version $Id: DirectoryIndexer.java,v 1.2 2002/02/23 20:41:21 jvanzyl Exp $
       */
       public DirectoryIndexer( String directory,
                                String image_folder,
  @@ -107,7 +107,7 @@
       Create a given DirectoryIndexer with the given dir, images, etc
       
       @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
  -    @version $Id: DirectoryIndexer.java,v 1.1 2002/02/23 20:18:08 jvanzyl Exp $
  +    @version $Id: DirectoryIndexer.java,v 1.2 2002/02/23 20:41:21 jvanzyl Exp $
       */
       public DirectoryIndexer( String directory,
                                String image_folder,
  @@ -140,7 +140,7 @@
       
       /**
       @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
  -    @version $Id: DirectoryIndexer.java,v 1.1 2002/02/23 20:18:08 jvanzyl Exp $
  +    @version $Id: DirectoryIndexer.java,v 1.2 2002/02/23 20:41:21 jvanzyl Exp $
       */
       private final void process() throws IOException {
           
  @@ -255,7 +255,7 @@
       Make an href for a file
       
       @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
  -    @version $Id: DirectoryIndexer.java,v 1.1 2002/02/23 20:18:08 jvanzyl Exp $
  +    @version $Id: DirectoryIndexer.java,v 1.2 2002/02/23 20:41:21 jvanzyl Exp $
       */
       private final String getItem(File item) {
           
  @@ -293,7 +293,7 @@
       
       /**
       @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
  -    @version $Id: DirectoryIndexer.java,v 1.1 2002/02/23 20:18:08 jvanzyl Exp $
  +    @version $Id: DirectoryIndexer.java,v 1.2 2002/02/23 20:41:21 jvanzyl Exp $
       */
       private final String[] getDirs() throws IOException {
           
  @@ -322,7 +322,7 @@
   
       /**
       @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
  -    @version $Id: DirectoryIndexer.java,v 1.1 2002/02/23 20:18:08 jvanzyl Exp $
  +    @version $Id: DirectoryIndexer.java,v 1.2 2002/02/23 20:41:21 jvanzyl Exp $
       */
       private final String[] getFiles() throws IOException {
           Vector v = new Vector();
  @@ -375,7 +375,7 @@
       Copy one file to another file
       
       @author <A HREF="mailto:burton@apache.org">Kevin A. Burton</A>
  -    @version $Id: DirectoryIndexer.java,v 1.1 2002/02/23 20:18:08 jvanzyl Exp $
  +    @version $Id: DirectoryIndexer.java,v 1.2 2002/02/23 20:41:21 jvanzyl Exp $
       */
       public void copy(String source, String dest) throws IOException {
   
  
  
  
  1.4       +23 -1     jakarta-turbine-maven/src/java/org/apache/maven/project/Project.java
  
  Index: Project.java
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/project/Project.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- Project.java	21 Feb 2002 21:04:38 -0000	1.3
  +++ Project.java	23 Feb 2002 20:41:21 -0000	1.4
  @@ -61,7 +61,7 @@
   
   /**
    * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  - * @version $Id: Project.java,v 1.3 2002/02/21 21:04:38 jvanzyl Exp $
  + * @version $Id: Project.java,v 1.4 2002/02/23 20:41:21 jvanzyl Exp $
    */
   public class Project
       extends BaseObject
  @@ -290,4 +290,26 @@
       {
           return inceptionYear;
       }            
  +    
  +    // JXR compat
  +    
  +    // This is for capat with the JXR code. Should probably add
  +    // this though makes more sense for where the code is and it
  +    // will not always be based on the project name.
  +    public String getModule()
  +    {
  +        return getName();
  +    }        
  +    
  +    // Again probably better named.
  +    public String getHomePage()
  +    {
  +        return getUrl();
  +    }        
  +
  +    // Another good addition and this should be flexible.
  +    public String getLicense()
  +    {
  +        return "ASL";
  +    }
   }
  
  
  
  1.3       +7 -1      jakarta-turbine-maven/src/java/org/apache/maven/project/Repository.java
  
  Index: Repository.java
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/project/Repository.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- Repository.java	21 Feb 2002 14:09:23 -0000	1.2
  +++ Repository.java	23 Feb 2002 20:41:21 -0000	1.3
  @@ -55,7 +55,7 @@
   
   /**
    * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  - * @version $Id: Repository.java,v 1.2 2002/02/21 14:09:23 jvanzyl Exp $
  + * @version $Id: Repository.java,v 1.3 2002/02/23 20:41:21 jvanzyl Exp $
    */
   public class Repository
       extends BaseObject
  @@ -158,6 +158,12 @@
       public String getCvsWeb()
       {
           return cvsWeb;
  +    }
  +
  +    // Compat with JXR
  +    public String getRoot()
  +    {
  +        return ":" + method + ":" + user + "@" + hostname + ":" + path;
       }
   
   }
  
  
  
  1.12      +21 -1     jakarta-turbine-maven/src/templates/build/build-docs.xml
  
  Index: build-docs.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/src/templates/build/build-docs.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- build-docs.xml	23 Feb 2002 18:03:55 -0000	1.11
  +++ build-docs.xml	23 Feb 2002 20:41:21 -0000	1.12
  @@ -39,6 +39,26 @@
     </target>
   
     <!-- ================================================================== -->
  +  <!-- C R O S S  R E F E R E N C E  S O U R C E S                        -->
  +  <!-- ================================================================== -->
  +
  +  <target
  +    name="cross-ref"
  +    depends="init">
  +    
  +    <jxr
  +      startDir="src/java"
  +      destDir="docs/xref"
  +      imageFolder="xdocs/images/folder.gif"
  +      imageFile="xdocs/images/file.gif"
  +    />
  +  
  +    <!-- The last two parameters don't really matter but the
  +         task craps out if they aren't there. -->
  +  
  +  </target>
  +
  +  <!-- ================================================================== -->
     <!-- P R O J E C T  D O C U M E N T A T I O N                           -->
     <!-- ================================================================== -->
   
  @@ -154,7 +174,7 @@
   
     <target 
       name="deploy-site" 
  -    depends="init,docs,javadocs">
  +    depends="init,docs,javadocs,cross-ref">
       
       <!-- This needs to taken from the project properties -->
       <property name="homepage" value="/www/jakarta.apache.org/turbine/maven/"/>
  
  
  
  1.2       +6 -0      jakarta-turbine-maven/src/templates/build/build.init.target
  
  Index: build.init.target
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/src/templates/build/build.init.target,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- build.init.target	23 Feb 2002 07:18:02 -0000	1.1
  +++ build.init.target	23 Feb 2002 20:41:21 -0000	1.2
  @@ -19,6 +19,12 @@
       name="init">
   
       <taskdef
  +      name="jxr"
  +      classname="org.apache.maven.jxr.JxrTask">
  +      <classpath refid="maven-classpath"/>
  +    </taskdef>
  +
  +    <taskdef
         name="project-properties"
         classname="org.apache.maven.build.ProjectProperties">
         <classpath refid="maven-classpath"/>
  
  
  
  1.8       +1 -0      jakarta-turbine-maven/xdocs/project.xml
  
  Index: project.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/xdocs/project.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- project.xml	23 Feb 2002 18:03:55 -0000	1.7
  +++ project.xml	23 Feb 2002 20:41:21 -0000	1.8
  @@ -19,6 +19,7 @@
       </menu>
       <menu name="Developers">
         <item name="Building"                href="/bootstrap.html"/>
  +      <item name="Source XReference"       href="/xref/index.html"/>
       </menu>
   
     </body>
  
  
  
  1.1                  jakarta-turbine-maven/xdocs/images/file.gif
  
  	<<Binary file>>
  
  
  1.1                  jakarta-turbine-maven/xdocs/images/folder.gif
  
  	<<Binary file>>
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>