svn commit: r332354 - in /maven/maven-1/plugins/trunk/html2xdoc: plugin.jelly xdocs/changes.xml xdocs/index.xml xdocs/properties.xml

[lt...@apache.org]

Author: ltheussl
Date: Thu Nov 10 11:05:38 2005
New Revision: 332354

URL: http://svn.apache.org/viewcvs?rev=332354&view=rev
Log:
Update documentation

Modified:
    maven/maven-1/plugins/trunk/html2xdoc/plugin.jelly
    maven/maven-1/plugins/trunk/html2xdoc/xdocs/changes.xml
    maven/maven-1/plugins/trunk/html2xdoc/xdocs/index.xml
    maven/maven-1/plugins/trunk/html2xdoc/xdocs/properties.xml

Modified: maven/maven-1/plugins/trunk/html2xdoc/plugin.jelly
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/html2xdoc/plugin.jelly?rev=332354&r1=332353&r2=332354&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/html2xdoc/plugin.jelly (original)
+++ maven/maven-1/plugins/trunk/html2xdoc/plugin.jelly Thu Nov 10 11:05:38 2005
@@ -42,8 +42,7 @@
     
     <j:set var="srcdir" value="${maven.html2xdoc.dir}"/>    
     <j:if test="${empty(srcdir)}">
-      <!-- FIXME? Should be maven.docs.src -->
-      <j:set var="srcdir" value="${basedir}/xdocs"/>
+      <j:set var="srcdir" value="${maven.docs.src}"/>
     </j:if>
     
     <j:set var="outputencoding" value="${maven.docs.outputencoding}"/>

Modified: maven/maven-1/plugins/trunk/html2xdoc/xdocs/changes.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/html2xdoc/xdocs/changes.xml?rev=332354&r1=332353&r2=332354&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/html2xdoc/xdocs/changes.xml (original)
+++ maven/maven-1/plugins/trunk/html2xdoc/xdocs/changes.xml Thu Nov 10 11:05:38 2005
@@ -25,6 +25,7 @@
   </properties>
   <body>
     <release version="1.4-SNAPSHOT" date="In SVN">
+      <action dev="ltheussl" type="update">Update documentation.</action>
       <action dev="aheritier" type="update" issue="MAVEN-1712">Update dependencies to match ones in maven 1.1 core and to unify them between plugins. The following dependencies are updated : 
         <ul>
           <li>commons-jelly-tags-xml v1.0 -> v1.1</li>

Modified: maven/maven-1/plugins/trunk/html2xdoc/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/html2xdoc/xdocs/index.xml?rev=332354&r1=332353&r2=332354&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/html2xdoc/xdocs/index.xml (original)
+++ maven/maven-1/plugins/trunk/html2xdoc/xdocs/index.xml Thu Nov 10 11:05:38 2005
@@ -45,12 +45,15 @@
         are documented <a href="properties.html">here</a>.
       </p>
       <p>
-      	To enable HTML to xdoc conversion add the following to your maven.xml
+        To enable HTML to xdoc conversion, either set the
+        <code>maven.html2xdoc.enabled</code>
+        <a href="properties.html">property</a>,
+        or add the following to your <code>maven.xml</code>:
       </p>
       <source>
-  &lt;preGoal name="xdoc:jelly-transform"&gt;
+  &lt;preGoal name="xdoc:init"&gt;
     &lt;attainGoal name="html2xdoc"/&gt;
-  &lt;/preGoal&gt;      	
+  &lt;/preGoal&gt;
       </source>
     </section>
  </body>

Modified: maven/maven-1/plugins/trunk/html2xdoc/xdocs/properties.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/html2xdoc/xdocs/properties.xml?rev=332354&r1=332353&r2=332354&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/html2xdoc/xdocs/properties.xml (original)
+++ maven/maven-1/plugins/trunk/html2xdoc/xdocs/properties.xml Thu Nov 10 11:05:38 2005
@@ -30,11 +30,11 @@
         <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
         <tr>
           <td>maven.html2xdoc.dir</td>
-          <td>Yes (default=xdoc)</td>
+          <td>Yes (default=<code>${maven.docs.src}</code>)</td>
           <td>
             Specifies the directory containing HTML documents which will be
-            turned into xdoc XML documents in the 
-						<code>target/generated-xdoc</code> directory
+            turned into xdoc XML documents in the
+            <code>target/generated-xdoc</code> directory
             ready for use by the xdoc plugin.
           </td>
         </tr>
@@ -47,6 +47,7 @@
             to produce its output as if it's a normal part of the site.
           </td>
         </tr>
+<!--
         <tr>
           <td>maven.html2xdoc.jsl</td>
           <td>Yes</td>
@@ -55,6 +56,7 @@
           	HTML to XDoc transformation.
           </td>
         </tr>
+-->
       </table>
     </section>
   </body>