nicolaken 2002/11/18 06:16:41
Added: . forrest-targets.ent forrest.properties status.xml
Log:
First step of migration of documentation to Forrest.
New docs dir:
jakarta-avalon-phoenix/src/documentation
New content dir:
jakarta-avalon-phoenix/src/documentation/content
New resources and images dir:
jakarta-avalon-phoenix/src/documentation/resources
To build the documentation download Forrest from CVS
http://xml.apache.org/forrest/your-project.html#N10022
install it as described here
http://xml.apache.org/forrest/your-project.html#N10036
cd in the jakarta-avalon-phoenix dir and run "forrest"
To see the site real-time from a local embedded webserver run "forrest run"
and point the browser to http://localhost:8888/
The sources to change are in ./build/webapp, you will need to synch them with
the actual docs manually.
Or run the Phoenix build.xml with target "site".
Revision Changes Path
1.1 jakarta-avalon-phoenix/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:[EMAIL PROTECTED]:/home/cvs
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 jakarta-avalon-phoenix/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=avalon-phoenix
# Specifies name of Forrest skin to use
#project.skin=basic
project.skin=avalon-tigris
##############
# layout properties
# Properties that must be set to override the default locations
#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
#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.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.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.skinconf.includes=${skinconf-file}
#forrest.validate.skinconf.excludes=
#forrest.validate.skinconf.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 jakarta-avalon-phoenix/status.xml
Index: status.xml
===================================================================
<?xml version="1.0"?>
<status>
<developers>
<person name="Federico Barbieri" email="[EMAIL PROTECTED]" id="FB"/>
<person name="Berin Loritsch" email="[EMAIL PROTECTED]" id="BL"/>
<person name="Peter Donald" email="[EMAIL PROTECTED]" id="PD"/>
<person name="Paul Hammant" email="[EMAIL PROTECTED]" id="PH"/>
<person name="Mircea Toma" email="[EMAIL PROTECTED]" id="MT"/>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]" id="SM"/>
<person name="Nicola Ken Barozzi" email="[EMAIL PROTECTED]" id="NKB"/>
</developers>
<todo>
<actions priority="high">
<action context="docs" dev="open">
Improve docs.
</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="4.0a4" date="Unreleased">
<!-- Sample action:
<action dev="JB" type="fix" due-to="Joe Contributor"
due-to-email="[EMAIL PROTECTED]">Fixed a bug in the Foo
class.</action>
-->
<action dev="NKB" type="update">
Move to Forrest http://xml.apache.org/forrest/ for document generation.
</action>
<action dev="PD" type="add">
Update documentation and move to Anakia for document generation.
</action>
<action dev="PD" type="add">
Remove deprecated functionality for deploying old style .sar files or
deploying from a directory.
</action>
<action dev="PD" type="add">
Remove deprecated Service interface.
</action>
<action dev="PD" type="add">
Remove some deprecated methods from BlockContext.
</action>
<action dev="PD" type="add">
Warn users if their blocks Work interfaces/Services implement
any lifecycle interfaces.
</action>
<action dev="SM" type="add">
Allow name sub-element in block section of BlockInfo.
</action>
<action dev="PD" type="add">
Add "sar:" URL protocol handling to policy section in environment.xml
file.
</action>
<action dev="PD" type="add">
Blocks no longre need to implement Block interface. Block interface
is thus deprecated as is AbstractBlock. This was done to facilitate
sharing of components between multiple containers.
</action>
<action dev="PD" type="add">
Extrace Blocks to directory based on name deployed with rather than
.sar name (to support multiple deployments of same .sar). Submitted
By: Ulrich Mayring ([EMAIL PROTECTED])
</action>
<action dev="PD" type="add">
Rework deployer such that jars are extracted to a temporary work
directory and then deleted when application is undeployed. This is
to work around the JVM locking and caching the jars and thus allowing
users to redeploy applications. Submitted By: Ulrich Mayring
([EMAIL PROTECTED])
</action>
<action dev="PD" type="add">
Updated build script so it will work when installed in a directory
with spaces. Submitted By: [EMAIL PROTECTED] (David Smiley)
</action>
<action dev="PD" type="add">
Use MX4J project to provide the JMX management kernel rather than
RI.
</action>
<action dev="PD" type="add">
Make phoenix use a temporary located in its hierarchy by setting
the JVM system property "java.io.tmp". By default this temporary
location is $PHOENIX_HOME/temp
</action>
<action dev="PD" type="add">
Rework Embeddor so that it instantiates kernel components from a
by reading the contents of conf/kernel.xml file.
Submitted By: Joerg Bauer ([EMAIL PROTECTED])
</action>
<action dev="PD" type="add">
Add XDoclet tasks to generate the manifest and BlockInfo files
based on javadoc tags inserted into Blocks java file. Originally
Submitted By: vinay nair ([EMAIL PROTECTED])
</action>
<action dev="SM" type="add">
Added javadoc to more classes and added in package.html files
where appropriate.
</action>
<action dev="PH" type="add">
Added ApplicationListener objects that implement all same
funcitonality as BlockListener but also provide support
for Application Starting/Stopping/Failure events and
provide access to SarMetaData. Consequently deprecated
BlockListener interface.
</action>
<action dev="PD" type="add">
Enhanced DefaultManager to support authenticated connecitons.
Submitted By: "Jorg Bauer/Denic" ([EMAIL PROTECTED])
</action>
<action dev="MT" type="change">
Add support for Parameterizable blocks. Submitted by:
Brian Olsen ([EMAIL PROTECTED])
</action>
<action dev="PD" type="add">
Allow Blocks to declare that they are able to be exported to a Management
subsystem (ie JMS) by making their blocks declare (Management-access-points/)
in their BlockInfo. Blocks will be exported to JMX with names like
"application=Foo,name=MrBlock,role=org.apache.MyManagementInterface"
</action>
<action dev="PD" type="change">
Validate the assembly.xml file and any BlockInfo files if they
declare the DTD correctly.
</action>
<action dev="PD" type="change">
Add native daemon support by using the daemon created in the
http://wrapper.sourceforge.net/ project. Submitted By:
Leif Mortenson ([EMAIL PROTECTED])
</action>
<action dev="PD" type="fix">
Fixed bug where application names were inapropriately prefixed
to log categories. Submitted By Antal Attila ([EMAIL PROTECTED])
</action>
<action dev="PD" type="fix">
Fixed bug where application names were inapropriately prefixed
to log categories.
</action>
<action dev="PD" type="change">
Allow jars contained within the .sar file to declare dependencies
on libraries using the standard JDK1.2+ Extension mechanism. For
more information about optional packages, see the document
Optional Package Versioning in the documentation bundle for your
Java2 Standard Edition package, in the file
guide/extensions/versioning.html.
</action>
</release>
<release version="4.0a3" date="November 13, 2001">
<action dev="PD" type="change">
Add documentation describing BlockListener.
</action>
<action dev="PD" type="change">
Fixed bug that allowed binary distributions to be built without
copying xerces.jar into correct place.
</action>
</release>
<release version="4.0a2" date="November 12, 2001">
<action dev="PD" type="change">
Update Phoenix to use the new Avalon Framework Logger interface rather
than
directly using LogKits Logger class. This required a backwards
incompatible
change in BlockContext. The getLogger() methods now return the Logger
interface
rather than LogKits Logger class. If a Block implements Loggable then it
will
be passed LogKits Logger, this is required for backwards compatability.
If the
Block implements LogEnabled it will receive the new style Logger.
</action>
<action dev="MT" type="add">
Add support for undeploying and unistalling applications. Add support for
separating
out install phase from deployment phase and persisting information about
application installations.
</action>
<action dev="PD" type="change">
Rework the application deployment format (ie .sar format) to be more in
line
with other specifications. See docs/creating-a-server-application.html in
distribution
for current format description. The old format is deprecated but will
still work.
</action>
<action dev="PH" type="add">
Created the start of a Phoenix Developers Kit (PDK) that will enable
developers to rapidly become accustom to developing Phoenix applications.
</action>
<action dev="PD" type="add">
Started to incorporate the JMX code more fully into Phoenix kernel.
Started
doing this by refactoring the base MBeans and testing using the RIs agent.
</action>
<action dev="PD" type="change">
Separated code that validated assembly of application into separate
classes. The validation is now much stricter and requires that
Blocks conform to established patterns. The validation phase should give
more reasonable explanations for violations. Extra validation checks
include verifying that services offered by a Block are actually
interfaces,
that there is no circular dependencies, that declared Blocks and
BlockListeners
actually implement Block or BlockListener interface, that the names of
Blocks
are valid etc.
</action>
</release>
<release version="4.0a1" date="September 25, 2001">
<action dev="BL" type="change">
Too many things to enumerate here. This is the first public release,
and the code is still considered alpha. In future releases, we will
be much more careful to record the changes to Phoenix.
</action>
</release>
<release version="3.1a2" date="Unreleased">
<action dev="BL" type="add">
Added stylesheet to convert Stylebook markup to DocBook markup.
</action>
<action dev="BL" type="change">
Changed the documentation build process to use Cocoon to build
the site.
</action>
<action dev="PD" type="remove">
Legacy support for nested configuration elements in assembly file
removed.
</action>
<action dev="PD" type="update">
Simplified Loader and made it set ContextClassLoader before executing
Main method. It will also use the System property phoenix.home if set
rather than always trying to dynamically determine home directory.
</action>
<action dev="PD" type="add">
Added SingleAppEmbeddor to launch a kernel to load a single Application.
Patch supplied by "Eung-ju Park" ([EMAIL PROTECTED]). This is useful if
you need to reuse the blocks in other contexts (such as in a Servlet).
</action>
<action dev="PD" type="add">
Made default SystemManager a NoopSystemManager. Patch supplied
by "Eung-ju Park" ([EMAIL PROTECTED]). To re-enable RMI manager a new
command line switch "--remote-manager" was added.
</action>
<action dev="PD" type="update">
Reworked SecurityManager setup. Instead of starting a security
Manager inside the code it has been re-architectured so that the
SecurityManager is set on the command line. This was to avoid a number
of issues related to creating a URLClassLoader in an unprotected context
before setting SecurityManager. ie As AccessControllerContext was null it
is impossible to use ClassLoader.getResource(AsStream)(). This means that
defining phoenix.insecure will no longer disable the SecurityManager. The
replacement method is to set the native OS environment variable
'PHOENIX_SECURE=false'.
</action>
<action dev="PD" type="update">
Separate Parsing of CLI arguements into separate class (CLISetup).
This is to facilitate launching Phoenix as a native daemon using
Tomcats Services API.
</action>
<action dev="PD" type="add">
Started Localizing text strings throughout Phoenix. This is done using
ResourceManager and Resources from Avalon/Excalibur project.
</action>
</release>
</changes>
</status>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
