[Sandev-cvs] sand/platform/tools/build/generate/org/sandev/generator ProjectIndexGenerator.java, 1.

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/sandev/sand/platform/tools/build/generate/org/sandev/generator
In directory sfp-cvsdas-3.v30.ch3.sourceforge.com:/tmp/cvs-serv27788

Modified Files:
	ProjectIndexGenerator.java 
Log Message:
Changed comment references to SAND_HOME to just "sand" as part of
removing dependence on any environment variables to build.  Also
changed this in the generated doc output.


Index: ProjectIndexGenerator.java
===================================================================
RCS file: /cvsroot/sandev/sand/platform/tools/build/generate/org/sandev/generator/ProjectIndexGenerator.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** ProjectIndexGenerator.java	8 Mar 2008 00:52:28 -0000	1.3
--- ProjectIndexGenerator.java	22 Aug 2010 07:18:58 -0000	1.4
***************
*** 1,5 ****
  /*
   * SAND development/deployment environment
!  * Copyright (C) 2003,2008  SAND Services Inc.
   *
   * This library is free software; you can redistribute it and/or
--- 1,5 ----
  /*
   * SAND development/deployment environment
!  * Copyright (C) 2003,2008,2010  SAND Services Inc.
   *
   * This library is free software; you can redistribute it and/or
***************
*** 43,52 ****
  
  /**
!  * Write out a navigable web of documentation through interlinked index
!  * pages.  The index pages have a navigable tree of the build, with 
!  * SAND_HOME as the root.  The index.html file for a given project is
!  * regenerated if any structs or nodes have been added or deleted, but
!  * this generator does not track changes in documentation source.  If 
!  * you delete the index.html file, it will be rebuilt. <BR>
   *
   * <P>Index page construction hooks: <UL>
--- 43,53 ----
  
  /**
!  * Write out a navigable web of documentation through interlinked
!  * index pages.  The index pages have a navigable tree of the build,
!  * with the top level sand directory as the root.  The index.html file
!  * for a given project is regenerated if any structs or nodes have
!  * been added or deleted, but this generator does not track changes in
!  * documentation source.  If you delete the index.html file, it will
!  * be rebuilt. <BR>
   *
   * <P>Index page construction hooks: <UL>
***************
*** 57,61 ****
   * <LI><CODE>loclink.html</CODE> is used to create the local links for
   *     any given project.
!  * <LI><CODE>SAND_HOME/docs/globlink.html</CODE> is used to create the
   *     global links for all projects.
   * </UL>
--- 58,62 ----
   * <LI><CODE>loclink.html</CODE> is used to create the local links for
   *     any given project.
!  * <LI><CODE>sand/docs/globlink.html</CODE> is used to create the
   *     global links for all projects.
   * </UL>
***************
*** 138,156 ****
  
      /**
!      * Holds all the navtree elements as a list of canonical paths. 
!      * The paths all start with SAND_HOME and use forward slash notation.
!      * The elements are then manipulated at display time to write out the
!      * tree in HTML.  An example value: <UL><CODE>
!      * [0] "SAND_HOME/docs/index.html"
!      * [1] "SAND_HOME/apps/docs/index.html"
!      * [2] "SAND_HOME/apps/basics/docs/index.html"
!      * [3] "SAND_HOME/apps/TaskHeap/docs/index.html"
!      * [4] "SAND_HOME/deploy/docs/index.html"
!      * [5] "SAND_HOME/deploy/TaskHeapDemo/docs/index.html"
!      * [6] "SAND_HOME/platform/docs/index.html"
!      * [7] "SAND_HOME/platform/tools/docs/index.html"
       * </CODE></UL>
-      *
-      * <P>Where "SAND_HOME" will vary depending on the environment. <BR>
       */
      protected String[] webelems;
--- 139,156 ----
  
      /**
!      * Holds all the navtree elements as a list of canonical paths.
!      * The paths all start with the top level sand directory and use
!      * forward slash notation.  The elements are then manipulated at
!      * display time to write out the tree in HTML.  An example value:
!      * <UL><CODE>
!      * [0] "sand/docs/index.html"
!      * [1] "sand/apps/docs/index.html"
!      * [2] "sand/apps/basics/docs/index.html"
!      * [3] "sand/apps/TaskHeap/docs/index.html"
!      * [4] "sand/deploy/docs/index.html"
!      * [5] "sand/deploy/TaskHeapDemo/docs/index.html"
!      * [6] "sand/platform/docs/index.html"
!      * [7] "sand/platform/tools/docs/index.html"
       * </CODE></UL>
       */
      protected String[] webelems;
***************
*** 165,169 ****
  
      /**
!      * The directory specification for SAND_HOME.
       */
      protected String sandhome;
--- 165,169 ----
  
      /**
!      * The name of the top level sand directory used for build.
       */
      protected String sandhome;
