You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by si...@apache.org on 2002/04/18 16:33:07 UTC
cvs commit: jakarta-velocity-tools/xdocs index.xml menue.xml site.dvsl vellibrary-menue.xml vellibrary.xml
sidler 02/04/18 07:33:07
Modified: . build.xml
struts build.xml
struts/xdocs ErrorsTool.xml FormTool.xml LinkTool.xml
MessageTool.xml index.xml menue.xml userguide.xml
tools build.xml
tools/xdocs DateTool.xml MathTool.xml ParameterParser.xml
ToolLoader.xml
view build.xml
view/xdocs velservlet-menue.xml
xdocs index.xml menue.xml site.dvsl
Added: struts/xdocs StrutsTools.xml
tools/xdocs index.xml menue.xml
Removed: struts/xdocs tools.xml
xdocs vellibrary-menue.xml vellibrary.xml
Log:
Reorganized and simplified documentation and generation thereof:
- Simplified navigation and organization of documentation
- Removed absolute links
- Added printer-friendly versions of docs that are automatically generated and linked
- Draft at: http://www.teamup.com/jakarta-velocity-tools/docs/index.html
Revision Changes Path
1.5 +32 -52 jakarta-velocity-tools/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/build.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- build.xml 16 Apr 2002 14:09:06 -0000 1.4
+++ build.xml 18 Apr 2002 14:33:06 -0000 1.5
@@ -9,7 +9,7 @@
<!-- ========== External Dependencies ===================================== -->
<!-- the local repository -->
- <property name="project.repository" value="./lib" />
+ <property name="project.repository" value="./lib" />
<!-- ========== Component Declarations ==================================== -->
@@ -72,7 +72,6 @@
<target name="prepare" depends="init">
<!-- Prepare build directory -->
<mkdir dir="${docs.dest}/javadoc"/>
- <mkdir dir="${docs.dest}/javadoc-vellibrary"/>
</target>
<!-- ================================================================== -->
@@ -96,8 +95,6 @@
<delete dir="${docs.dest}/javadoc"/>
- <delete dir="${docs.dest}/javadoc-vellibrary"/>
-
<delete>
<fileset dir="${basedir}" includes="**/*.bak"/>
</delete>
@@ -118,14 +115,41 @@
<!-- ================================================================== -->
<!-- A L L -->
<!-- ================================================================== -->
- <target name="all" depends="clean,docs,javadocs,javadocs-vellibrary"
+ <target name="all" depends="clean,view,library,struts,docs,javadocs"
description="Build entire project, including all subprojects">
+
+ </target>
+
+
+ <!-- ================================================================== -->
+ <!-- V I E W -->
+ <!-- ================================================================== -->
+ <target name="view" depends=""
+ description="Build the 'view' subproject">
<!-- Build view package -->
<ant dir="view" target="all" inheritAll="false"/>
+
+ </target>
+
+
+ <!-- ================================================================== -->
+ <!-- L I B R A R Y -->
+ <!-- ================================================================== -->
+ <target name="library" depends="view"
+ description="Build the 'library' subproject">
<!-- Build library package -->
<ant dir="tools" target="all" inheritAll="false"/>
+
+ </target>
+
+
+ <!-- ================================================================== -->
+ <!-- S T R U T S -->
+ <!-- ================================================================== -->
+ <target name="struts" depends="view,library"
+ description="Build the 'struts' subproject">
<!-- Build struts package -->
<ant dir="struts" target="all" inheritAll="false"/>
@@ -136,7 +160,6 @@
</target>
-
<!-- ================================================================== -->
<!-- J A V A D O C S -->
<!-- ================================================================== -->
@@ -168,49 +191,10 @@
</target>
-
- <!-- ================================================================== -->
- <!-- J A V A D O C S V E L L I B R A R Y -->
- <!-- ================================================================== -->
- <target name="javadocs-vellibrary" depends="static"
- description="Create Javadoc documentation for VelocityLibrary subproject, only public members">
-
-
- <!-- Construct compile classpath -->
- <path id="sourcepath">
- <pathelement path="view/src/java/"/>
- <pathelement path="struts/src/java/"/>
- <pathelement path="tools/src/java/"/>
- </path>
-
- <javadoc sourcepathref="sourcepath"
- destdir="${docs.dest}/javadoc-vellibrary"
- author="true"
- public="true"
- version="true"
- doctitle="<h1>${project.title}</h1>"
- windowtitle="${project.title} (Version ${project.version})"
- bottom="Copyright (c) 2002 Apache Software Foundation" >
-
- <package name="org.apache.velocity.tools.tools"/>
- <package name="org.apache.velocity.tools.struts"/>
- <package name="org.apache.velocity.tools.view.tools"/>
- <package name="org.apache.velocity.tools.view.context"/>
-
- <group title="View Tools" packages="org.apache.velocity.tools.tools:org.apache.velocity.tools.struts"/>
- <group title="View Tools Infrastructure" packages="org.apache.velocity.tools.view.tools:org.apache.velocity.tools.view.context"/>
-
- <classpath refid="classpath"/>
-
- </javadoc>
- </target>
-
-
-
<!-- ================================================================== -->
<!-- D O C S -->
<!-- ================================================================== -->
- <target name="docs"
+ <target name="docs" depends="static"
description="Generate documentation into ${docs.dest}">
<taskdef name="dvsl" classname="org.apache.tools.dvsl.DVSLTask">
@@ -228,15 +212,11 @@
extension=".html"
style="xdocs/site.dvsl"
excludes="*menue.xml"
- includes="**/*.xml"
+ includes="*.xml"
/>
- <replace dir="${docs.dest}">
- <replacefilter token="@@@version@@@" value="${project.version}"/>
- <replacefilter token="@@@date@@@" value="${project.date}"/>
- </replace>
-
</target>
+
</project>
1.8 +15 -0 jakarta-velocity-tools/struts/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/build.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- build.xml 16 Apr 2002 14:09:06 -0000 1.7
+++ build.xml 18 Apr 2002 14:33:06 -0000 1.8
@@ -220,6 +220,7 @@
</taskdef>
+ <!-- create browser version of documentaiton -->
<dvsl
basedir="${docs.src}"
destdir="${docs.dest}/"
@@ -228,6 +229,20 @@
style="${basedir}/../xdocs/site.dvsl"
excludes="*menue.xml"
includes="**/*.xml">
+ <tool name="toolbox.string.LinkToPrinterFriendlyVersion" value="yes" />
+ <tool name="toolbox.string.basedir" value="${basedir}" />
+ </dvsl>
+
+ <!-- create printer version of documentation -->
+ <dvsl
+ basedir="${docs.src}"
+ destdir="${docs.dest}/"
+ toolboxfile="${basedir}/../xdocs/toolbox.props"
+ extension="-printer.html"
+ style="${basedir}/../xdocs/site.dvsl"
+ excludes="*menue.xml"
+ includes="**/*.xml">
+ <tool name="toolbox.string.PrinterFriendlyVersion" value="yes" />
<tool name="toolbox.string.basedir" value="${basedir}" />
</dvsl>
1.2 +1 -1 jakarta-velocity-tools/struts/xdocs/ErrorsTool.xml
Index: ErrorsTool.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/ErrorsTool.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ErrorsTool.xml 2 Apr 2002 16:46:30 -0000 1.1
+++ ErrorsTool.xml 18 Apr 2002 14:33:06 -0000 1.2
@@ -5,7 +5,7 @@
<properties>
<title>ErrorsTool</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
- <projectfile>../xdocs/vellibrary-menue.xml</projectfile>
+ <projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
1.2 +7 -4 jakarta-velocity-tools/struts/xdocs/FormTool.xml
Index: FormTool.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/FormTool.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FormTool.xml 2 Apr 2002 16:46:30 -0000 1.1
+++ FormTool.xml 18 Apr 2002 14:33:06 -0000 1.2
@@ -5,7 +5,7 @@
<properties>
<title>FormTool</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
- <projectfile>../xdocs/vellibrary-menue.xml</projectfile>
+ <projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
@@ -110,7 +110,8 @@
<p>This produces the following output:</p>
-<sourcecode><input type="submit" name="org.apache.struts.taglib.html.CANCEL" value="Cancel"></sourcecode>
+<sourcecode><input type="submit" name="org.apache.struts.taglib.html.CANCEL"
+value="Cancel"></sourcecode>
</description>
@@ -165,10 +166,12 @@
<description>
<sourcecode>## A hidden form field with the transaction token
-<input type="hidden" name="$form.getTokenName()" value="$form.getToken()">
+<input type="hidden" name="$form.getTokenName()"
+value="$form.getToken()">
## Can also be written as
-<input type="hidden" name="$form.tokenName()" value="$form.token()"></sourcecode>
+<input type="hidden" name="$form.tokenName()"
+value="$form.token()"></sourcecode>
<p>This produces output similar to:</p>
1.3 +1 -1 jakarta-velocity-tools/struts/xdocs/LinkTool.xml
Index: LinkTool.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/LinkTool.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- LinkTool.xml 15 Apr 2002 12:49:05 -0000 1.2
+++ LinkTool.xml 18 Apr 2002 14:33:06 -0000 1.3
@@ -5,7 +5,7 @@
<properties>
<title>LinkTool</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
- <projectfile>../xdocs/vellibrary-menue.xml</projectfile>
+ <projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
1.3 +1 -1 jakarta-velocity-tools/struts/xdocs/MessageTool.xml
Index: MessageTool.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/MessageTool.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- MessageTool.xml 3 Apr 2002 15:47:25 -0000 1.2
+++ MessageTool.xml 18 Apr 2002 14:33:06 -0000 1.3
@@ -5,7 +5,7 @@
<properties>
<title>MessageTool</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
- <projectfile>../xdocs/vellibrary-menue.xml</projectfile>
+ <projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
1.5 +1 -1 jakarta-velocity-tools/struts/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/index.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.xml 15 Apr 2002 18:30:28 -0000 1.4
+++ index.xml 18 Apr 2002 14:33:06 -0000 1.5
@@ -3,7 +3,7 @@
<document>
<properties>
- <title>Project VelocityStruts</title>
+ <title>Overview</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
<projectfile>xdocs/menue.xml</projectfile>
</properties>
1.4 +23 -20 jakarta-velocity-tools/struts/xdocs/menue.xml
Index: menue.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/menue.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- menue.xml 15 Apr 2002 18:30:28 -0000 1.3
+++ menue.xml 18 Apr 2002 14:33:06 -0000 1.4
@@ -2,38 +2,41 @@
<project href="http://jakarta.apache.org/velocity">
- <title>Math</title>
+ <title>VelocityStruts</title>
<logo href="http://jakarta.apache.org/velocity/images/logo.gif"> < :) /></logo>
<body>
- <uplink name="Velocity Tools Home" href="docs/index.html" alt="top"/>
+ <uplink name="Velocity Tools Home" href="../../docs/index.html" alt="top"/>
<menu name="About VelocityStruts">
- <item name="Overview" href="struts/docs/index.html"/>
- <item name="Documentation" href="struts/docs/index.html#Documentation"/>
- <item name="Download" href="struts/docs/index.html#Download"/>
- <item name="License" href="struts/docs/index.html#License"/>
+ <item name="Overview" href="index.html"/>
+ <item name="Documentation" href="#Documentation"/>
+ <item name="Download" href="#Download"/>
+ <item name="License" href="#License"/>
</menu>
<menu name="VelocityStruts User Guide">
- <item name="Overview" href="struts/docs/userguide.html"/>
- <item name="Documentation" href="struts/docs/userguide.html#Documentation"/>
- <item name="Model 2 Applications" href="struts/docs/userguide.html#Model 2 Applications"/>
- <item name="Velocity Context" href="struts/docs/userguide.html#Velocity Context"/>
- <item name="View Tools" href="struts/docs/userguide.html#View Tools"/>
- <item name="Velocity and JSP" href="struts/docs/userguide.html#Velocity and JSP"/>
- <item name="Velocity vs. JSP" href="struts/docs/userguide.html#Velocity vs. JSP"/>
- <item name="Velocity Configuration" href="struts/docs/userguide.html#Velocity Configuration"/>
- <item name="Velocity Configuration" href="struts/docs/userguide.html#Velocity Configuration"/>
+ <item name="Overview" href="userguide.html"/>
+ <item name="Documentation" href="userguide.html#Documentation"/>
+ <item name="Model 2 Applications" href="userguide.html#Model 2 Applications"/>
+ <item name="Velocity Context" href="userguide.html#Velocity Context"/>
+ <item name="View Tools" href="userguide.html#View Tools"/>
+ <item name="Velocity and JSP" href="userguide.html#Velocity and JSP"/>
+ <item name="Velocity vs. JSP" href="userguide.html#Velocity vs. JSP"/>
+ <item name="Velocity Configuration" href="userguide.html#Velocity Configuration"/>
+ <item name="Velocity Configuration" href="userguide.html#Velocity Configuration"/>
</menu>
- <menu name="VelocityStruts Reference Doc" href="struts/docs/tools.html" target="velLibrary">
- <item name="ErrorsTool" href="struts/docs/ErrorsTool.html" target="velLibrary"/>
- <item name="FormTool" href="struts/docs/FormTool.html" target="velLibrary"/>
- <item name="LinkTool" href="struts/docs/LinkTool.html" target="velLibrary"/>
- <item name="MessageTool" href="struts/docs/MessageTool.html" target="velLibrary"/>
+ <menu name="VelocityStruts Tool Reference" href="StrutsTools.html">
+ <item name="ErrorsTool" href="ErrorsTool.html"/>
+ <item name="FormTool" href="FormTool.html"/>
+ <item name="LinkTool" href="LinkTool.html"/>
+ <item name="MessageTool" href="MessageTool.html"/>
</menu>
+
+ <printerversion/>
+
</body>
</project>
1.3 +1 -1 jakarta-velocity-tools/struts/xdocs/userguide.xml
Index: userguide.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/userguide.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- userguide.xml 15 Apr 2002 18:30:28 -0000 1.2
+++ userguide.xml 18 Apr 2002 14:33:06 -0000 1.3
@@ -3,7 +3,7 @@
<document>
<properties>
- <title>Velocity for Struts - User Guide</title>
+ <title>User Guide</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
<projectfile>xdocs/menue.xml</projectfile>
</properties>
1.1 jakarta-velocity-tools/struts/xdocs/StrutsTools.xml
Index: StrutsTools.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Tools Reference</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
<projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
<section name="VelocityStruts - Reference Documentation">
<p>
VelocityStruts includes four view tools that provide access
to Struts resources from within Velocity templates. This page is the
starting point to the reference documentation for the view tools.
Primary audience are the template designers.</p>
<p>
Velocity for Struts currently supports the follwing four tools:
</p>
<p>
<strong><a href="MessageTool.html">MessageTool</a></strong><br />
Provides access to the Struts message resources for internationalized output.
</p>
<p>
<strong><a href="ErrorsTool.html">ErrorsTool</a></strong><br />
Provides methods to work with Struts error messages.
</p>
<p>
<strong><a href="FormTool.html">FormTool</a></strong><br />
Provides miscellaneous methods to work with forms and form beans in the context
of Struts applications.
</p>
<p>
<strong><a href="LinkTool.html">LinkTool</a></strong><br />
Provides methods to work with URIs.
</p>
<p>
<strong>ActionMessagesTool</strong><br/>
Provides methods to work with Struts action messages, a new feature in the
upcoming 1.1. release. Will be added shortly.
</p>
</section>
</body>
</document>
1.4 +75 -49 jakarta-velocity-tools/tools/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/build.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- build.xml 16 Apr 2002 14:09:07 -0000 1.3
+++ build.xml 18 Apr 2002 14:33:06 -0000 1.4
@@ -3,9 +3,9 @@
<!-- ========== Initialize Properties ===================================== -->
- <property file="${basedir}/build/build.properties"/> <!-- Component local -->
- <property file="${basedir}/../build.properties"/> <!-- Commons local -->
- <property file="${user.home}/.build.properties"/> <!-- User local -->
+ <property file="${basedir}/build/build.properties"/> <!-- Component local -->
+ <property file="${basedir}/../build.properties"/> <!-- Commons local -->
+ <property file="${user.home}/.build.properties"/> <!-- User local -->
<!-- ========== External Dependencies ===================================== -->
@@ -106,24 +106,13 @@
</copy>
</target>
+
<!-- ================================================================== -->
- <!-- C O M P I L E -->
+ <!-- A L L -->
<!-- ================================================================== -->
- <target name="compile" depends="static" description="Compile">
-
- <javac srcdir="${source.home}/java"
- destdir="${build.home}/classes"
- debug="${compile.debug}"
- deprecation="${compile.deprecation}"
- optimize="${compile.optimize}">
- <classpath refid="classpath"/>
- </javac>
-
- <copy todir="${build.home}/classes" filtering="on">
- <fileset dir="${source.home}/java" excludes="**/*.java"/>
- </copy>
+ <target name="all" depends="clean,jar,install-jar,docs,javadocs"
+ description="Build entire project"/>
- </target>
<!-- ================================================================== -->
<!-- C L E A N -->
@@ -155,27 +144,52 @@
<!-- ================================================================== -->
- <!-- A L L -->
+ <!-- C O M P I L E -->
<!-- ================================================================== -->
- <target name="all" depends="clean,jar,install-jar,docs,javadocs"
- description="Build entire project"/>
+ <target name="compile" depends="static" description="Compile">
+
+ <javac srcdir="${source.home}/java"
+ destdir="${build.home}/classes"
+ debug="${compile.debug}"
+ deprecation="${compile.deprecation}"
+ optimize="${compile.optimize}">
+ <classpath refid="classpath"/>
+ </javac>
+
+ <copy todir="${build.home}/classes" filtering="on">
+ <fileset dir="${source.home}/java" excludes="**/*.java"/>
+ </copy>
+
+ </target>
<!-- ================================================================== -->
<!-- J A V A D O C S -->
<!-- ================================================================== -->
- <target name="javadocs" depends="compile"
- description="Create Javadoc documentation">
+ <target name="javadocs" depends="static"
+ description="Create Javadoc documentation, public members only">
- <javadoc sourcepath="${source.home}/java"
- destdir="${build.home}/javadoc"
- packagenames="org.apache.velocity.tools.tools.*"
- author="true"
- private="true"
- version="true"
- doctitle="<h1>${project.title}</h1>"
- windowtitle="${project.title} (Version ${project.version})"
- bottom="Copyright (c) 2002 Apache Software Foundation" >
+ <!-- Construct compile classpath -->
+ <path id="sourcepath">
+ <pathelement path="${basedir}/../view/src/java/"/>
+ <pathelement path="${basedir}/src/java/"/>
+ </path>
+
+ <javadoc sourcepathref="sourcepath"
+ destdir="${docs.dest}/javadoc"
+ author="true"
+ public="true"
+ version="true"
+ doctitle="<h1>${project.title}</h1>"
+ windowtitle="${project.title} (Version ${project.version})"
+ bottom="Copyright (c) 2002 Apache Software Foundation" >
+
+ <package name="org.apache.velocity.tools.tools"/>
+ <package name="org.apache.velocity.tools.view.tools"/>
+ <package name="org.apache.velocity.tools.view.context"/>
+
+ <group title="View Tools" packages="org.apache.velocity.tools.tools"/>
+ <group title="View Tools Infrastructure" packages="org.apache.velocity.tools.view.tools:org.apache.velocity.tools.view.context"/>
<classpath refid="classpath"/>
@@ -194,6 +208,21 @@
<!-- ================================================================== -->
+ <!-- I N S T A L L J A R -->
+ <!-- ================================================================== -->
+ <target name="install-jar" depends="jar"
+ description="--> Installs .jar file in ${project.repository}">
+
+ <copy todir="${project.repository}" filtering="no">
+ <fileset dir="${basedir}">
+ <include name="${project.name}-${project.version}.jar"/>
+ </fileset>
+ </copy>
+
+ </target>
+
+
+ <!-- ================================================================== -->
<!-- D O C S -->
<!-- ================================================================== -->
<target name="docs">
@@ -214,6 +243,20 @@
style="${basedir}/../xdocs/site.dvsl"
excludes="*menue.xml"
includes="**/*.xml">
+ <tool name="toolbox.string.LinkToPrinterFriendlyVersion" value="yes" />
+ <tool name="toolbox.string.basedir" value="${basedir}" />
+ </dvsl>
+
+ <!-- create printer version of documentation -->
+ <dvsl
+ basedir="${docs.src}"
+ destdir="${docs.dest}/"
+ toolboxfile="${basedir}/../xdocs/toolbox.props"
+ extension="-printer.html"
+ style="${basedir}/../xdocs/site.dvsl"
+ excludes="*menue.xml"
+ includes="**/*.xml">
+ <tool name="toolbox.string.PrinterFriendlyVersion" value="yes" />
<tool name="toolbox.string.basedir" value="${basedir}" />
</dvsl>
@@ -222,24 +265,7 @@
<replacefilter token="@@@date@@@" value="${project.date}"/>
</replace>
-
- </target>
-
-
- <!-- ================================================================== -->
- <!-- I N S T A L L J A R -->
- <!-- ================================================================== -->
- <target name="install-jar" depends="jar"
- description="--> Installs .jar file in ${project.repository}">
-
- <copy todir="${project.repository}" filtering="no">
- <fileset dir="${basedir}">
- <include name="${project.name}-${project.version}.jar"/>
- </fileset>
- </copy>
-
</target>
-
</project>
1.2 +1 -1 jakarta-velocity-tools/tools/xdocs/DateTool.xml
Index: DateTool.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/xdocs/DateTool.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DateTool.xml 3 Apr 2002 09:10:03 -0000 1.1
+++ DateTool.xml 18 Apr 2002 14:33:07 -0000 1.2
@@ -5,7 +5,7 @@
<properties>
<title>DateTool</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
- <projectfile>../xdocs/vellibrary-menue.xml</projectfile>
+ <projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
1.2 +1 -1 jakarta-velocity-tools/tools/xdocs/MathTool.xml
Index: MathTool.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/xdocs/MathTool.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MathTool.xml 3 Apr 2002 09:10:03 -0000 1.1
+++ MathTool.xml 18 Apr 2002 14:33:07 -0000 1.2
@@ -5,7 +5,7 @@
<properties>
<title>MathTool</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
- <projectfile>../xdocs/vellibrary-menue.xml</projectfile>
+ <projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
1.3 +1 -1 jakarta-velocity-tools/tools/xdocs/ParameterParser.xml
Index: ParameterParser.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/xdocs/ParameterParser.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ParameterParser.xml 15 Apr 2002 18:30:29 -0000 1.2
+++ ParameterParser.xml 18 Apr 2002 14:33:07 -0000 1.3
@@ -5,7 +5,7 @@
<properties>
<title>ParameterParser</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
- <projectfile>../xdocs/vellibrary-menue.xml</projectfile>
+ <projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
1.3 +1 -1 jakarta-velocity-tools/tools/xdocs/ToolLoader.xml
Index: ToolLoader.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/xdocs/ToolLoader.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ToolLoader.xml 15 Apr 2002 18:30:29 -0000 1.2
+++ ToolLoader.xml 18 Apr 2002 14:33:07 -0000 1.3
@@ -5,7 +5,7 @@
<properties>
<title>ToolLoader</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
- <projectfile>../xdocs/vellibrary-menue.xml</projectfile>
+ <projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
1.1 jakarta-velocity-tools/tools/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Project VelocityLibrary</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
<projectfile>xdocs/menue.xml</projectfile>
</properties>
<body>
<section name="Welcome to the VelocityLibrary Project">
<p>VelocityLibrary is a Velocity subproject that aims to build of collection
of reusable and well documented view tools.</p>
<p>Emphasis is being put on providing tool documentation that is
suitable for template designers. To achive this goal, a documenation
format has been defined that captures all information relevant to the
template designer. It is being supplied in addition to the customary
Javadoc. This should help to achive what we always claim for Velocity:
"Decouple the work of template designers from the work of software
developers". Look at the <a href="../../struts/docs/MessageTool.html">Struts MessageTool</a> for a good example of the
new documentation format. We are keen on your feedback. </p>
<p>Your contribution of useful view tools to the VelocityLibrary
project are welcome. See <a href="#Contributions">below</a> for more details.</p>
<p><strong>VelocityLibrary Content:</strong></p>
<dl>
<dt><a href="../tools/docs/DateTool.html"><strong>DateTool</strong></a></dt>
<dd>A tool for manipulating and formating dates.</dd>
<dt><a href="../tools/docs/MathTool.html"><strong>MathTool</strong></a></dt>
<dd>A tool for performing floating point math.</dd>
<dt><a href="../tools/docs/ParameterParser.html"><strong>ParameterParser</strong></a></dt>
<dd>A tool for easy parsing of servlet request parameters.</dd>
<dt><a href="../tools/docs/ToolLoader.html"><strong>ToolLoader</strong></a></dt>
<dd>A tool allowing template designers to load view tools
from within the template.</dd>
</dl>
</section>
<section name="Download">
<p>There is no release available at this point in time.</p>
<pre> </pre>
</section>
<section name="Contributions">
<p>We welcome your contributions to this library. Please post your offer
to contribute a tool to the
<a href="mailto:velocity-user@jakarta.apache.org">Velocity mailing list</a>.</p>
<p><strong>Checklist for Contributions</strong></p>
<ul>
<li><a href="http://jakarta.apache.org/velocity/code-standards.html">Velocity coding conventions</a></li>
<li>JavaDoc included (the more detailed the better)</li>
<li>Examples included (in JavaDoc or as stand-alone template example)</li>
</ul>
</section>
</body>
</document>
1.1 jakarta-velocity-tools/tools/xdocs/menue.xml
Index: menue.xml
===================================================================
<?xml version="1.0"?>
<project href="http://jakarta.apache.org/velocity/">
<title>Velocity Tools Menue</title>
<logo href="http://jakarta.apache.org/velocity/images/logo.gif">< :) /></logo>
<body>
<uplink name="Velocity Tools Home" href="../../docs/index.html" alt="top"/>
<menu name="About VelocityLibrary">
<item name="Overview" href="index.html"/>
<item name="Download" href="index.html#Download"/>
<item name="Contributions" href="index.html#Contributions"/>
</menu>
<menu name="VelocityLibrary Documentation">
<item name="DateTool" href="DateTool.html"/>
<item name="MathTool" href="MathTool.html"/>
<item name="ParameterParser" href="ParameterParser.html"/>
<item name="ToolLoader" href="ToolLoader.html"/>
</menu>
<printerversion/>
</body>
</project>
1.10 +21 -1 jakarta-velocity-tools/view/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/build.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- build.xml 16 Apr 2002 14:09:07 -0000 1.9
+++ build.xml 18 Apr 2002 14:33:07 -0000 1.10
@@ -234,16 +234,36 @@
</taskdef>
+ <!-- create browser version of documentaiton -->
<dvsl
basedir="${docs.src}"
destdir="${docs.dest}/"
toolboxfile="${basedir}/../xdocs/toolbox.props"
extension=".html"
style="${basedir}/../xdocs/site.dvsl"
- excludes="**/*menue.xml"
+ excludes="*menue.xml"
includes="**/*.xml">
+ <tool name="toolbox.string.LinkToPrinterFriendlyVersion" value="yes" />
<tool name="toolbox.string.basedir" value="${basedir}" />
</dvsl>
+
+ <!-- create printer version of documentation -->
+ <dvsl
+ basedir="${docs.src}"
+ destdir="${docs.dest}/"
+ toolboxfile="${basedir}/../xdocs/toolbox.props"
+ extension="-printer.html"
+ style="${basedir}/../xdocs/site.dvsl"
+ excludes="*menue.xml"
+ includes="**/*.xml">
+ <tool name="toolbox.string.PrinterFriendlyVersion" value="yes" />
+ <tool name="toolbox.string.basedir" value="${basedir}" />
+ </dvsl>
+
+ <replace dir="${docs.dest}">
+ <replacefilter token="@@@version@@@" value="${project.version}"/>
+ <replacefilter token="@@@date@@@" value="${project.date}"/>
+ </replace>
</target>
1.3 +5 -3 jakarta-velocity-tools/view/xdocs/velservlet-menue.xml
Index: velservlet-menue.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/xdocs/velservlet-menue.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- velservlet-menue.xml 4 Apr 2002 09:18:56 -0000 1.2
+++ velservlet-menue.xml 18 Apr 2002 14:33:07 -0000 1.3
@@ -7,16 +7,18 @@
<body>
- <uplink name="Velocity Tools Home" href="docs/index.html" alt="top"/>
+ <uplink name="Velocity Tools Home" href="../../docs/index.html" alt="top"/>
<menu name="About VelocityServlet">
- <item name="Overview" href="view/docs/velservlet.html"/>
+ <item name="Overview" href="velservlet.html"/>
<item name="Examples"/>
<item name="Servlet Configuration"/>
<item name="Toolbox Configuration"/>
<item name="Download"/>
- <item name="Javadoc" href="view/docs/javadoc-velservlet/index.html"/>
+ <item name="Javadoc" href="javadoc-velservlet/index.html"/>
</menu>
+
+ <printerversion/>
</body>
</project>
1.4 +1 -1 jakarta-velocity-tools/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 15 Apr 2002 18:30:30 -0000 1.3
+++ index.xml 18 Apr 2002 14:33:07 -0000 1.4
@@ -22,7 +22,7 @@
<p><strong>Subprojects</strong></p>
<dl>
- <dt><strong><a href="vellibrary.html">VelocityLibrary</a></strong></dt>
+ <dt><strong><a href="../tools/docs/index.html">VelocityLibrary</a></strong></dt>
<dd>VelocityLibrary is an effort to setup a library of reuseable and well documented
view tools. Most tools are optimized for use with an automatically managed
toolbox (see VelocityServlet).</dd>
1.3 +5 -5 jakarta-velocity-tools/xdocs/menue.xml
Index: menue.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/menue.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- menue.xml 4 Apr 2002 09:18:56 -0000 1.2
+++ menue.xml 18 Apr 2002 14:33:07 -0000 1.3
@@ -8,14 +8,14 @@
<body>
<menu name="About">
- <item name="Overview" href="docs/index.html"/>
- <item name="CVS Repository" href="docs/index.html#CVS Repository"/>
+ <item name="Overview" href="index.html"/>
+ <item name="CVS Repository" href="index.html#CVS Repository"/>
</menu>
<menu name="Subprojects">
- <item name="VelocityLibrary" href="docs/vellibrary.html"/>
- <item name="VelocityStruts" href="struts/docs/index.html"/>
- <item name="VelocityServlet" href="view/docs/velservlet.html"/>
+ <item name="VelocityLibrary" href="../tools/docs/index.html"/>
+ <item name="VelocityStruts" href="../struts/docs/index.html"/>
+ <item name="VelocityServlet" href="../view/docs/velservlet.html"/>
</menu>
</body>
1.6 +158 -109 jakarta-velocity-tools/xdocs/site.dvsl
Index: site.dvsl
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/site.dvsl,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- site.dvsl 16 Apr 2002 14:09:07 -0000 1.5
+++ site.dvsl 18 Apr 2002 14:33:07 -0000 1.6
@@ -1,7 +1,42 @@
+##
+## DVSL style sheet for velocity-tools project
+##
+##
+## The style sheet looks for the following configuration parameters:
+##
+## $context.toolbox.basedir
+## Its value is expected to be the path to the base directory of
+## this documentation set. It can be used to reference other files,
+## for example a menue file that is to be loaded.
+##
+## $context.toolbox.PrinterFriendlyVersion
+## If its value is "yes", the generated page has no left-hand menue.
+## This facilitates the printing of documentation.
+##
+## $context.toolbox.LinkToPrinterFriendlyVersion
+## If its value is "yes", a link to a printer-friendly version of
+## the same document is added to the end of the left-hand menue.
+## The file name of the printer-frienly document is derived from the
+## the name of the current template in the following way:
+## filename.html becomes filename-printer.html
+##
+##
+## Shown below is a configuration example of an ant task:
+## <!-- create printer version of documentation -->
+## <dvsl
+## basedir="${docs.src}"
+## destdir="${docs.dest}/"
+## toolboxfile="${basedir}/../xdocs/toolbox.props"
+## extension="-printer.html"
+## style="${basedir}/../xdocs/site.dvsl"
+## excludes="*menue.xml"
+## includes="**/*.xml">
+## <tool name="toolbox.string.PrinterFriendlyVersion" value="yes" />
+## <tool name="toolbox.string.basedir" value="${basedir}" />
+## </dvsl>
+##
-#set( $relative-path = "file://C:/Users/Sidler/VelTools/jakarta-velocity-tools/" )
-
#set( $body-bg = '#ffffff' )
#set( $body-fg = '#000000' )
#set( $body-link = '#525D76' )
@@ -31,7 +66,7 @@
<meta name="author" value="$n"/>
<meta name="email" value="$n.attribute("email")" />
#end
-
+
</head>
@@ -73,14 +108,19 @@
<tr>
## LEFT SIDE NAVIGATION
+ #if ($context.toolbox.PrinterFriendlyVersion.equals("yes"))
+ <td> </td>
+ #else
<td width="20%" valign="top" nowrap="true">
- $context.applyTemplates( $project, "body/toplink" )
- $context.applyTemplates( $project, "body/uplink" )
- $context.applyTemplates( $project, "body/menu" )
+ $context.applyTemplates( $project, "body/toplink" )
+ $context.applyTemplates( $project, "body/uplink" )
+ $context.applyTemplates( $project, "body/menu" )
+ $context.applyTemplates( $project, "body/printerversion" )
</td>
+ #end
<!-- RIGHT SIDE MAIN BODY -->
- <td colspan="1" width="80%" valign="top" align="left">
+ <td colspan="1" valign="top" align="left">
$context.applyTemplates("body/section")
</td>
@@ -110,16 +150,16 @@
* Process a menu for the navigation bar
*#
#match( "menu" )
- <p>
- #if ($attrib.href)
- <a href="${relative-path}$attrib.href"><strong>$attrib.name</strong></a>
- #else
- <strong>$attrib.name</strong>
- #end
- </p>
- <ul>
- $context.applyTemplates()
- </ul>
+<p>
+#if ($attrib.href)
+ <a href="$attrib.href"><strong>$attrib.name</strong></a>
+#else
+ <strong>$attrib.name</strong>
+#end
+</p>
+<ul>
+ $context.applyTemplates()
+</ul>
#end
@@ -127,16 +167,15 @@
* Process a submenu for the navigation bar
*#
#match( "submenu" )
-
- #if ($attrib.href)
- <li><a href="${relative-path}$attrib.href">$attrib.name</a>
- #else
- <li>$attrib.name
- #end
- <ul>
- $context.applyTemplates("item")
- </ul>
- </li>
+#if ($attrib.href)
+ <li><a href="$attrib.href">$attrib.name</a>
+#else
+ <li>$attrib.name
+#end
+ <ul>
+ $context.applyTemplates("item")
+ </ul>
+</li>
#end
@@ -144,11 +183,11 @@
* Process a menu item for the navigation bar
*#
#match( "item" )
- #if ($attrib.href)
- <li><a href="${relative-path}$attrib.href">$attrib.name</a></li>
- #else
- <li>$attrib.name</li>
- #end
+#if ($attrib.href)
+ <li><a href="$attrib.href">$attrib.name</a></li>
+#else
+ <li>$attrib.name</li>
+#end
#end
@@ -156,45 +195,63 @@
* Process a link to one layer above in the navigation hierarchy
*#
#match( "uplink" )
- <p><strong><a href="${relative-path}$attrib.href">$attrib.name</a></strong></p>
+ <p><strong><a href="$attrib.href">$attrib.name</a></strong></p>
#end
#*
- * process a documentation section
+ * Insert a link to a printerfriendly version of the document
*#
-#match( "section" )
-
- <table border="0" cellspacing="0" cellpadding="2" width="100%">
-
- <tr><td bgcolor="$banner-bg">
- <font color="$banner-fg" face="arial,helvetica.sanserif">
- <a name="$attrib.name">
- <strong>$attrib.name</strong></a></font>
- </td></tr>
+#match( "printerversion" )
+<p>
+#if ($context.toolbox.LinkToPrinterFriendlyVersion.equals("yes"))
+<strong><a href="$context.getAppValue('infilename').substring(0, $context.getAppValue('infilename').lastIndexOf("."))-printer.html">Printer-friendly Version</a></strong>
+#end
+</p>
+#end
- <tr><td><blockquote>
- $context.applyTemplates("*")
- </blockquote></td></tr>
- </table>
+#*
+ * process a documentation section
+ *#
+#match( "section" )
+<table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr>
+ <td colspan="2" bgcolor="$banner-bg">
+ <font color="$banner-fg" face="arial,helvetica.sanserif">
+ <a name="$attrib.name">
+ <strong>$attrib.name</strong></a></font>
+ </td>
+ </tr>
+ <tr>
+ <td NOWRAP> </td>
+ <td>
+ $context.applyTemplates("*")
+ </td>
+ </tr>
+</table>
#end
-#match( "subsection" )
-
- <table border="0" cellspacing="0" cellpadding="2" width="100%">
- <!-- Subsection heading -->
- <tr><td bgcolor="$sub-banner-bg">
- <font color="$sub-banner-fg" face="arial,helvetica.sanserif">
- <a name="$attrib.name">
- <strong>$attrib.name</strong></a></font>
- </td></tr>
- <!-- Subsection body -->
- <tr><td><blockquote>
- $context.applyTemplates("*")
- </blockquote></td></tr>
- </table>
+#*
+ * process a documentation subsection
+ *#
+#match( "subsection" )
+<table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr>
+ <td colspan="2" bgcolor="$sub-banner-bg">
+ <font color="$sub-banner-fg" face="arial,helvetica.sanserif">
+ <a name="$attrib.name">
+ <strong>$attrib.name</strong></a></font>
+ </td>
+ </tr>
+ <tr>
+ <td NOWRAP> </td>
+ <td>
+ $context.applyTemplates("*")
+ </td>
+ </tr>
+</table>
#end
@@ -205,7 +262,7 @@
#match( "method" )
$context.applyTemplates("*")
- <p></p>
+ <br clear="all">
#end
#*
@@ -272,13 +329,12 @@
* process a 'see' tag of a method documentation
*#
#match( "see" )
- <dl>
- <dt><strong>See Also</strong></dt>
- <dd>
- $node.copy()
- </dd>
- </dl>
-
+<dl>
+ <dt><strong>See Also</strong></dt>
+ <dd>
+ $node.copy()
+ </dd>
+</dl>
#end
#*
@@ -293,27 +349,26 @@
* process a 'toolinfo' block
*#
#match( "toolinfo" )
- <table cellpadding="0" cellspacing="0">
- <tr><td colspan="2"><strong>Version</strong></td></tr>
- <tr><td> </td><td>$node.version.value()</td></tr>
-
- <tr><td colspan="2"><strong>JAR</strong></td></tr>
- <tr><td> </td><td>$node.jar.value()</td></tr>
-
- <tr><td colspan="2"><strong>Class</strong></td></tr>
- <tr><td> </td><td>$node.clazz.value()</td></tr>
-
- <tr><td colspan="2"><strong>Name</strong></td></tr>
- <tr><td> </td><td>$node.name.value() (this is the recommended name of the tool in
- the Velocity context)</td></tr>
-
- <tr><td colspan="2"><strong>Toolbox Configuration Example</strong></td></tr>
- <tr><td> </td><td><pre>$node.copy($node.config-example.children())</pre></td></tr>
-
- <tr><td colspan="2"><strong>Author(s)</strong></td></tr>
- <tr><td> </td><td>#foreach($n in $node.selectNodes("author"))<a href="mailto:$n.attribute("email")">$n</a><br>#end</td></tr>
- </table>
-
+<table cellpadding="0" cellspacing="0">
+ <tr><td colspan="2"><strong>Version</strong></td></tr>
+ <tr><td> </td><td>$node.version.value()</td></tr>
+
+ <tr><td colspan="2"><strong>JAR</strong></td></tr>
+ <tr><td> </td><td>$node.jar.value()</td></tr>
+
+ <tr><td colspan="2"><strong>Class</strong></td></tr>
+ <tr><td> </td><td>$node.clazz.value()</td></tr>
+
+ <tr><td colspan="2"><strong>Name</strong></td></tr>
+ <tr><td> </td><td>$node.name.value() (this is the recommended name of the tool in
+ the Velocity context)</td></tr>
+
+ <tr><td colspan="2"><strong>Toolbox Configuration Example</strong></td></tr>
+ <tr><td> </td><td><pre>$node.copy($node.config-example.children())</pre></td></tr>
+
+ <tr><td colspan="2"><strong>Author(s)</strong></td></tr>
+ <tr><td> </td><td>#foreach($n in $node.selectNodes("author"))<a href="mailto:$n.attribute("email")">$n</a><br>#end</td></tr>
+</table>
#end
@@ -322,7 +377,9 @@
* process a 'methods' block. Generates a list of methods.
*#
#match( "methods" )
- <strong>Method Overview</strong>
+<dl>
+ <dt><strong>Method Overview</strong></dt>
+ <dd>
<table cellpadding="2" cellspacing="2" border="0">
#foreach ($s in $document.body.selectNodes("section") )
#if ($s.method)
@@ -336,35 +393,27 @@
#end
#end
</table>
+ </dd>
+</dl>
#end
#*
- * process a 'atest' block.
+ * process a 'sourcecode' block.
*#
-#match( "atest" )
- <p>Beginning of List</p>
- #foreach ($i in [1, 2, 3, 4, 5])
- Current index is: $i<br/>
- #end
- <p>End of list</p>
-#end
-
-
-
-
#match( "sourcecode" )
- <table width="80%" cellpadding="1" cellspacing="0" border="0"><tr><td bgcolor="#000000">
- <table width="100%" cellpadding="5" cellspacing="0" border="0"><tr><td bgcolor="#FFFFFF">
- <pre>$node.copy()</pre>
- </td></tr></table>
+<table width="100%" cellpadding="1" cellspacing="0" border="0"><tr><td bgcolor="#000000">
+ <table width="100%" cellpadding="5" cellspacing="0" border="0"><tr><td bgcolor="#FFFFFF">
+ <pre>$node.copy()</pre>
</td></tr></table>
+</td></tr></table>
#end
-
+#*
+ * process a 'source' block.
+ *#
#match( "source" )
-
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>