holtdl 01/05/21 18:25:24
Modified: docs/manual/CoreTasks tstamp.html
Log:
Add link to Javadoc for date format + general clean-up.
Revision Changes Path
1.4 +32 -21 jakarta-ant/docs/manual/CoreTasks/tstamp.html
Index: tstamp.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/tstamp.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- tstamp.html 2001/03/27 08:11:03 1.3
+++ tstamp.html 2001/05/22 01:25:23 1.4
@@ -8,14 +8,19 @@
<body>
<h2><a name="tstamp">Tstamp</a></h2>
+
<h3>Description</h3>
-<p>Sets the DSTAMP, TSTAMP and TODAY properties in the current project. The
-DSTAMP is in the "yyyymmdd" format, the TSTAMP is in the
"hhmm"
-format and TODAY is "month day year".</p>
-<p>These properties can be used in the buildfile, for instance, to create
-timestamped filenames or used to replace placeholder tags inside documents to
-indicate, for example, the release date. The best place for this task is in
your
-initialization target.</p>
+<p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and <code>TODAY</code>
+properties in the current project. The <code>DSTAMP</code> property is in the
+format "yyyymmdd", <code>TSTAMP</code> is in the
+format "hhmm", and <code>TODAY</code> is in the
+format "month day year".
+
+<p>These properties can be used in the build-file, for instance, to create
+time-stamped filenames, or used to replace placeholder tags inside documents
+to indicate, for example, the release date. The best place for this task is
+probably in an initialization target.
+
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -28,9 +33,10 @@
</table>
<h3>Nested Elements</h3>
-The tstamp task supports a format nested element which allows a property to
be
-given the current date and time in a given format. The date/time patterns
are as defined in the Java
-SimpleDateFormat class.
+The Tstamp task supports a <code><format></code> nested element that
+allows a property to be set to the current date and time in a given format.
+The date/time patterns are as defined in the Java
+<a
href=http://java.sun.com/products/jdk/1.2/docs/api/java/text/SimpleDateFormat.html>SimpleDateFormat</a>
class.
<table width="60%" border="1" cellpadding="2" cellspacing="0">
@@ -42,33 +48,38 @@
<tr>
<td valign="top">property</td>
<td valign="top">
- The property which is to receive the date/time string in the given
pattern
+ The property to receive the date/time string in the given pattern.
</td>
<td align="center" valign="top">Yes</td>
</tr>
<tr>
<td valign="top">pattern</td>
- <td valign="top">The date/time pattern to be used. The values are
defined by the Java
- SimpleDateFormat class</td>
+ <td valign="top">The date/time pattern to be used. The values are as
defined by the Java SimpleDateFormat class.</td>
<td align="center" valign="top">Yes</td>
</tr>
</table>
<h3>Examples</h3>
-<p> Set the standard DSTAMP, TSTAMP and TODAY properties according to the
formats above</p>
-<pre> <tstamp/></pre>
-<p> As for the above example, set the standard properties and also set the
property
-"TODAY_UK" with the date/time pattern "d MMM yyyy"</p>
+<pre>
+ <tstamp/>
+</pre>
-<pre> <tstamp>
- <format property="TODAY_UK" pattern="d MMMM
yyyy"/>
+<p>
+sets the standard <code>DSTAMP</code>, <code>TSTAMP</code>,
+and <code>TODAY</code> properties according to the default formats.</p>
+<pre>
+ <tstamp>
+ <format property="TODAY_UK"
pattern="d-MMMM-yyyy"/>
</tstamp>
</pre>
+<p>
+sets the standard properties as well as the property
+<code>TODAY_UK</code> with the date/time pattern "d-MMMM-yyyy"
+(eg., 21-May-2001).
<hr>
-<p align="center">Copyright © 2000,2001 Apache Software Foundation. All
rights
-Reserved.</p>
+<p align="center">Copyright © 2000,2001 Apache Software Foundation. All
rights Reserved.</p>
</body>
</html>