***************
*** 175,181 ****
  
      /**
!      * Starting from SAND_HOME, update the index pages according to the
!      * mode specified.  This method is used by both SandGenerator interface
!      * methods, but may also be called directly.
       */
      public void writeSandWeb(int mode,File baseDir)
--- 175,182 ----
  
      /**
!      * Starting from the top level sand directory, update the index
!      * pages according to the mode specified.  This method is used by
!      * both SandGenerator interface methods, but may also be called
!      * directly.
       */
      public void writeSandWeb(int mode,File baseDir)
***************
*** 203,209 ****
  
      /**
!      * Return the SAND_HOME directory with no trailing file separator.
       * This method assumes we are being called from the platform/tools
!      * project, so baseDir is SAND_HOME/platform/tools/build and we
       * just need to walk upwards three levels.
       */
--- 204,210 ----
  
      /**
!      * Return the top level sand directory with no trailing file separator.
       * This method assumes we are being called from the platform/tools
!      * project, so baseDir is sand/platform/tools/build and we
       * just need to walk upwards three levels.
       */
***************
*** 283,289 ****
      /**
       * Given a canonical webelem specification, return a platform
!      * appropriate filename.  Since the SAND_HOME portion of the web
!      * element is set, this pretty much means changing the path 
!      * separator characters from forward slash to backslash if windoze.
       */
      protected String getFileNameForWebElem(String elem) {
--- 284,291 ----
      /**
       * Given a canonical webelem specification, return a platform
!      * appropriate filename.  Since the top level sand directory name
!      * portion of the web element is set, this pretty much means
!      * changing the path separator characters from forward slash to
!      * backslash if windoze.
       */
      protected String getFileNameForWebElem(String elem) {
***************
*** 352,356 ****
          retval=retval.substring(0,retval.lastIndexOf(indexfile));
          if(retval.equals("")) {
!             retval="SAND_HOME"; }
          return retval;
      }
--- 354,358 ----
          retval=retval.substring(0,retval.lastIndexOf(indexfile));
          if(retval.equals("")) {
!             retval="sand"; }
          return retval;
      }
***************
*** 403,407 ****
              String currentry=getCoreSpec(i);
              if(currentry.equals("")) {
!                 currentry="SAND_HOME"; }
              else {
                  currdepth=countSlashes(currentry)+1;
--- 405,409 ----
              String currentry=getCoreSpec(i);
              if(currentry.equals("")) {
!                 currentry="sand"; }
              else {
                  currdepth=countSlashes(currentry)+1;
***************
*** 464,470 ****
  
      /**
!      * Return the relative path from a current element to SAND_HOME.
!      * This will return ".." or "../.." or "../../.." since each element
!      * starts in the /docs directory.
       */
      protected String getRelSandHome(int elemindex) {
--- 466,472 ----
  
      /**
!      * Return the relative path from a current element to the top
!      * level sand directory.  This will return ".." or "../.." or
!      * "../../.." since each element starts in the /docs directory.
       */
      protected String getRelSandHome(int elemindex) {
***************
*** 485,489 ****
      /**
       * Count the number of forward slashes in the given String.  Used for
!      * computing the depth of a directory off of SAND_HOME.
       */
      protected int countSlashes(String val) {
--- 487,491 ----
      /**
       * Count the number of forward slashes in the given String.  Used for
!      * computing the depth of a directory off of the top level sand dir.
       */
      protected int countSlashes(String val) {
***************
*** 526,530 ****
  
      /**
!      * Write the global links.  These are from SAND_HOME/docs/globlink.html
       * which we fetch from disk and dump out here.  We need to translate
       * this contents relative to each page, so we read it each time.
--- 528,532 ----
  
      /**
!      * Write the global links.  These are from sand/docs/globlink.html
       * which we fetch from disk and dump out here.  We need to translate
       * this contents relative to each page, so we read it each time.
***************
*** 540,544 ****
              BufferedReader br=new BufferedReader(new FileReader(globlink));
              for(String line=br.readLine();line!=null;line=br.readLine()) {
!                 String homesym="${SAND_HOME}";
                  int symindex=line.indexOf(homesym);
                  if(symindex>=0) {
--- 542,546 ----
              BufferedReader br=new BufferedReader(new FileReader(globlink));
              for(String line=br.readLine();line!=null;line=br.readLine()) {
!                 String homesym="../../..";
                  int symindex=line.indexOf(homesym);
                  if(symindex>=0) {
***************
*** 725,729 ****
      {
          String title=getCoreSpec(elemindex);
!         String sandHomeTitle="SAND_HOME";
          if(title.equals("")) {
              title=sandHomeTitle; }
--- 727,731 ----
      {
          String title=getCoreSpec(elemindex);
!         String sandHomeTitle="sand";
          if(title.equals("")) {
              title=sandHomeTitle; }

[Sandev-cvs] sand/platform/tools/build/generate/org/sandev/generator ProjectIndexGenerator.java, 1.

[Sandev-cvs] sand/platform/tools/build/generate/org/sandev/generator ProjectIndexGenerator.java, 1.3, 1.4