ws-wsif-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ow...@apache.org
Subject cvs commit: xml-axis-wsif/forrest-src status.xml forrest-targets.ent forrest.properties readme.txt
Date Fri, 31 Jan 2003 13:02:47 GMT
owenb       2003/01/31 05:02:47

  Added:       forrest-src status.xml forrest-targets.ent
                        forrest.properties readme.txt
  Log:
  Create new folder to hold the WSIF Forrest source files and include the current files
  
  Revision  Changes    Path
  1.1                  xml-axis-wsif/forrest-src/status.xml
  
  Index: status.xml
  ===================================================================
  <?xml version="1.0"?>
  <status>
  
   <developers>
    <person name="Anthony Elder" email="antelder@apache.org" id="AE" />
    <person name="Owen Burroughs" email="owenb@apache.org" id="OB" />
    <person name="Jeremy Hughes" email="hughesj@apache.org" id="JH" />
    <person name="Mark Whitlock" email="whitlock@apache.org" id="MW" />
    <person name="Alek Slominski" email="aslom@apache.org" id="AS" />
    <person name="Nirmal Mukhi" email="nmukhi@apache.org" id="NM" />
    <!-- Add more people here -->
   </developers>
  
   <todo info="Tasks for ">
    <actions priority="high">
     <action context="test" dev="">
          check current release and report problems
     </action>
     <action context="dist" dev="">
          check if we can distribute all jar files
     </action>
     <action context="samples" dev="">
          samples (we need to decide what does in and what is not to be in release
     </action>
     <action context="misc" dev="">
          etc
     </action>  
    </actions>
    <actions priority="medium">
     <action context="misc" dev="">
          etc
     </action>
    </actions>
    <actions priority="low">
     <action context="misc" dev="">
          etc
     </action>
    </actions>  
    <!-- Add todo items. @context is an arbitrary string. Eg:
    <actions priority="high">
      <action context="code" dev="SN">
      </action>
    </actions>
    <actions priority="medium">
      <action context="docs" dev="open">
      </action>
    </actions>
    -->
   </todo>
  
   <changes>
    <!-- Add new releases here -->
    <release version="2.0-alpha1" date="2002">
     <!-- Some action types have associated images. By default, images are
     defined for 'add', 'fix', 'remove' and 'update'. If you add
     src/documentation/resources/images/<foo>.jpg images, these will
       automatically be used for entries of type <foo>. -->
  
     <action dev="" type="add" context="admin">
              Initial 2.0 alpha release. <link href="http://cvs.apache.org/dist/axis/wsif/">Download
here</link>
     </action>
     <!-- Sample action:
     <action dev="JB" type="fix" due-to="Joe Contributor"
       due-to-email="joec@apache.org">
       Fixed a bug in the Foo class.
     </action>
     -->
    </release>
   </changes>
  </status>
  
  
  
  1.1                  xml-axis-wsif/forrest-src/forrest-targets.ent
  
  Index: forrest-targets.ent
  ===================================================================
  <!--
  This build.xml snippet contains Forrest targets for Ant 1.5+.  It checks that
  the user has set ${forrest.home}, either in one of:
    build.properties
    project.properties
    ant.properties
    .ant.properties
  or with the FORREST_HOME environment variable, and prints an informative error
  message if not found.
  
  Usage:
  1) Copy this file to somewhere in your project.
  2) Add the following to the top of your project's Ant build.xml script
  (adjusting the path):
  
    <!DOCTYPE project [
      <!ENTITY forrest-targets SYSTEM "file:./forrest-targets.ent">
    ]>
  
  3) Before the closing '</project>' in your build.xml, add this:
  
    &forrest-targets;
    
  This is like expanding a macro: it pulls in the contents of this file.
  
  A minimal build.xml would thus be:
  
  <!DOCTYPE project [
  <!ENTITY forrest-targets SYSTEM "file:./forrest-targets.ent">
  ]>
  
  <project default="site">
      &forrest-targets;
  </project>
  -->
  
    <target name="site" depends="forrest.init" description="Generates static HTML documentation">
      <ant antfile="${forrest.home}/forrest.antproxy.xml" target="site"/>
    </target>
  
    <target name="webapp" depends="forrest.init" description="Generates an unpackaged webapp
of the website">
      <ant antfile="${forrest.home}/forrest.antproxy.xml" target="webapp"/>
    </target>
  
    <target name="war" depends="forrest.init" description="Generates a .war file containing
the website">
      <ant antfile="${forrest.home}/forrest.antproxy.xml" target="war"/>
    </target>
  
    <target name="validate" depends="forrest.init" description="Validates XML documentation
