ajack 2003/09/05 16:08:49
Modified: . .cvsignore
python/gump document.py conf.py
Added: template forrest.properties forrest-targets.ent status.xml
template/forrest skinconf.xml README.txt
template/forrest/resources/images project.svg group.svg
group-logo.gif icon.png project-logo.gif
template/forrest/content/xdocs tabs.xml site.xml
Log:
Still trying to make forrest happy.
I've tried launching 'forrest seed', but I don't like that result,
so I am trying to copy a template/forrest to gen xdocs into.
I now attempt to have forrest/content/xdocs under the workspace.basedir
and set site=log.
It seems to be closer to right, forrest is still not happy.
Any taker?
Revision Changes Path
1.1 jakarta-gump/template/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=gump
# Specifies name of Forrest skin to use
#project.skin=forrest-site
#project.skin=forrest-css
#project.skin=avalon-tigris
#project.skin=krysalis-site
##############
# behavioural properties
#project.menu-scheme=tab_attributes
#project.menu-scheme=directories
##############
# 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=forrest
#project.conf-dir=${project.content-dir}/conf
#project.sitemap-dir=${project.content-dir}
#project.xdocs-dir=${project.content-dir}/content/xdocs
#project.resources-dir=${project.content-dir}/resources
#project.stylesheets-dir=${project.resources-dir}/stylesheets
#project.images-dir=${project.resources-dir}/images
#project.schema-dir=${project.resources-dir}/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 OASIS catalog file to supplement the default Forrest catalog
#project.catalog=${project.schema-dir}/catalog.xcat
# 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=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=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}
##############
# General Forrest properties
# The URL to start crawling from
#project.start-uri=index.html
# Set logging level for messages printed to the console
#project.debuglevel=ERROR
# Max memory to allocate to Java
#forrest.maxmemory=64m
# Any other arguments to pass to the JVM. For example, to run on an X-less
# server, set to -Djava.awt.headless=true
#forrest.jvmargs=
1.1 jakarta-gump/template/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/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 jakarta-gump/template/status.xml
Index: status.xml
===================================================================
<?xml version="1.0"?>
<status>
<developers>
<person name="Joe Bloggs" email="[EMAIL PROTECTED]" id="JB" />
<!-- Add more people here -->
</developers>
<todo>
<actions priority="high">
<action context="docs" dev="JB">
Customize this template project with your project's details. This
TODO list is generated from 'status.xml'.
</action>
<action context="docs" dev="JB">
Add lots of content. XML content goes in
<code>src/documentation/content/xdocs</code>, or wherever the
<code>${project.xdocs-dir}</code> property (set in
<code>forrest.properties</code>) points.
</action>
<action context="feedback" dev="JB">
Mail <link
href="mailto:[EMAIL PROTECTED]">[EMAIL PROTECTED]</link>
with feedback.
</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="0.1" 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="JB" type="add" context="admin">
Initial Import
</action>
<!-- Sample action:
<action dev="JB" type="fix" due-to="Joe Contributor"
due-to-email="[EMAIL PROTECTED]" fixes-bug="123">
Fixed a bug in the Foo class.
</action>
-->
</release>
</changes>
</status>
1.15 +1 -0 jakarta-gump/.cvsignore
Index: .cvsignore
===================================================================
RCS file: /home/cvs/jakarta-gump/.cvsignore,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- .cvsignore 9 Aug 2003 23:21:45 -0000 1.14
+++ .cvsignore 5 Sep 2003 23:08:48 -0000 1.15
@@ -11,5 +11,6 @@
javadocs
velocity.log
build
+tmp
*~
LOCAL-ENV.bat
1.1 jakarta-gump/template/forrest/skinconf.xml
Index: skinconf.xml
===================================================================
<?xml version="1.0"?>
<!--
Skin configuration file. This file contains details of your project, which will
be used to configure the chosen Forrest skin.
-->
<!DOCTYPE skinconfig [
<!ENTITY % links.att 'name CDATA #REQUIRED'>
<!ENTITY % link.att 'name CDATA #REQUIRED href CDATA #REQUIRED'>
<!ELEMENT skinconfig (disable-search?, disable-print-link?, disable-pdf-link?,
disable-xml-link?, disable-compliance-links?, searchsite-domain?, searchsite-name?,
project-name, project-url, project-logo, group-name?, group-url?, group-logo?,
host-url?, host-logo?, year?, vendor?, trail?, credits?)*>
<!ELEMENT credits (credit*)>
<!ELEMENT credit (name, url, image?, width?, height?)>
<!-- id uniquely identifies the tool, and role indicates its function -->
<!ATTLIST credit id CDATA #IMPLIED
role CDATA #IMPLIED>
<!ELEMENT disable-search (#PCDATA)>
<!ELEMENT disable-print-link (#PCDATA)>
<!ELEMENT disable-pdf-link (#PCDATA)>
<!ELEMENT disable-xml-link (#PCDATA)>
<!ELEMENT disable-compliance-links (#PCDATA)>
<!ELEMENT searchsite-domain (#PCDATA)>
<!ELEMENT searchsite-name (#PCDATA)>
<!ELEMENT project-name (#PCDATA)>
<!ELEMENT project-url (#PCDATA)>
<!ELEMENT project-logo (#PCDATA)>
<!ELEMENT group-name (#PCDATA)>
<!ELEMENT group-url (#PCDATA)>
<!ELEMENT group-logo (#PCDATA)>
<!ELEMENT host-url (#PCDATA)>
<!ELEMENT host-logo (#PCDATA)>
<!ELEMENT year (#PCDATA)>
<!ELEMENT vendor (#PCDATA)>
<!ELEMENT trail (link1, link2, link3)>
<!ELEMENT link1 EMPTY>
<!-- Seems we can't use param entity refs until this is DTDified -->
<!ATTLIST link1 name CDATA #REQUIRED href CDATA #IMPLIED>
<!ELEMENT link2 EMPTY>
<!ATTLIST link2 name CDATA #REQUIRED href CDATA #IMPLIED>
<!ELEMENT link3 EMPTY>
<!ATTLIST link3 name CDATA #REQUIRED href CDATA #IMPLIED>
<!ELEMENT name (#PCDATA)>
<!ELEMENT url (#PCDATA)>
<!ELEMENT image (#PCDATA)>
<!ELEMENT width (#PCDATA)>
<!ELEMENT height (#PCDATA)>
]>
<skinconfig>
<!-- Do we want to disable the Google search box? -->
<disable-search>false</disable-search>
<!-- Do we want to disable the print link? -->
<disable-print-link>false</disable-print-link>
<!-- Do we want to disable the PDF link? -->
<disable-pdf-link>false</disable-pdf-link>
<!-- Do we want to disable the xml source link? -->
<disable-xml-link>true</disable-xml-link>
<!-- Do we want to disable w3c compliance links? -->
<disable-compliance-links>false</disable-compliance-links>
<searchsite-domain>jakarta.apache.org</searchsite-domain>
<searchsite-name>Jakarta Gump</searchsite-name>
<!-- mandatory project logo
skin: forrest-site renders it at the top -->
<project-name>Jakarta Gump</project-name>
<project-url>http://jakarta.apache.org/gump</project-url>
<project-logo>images/project.png</project-logo>
<!-- Alternative static image:
<project-logo>images/project-logo.gif</project-logo> -->
<!-- optional group logo
skin: forrest-site renders it at the top-left corner -->
<group-name>Jakarta</group-name>
<group-url>http://jakarta.apache.org</group-url>
<group-logo>images/group.png</group-logo>
<!-- Alternative static image:
<group-logo>images/group-logo.gif</group-logo> -->
<!-- optional host logo (e.g. sourceforge logo)
skin: forrest-site renders it at the bottom-left corner -->
<host-url></host-url>
<host-logo></host-logo>
<!-- The following are used to construct a copyright statement -->
<year>2003</year>
<vendor>The Apache Software Foundation.</vendor>
<!-- Some skins use this to form a 'breadcrumb trail' of links. If you don't
want these, set the attributes to blank. The DTD purposefully requires them.
-->
<trail>
<link1 name="Jakarta" href="http://jakarta.apache.org/"/>
<link2 name="Jakarta Gump" href="http://jakarta.apache.org/gump/"/>
<link3 name="" href=""/>
</trail>
<!-- Credits are typically rendered as a set of small clickable images in the
page footer -->
<credits>
<credit>
<name>Built with Apache Forrest</name>
<url>http://xml.apache.org/forrest/</url>
<image>images/built-with-forrest-button.png</image>
<width>88</width>
<height>31</height>
</credit>
<!-- A credit with @role='pdf' will have its name and url displayed in the
PDF page's footer. -->
</credits>
</skinconfig>
1.1 jakarta-gump/template/forrest/README.txt
Index: README.txt
===================================================================
This is the base documentation directory. It usually contains two files:
skinconf.xml # This file customizes Forrest for your project. In it, you
# tell forrest the project name, logo, copyright info, etc
sitemap.xmap # Optional. This sitemap overrides the default one bundled
# with Forrest. Typically, one would copy a sitemap from
# xml-forrest/src/resources/conf/sitemap.xmap, and customize
# it.
1.1 jakarta-gump/template/forrest/resources/images/project.svg
Index: project.svg
===================================================================
<?xml version="1.0" standalone="no"?>
<!--
SVG Anteater logo
[EMAIL PROTECTED]
To get started with SVG, I'd recommend getting the Adobe SVG plugin, and the
xml-batik CVS module. Then have a look at the xml-batik/samples files. Use the
SVG spec (http://www.w3.org/TR/SVG/) as a reference.
-->
<!--
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN"
"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd";>
-->
<svg xmlns="http://www.w3.org/2000/svg";
xmlns:xlink="http://www.w3.org/1999/xlink"; width="340" height="60" viewBox="0 0
340 60">
<title>Anteater logo</title>
<defs>
<!--
<radialGradient id="radialGradient">
<stop style="stop-color:gold" offset="0"/>
<stop style="stop-color:orange" offset=".5"/>
<stop style="stop-color:crimson" offset="1"/>
</radialGradient>
<linearGradient id="linearGradient">
<stop style="stop-color:gold" offset="0"/>
<stop style="stop-color:orange" offset=".5"/>
<stop style="stop-color:crimson" offset="1"/>
</linearGradient>
-->
<linearGradient id="gradient" x1="0" y1="0" x2="0" y2="1">
<stop style="stop-color:white" offset="0"/>
<stop style="stop-color:lightgreen" offset="1"/>
</linearGradient>
<filter id="shadowFilter" filterUnits="objectBoundingBox">
<!-- Takes the alpha channel (black outline of the text), blurs it and saves
as 'blur' -->
<feGaussianBlur in="SourceAlpha" stdDeviation="2 2" result="blur"/>
<!-- Takes saved 'blur' and offsets it by 4 pixels, saves as 'offsetBlur' -->
<feOffset in="blur" dx="4" dy="4" result="offsetBlur"/>
<!-- Merges SourceGraphic (original image) and 'offsetBlur', putting the
former 'over' the latter, and using the merged result as the finished
image -->
<feComposite in="SourceGraphic" in2="offsetBlur" operator="over"/>
</filter>
</defs>
<g filter="url(#shadowFilter)" fill="url(#gradient)">
<text x="51%" y="75%" style="font-size:42pt; font-family:Verdana ; text-anchor:
middle">
MyProj
</text>
<text x="91%" y="80%" style="font-size:6pt; font-family:Arial ; text-anchor:
middle">
Change this in
</text>
<text x="91%" y="95%" style="font-size:6pt; font-family:Arial ; text-anchor:
middle">
project-logo.svg
</text>
</g>
</svg>
1.1 jakarta-gump/template/forrest/resources/images/group.svg
Index: group.svg
===================================================================
<?xml version="1.0" standalone="no"?>
<!--
SVG Anteater logo
[EMAIL PROTECTED]
To get started with SVG, I'd recommend getting the Adobe SVG plugin, and the
xml-batik CVS module. Then have a look at the xml-batik/samples files. Use the
SVG spec (http://www.w3.org/TR/SVG/) as a reference.
-->
<!--
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN"
"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd";>
-->
<svg xmlns="http://www.w3.org/2000/svg";
xmlns:xlink="http://www.w3.org/1999/xlink"; width="340" height="60" viewBox="0 0
340 60">
<title>Anteater logo</title>
<defs>
<!--
<radialGradient id="radialGradient">
<stop style="stop-color:gold" offset="0"/>
<stop style="stop-color:orange" offset=".5"/>
<stop style="stop-color:crimson" offset="1"/>
</radialGradient>
<linearGradient id="linearGradient">
<stop style="stop-color:gold" offset="0"/>
<stop style="stop-color:orange" offset=".5"/>
<stop style="stop-color:crimson" offset="1"/>
</linearGradient>
-->
<linearGradient id="gradient" x1="0" y1="0" x2="0" y2="1">
<stop style="stop-color:white" offset="0"/>
<stop style="stop-color:lightgreen" offset="1"/>
</linearGradient>
<filter id="shadowFilter" filterUnits="objectBoundingBox">
<!-- Takes the alpha channel (black outline of the text), blurs it and saves
as 'blur' -->
<feGaussianBlur in="SourceAlpha" stdDeviation="2 2" result="blur"/>
<!-- Takes saved 'blur' and offsets it by 4 pixels, saves as 'offsetBlur' -->
<feOffset in="blur" dx="4" dy="4" result="offsetBlur"/>
<!-- Merges SourceGraphic (original image) and 'offsetBlur', putting the
former 'over' the latter, and using the merged result as the finished
image -->
<feComposite in="SourceGraphic" in2="offsetBlur" operator="over"/>
</filter>
</defs>
<g filter="url(#shadowFilter)" fill="url(#gradient)">
<text x="21%" y="60%" style="font-size:30pt; font-family:Verdana ; text-anchor:
middle">
Group
</text>
<text x="55%" y="80%" style="font-size:30pt; font-family:Verdana ; text-anchor:
middle">
Logo
</text>
<text x="81%" y="80%" style="font-size:6pt; font-family:Arial ; text-anchor:
middle">
Change this in
</text>
<text x="81%" y="95%" style="font-size:6pt; font-family:Arial ; text-anchor:
middle">
group-logo.svg
</text>
</g>
</svg>
1.1 jakarta-gump/template/forrest/resources/images/group-logo.gif
<<Binary file>>
1.1 jakarta-gump/template/forrest/resources/images/icon.png
<<Binary file>>
1.1 jakarta-gump/template/forrest/resources/images/project-logo.gif
<<Binary file>>
1.1 jakarta-gump/template/forrest/content/xdocs/tabs.xml
Index: tabs.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.0//EN"
"tab-cocoon-v10.dtd">
<tabs software="Gump"
title="Gump"
copyright="Apache Software Foundation"
xmlns:xlink="http://www.w3.org/1999/xlink";>
<!-- The rules are:
@dir will always have '/@indexfile' added.
@indexfile gets appended to @dir if the tab is selected. Defaults to 'index.html'
@href is not modified unless it is root-relative and obviously specifies a
directory (ends in '/'), in which case /index.html will be added
-->
<tab label="Home" dir="" indexfile="index.html"/>
<tab label="Stats" dir="" indexfile="stats/index.html"/>
<tab label="XRef" dir="" indexfile="xref/index.html"/>
</tabs>
1.1 jakarta-gump/template/forrest/content/xdocs/site.xml
Index: site.xml
===================================================================
<?xml version="1.0"?>
<!--
Forrest site.xml
-->
<site label="Gump" href="" xmlns="http://apache.org/forrest/linkmap/1.0";>
<about label="Work">
<index label="Index" href="index.html"/>
</about>
<external-refs>
<xml.apache.org href="http://xml.apache.org/";>
<forrest href="forrest/">
<validation href="validation.html"/>
<webapp href="your-project.html#webapp"/>
<document-v11 href="document-v11.html"/>
</forrest>
<cocoon href="cocoon/"/>
</xml.apache.org>
</external-refs>
</site>
1.6 +112 -13 jakarta-gump/python/gump/document.py
Index: document.py
===================================================================
RCS file: /home/cvs/jakarta-gump/python/gump/document.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- document.py 5 Sep 2003 18:11:22 -0000 1.5
+++ document.py 5 Sep 2003 23:08:49 -0000 1.6
@@ -125,7 +125,9 @@
def
document(workspace,context,full=None,moduleFilterList=None,projectFilterList=None):
log.info('--- Documenting Results')
-
+
+ seedForrest(workspace,context)
+
# Testing...
documentText(workspace,context,moduleFilterList,projectFilterList)
@@ -136,16 +138,64 @@
if full or 1: # Testing
documentStatistics(workspace,context,db,moduleFilterList,projectFilterList)
#documentXRef(workspace,context)
-
-
- content=getContentDir(workspace)
- xdocs=getWorkspaceDir(workspace,content)
- forrest=Cmd('forrest','forrest',content)
+
+ executeForrest(workspace,context)
+
+#####################################################################
+#
+# Forresting...
+def seedForrest(workspace,context):
+ forrestTemplate=getForrestTemplateDir()
+ forrestSiteTemplate=getForrestSiteTemplateDir()
+ forrest=getForrestDir(workspace)
+
+ # This gave an ugly tree (src/doc/cont../xdocs..)
+ # with sub-directories. It is a nice idea, but not
+ # quite there for us now, do a plain old tempalte
+ # copy instead.
+
+ # First .. seed the project
+ #forrestSeed=Cmd('forrest','forrest_seed',forrest)
+ #forrestSeed.addPrefixedParameter('-D','java.awt.headless','true','=')
+ #forrestSeed.addParameter('seed')
+ #forrestSeedResult=execute(forrestSeed)
+ # Consider adding, but a second seed might fail, need to ignore that...
+ #work=CommandWorkItem(WORK_TYPE_DOCUMENT,forrest,forrestSeedResult)
+ #context.performedWork(work)
+
+ # Copy in the defaults
+ forrestSeed=Cmd('cp','forrest_seed',forrest)
+ forrestSeed.addParameter('-Rf')
+ forrestSeed.addParameter(forrestTemplate)
+ forrestSeed.addParameter(workspace.basedir)
+ forrestSeedResult=execute(forrestSeed)
+ work=CommandWorkItem(WORK_TYPE_DOCUMENT,forrestSeed,forrestSeedResult)
+ context.performedWork(work)
+
+ # Copy over the local site defaults (if any)
+ if os.path.exists(forrestSiteTemplate):
+ forrestSiteSeed=Cmd('cp','forrest_site_seed',forrest)
+ forrestSiteSeed.addParameter('-Rf')
+ forrestSiteSeed.addParameter(forrestSiteTemplate)
+ forrestSiteSeed.addParameter(workspace.basedir)
+ forrestSiteSeedResult=execute(forrestSiteSeed)
+
work=CommandWorkItem(WORK_TYPE_DOCUMENT,forrestSiteSeed,forrestSiteSeedResult)
+ context.performedWork(work)
+
+
+def executeForrest(workspace,context):
+ # The project tree
+ forrest=getForrestDir(workspace)
+ content=getContentDir(workspace,forrest)
+ xdocs=getWorkspaceDir(workspace,content)
+
+ # Then generate...
+ forrest=Cmd('forrest','forrest',forrest)
forrest.addPrefixedParameter('-D','java.awt.headless','true','=')
forrest.addPrefixedParameter('-D','project.content-dir', \
content, '=')
- forrest.addPrefixedParameter('-D','project.xdocs-dir', \
- xdocs, '=')
+ #forrest.addPrefixedParameter('-D','project.xdocs-dir', \
+ # xdocs, '=')
#forrest.addPrefixedParameter('-D','project.sitemap-dir', \
# docroot, '=')
#forrest.addPrefixedParameter('-D','project.stylesheets-dir', \
@@ -161,7 +211,7 @@
work=CommandWorkItem(WORK_TYPE_DOCUMENT,forrest,forrestResult)
context.performedWork(work)
-
+
#####################################################################
#
@@ -619,8 +669,22 @@
if not os.path.exists(sdir): os.mkdir(sdir)
return sdir
-def getContentDir(workspace):
- cdir=os.path.normpath(os.path.join(workspace.logdir,'content'))
+def getForrestTemplateDir():
+ fdir=os.path.normpath(os.path.join(dir.template,'forrest'))
+ return fdir
+
+def getForrestSiteTemplateDir():
+ fdir=os.path.normpath(os.path.join(dir.template,'site-forrest'))
+ return fdir
+
+def getForrestDir(workspace):
+ fdir=os.path.normpath(os.path.join(workspace.basedir,'forrest'))
+ if not os.path.exists(fdir): os.mkdir(fdir)
+ return fdir
+
+def getContentDir(workspace,forrestdir=None):
+ fdir=forrestdir or getForrestDir(workspace)
+ cdir=os.path.normpath(os.path.join(fdir,'content'))
if not os.path.exists(cdir): os.mkdir(cdir)
return cdir
@@ -632,7 +696,7 @@
def getStatisticsDir(workspace,workspacedir=None):
wdir=workspacedir or getWorkspaceDir(workspace)
- sdir=os.path.normpath(os.path.join(wdir,'stats'))
+ sdir=os.path.normpath(os.path.join(wdir,'gump_stats'))
if not os.path.exists(sdir): os.mkdir(sdir)
return sdir
@@ -828,4 +892,39 @@
f.write('<source>\n')
f.write(text)
f.write('</source>\n')
-
\ No newline at end of file
+
+
+
+
+# static void main()
+if __name__=='__main__':
+
+ # init logging
+ logging.basicConfig()
+
+ #set verbosity to show all messages of severity >= default.logLevel
+ log.setLevel(default.logLevel)
+
+ args = handleArgv(sys.argv,0)
+ ws=args[0]
+ ps=args[1]
+
+ context=GumpContext()
+
+
+ # get parsed workspace definition
+ from gump import load
+ workspace=load(ws, context)
+
+ #
+ #from gump.check import checkEnvironment
+ #checkEnvironment(workspace, context)
+
+ #
+ # Store for later
+ #
+ from gump.logic import getGumpSetForProjectExpression
+ context.gumpset=getGumpSetForProjectExpression(ps)
+
+ # Document
+ document(workspace, context, 1);
1.10 +4 -3 jakarta-gump/python/gump/conf.py
Index: conf.py
===================================================================
RCS file: /home/cvs/jakarta-gump/python/gump/conf.py,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- conf.py 5 Sep 2003 05:20:42 -0000 1.9
+++ conf.py 5 Sep 2003 23:08:49 -0000 1.10
@@ -82,6 +82,7 @@
cache = os.path.normpath('%s/%s' % (base,'cache'))
work = os.path.normpath('%s/%s' % (base,'work'))
tmp = os.path.normpath('%s/%s' % (base,'tmp'))
+ template = os.path.normpath('%s/%s' % (base,'template'))
class default:
"""Configuration of default settings"""
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
