Date: 2004-12-04T16:50:39
Editor: DavidCrossley <[EMAIL PROTECTED]>
Wiki: Cocoon Wiki
Page: HowToForrestTransition
URL: http://wiki.apache.org/cocoon/HowToForrestTransition
Improve statement about the relevance of this doc
Change Log:
------------------------------------------------------------------------------
@@ -1,4 +1,4 @@
-'''''Note:''''' This document is not relevant anymore since Cocoon has its
docs built by Forrest ''-- Vadim''
+'''Note:''' Some parts of this document are not relevant anymore since Cocoon
has its docs built by Forrest. The problem areas are now the generation of the
docs via the webapp.
'''Overview'''[[BR]]
What follows is what I hope to be a minimally invasive (to the Cocoon CVS) way
for the Cocoon project to begin a Forrest-Transition trial run of its
documentation. All in-process configuration files (that will eventually need to
live in the Cocoon CVS) are stored in the Forrest cvs at
src/resources/convert/cocoon. All CVS doc files, transformed during this trial
run, are stored in Cocoon's build directory.
@@ -27,9 +27,9 @@
* Run ./build.sh
* Add $FORREST_HOME to your environment (points to
<path_to_forrest_cvs>xml-forrest-cvs/build/dist/shbat)
* Copy Cocoon-specific build files to $FORREST_HOME
-{{{
- cp $FORREST_HOME/../../../src/resources/convert/cocoon/forrest.build.xml
$FORREST_HOME/forrest.build.xml
- cp $FORREST_HOME/../../../src/resources/convert/cocoon/forrest.antproxy.xml
$FORREST_HOME/forrest.antproxy.xml
+{{{
+ cp $FORREST_HOME/../../../src/resources/convert/cocoon/forrest.build.xml
$FORREST_HOME/forrest.build.xml
+ cp $FORREST_HOME/../../../src/resources/convert/cocoon/forrest.antproxy.xml
$FORREST_HOME/forrest.antproxy.xml
}}}
@@ -38,24 +38,24 @@
* You may want to add $COCOON_HOME (<path_to_xml_cocoon2>) to your
environment for the purposes of this How-To)
* Clean out your build directory: 'build clean'
* Copy forrest.properties and forrest-targets.ent to $COCOON_HOME
-{{{
- cp $FORREST_HOME/../../../src/resources/convert/cocoon/forrest.properties
$COCOON_HOME/forrest.properties
- cp $FORREST_HOME/../../../src/resources/convert/cocoon/forrest-targets.ent
$COCOON_HOME/forrest-targets.ent
+{{{
+ cp $FORREST_HOME/../../../src/resources/convert/cocoon/forrest.properties
$COCOON_HOME/forrest.properties
+ cp $FORREST_HOME/../../../src/resources/convert/cocoon/forrest-targets.ent
$COCOON_HOME/forrest-targets.ent
}}}
* Copy status.xml and status-docs.xml to $COCOON_HOME
-{{{
- cp $FORREST_HOME/../../../src/resources/convert/cocoon/status.xml
$COCOON_HOME/status.xml
- cp $FORREST_HOME/../../../src/resources/convert/cocoon/status-docs.xml
$COCOON_HOME/status-docs.xml
+{{{
+ cp $FORREST_HOME/../../../src/resources/convert/cocoon/status.xml
$COCOON_HOME/status.xml
+ cp $FORREST_HOME/../../../src/resources/convert/cocoon/status-docs.xml
$COCOON_HOME/status-docs.xml
}}}
* Add to the top of Cocoon's build file:
-{{{
- <!DOCTYPE project [
- <!ENTITY forrest-targets SYSTEM "file:./forrest-targets.ent">
- ]>
+{{{
+ <!DOCTYPE project [
+ <!ENTITY forrest-targets SYSTEM "file:./forrest-targets.ent">
+ ]>
}}}
* Before the closing </project> of Cocoon's build file add:
-{{{
- &forrest-targets;
+{{{
+ &forrest-targets;
}}}
'''3. Prepare for Transition'''[[BR]]
@@ -66,9 +66,9 @@
* copies all other needed files (e.g. .txt files)
You do this by:
-{{{
-cd $COCOON_HOME
-./build.[sh|bat] trial-run-F
+{{{
+cd $COCOON_HOME
+./build.[sh|bat] trial-run-F
}}}
You will find the results of this preparation here:
@@ -77,10 +77,10 @@
'''4. Build other targets'''[[BR]]
Now you're ready to use the full power of Forrest. Type any of the
following:[[BR]]
-{{{
-./build.sh site-F
-./build.sh webapp-F
-./build.sh validate-F
+{{{
+./build.sh site-F
+./build.sh webapp-F
+./build.sh validate-F
}}}
Note: I had to add "-F" to these targets so that they didn't conflict with
Cocoon's existing build targets.