files">
      <ant antfile="${forrest.home}/forrest.antproxy.xml" target="validate"/>
    </target>
  
    <target name="forrest.init" depends="forrest.sethome, forrest.home.defined"/>
  
    <target name="forrest.sethome" depends="forrest.loadenv,
    forrest.checkenv, forrest.checkhome, forrest.check-build.properties,
    forrest.check-project.properties, forrest.check-ant.properties,
    forrest.check-.ant.properties"/>
  
    <target name="forrest.loadenv" unless="forrest.home.present">
      <property environment="env"/>
      <echo level="verbose">Forrest: Got ${env.FORREST_HOME}</echo>
    </target>
  
    <target name="forrest.checkenv" if="env.FORREST_HOME">
      <echo level="verbose">Found $FORREST_HOME..</echo>
      <property name="forrest.home" location="${env.FORREST_HOME}"/>
      <echo level="verbose">forrest.home set to ${forrest.home}</echo>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
    </target>
  
  
    <target name="forrest.checkhome">
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
      <available file="build.properties" type="file" property="build.properties.present"/>
      <available file="project.properties" type="file" property="project.properties.present"/>
      <available file="ant.properties" type="file" property="ant.properties.present"/>
      <available file=".ant.properties" type="file" property=".ant.properties.present"/>
    </target>
  
    <!-- No we can't extract the commonalities below into an antcall'ed target,
    because it wouldn't be able to set forrest.home -->
    <target name="forrest.check-build.properties" unless="forrest.home.present"
    if="build.properties.present">
      <echo level="verbose">Forrest: Checking build.properties..</echo>
      <loadproperties srcfile="build.properties">
        <filterchain>
          <linecontains>
            <contains value="forrest.home"/>
          </linecontains>
        </filterchain>
      </loadproperties>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
  
    </target>
  
    <target name="forrest.check-project.properties" unless="forrest.home.present"
    if="project.properties.present">
      <echo level="verbose">Forrest: Checking project.properties..</echo>
      <loadproperties srcfile="project.properties">
        <filterchain>
          <linecontains>
            <contains value="forrest.home"/>
          </linecontains>
        </filterchain>
      </loadproperties>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
    </target>
  
    <target name="forrest.check-ant.properties" unless="forrest.home.present"
    if="ant.properties.present">
      <echo level="verbose">Forrest: Checking ant.properties..</echo>
      <loadproperties srcfile="ant.properties">
        <filterchain>
          <linecontains>
            <contains value="forrest.home"/>
          </linecontains>
        </filterchain>
      </loadproperties>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
    </target>
  
    <target name="forrest.check-.ant.properties" unless="forrest.home.present"
    if=".ant.properties.present">
      <echo level="verbose">Forrest: Checking .ant.properties..</echo>
      <loadproperties srcfile=".ant.properties">
        <filterchain>
          <linecontains>
            <contains value="forrest.home"/>
          </linecontains>
        </filterchain>
      </loadproperties>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
    </target>
  
    <target name="forrest.home.defined" depends="forrest.sethome" unless="forrest.home.present">
      <property name="path" value="${user.home}/xml-forrest/build/dist/shbat"/>
      <pathconvert targetos="windows" property="winpath">
        <path>
          <pathelement location="${path}"/>
        </path>
      </pathconvert>
      <pathconvert targetos="unix" property="unixpath">
        <path>
          <pathelement
            location="${path}"/>
        </path>
      </pathconvert>
  
      <echo>
        ----------------------------------------------
        To run this target, you need Forrest installed.
        Please do the following:
  
        export CVSROOT=:pserver:anoncvs@cvs.apache.org:/home/cvspublic
        cvs checkout xml-forrest
        cd xml-forrest
        build      (Windows)
        ./build.sh (Unix)
  
        Then either:
  
        - Set FORREST_HOME as the Forrest build instructions describe
        - Create a build.properties, with the forrest.home property pointing to
          the forrest shbat directory, eg:
  
          forrest.home=${winpath}  (Windows)
          forrest.home=${unixpath}  (Unix)
  
          (adjusting the path according to where your xml-forrest is)
        ----------------------------------------------
      </echo>
      <fail message="Need to define $${forrest.home}"/>
    </target>
  
  
  
  1.1                  xml-axis-wsif/forrest-src/forrest.properties
  
  Index: forrest.properties
  ===================================================================
  ##############
  # Properties used by forrest.build.xml for building the website
  ##############
  
  # Prints out a summary of Forrest settings for this project
  forrest.echo=true 
  
  # Project name (used to name .war file)
  project.name=wsif
  
  # Specifies name of Forrest skin to use
  #project.skin=forrest-site
  project.skin=wsif-skin
  
  
  ##############
  # layout properties
  
  # Properties that must be set to override the default locations
  #
  # Parent properties must be set. This usually means uncommenting
  # project.content-dir if any other property using it is uncommented
  
  project.status=status.xml
  project.content-dir=src/documentation
  project.conf-dir=${project.content-dir}/conf
  project.sitemap=${project.content-dir}/sitemap.xmap
  project.xdocs-dir=${project.content-dir}/content/xdocs
  project.stylesheets-dir=${project.content-dir}/resources/stylesheets
  project.images-dir=${project.content-dir}/resources/images
  project.schema-dir=${project.content-dir}/resources/schema
  project.skins-dir=${project.content-dir}/skins
  project.skinconf=${project.content-dir}/skinconf.xml
  project.lib-dir=${project.content-dir}/lib
  project.classes-dir=${project.content-dir}/classes
  
  
  ##############
  # validation properties
  
  # These props determine if validation is performed at all
  # Values are inherited unless overridden.
  # Eg, if forrest.validate=false, then all others are false unless set to true.
  forrest.validate=true
  forrest.validate.xdocs=${forrest.validate}
  forrest.validate.skinconf=${forrest.validate}
  forrest.validate.sitemap=${forrest.validate}
  forrest.validate.stylesheets=${forrest.validate}
  forrest.validate.skins=${forrest.validate}
  forrest.validate.skins.stylesheets=${forrest.validate.skins}
  
  
  # Key:
  # *.failonerror=(true|false)    stop when an XML file is invalid
  # *.includes=(pattern)         Comma-separated list of path patterns to validate
  # *.excludes=(pattern)         Comma-separated list of path patterns to not validate
  
  forrest.validate.failonerror=true
  forrest.validate.includes=**/*
  forrest.validate.excludes=
  #
  forrest.validate.xdocs.failonerror=${forrest.validate.failonerror}
  #
  forrest.validate.xdocs.includes=**/*.x*
  forrest.validate.xdocs.excludes=
  #
  forrest.validate.skinconf.includes=${skinconf-file}
  forrest.validate.skinconf.excludes=
  forrest.validate.skinconf.failonerror=${forrest.validate.failonerror}
  #
  forrest.validate.sitemap.includes=${sitemap-file}
  forrest.validate.sitemap.excludes=
  forrest.validate.sitemap.failonerror=${forrest.validate.failonerror}
  #
  forrest.validate.stylesheets.includes=**/*.xsl
  forrest.validate.stylesheets.excludes=
  forrest.validate.stylesheets.failonerror=${forrest.validate.failonerror}
  #
  forrest.validate.skins.includes=**/*
  forrest.validate.skins.excludes=**/*.xsl
  forrest.validate.skins.failonerror=${forrest.validate.failonerror}
  #
  forrest.validate.skins.stylesheets.includes=**/*.xsl
  forrest.validate.skins.stylesheets.excludes=
  forrest.validate.skins.stylesheets.failonerror=${forrest.validate.skins.failonerror}
  
  
  
  1.1                  xml-axis-wsif/forrest-src/readme.txt
  
  Index: readme.txt
  ===================================================================
  This directory contains the source for the WSIF web site - http://ws.apache.org/wsif
  
  Ultimately the source xml files contained within this directory and sub-directories will
