svn commit: r692883 - /maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt

[de...@apache.org]

Author: dennisl
Date: Sun Sep  7 08:50:08 2008
New Revision: 692883

URL: http://svn.apache.org/viewvc?rev=692883&view=rev
Log:
[MSITE-349] Update this plugin's site documentation page: "Configuring the Site Descriptor" to include the <version> element

Modified:
    maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt

Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt?rev=692883&r1=692882&r2=692883&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt Sun Sep  7 08:50:08 2008
@@ -5,7 +5,7 @@
  <vi...@gmail.com>
  Maria Odea Ching
  ------
- November 2006
+ 2008-09-07
  ------
 
  ~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -86,6 +86,32 @@
 </project>
 +-----+
 
+* Version
+
+  You can show the "Version" of your project on the site, by addding a <<<\<version\>>>> element to your
+  <<<site.xml>>> like this:
+
++-----+
+<project>
+  ...
+  <version position="right"/>
+  ...
+</project>
++-----+
+
+  The <<<position>>> attribute can have the same values as the <<<publishDate>>> attribute, see above.
+  If the <<<position>>> attribute is omitted, the default value is <<<left>>>.
+
+  If you want hide the version, you can use this in your <<<site.xml>>>:
+
++-----+
+<project>
+  ...
+  <version position="none"/>
+  ...
+</project>
++-----+
+
 * "Powered by" Logo
 
   You can add your own "Powered by" logo to your site.