Menu
▾
▴
[Objectlabkit-svn] SF.net SVN: objectlabkit:[357] trunk/src/site/xdoc
|
From: <ma...@us...> - 2010-04-16 10:25:22
|
Revision: 357
http://objectlabkit.svn.sourceforge.net/objectlabkit/?rev=357&view=rev
Author: marchy
Date: 2010-04-16 10:25:16 +0000 (Fri, 16 Apr 2010)
Log Message:
-----------
collapsed 3 sections into 1 (Getting Started) to make index page cleaner.
Modified Paths:
--------------
trunk/src/site/xdoc/download.xml
trunk/src/site/xdoc/index.xml
Modified: trunk/src/site/xdoc/download.xml
===================================================================
--- trunk/src/site/xdoc/download.xml 2010-04-16 08:40:59 UTC (rev 356)
+++ trunk/src/site/xdoc/download.xml 2010-04-16 10:25:16 UTC (rev 357)
@@ -19,35 +19,41 @@
<body>
- <section name="Maven Dependency">
- <p>
- We're in Maven Central Repo, so if you're using Maven, you can just insert this dependency in your project's pom.xml:
- <subsection name="Joda Time (recommended)">
- <pre class="brush: xml; gutter: false;">
- <dependency>
- <groupId>net.objectlab.kit.datecalc</groupId>
- <artifactId>datecalc-joda</artifactId>
- <version>1.2.0</version>
- </dependency>
- </pre>
- </subsection>
+ <subsection name="Maven">
+ <p>The ObjectLab Kit is in the Maven Central Repository.</p>
+ <p>To use the JDK Version:</p>
+ <pre class="brush: xml; gutter: false">
+ <dependency>
+ <groupId>net.objectlab.kit</groupId>
+ <artifactId>datecalc-common</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>net.objectlab.kit</groupId>
+ <artifactId>datecalc-jdk</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ </pre>
+
+ <p>To use the JODA Version (recommended):</p>
+ <pre class="brush: xml; gutter: false">
+ <dependency>
+ <groupId>net.objectlab.kit</groupId>
+ <artifactId>datecalc-common</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>net.objectlab.kit</groupId>
+ <artifactId>datecalc-joda</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ </pre>
+ </subsection>
- <subsection name="JDK">
- <pre class="brush: xml; gutter: false;">
- <dependency>
- <groupId>net.objectlab.kit.datecalc</groupId>
- <artifactId>datecalc-jdk</artifactId>
- <version>1.2.0</version>
- </dependency>
- </pre>
- </subsection>
- </p>
- </section>
+ <subsection name="Download the jars">
+ <p>If you are not using Maven, you can <a href="https://sourceforge.net/projects/objectlabkit/files/">download the jars here</a>.</p>
+ </subsection>
- <section name="Download the jars">
- <p>Alternatively, you can <a href="https://sourceforge.net/projects/objectlabkit/files/">download the zip file</a> which contains all of the jars.</p>
- </section>
-
</body>
</document>
\ No newline at end of file
Modified: trunk/src/site/xdoc/index.xml
===================================================================
--- trunk/src/site/xdoc/index.xml 2010-04-16 08:40:59 UTC (rev 356)
+++ trunk/src/site/xdoc/index.xml 2010-04-16 10:25:16 UTC (rev 357)
@@ -108,25 +108,47 @@
<p>ObjectLab Kit came out of our frustration to have to re-do the same kind of code over and over each time we
joined a new company and Bank. Most banks will require basic Date calculation, we did spot another open source
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. <a href="http://digg.com/submit?phase=2&url=objectlabkit.sourceforge.net&title=ObjectLab%20Kit%3A%20Open%20Source%20Date%20Calculators%20for%20Business%20and%20Finance&bodytext=ObjectLab%20released%20version%201%2E1%2E0%20of%20ObjectLab%20Kit%20for%20Java%201%2E5,%20available%20for%20download%20via%20SourceForge%20or%20the%20Maven%20Central%20Repository%2E%20The%20Kit%20provides%20a%20Date%20Calculator%20that%20handle%20holidays,%20a%20IMM%20Date%20and%20Period%20Count%20Calculator%20and%20comes%20in%20two%20versions%3A%20one%20based%20on%20pure%20JDK%20(1%2E5)%20and%20one%20based%20on%20the%20Joda-time%20library%20(1%2E3%2B,%20JDK%201%2E5)%2E&topic=programming">
+ the business-friendly Apache 2.0 license. <a href="http://digg.com/submit?phase=2&url=objectlabkit.sourceforge.net&title=ObjectLab%20Kit%3A%20Open%20Source%20Date%20Calculators%20for%20Business%20and%20Finance&bodytext=ObjectLab%20released%20version%201%2E2%2E0%20of%20ObjectLab%20Kit%20for%20Java%201%2E5,%20available%20for%20download%20via%20SourceForge%20or%20the%20Maven%20Central%20Repository%2E%20The%20Kit%20provides%20a%20Date%20Calculator%20that%20handle%20holidays,%20a%20IMM%20Date%20and%20Period%20Count%20Calculator%20and%20comes%20in%20two%20versions%3A%20one%20based%20on%20pure%20JDK%20(1%2E5)%20and%20one%20based%20on%20the%20Joda-time%20library%20(1%2E3%2B,%20JDK%201%2E5)%2E&topic=programming">
<img src="http://digg.com/img/badges/91x17-digg-button.png" width="91" height="17" alt="Digg!" style="vertical-align:middle" /></a></p>
-
- <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>
+ <subsection name="Getting Started">
+ <p>DateCalc comes in 2 different implementations, both run on <strong>JDK 1.5 or higher</strong>:
<ul>
- <li><strong>datecalc-common.jar</strong> (mandatory)</li>
- <li>and either <strong>datecalc-jdk.jar</strong> OR <strong>datecalc-joda.jar</strong></li>
+ <li>The vanilla <a href="datecalc-jdk/index.html">JDK implementation</a> has no external dependencies.</li>
+ <li>The <a href="datecalc-jdk/index.html">Joda Time implementation</a>, which depends on the <a href="http://joda-time.sourceforge.net">Joda Time library</a> (we recommend using this one).</li>
</ul>
+ </p>
+ <p>If you're using Maven, setup is easy, as DateCalc is in the Maven Central Repository.</p>
+ <p>To use the JDK Version:</p>
+ <pre class="brush: xml; gutter: false">
+ <dependency>
+ <groupId>net.objectlab.kit</groupId>
+ <artifactId>datecalc-common</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>net.objectlab.kit</groupId>
+ <artifactId>datecalc-jdk</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ </pre>
- <p>The <a href="datecalc-jdk/index.html">datecalc-jdk.jar</a> has no dependencies other than JDK 1.5+.
- <a href="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>
-
- <p>See the <a href="download.html">Download</a> page for details.</p>
+ <p>To use the JODA Version (recommended):</p>
+ <pre class="brush: xml; gutter: false">
+ <dependency>
+ <groupId>net.objectlab.kit</groupId>
+ <artifactId>datecalc-common</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>net.objectlab.kit</groupId>
+ <artifactId>datecalc-joda</artifactId>
+ <version>1.2.0</version>
+ </dependency>
+ </pre>
+ <p>If you are not using Maven, you can <a href="https://sourceforge.net/projects/objectlabkit/files/">download the jars here</a>.</p>
</subsection>
-
+
<subsection name ="Date Calculations? What is that?">
<p>Apart from the very basic "add days" features, most business have to <strong>deal with Holidays</strong> and what to do when a
<strong>calculated day falls on a holiday</strong>. This library does <strong>not</strong> attempt to create or guess the holidays, we
@@ -136,8 +158,8 @@
Friday, our library provides you with full flexibility to design a Working Week.</p>
<p>As such a Non-working Day can be a holiday or a 'weekend'.</p>
</subsection>
+
-
<subsection name ="Ok, what algorithm for handling a holiday do you support?">
<p>At the moment, we support the following 6 algorithms:</p>
<ol>
@@ -153,41 +175,6 @@
<p>See this page for some <a href="algo.html">examples</a>.</p>
</subsection>
- <subsection name="Which JDK?">
- <p>1.5 or above.</p>
- </subsection>
-
- <subsection name="Maven Repository">
- <p>The ObjectLab Kit should be in the Maven Central Repository.</p>
- <p>To use the JDK Version:</p>
- <pre class="brush: xml">
- <dependency>
- <groupId>net.objectlab.kit</groupId>
- <artifactId>datecalc-common</artifactId>
- <version>1.2.0</version>
- </dependency>
- <dependency>
- <groupId>net.objectlab.kit</groupId>
- <artifactId>datecalc-jdk</artifactId>
- <version>1.2.0</version>
- </dependency>
- </pre>
-
- <p>To use the JODA Version:</p>
- <pre class="brush: xml">
- <dependency>
- <groupId>net.objectlab.kit</groupId>
- <artifactId>datecalc-common</artifactId>
- <version>1.2.0</version>
- </dependency>
- <dependency>
- <groupId>net.objectlab.kit</groupId>
- <artifactId>datecalc-joda</artifactId>
- <version>1.2.0</version>
- </dependency>
- </pre>
- </subsection>
-
<subsection name="UML?">
<p>We generate our JavaDocs with the added twist of UML diagrams:</p>
<ul>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
![http://digg.com/img/badges/91x17-digg-button.png"](http://digg.com/img/badges/91x17-digg-button.png"){kind=link}