svn commit: r703445 - /maven/doxia/site/src/site/apt/references/apt-format.apt

[vs...@apache.org]

Author: vsiveton
Date: Fri Oct 10 06:02:35 2008
New Revision: 703445

URL: http://svn.apache.org/viewvc?rev=703445&view=rev
Log:
DOXIA-252: Date format in the title of an apt file is not described in detail within the online documentation

o added a note about date

Modified:
    maven/doxia/site/src/site/apt/references/apt-format.apt

Modified: maven/doxia/site/src/site/apt/references/apt-format.apt
URL: http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/references/apt-format.apt?rev=703445&r1=703444&r2=703445&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/references/apt-format.apt (original)
+++ maven/doxia/site/src/site/apt/references/apt-format.apt Fri Oct 10 06:02:35 2008
@@ -120,7 +120,7 @@
   several consecutive lines of text which specifies the author of the
   document.
 
-  The author sub-block may optionaly be followed by a date sub-block using the
+  The author sub-block may optionally be followed by a date sub-block using the
   same syntax.
 
   The following example is used for a document with an title and a date but
@@ -137,6 +137,15 @@
 
   The last line is ignored. It is just there to make the block nicer.
 
+  <<Note>>: the date has no specific format and will be parsed as string. But we recommend to use the ISO-8601 standard,
+  since formatting a date varies around the world:
+
+  <<YYYY-MM-DD>>
+
+  where <<YYYY>> is the year in the Gregorian calendar, <<MM>> is the month of
+  the year between 01 (January) and 12 (December), and <<DD>> is the day of the
+  month between 01 and 31.
+
 *** Paragraph
 ~~~~~~~~~~~~~
 
@@ -283,7 +292,7 @@
 
 +----------------------------------------+
 ----------------------------------------
-Verbatim 
+Verbatim
          text,
                 preformatted,
                                 escaped.