From 042407881baf2cb2557d42026af92d57ce379166 Mon Sep 17 00:00:00 2001
From: vmassol <vmassol@13f79535-47bb-0310-9956-ffa450edef68>
Date: Sat, 1 May 2004 17:53:24 +0000
Subject: [PATCH] improved website documentation

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115149 13f79535-47bb-0310-9956-ffa450edef68
---
 announcement/xdocs/changes.xml |  3 ++
 announcement/xdocs/goals.xml   |  8 ++++-
 announcement/xdocs/index.xml   | 60 ++++++++++++++++++++++++++++++++++
 3 files changed, 70 insertions(+), 1 deletion(-)

diff --git a/announcement/xdocs/changes.xml b/announcement/xdocs/changes.xml
index 90764738..949635aa 100644
--- a/announcement/xdocs/changes.xml
+++ b/announcement/xdocs/changes.xml
@@ -25,6 +25,9 @@
   </properties>
   <body>
     <release version="1.1" date="in CVS">
+      <action dev="vmassol" type="add">
+        Improved web site documentation.
+      </action>
       <action dev="vmassol" type="fix">
         Add a space after the "." of the "Fixes xxx." (which happens when
         you use the "issue" attribute in changes.xml).
diff --git a/announcement/xdocs/goals.xml b/announcement/xdocs/goals.xml
index 45e49578..5e085241 100644
--- a/announcement/xdocs/goals.xml
+++ b/announcement/xdocs/goals.xml
@@ -29,7 +29,13 @@
       <table>
         <tr><th>Goal</th><th>Description</th></tr>
         <tr>
-          <td>announcement:text</td>
+          <td>announcement</td>
+          <td>
+            Default goal. Does the same as <code>announcement:generate</code>.
+          </td>
+        </tr>
+        <tr>
+          <td>announcement:generate</td>
           <td>
             Generate text release announcement.
           </td>
diff --git a/announcement/xdocs/index.xml b/announcement/xdocs/index.xml
index 99d66026..dc7a625d 100644
--- a/announcement/xdocs/index.xml
+++ b/announcement/xdocs/index.xml
@@ -32,5 +32,65 @@
         generates release information.
       </p>
     </section>
+    <section name="Example">
+      <p>
+        Here is a sample announcement:
+      </p>
+<source><![CDATA[
+The maven team is pleased to announce the Maven Announcement plugin 1.1 
+release! 
+
+http://maven.apache.org/reference/plugins/announcement/
+
+The Announcement plugin generates release announcements. It uses the 
+information found in both the POM and in the changes.xml file to generate the 
+announcement text. 
+
+Changes in this version include:
+
+  New Features:
+
+o Added description information from the POM to the generated announcement to 
+  explain what the project does. 
+o Added information in the generated announcement to indicate from where the 
+  plugin can be downloaded. 
+o Added information in the generated announcement to indicate how to install 
+  the plugin using the plugin:download goal. 
+o Added more information when running the plugin. Also added a check to 
+  verify if the announcement version matches an entry in the changes.xml 
+  file. Fixes MPANNOUNCEMENT-2. Thanks to Fabrizio Giustina. 
+o Several new additions that makes the plugin more generic: the team name is 
+  now taken from pom.groupId, "[]" are removed from the first line, changes 
+  are sorted by type, changes report issue number and due-to, the download 
+  link is generated from pom.distributionDirectory and the "plugin has been 
+  tested with..." line has been removed. Fixes MPANNOUNCEMENT-1. Thanks to 
+  Fabrizio Giustina. 
+
+  Fixed bugs:
+
+o Add a space after the "." of the "Fixes xxx." (which happens when you use 
+  the "issue" attribute in changes.xml). 
+
+  Changes:
+
+o Added maven.announcement.file property and echo'd it during generation  
+
+To automatically install the plugin, type the following on a single line:
+
+maven plugin:download 
+  -DgroupId=maven 
+  -DartifactId=maven-announcement-plugin
+  -Dversion=1.1
+
+For a manual installation, you can download the Maven Announcement plugin 
+here:
+
+http://www.ibiblio.org/maven/maven/plugins/maven-announcement-plugin-1.1.jar
+
+Have fun!
+-The development team
+]]></source>
+    </section>
  </body>
+
 </document>