be used to generate the
  distributed documentation for WSIF as well (i.e. the files in the docs dir).
  
  
  Using forrest
  -------------
  
  This directory forms an Apache Forrest project. To build the pages, follow these simple
steps:
  
  1) Download Apache Forrest from http://www.apache.org/dist/xml/forrest/
  
  2) Set up the Forrest environment as described in the Using Forrest article on the Forrest
web site:
     http://xml.apache.org/forrest/your-project.html
     
     Bascially this involves setting a FORREST_HOME variable pointing at the directory you
extracted the 
     forrest zip to, and then adding FORREST_HOME to your PATH variable.
     
  3) Navigate to the forrest-src directory.
  
  4) Run Forrest on the WSIF pages by simply typing forrest
  
  5) Hopefully after quite a few lines of output you should see the line BUILD SUCCESSFUL
and a build directory should have been 
     created under the website directory
  
  6) Navigate to website/build/site and launch index.html to view the WSIF site
  
  
  ** NOTE FOR COMMITTERS **
  
  If you make changes to the source files, check them in but please DO NOT check in the generated
build directory or any of its contents.
  We should keep the forrest-src directory for source only...as the name suggests :-)
  
  
  More info
  ---------
  
  If you have problems building the site check the following that you have correctly configured
Forrest 
  (see http://xml.apache.org/forrest/your-project.html)
  
  If you make changes to the source files and rebuild the site, you might find that the changes
don't seem to take effect.
  If this happens, try deleting the previously generated forrest-src/build directory before
running forrest.
  
  More inforamtion about using Forrest can be found at http://xml.apache.org/forrest
  
  

Mime
View raw message