|
From: <be...@us...> - 2006-09-21 15:33:20
|
Revision: 194
http://svn.sourceforge.net/objectlabkit/?rev=194&view=rev
Author: benoitx
Date: 2006-09-21 08:32:53 -0700 (Thu, 21 Sep 2006)
Log Message:
-----------
Take into account Gerald's comments (thanks).
Put the source files for site in the recommended src/site directory (from xdocs).
Update some web pages.
Modified Paths:
--------------
trunk/common-build/project.properties
trunk/datecalc-common/maven.xml
trunk/datecalc-jdk/maven.xml
trunk/datecalc-jdk/project.xml
trunk/datecalc-joda/maven.xml
trunk/datecalc-joda/project.xml
trunk/src/site/algo.xml
trunk/src/site/changes.xml
trunk/src/site/index.xml
trunk/src/site/tenor.xml
Added Paths:
-----------
trunk/datecalc-common/src/site/index.xml
trunk/datecalc-common/src/site/navigation.xml
trunk/datecalc-jdk/src/site/index.xml
trunk/datecalc-jdk/src/site/navigation.xml
trunk/datecalc-joda/src/site/index.xml
trunk/datecalc-joda/src/site/navigation.xml
Modified: trunk/common-build/project.properties
===================================================================
--- trunk/common-build/project.properties 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/common-build/project.properties 2006-09-21 15:32:53 UTC (rev 194)
@@ -87,6 +87,7 @@
#maven.xdoc.theme.url=http://maven.apache.org/maven-1.x/style/maven-stylus.css
#maven.xdoc.theme.url=http://maven.apache.org/style/maven-stylus.css
maven.xdoc.theme=stylus
+maven.docs.src=${basedir}/src/site
#
# CHECKSTYLE
Modified: trunk/datecalc-common/maven.xml
===================================================================
--- trunk/datecalc-common/maven.xml 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/datecalc-common/maven.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -15,46 +15,4 @@
<goal name="kit:build" prereqs="jar:install" />
<goal name="kit:rebuild" prereqs="clean,kit:build" />
-
- <goal name="ydoc" prereqs="xdoc:init"
- description="Generate API documentation">
- <path id="maven.ydoc.path">
- <path refid="maven.dependency.classpath" />
- <path location="${maven.build.dest}" />
- <path location="${basedir}/../common-build/ydoc.jar" />
- <path location="${basedir}/../common-build/class2svg.jar" />
- <path location="${basedir}/../common-build/styleed.jar" />
- <path location="${maven.ydoc.resources}" />
- </path>
- <property name="maven.ydoc.path.property" refid="maven.ydoc.path" />
- <mkdir dir="${maven.build.dir}/docs/apidocs" />
- <mkdir dir="${maven.build.dir}/ydoc/" />
- <record name="${maven.build.dir}/ydoc/report.txt" action="start" />
- <echo message="Generating API docs in ${maven.ydoc.destination}" />
- <javadoc sourcepathref="maven.compile.src.set"
- packagenames="net.objectlab.safemargin.*" maxmemory="255m"
- destdir="${maven.build.dir}/docs/apidocs"
- classpath="${maven.ydoc.path.property}" author="true"
- additionalparam="-breakiterator">
- <doclet name="ydoc.doclets.YStandard"
- path="${maven.ydoc.path.property}">
- <param name="-generic" />
- <param name="-umlautogen" />
- <param name="-ymode" value="LOG" />
- <param name="-filterpath"
- value="${maven.ydoc.path.property}" />
- <param name="-filter" value="ydoc.filters.ExcludeFilter" />
- <param name="-tag" value="y.precondition" />
- <param name="-tag" value="y.postcondition" />
- <param name="-tag" value="y.complexity" />
- <param name="-tag" value="param" />
- <param name="-tag" value="return" />
- <param name="-tag" value="see" />
- <param name="-tag" value="y.uml" />
- </doclet>
- </javadoc>
- <ant:record name="${maven.build.dir}/ydoc/report.txt"
- action="stop" />
- </goal>
-
</project>
Added: trunk/datecalc-common/src/site/index.xml
===================================================================
--- trunk/datecalc-common/src/site/index.xml (rev 0)
+++ trunk/datecalc-common/src/site/index.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -0,0 +1,31 @@
+<document>
+ <properties>
+ <author email="Ki...@ob...">Benoit Xhenseval</author>
+ <title>DateCalc Common Intro</title>
+ </properties>
+ <head>
+ <meta name="description"
+ content="ObjectLab Kit offers free and open source Date calculators, released under the business-friendly Apache 2.0 license."
+ />
+
+ <meta name="keywords"
+ content="Date calculator, IMM Dates, Period Calculator, Financial Calendar, Business Calendar, java, open source" />
+ <meta name="Subject" content="Date Calculators" />
+ <meta name="Copyright" content="ObjectLab Financial Ltd" />
+ <meta name="Language" content="English" />
+ <meta name="Designer" content="ObjectLab Financial Ltd" />
+ <meta name="Distribution" content="Global" />
+ <meta name="robots" content="ALL"/>
+ <meta name="Revisit-After" content="20 Days" />
+ </head>
+ <body>
+ <!-- The body of the document contains a number of sections -->
+ <section name="DateCalc Common Introduction">
+
+ <p>DateCalc Common defines the common functionalities (implementation using some generics).</p>
+ <p>Check out the UML diagrams <a href="apidocs/index.html">here</a></p>
+ <p>Also look at the Report menu on the left for project specific items, unit tests, QA etc.</p>
+ </section>
+
+ </body>
+</document>
\ No newline at end of file
Added: trunk/datecalc-common/src/site/navigation.xml
===================================================================
--- trunk/datecalc-common/src/site/navigation.xml (rev 0)
+++ trunk/datecalc-common/src/site/navigation.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project name="ObjectLab-Kit">
+ <title>ObjectLab Kit</title>
+ <body>
+ <links>
+ <item name="ObjectLab Kit" href="../../index.html" />
+ <item name="DateCalc Common" href="../datecalc-common/index.html" />
+ <item name="DateCalc JDK" href="../datecalc-jdk/index.html" />
+ <item name="DateCalc Joda" href="../datecalc-joda/index.html" />
+ </links>
+
+ </body>
+</project>
\ No newline at end of file
Modified: trunk/datecalc-jdk/maven.xml
===================================================================
--- trunk/datecalc-jdk/maven.xml 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/datecalc-jdk/maven.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -3,7 +3,21 @@
<!--
/*
* ========================================================================
- * ObjectLab Financial Ltd, proud sponsor of The Kit.
+ * $Id$
+ *
+ * Copyright 2006 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
* ========================================================================
*/
-->
@@ -14,15 +28,5 @@
<goal name="kit:rebuild" prereqs="clean,kit:build" />
- <goal name="kit:build" prereqs="jar:jar">
- <!--
- <echo>ADD Common to full JAR</echo>
- <ant:jar basedir="target/classes"
- jarfile="${maven.build.dir}/${pom.artifactId}-full-${pom.currentVersion}.jar"
- update="yes">
- <fileset dir="${basedir}/../datecalc-common/target/classes"
- excludes="**/Test.class" includes="**/*.class" />
- </ant:jar>
- -->
- </goal>
+ <goal name="kit:build" prereqs="jar:install" />
</project>
Modified: trunk/datecalc-jdk/project.xml
===================================================================
--- trunk/datecalc-jdk/project.xml 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/datecalc-jdk/project.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -74,17 +74,5 @@
</resource>
</resources>
</unitTest>
-
- <!-- This JAR should contain the common jar. -->
- <resources>
- <resource>
- <directory>../datecalc-common/target/</directory>
- <filtering>false</filtering>
- <includes>
- <include>*.jar</include>
- </includes>
- </resource>
- </resources>
</build>
-
</project>
Added: trunk/datecalc-jdk/src/site/index.xml
===================================================================
--- trunk/datecalc-jdk/src/site/index.xml (rev 0)
+++ trunk/datecalc-jdk/src/site/index.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -0,0 +1,31 @@
+<document>
+ <properties>
+ <author email="Ki...@ob...">Benoit Xhenseval</author>
+ <title>DateCalc JDK Intro</title>
+ </properties>
+ <head>
+ <meta name="description"
+ content="ObjectLab Kit offers free and open source Date calculators, released under the business-friendly Apache 2.0 license."
+ />
+
+ <meta name="keywords"
+ content="Date calculator, IMM Dates, Period Calculator, Financial Calendar, Business Calendar, java, open source" />
+ <meta name="Subject" content="Date Calculators" />
+ <meta name="Copyright" content="ObjectLab Financial Ltd" />
+ <meta name="Language" content="English" />
+ <meta name="Designer" content="ObjectLab Financial Ltd" />
+ <meta name="Distribution" content="Global" />
+ <meta name="robots" content="ALL"/>
+ <meta name="Revisit-After" content="20 Days" />
+ </head>
+ <body>
+ <!-- The body of the document contains a number of sections -->
+ <section name="DateCalc JDK Introduction">
+
+ <p>DateCalc JDK provides an implementation for pure JDK.</p>
+ <p>Check out the UML diagrams <a href="apidocs/index.html">here</a></p>
+ <p>Also look at the Report menu on the left for project specific items, unit tests, QA etc.</p>
+ </section>
+
+ </body>
+</document>
\ No newline at end of file
Added: trunk/datecalc-jdk/src/site/navigation.xml
===================================================================
--- trunk/datecalc-jdk/src/site/navigation.xml (rev 0)
+++ trunk/datecalc-jdk/src/site/navigation.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project name="ObjectLab-Kit">
+ <title>ObjectLab Kit</title>
+ <body>
+ <links>
+ <item name="ObjectLab Kit" href="../../index.html" />
+ <item name="DateCalc Common" href="../datecalc-common/index.html" />
+ <item name="DateCalc JDK" href="../datecalc-jdk/index.html" />
+ <item name="DateCalc Joda" href="../datecalc-joda/index.html" />
+ </links>
+
+ </body>
+</project>
\ No newline at end of file
Modified: trunk/datecalc-joda/maven.xml
===================================================================
--- trunk/datecalc-joda/maven.xml 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/datecalc-joda/maven.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -3,10 +3,24 @@
<!--
/*
* ========================================================================
- * ObjectLab Financial Ltd, proud sponsor of The Kit.
+ * $Id$
+ *
+ * Copyright 2006 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
* ========================================================================
*/
--->
+-->
<project xmlns:j="jelly:core" xmlns:ant="jelly:ant"
xmlns:artifact="artifact"
@@ -14,16 +28,5 @@
<goal name="kit:rebuild" prereqs="clean,kit:build" />
- <goal name="kit:build" prereqs="jar:jar">
-<!--
- <echo>ADD Common classes to full JAR</echo>
-
- <ant:jar basedir="target/classes"
- jarfile="${maven.build.dir}/${pom.artifactId}-full-${pom.currentVersion}.jar"
- update="yes">
- <fileset dir="${basedir}/../datecalc-common/target/classes"
- excludes="**/Test.class" includes="**/*.class" />
- </ant:jar>
--->
- </goal>
+ <goal name="kit:build" prereqs="jar:install"/>
</project>
Modified: trunk/datecalc-joda/project.xml
===================================================================
--- trunk/datecalc-joda/project.xml 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/datecalc-joda/project.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -79,15 +79,5 @@
</resource>
</resources>
</unitTest>
- <!-- This JAR should contain the common jar. -->
- <resources>
- <resource>
- <directory>../datecalc-common/target/</directory>
- <filtering>false</filtering>
- <includes>
- <include>*.jar</include>
- </includes>
- </resource>
- </resources>
</build>
</project>
Added: trunk/datecalc-joda/src/site/index.xml
===================================================================
--- trunk/datecalc-joda/src/site/index.xml (rev 0)
+++ trunk/datecalc-joda/src/site/index.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -0,0 +1,31 @@
+<document>
+ <properties>
+ <author email="Ki...@ob...">Benoit Xhenseval</author>
+ <title>DateCalc JODA Intro</title>
+ </properties>
+ <head>
+ <meta name="description"
+ content="ObjectLab Kit offers free and open source Date calculators, released under the business-friendly Apache 2.0 license."
+ />
+
+ <meta name="keywords"
+ content="Date calculator, IMM Dates, Period Calculator, Financial Calendar, Business Calendar, java, open source" />
+ <meta name="Subject" content="Date Calculators" />
+ <meta name="Copyright" content="ObjectLab Financial Ltd" />
+ <meta name="Language" content="English" />
+ <meta name="Designer" content="ObjectLab Financial Ltd" />
+ <meta name="Distribution" content="Global" />
+ <meta name="robots" content="ALL"/>
+ <meta name="Revisit-After" content="20 Days" />
+ </head>
+ <body>
+ <!-- The body of the document contains a number of sections -->
+ <section name="DateCalc JODA Introduction">
+
+ <p>DateCalc Joda provides an implementation based on <a href="http://joda-time.sourceforge.net">Joda Time</a>.</p>
+ <p>Check out the UML diagrams <a href="apidocs/index.html">here</a></p>
+ <p>Also look at the Report menu on the left for project specific items, unit tests, QA etc.</p>
+ </section>
+
+ </body>
+</document>
\ No newline at end of file
Added: trunk/datecalc-joda/src/site/navigation.xml
===================================================================
--- trunk/datecalc-joda/src/site/navigation.xml (rev 0)
+++ trunk/datecalc-joda/src/site/navigation.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project name="ObjectLab-Kit">
+ <title>ObjectLab Kit</title>
+ <body>
+ <links>
+ <item name="ObjectLab Kit" href="../../index.html" />
+ <item name="DateCalc Common" href="../datecalc-common/index.html" />
+ <item name="DateCalc JDK" href="../datecalc-jdk/index.html" />
+ <item name="DateCalc Joda" href="../datecalc-joda/index.html" />
+ </links>
+
+ </body>
+</project>
\ No newline at end of file
Modified: trunk/src/site/algo.xml
===================================================================
--- trunk/src/site/algo.xml 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/src/site/algo.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -1,7 +1,7 @@
<document>
<properties>
<author email="Ki...@ob...">Benoit Xhenseval</author>
- <title>ObjectLab Kit - Holiday Handler Algorithms</title>
+ <title>Holiday Handler Algorithms</title>
</properties>
<head>
<meta name="description"
Modified: trunk/src/site/changes.xml
===================================================================
--- trunk/src/site/changes.xml 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/src/site/changes.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -4,7 +4,7 @@
<document>
<properties>
- <title>ObjectLabKit Changes</title>
+ <title>Changes</title>
<author email="ki...@ob...">Benoit Xhenseval</author>
</properties>
<body>
Modified: trunk/src/site/index.xml
===================================================================
--- trunk/src/site/index.xml 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/src/site/index.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -1,7 +1,7 @@
<document>
<properties>
<author email="Ki...@ob...">Benoit Xhenseval</author>
- <title>ObjectLab Kit - Introduction</title>
+ <title>Introduction</title>
</properties>
<head>
<meta name="description"
@@ -27,15 +27,17 @@
project for this but their licence forbids most financial institution from using it. This one is released under
the business-friendly Apache 2.0 license.</p>
- <subsection name="So, what do we provide?">
- <p>The initial release provides 2 modules for <strong>Date calculations</strong>, both depend on the classes in common:</p>
- <ul><li>one for the <a href="./multiproject/datecalc-jdk/index.html">datecalc-jdk.jar JDK</a> with no dependencies</li>
- <li>and one is based on the powerful <a href="./multiproject/datecalc-joda/index.html">datecalc-joda.jar Joda-time</a> library (we recommend it!)</li>
+ <subsection name="So, what is on offer?">
+ <p>The initial release provides 2 implementations for <strong>Date calculations</strong>, both depend on the classes in datecalc-common. So,
+ you need to include:</p>
+ <ul>
+ <li><strong>datecalc-common.jar</strong> (mandatory)</li>
+ <li>and either <strong>datecalc-jdk.jar</strong> OR <strong>datecalc-joda.jar</strong></li>
</ul>
- </subsection>
- <subsection name="Which JDK?">
- <p>1.5+, get over it :-)</p>
+ <p>the <a href="./multiproject/datecalc-jdk/index.html">datecalc-jdk.jar</a> has no dependencies other than JDK 1.5+.
+ <a href="./multiproject/datecalc-joda/index.html">datecalc-joda.jar</a> is based on the powerful
+ <a href="http://joda-time.sourceforge.net">JODA-Time</a> library (we recommend it!)</p>
</subsection>
<subsection name ="Date Calculations? What is that?">
@@ -63,6 +65,19 @@
<p>See this page for some <a href="algo.html">examples</a>.</p>
</subsection>
+ <subsection name="Which JDK?">
+ <p>1.5+, get over it :-)</p>
+ </subsection>
+
+ <subsection name="UML?">
+ <p>We are using yDoc to generate a 'javadoc-like' documentation per module with the added twist of UML diagrams:</p>
+ <ul>
+ <li><a href="multiproject/datecalc-common/apidocs/index.html">UML for DateCalc Common</a></li>
+ <li><a href="multiproject/datecalc-jdk/apidocs/index.html">UML for DateCalc JDK</a></li>
+ <li><a href="multiproject/datecalc-joda/apidocs/index.html">UML for DateCalc JODA</a></li>
+ </ul>
+ </subsection>
+
<subsection name="Main interfaces">
<p>The main interfaces are:</p>
<ul>
Modified: trunk/src/site/tenor.xml
===================================================================
--- trunk/src/site/tenor.xml 2006-09-20 15:39:25 UTC (rev 193)
+++ trunk/src/site/tenor.xml 2006-09-21 15:32:53 UTC (rev 194)
@@ -1,7 +1,7 @@
<document>
<properties>
<author email="Ki...@ob...">Benoit Xhenseval</author>
- <title>ObjectLab Kit - Tenor Handling</title>
+ <title>Tenor Handling</title>
</properties>
<head>
<meta name="description"
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|