Author: reinhard
Date: Sat Mar 19 02:57:33 2005
New Revision: 158228
URL: http://svn.apache.org/viewcvs?view=rev&rev=158228
Log:
formatting
Modified:
cocoon/trunk/tools/targets/docs-build.xml
Modified: cocoon/trunk/tools/targets/docs-build.xml
URL:
http://svn.apache.org/viewcvs/cocoon/trunk/tools/targets/docs-build.xml?view=diff&r1=158227&r2=158228
==============================================================================
--- cocoon/trunk/tools/targets/docs-build.xml (original)
+++ cocoon/trunk/tools/targets/docs-build.xml Sat Mar 19 02:57:33 2005
@@ -16,61 +16,51 @@
-->
<!-- $Id$ -->
<project name="docs">
-
- <description>
- Documentation Targets
- </description>
+ <description> Documentation Targets </description>
- <target name="docs" depends="prepare-docs" unless="exclude.documentation"
- description="Test documentation target">
-
- <!-- check whether Forrest bin directory ist set -->
+ <target name="docs" depends="prepare-docs" unless="exclude.documentation"
description="Test documentation target">
+ <!-- check whether Forrest bin directory ist set -->
<condition property="cond.forrest.bin.exists">
<available file="${forrest.bin}/forrest.bat" property="blaaaa"/>
- </condition>
- <fail unless="cond.forrest.bin.exists"
- message="Set the variable 'forrest.bin' to the directory that contains
the Forrest start scripts!"/>
+ </condition>
+ <fail unless="cond.forrest.bin.exists"
+ message="Set the variable 'forrest.bin' to the directory that contains
the Forrest start scripts!"/>
<!-- run Forrest using exec task - depending on the operating system
either choose
forrest.sh or forrest.bat -->
- <dirname file="${forrest.bin}/blaaaa" property="forrest.bin.absolute"/>
- <if>
- <contains string="${os.name}" substring="win" casesensitive="false"/>
- <then>
- <exec dir="./src/documentation"
executable="${forrest.bin.absolute}/forrest.bat"/>
+ <dirname file="${forrest.bin}/blaaaa" property="forrest.bin.absolute"/>
+ <if>
+ <contains string="${os.name}" substring="win" casesensitive="false"/>
+ <then>
+ <exec dir="./src/documentation"
executable="${forrest.bin.absolute}/forrest.bat"/>
</then>
<else>
- <exec dir="./src/documentation"
executable="${forrest.bin.absolute}/forrest.sh"/>
+ <exec dir="./src/documentation"
executable="${forrest.bin.absolute}/forrest.sh"/>
</else>
- </if>
-
- <!-- create Javadocs -->
- <!-- tbd -->
-
+ </if>
+ <!-- create Javadocs -->
+ <!-- tbd -->
</target>
-
- <target name="prepare-docs" unless="exclude.documentation"
depends="init-tasks" description="Test documentation target">
- <!-- create sitemap components: Task has to be rewritten -->
- <!--sitemap-components docDir="build/xdocs/userdocs"
source="./src/java"/-->
- <!-- create jar information -->
- <!-- TBD -->
- <!-- create Block status information -->
- <!-- create block structure -->
-
- </target>
-
- <target name="javadocs" depends="prepare-blocks"
- description="Builds the API documentation (javadocs)"
- unless="internal.exclude.javadocs">
- <ant antfile="${build.temp}/blocks-build.xml"
- inheritAll="true"
- inheritRefs="false"
- target="javadocs"/>
+
+ <target name="prepare-docs" unless="exclude.documentation"
depends="init-tasks"
+ description="Test documentation target">
+ <!-- create sitemap components: Task has to be rewritten -->
+ <!--sitemap-components docDir="build/xdocs/userdocs"
source="./src/java"/-->
+
+ <!-- create jar information -->
+ <!-- create block status information -->
+ <!-- create block structure -->
</target>
-
-
+
+ <target name="javadocs" depends="prepare-blocks" description="Builds the API
documentation (javadocs)"
+ unless="internal.exclude.javadocs">
+ <ant antfile="${build.temp}/blocks-build.xml" inheritAll="true"
inheritRefs="false" target="javadocs"/>
+ </target>
+
+
+ <!-- ******************************* old targets
********************************************* -->
+ <!-- (RP) I don't delete them for now as it is easier this way to find out
what the old version did -->
<target name="OLD_prepare-docs" unless="exclude.documentation"
depends="blocks">
-
<!-- Set classpath for documentation -->
<path id="documentation.classpath">
<path refid="classpath"/>
@@ -83,38 +73,29 @@
<path location="${tools.jar}"/>
<path location="${build.context}/WEB-INF/classes"/>
</path>
-
<mkdir dir="${build.context}"/>
<mkdir dir="${build.context}/images"/>
-
<!-- make filtered copy of XML docs -->
<copy todir="${build.context}" filtering="on">
<fileset dir="${documentation}">
<exclude name="images/**"/>
</fileset>
</copy>
-
<!-- Add some other documents -->
- <copy file="status.xml"
- tofile="${build.context}/xdocs/status.xml" filtering="on"/>
-
- <!-- generate sitemap components docs using SitemapTask -->
+ <copy file="status.xml" tofile="${build.context}/xdocs/status.xml"
filtering="on"/>
+ <!-- generate sitemap components docs using SitemapTask -->
<sitemap-components docDir="${build.context}/xdocs/userdocs"
source="${java}"/>
<echo message="Building component docs from blocks."/>
<sitemap-components docDir="${build.context}/xdocs/userdocs"
source="${blocks}"/>
<!--
-->
-
<!-- Forrest needs its own file at src/documentation/sitemap.xmap, so we
overwrite it with the old Cocoon-specific sitemap here -->
- <move file="${build.context}/sitemap-localdocs.xmap"
- tofile="${build.context}/sitemap.xmap"/>
-
+ <move file="${build.context}/sitemap-localdocs.xmap"
tofile="${build.context}/sitemap.xmap"/>
<!-- Copy images -->
<copy todir="${build.context}/images" filtering="off">
<fileset dir="${documentation}/images"/>
</copy>
-
<!-- Copy entity catalog and entities -->
<copy todir="${build.context}/WEB-INF/entities" filtering="on">
<fileset dir="${webapp}/WEB-INF/entities"/>
@@ -122,45 +103,34 @@
<copy todir="${build.context}/WEB-INF/classes" filtering="on">
<fileset dir="${webapp}/WEB-INF/classes"/>
</copy>
-
<!-- Copy the logkit configuration -->
<copy todir="${build.context}" filtering="on"
file="${webapp}/WEB-INF/logkit.xconf"/>
-
</target>
-
<!-- Set a variable if the generated docs are already up-to-date. -->
<target name="OLD_docs_check" depends="OLD_prepare-docs">
- <uptodate property="docs.notrequired"
targetfile="${build.docs}/index.html" >
+ <uptodate property="docs.notrequired"
targetfile="${build.docs}/index.html">
<srcfiles dir="." includes="status.xml"/>
<srcfiles dir="${build}" includes="jars.xml"/>
<srcfiles dir="${documentation}/xdocs" includes="**/*.xml"/>
</uptodate>
</target>
-
<!-- If generated docs are already up-to-date, print a message saying so. -->
<target name="OLD_docs_done" depends="OLD_docs_check" if="docs.notrequired">
- <echo>-------------------------------------------------------------
-Not rebuilding docs, as they are up-to-date:
- ${build.docs}/index.html is more recent than
- status.xml, ${documentation}/xdocs/*.xml
--------------------------------------------------------------
-</echo>
+ <echo>------------------------------------------------------------- Not
rebuilding docs, as they are up-to-date:
+ ${build.docs}/index.html is more recent than status.xml,
${documentation}/xdocs/*.xml
+ -------------------------------------------------------------</echo>
</target>
-
<!-- Create docs -->
-<!-- FIXME: Temporarily disable forrest until we fix the 0.6 vs 0.5 and cocoon
version number conflict
+ <!-- FIXME: Temporarily disable forrest until we fix the 0.6 vs 0.5 and
cocoon version number conflict
depends="validate-jars, prepare-docs, cocoon-validate-xdocs, docs_done,
javadocs, do-forrest"
-->
- <target name="OLD_docs"
- depends="validate-jars, prepare-docs, cocoon-validate-xdocs,
OLD_docs_done, javadocs"
- unless="docs.notrequired" description="Builds the documentation">
+ <target name="OLD_docs" depends="validate-jars, prepare-docs,
cocoon-validate-xdocs, OLD_docs_done, javadocs"
+ unless="docs.notrequired" description="Builds the documentation">
<!-- The docs are created using forrest, so we simply copy them for now -->
<mkdir dir="${build.docs}"/>
-
-<echo message="
-FIXME: Not copying the forrest-built docs to ${build.docs}
-because you now need to run forrest manually and copy them yourself."/>
-<!-- FIXME: Temporarily disable forrest until we fix the 0.6 vs 0.5 and cocoon
version number conflict
+ <echo
+ message=" FIXME: Not copying the forrest-built docs to ${build.docs}
because you now need to run forrest manually and copy them yourself."/>
+ <!-- FIXME: Temporarily disable forrest until we fix the 0.6 vs 0.5 and
cocoon version number conflict
<copy todir="${build.docs}" filtering="off">
<fileset dir="${build.site}"/>
</copy>
@@ -168,31 +138,30 @@
<copy todir="${build.docs}/apidocs" filtering="off">
<fileset dir="${build.javadocs}"/>
</copy>
-<echo message="
-NOTE: Now that the docs are prepared, run 'forrest' from the command-line.
-It will generate docs into ${build.site}"/>
+ <echo
+ message=" NOTE: Now that the docs are prepared, run 'forrest' from the
command-line. It will generate docs into ${build.site}"
+ />
</target>
-
<!-- Prepares the printer-docs -->
-<!--
+ <!--
<target name="prepare-printer-docs" depends="prepare-docs">
<mkdir dir="${build.context.printer}"/>
-->
- <!-- copy prepared docs -->
-<!--
+ <!-- copy prepared docs -->
+ <!--
<copy todir="${build.context.printer}" filtering="off">
<fileset dir="${build.context}"/>
</copy>
-->
- <!-- copy printer skin -->
-<!--
+ <!-- copy printer skin -->
+ <!--
<copy todir="${build.context.printer}/stylesheets" filtering="off"
overwrite="yes">
<fileset dir="${build.context}/stylesheets/printer_skin"/>
</copy>
</target>
-->
<!-- Set a variable if the generated printer docs are already up-to-date. -->
-<!--
+ <!--
<target name="printer-docs_check" depends="prepare">
<uptodate property="printer-docs.notrequired"
targetfile="${build.docs.printer}/index.html" >
<srcfiles dir="." includes="status.xml"/>
@@ -201,7 +170,7 @@
</target>
-->
<!-- If generated printer docs are already up-to-date, print a message
saying so. -->
-<!--
+ <!--
<target name="printer-docs_done" depends="printer-docs_check"
if="printer-docs.notrequired">
<echo message="Not rebuilding printer docs, as they are up-to-date:"/>
<echo message=" ${build.docs.printer}/index.html is more recent than"/>
@@ -209,7 +178,7 @@
</target>
-->
<!-- Create printer friendly docs -->
-<!--
+ <!--
<target name="printer-docs" depends="prepare-printer-docs,
cocoon-validate-xdocs, printer-docs_done" description="Builds printer-friendly
documentation">
<mkdir dir="${build.docs.printer}"/>
@@ -228,8 +197,7 @@
</java>
</target>
-->
-<!-- === Javadoc =============================================================
-->
-
+ <!-- === Javadoc
============================================================= -->
<!-- Check if javadocs have to be generated -->
<!-- Obsolete:
<target name="javadocs-check">
@@ -295,6 +263,4 @@
</target>
-->
-
-
</project>
