You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by to...@apache.org on 2005/01/27 10:41:44 UTC
cvs commit: ws-axis/site/src4forrest-060/java build.xml forrest-targets.ent forrest.properties
toshi 2005/01/27 01:41:44
Added: site/src4forrest-060/java build.xml forrest-targets.ent
forrest.properties
Log:
Migration for Forrest 0.6
Revision Changes Path
1.1 ws-axis/site/src4forrest-060/java/build.xml
Index: build.xml
===================================================================
<?xml version="1.0" encoding="UTF-8" ?>
<!--
================== [AXIS SITE BUILDER] ==================
* This is an ant build-file for building whole Axis site.
* This version supports only Windows platforms.
* You may have to edit the 'IEPath' property below.
* The target you have to edit will be temporary created in;
'ws-axis/site/build/webapp/content/xdocs'
* After editing the target, you have to commit a set of
updates in 'ws-axis/site/src' and 'ws-site/target/axis'.
-->
<project name="BuildSite" default="build-site" basedir=".">
<property name="version" value="0.1"/>
<property name="IEPath" location="C:\Program Files\Internet Explorer"/>
<description>
*=======================================================*
| Axis Site Builder |
| 0.1.0 |
| |
| $Date: 2005/01/27 09:41:44 $ |
*=======================================================*
</description>
<!-- ***************************************************************** -->
<!-- ** ** -->
<!-- ** TARGET: build-site ** -->
<!-- ** ** -->
<!-- ***************************************************************** -->
<!-- ===============================================================
Main target procedure.
=============================================================== -->
<target name="build-site" depends="clean">
<parallel >
<ant target="run-browser"/>
<ant target="run-forrest"/>
</parallel>
<ant target="backcopy"/>
<ant target="forrest"/>
<ant target="replace"/>
<ant target="putmessage"/>
</target>
<!-- ***************************************************************** -->
<!-- ** ** -->
<!-- ** TARGET: clean ** -->
<!-- ** ** -->
<!-- ***************************************************************** -->
<target name="clean" description="clean up the build area">
<delete dir="./build"/>
</target>
<!-- ***************************************************************** -->
<!-- ** ** -->
<!-- ** TARGET: run-browser ** -->
<!-- ** ** -->
<!-- ***************************************************************** -->
<target name="run-browser">
<echo message="=> After waiting 15 secs, IE will be comming up ..."/>
<sleep seconds="15"/>
<echo message="=> A browser (Internet Explorer) is starting up !!"/>
<exec executable="${IEPath}\IEXPLORE.EXE">
<arg line="http://localhost:8888/"/>
</exec>
</target>
<!-- ***************************************************************** -->
<!-- ** ** -->
<!-- ** TARGET: run-forrest ** -->
<!-- ** ** -->
<!-- ***************************************************************** -->
<target name="run-forrest">
<echo message="=> Starting Forrest with Jetty server ..."/>
<exec executable="cmd">
<env key="PATH" path="${path}"/>
<arg line="/c start forrest run"/>
</exec>
</target>
<!-- ***************************************************************** -->
<!-- ** ** -->
<!-- ** TARGET: backcopy ** -->
<!-- ** ** -->
<!-- ***************************************************************** -->
<target name="backcopy">
<echo message="=> Reflecting the updates to the original sources ..."/>
<exec executable="cmd">
<env key="PATH" path="${path}"/>
<arg line="/c forrest backcopy"/>
</exec>
<echo message="=> DONE !!"/>
</target>
<!-- ***************************************************************** -->
<!-- ** ** -->
<!-- ** TARGET: forrest ** -->
<!-- ** ** -->
<!-- ***************************************************************** -->
<target name="forrest">
<echo>
=> Creating static contents with the latest updates ...
</echo>
<exec executable="cmd">
<env key="PATH" path="${path}"/>
<arg line="/c forrest"/>
</exec>
<echo message="=> DONE !!"/>
</target>
<!-- ***************************************************************** -->
<!-- ** ** -->
<!-- ** TARGET: replace ** -->
<!-- ** ** -->
<!-- ***************************************************************** -->
<target name="replace">
<echo message="=> Copying the updated (static) contents ..."/>
<copy todir="../../../../ws-site/targets/axis">
<fileset dir="./build/site">
<different targetdir="../../../../ws-site/targets/axis"
ignoreFileTimes="true"/>
</fileset>
</copy>
<echo message="=> DONE !!"/>
</target>
<!-- ***************************************************************** -->
<!-- ** ** -->
<!-- ** TARGET: putmessage ** -->
<!-- ** ** -->
<!-- ***************************************************************** -->
<target name="putmessage">
<echo>
(If you are a committer,) please commit your updates in
'ws-axis/site/src4forrest-060/java' and 'ws-site/target/axis' !!
</echo>
</target>
</project>
1.1 ws-axis/site/src4forrest-060/java/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 ws-axis/site/src4forrest-060/java/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=my-project
# Specifies name of Forrest skin to use
#project.skin=forrest-site
#project.skin=avalon-tigris
#project.skin=krysalis-site
project.skin=ws-site
##############
# 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
##############
# Cocoon catalog entity resolver properties
# A local catalog to supplement the default Forrest catalog
#project.catalog=${project.schema-dir}/catalog
# The verbosity level for the entity resolver (1..10)
#forrest.catalog.verbosity=1
##############
# 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=false
#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=site.xml
#
#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}