forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject cvs commit: xml-forrest/src/resources/forrest-shbat
Date Sun, 05 Oct 2003 14:42:56 GMT
jefft       2003/10/05 07:42:56

  Modified:    .        Tag: FORREST_05_BRANCH module.xml status.xml
               src/resources/forrest-shbat Tag: FORREST_05_BRANCH
  Added:       etc      RELEASE-NOTES-0.5.1.txt
  Bump up to 0.5.1
  Revision  Changes    Path
  No                   revision
  No                   revision  +1 -1      xml-forrest/module.xml
  Index: module.xml
  RCS file: /home/cvs/xml-forrest/module.xml,v
  retrieving revision
  retrieving revision
  diff -u -r1.24.2.3 -r1.24.2.4
  --- module.xml	2 Oct 2003 12:32:17 -0000
  +++ module.xml	5 Oct 2003 14:42:56 -0000
  @@ -44,7 +44,7 @@
       <project name="xml-forrest">
  -      <version fix="1" major="0" minor="5" tag="-RC2"/>
  +      <version fix="1" major="0" minor="5" tag=""/>
  +3 -3      xml-forrest/status.xml
  Index: status.xml
  RCS file: /home/cvs/xml-forrest/status.xml,v
  retrieving revision
  retrieving revision
  diff -u -r1.213.2.13 -r1.213.2.14
  --- status.xml	5 Oct 2003 12:09:58 -0000
  +++ status.xml	5 Oct 2003 14:42:56 -0000
  @@ -24,9 +24,9 @@
     <!-- ===================================================================== -->
  -    <release version="0.5.1" date="unreleased">
  +    <release version="0.5.1" date="2003-10-06">
         <action dev="JT" type="fix" context="core" fixes-bug="FOR-66, FOR-62">
  -        Upgrade to Cocoon 2.1.2-dev, which fixes a bug that caused some
  +        Upgrade to Cocoon 2.1.2, which fixes a bug that caused some
           pages in a site not to be rendered from the command-line, and
           has some cosmetic improvements.
  1.1                  xml-forrest/etc/RELEASE-NOTES-0.5.1.txt
  Index: RELEASE-NOTES-0.5.1.txt
                               Apache Forrest 0.5.1
                                   Release Notes
  $Id: RELEASE-NOTES-0.5.1.txt,v 1.1 2003/10/05 14:42:56 jefft Exp $
  1) Introduction
  This document describes the 0.5.1 release of Apache Forrest, how to get
  started, known bugs and any other issues.  Please send all feedback to
  2) Status
  Forrest 0.5.1 is a bugfix release over 0.5.  Most notably, it comes with an
  updated Cocoon (2.1.2) which fixes a bug in the command-line where certain
  pages in a site weren't rendered (FOR-66).  Other bugfixes include:
   - Added obfuscate-mail-links skinconf.xml option, on by default.
   - Fix forrest-site tables bug that broke Opera
   - Fixed URLs for comma-separated bug keys in status.xml
   - In skinconf.xml, made project-description optional to keep compatibility
     with 0.4.
   - forrest.antproxy.xml script now properly fails when Cocoon fails
   - Fix bugs in forrest.bat|sh scripts encountered when used in odd environments
     (perl and Win9x).
   - The 'forrest' command no longer sources /etc/antrc and ~/.antrc, which
     solves problems on some *nix distributions.
  3) What is Forrest?
  Forrest is an XML standards-oriented project documentation framework based on
  Apache Cocoon, providing XSLT stylesheets and schemas, images and other
  resources. Forrest uses these to render the XML source content into a website
  via command-line, robot, or a dynamic web application.  For more details,
  please see the website at
  4) Requirements
  - The Forrest binary distribution requires a Java Runtime Environment (1.2 or
    higher) installed.  This can be obtained from
  - The Forrest source distribution requires a Java Development Kit (1.2 or
    higher) to build, obtainable from the same URL.
  Ant is not required: Forrest uses its own stripped-down, souped-up Ant in
  5) Installing Forrest
  Depending on which distribution you downloaded, one of these sections will
  apply to you.
  o 5.1) Source distribution
    The source distribution contains static Forrest resources (skins, XSLTs,
    images, schemas), source code and Forrest's own website.
    - To build the Forrest binary distribution, type:
      build.bat    (Windows)
      ./   (Unix)
      (if Ant 1.5+ is installed, typing 'ant' works just as well)
      A binary distribution will be built in build/dist/shbat Add the path to
      build/dist/shbat/bin to your PATH environment variable, and you have
      Forrest installed.  Windows users (esp. 95/98) may need to set FORREST_HOME
      to point to the build/dist/shbat directory.
  o 5.2) Binary distribution
    The binary distribution contains a static reusable Forrest ready for use.
    - Copy somewhere permanent, like /usr/local/forrest or c:\forrest.
      Support for installation on Windows systems into directories containing
      spaces is very new, please report back on your success or failure.
    - Windows users should set the FORREST_HOME environment variable to point to
      where Forrest is installed.
    - Add $FORREST_HOME/bin (Unix) or %FORREST_HOME%\bin (Windows) to the system
      PATH environment variable.
  6) Getting Started
  Having installed Forrest, here is a little test sequence to validate that
  everything works, and to get you started.  For more information, see
   - Type 'forrest -projecthelp'.  This should list the available Forrest
     NOTE: use the 'forrest.bat' version when running under Cygwin!
   - Create an empty directory somewhere, and change cd to it.
     [ e.g. mkdir /tmp/mysite ; cd /tmp/mysite ]
   - Type 'forrest seed'.  This will create a template site in the current
     directory, ready for you to edit or render.
   - (optional) Edit the XML content in src/documentation/content/xdocs
     Have a look around, familiarize yourself with the structure.
   - In your new project root [ e.g. /tmp/mysite ],  type 'forrest validate'.
     This will check that all XML files are valid.  Actually Forrest does this
     automatically for the next step, but we're proud of our validation :)
   - In the project root, type 'forrest' or 'forrest site'.  This will generate
     HTML for your project in build/site
   - (optional) Type 'forrest run'.  This starts up an internal webserver
     displaying the project contents rendered at runtime.  Point your browser at
     http://localhost:8888/ to see your site.  Edits to files in build/webapps
     are instantly rendered.  See the site docs for more info on how to exploit
     this capability.
  7) Issue tracking
  If you notice what appears to be a bug, please report it on Forrest's JIRA bug
  tracking installation:
  Known issues are summarized at:
  (a nice example of RSS syndication)
  8) Feedback
  Feedback, feature suggestions, bugs and any other issues can be discussed on
  the mailing list.
  $Revision: 1.1 $ $Date: 2003/10/05 14:42:56 $
  No                   revision
  No                   revision  +2 -2      xml-forrest/src/resources/forrest-shbat/
  RCS file: /home/cvs/xml-forrest/src/resources/forrest-shbat/,v
  retrieving revision
  retrieving revision
  diff -u -r1.95.2.3 -r1.95.2.4
  ---	2 Oct 2003 12:32:17 -0000
  +++	5 Oct 2003 14:42:56 -0000
  @@ -16,7 +16,7 @@
       |                 Forrest Site Builder                  |
  -    |                       0.5.1-RC2                       |
  +    |                         0.5.1                         |
       |             $Date$              |

View raw message