brett       2004/07/10 17:57:59

  Modified:    plugin   plugin.jelly
               plugin/xdocs goals.xml
               xdoc/xdocs properties.xml
  Log:
  doco for goals and properties
  
  Revision  Changes    Path
  1.42      +11 -6     maven-plugins/plugin/plugin.jelly
  
  Index: plugin.jelly
  ===================================================================
  RCS file: /home/cvs/maven-plugins/plugin/plugin.jelly,v
  retrieving revision 1.41
  retrieving revision 1.42
  diff -u -r1.41 -r1.42
  --- plugin.jelly      6 Jul 2004 22:21:07 -0000       1.41
  +++ plugin.jelly      11 Jul 2004 00:57:59 -0000      1.42
  @@ -56,7 +56,7 @@
     </goal>
   
     <goal name="plugin:install" prereqs="plugin:plugin"
  -    description="Install the plugin jar, prepare Maven to expand it locally and 
clear caches">
  +    description="Install the plugin jar, prepare Maven to expand it locally next 
run">
   
       <plugin:uninstall name="${pom.artifactId}" />
       <!-- Don't clear the cache. Maven will do this if we happened to clean up an 
additional version -->
  @@ -268,7 +268,7 @@
     -->
       
     <!-- test a plugin -->
  -  <goal name="plugin:test">
  +  <goal name="plugin:test" description="Run a plugin's test project">
       <u:available file="${basedir}/src/plugin-test/project.xml">
         <maven:maven
           descriptor="${basedir}/src/plugin-test/project.xml"
  @@ -277,7 +277,8 @@
       </u:available>
     </goal>
   
  -  <goal name="plugin:repository-install" prereqs="plugin:plugin">
  +  <goal name="plugin:repository-install" prereqs="plugin:plugin"
  +    description="install a plugin into the local repository">
       <artifact:install
         artifact="${maven.build.dir}/${maven.final.name}.jar"
         type="plugin"
  @@ -285,7 +286,8 @@
       />
     </goal>
   
  -  <goal name="plugin:repository-install-snapshot" prereqs="plugin:plugin">
  +  <goal name="plugin:repository-install-snapshot" prereqs="plugin:plugin"
  +    description="install a plugin snapshot into the local repository">
       <artifact:install-snapshot
         artifact="${maven.build.dir}/${maven.final.name}.jar"
         type="plugin"
  @@ -293,7 +295,8 @@
       />
     </goal>
   
  -  <goal name="plugin:repository-deploy" prereqs="plugin:plugin">
  +  <goal name="plugin:repository-deploy" prereqs="plugin:plugin"
  +    description="deploy a plugin into the local repository">
       <artifact:deploy
         artifact="${maven.build.dir}/${maven.final.name}.jar"
         type="plugin"
  @@ -301,7 +304,8 @@
       />
     </goal>
   
  -  <goal name="plugin:repository-deploy-snapshot" prereqs="plugin:plugin">
  +  <goal name="plugin:repository-deploy-snapshot" prereqs="plugin:plugin"
  +    description="deploy a plugin snapshot into the local repository">
       <artifact:deploy-snapshot
         artifact="${maven.build.dir}/${maven.final.name}.jar"
         type="plugin"
  @@ -365,3 +369,4 @@
     </define:taglib>
   
   </project>
  +
  
  
  
  1.7       +33 -4     maven-plugins/plugin/xdocs/goals.xml
  
  Index: goals.xml
  ===================================================================
  RCS file: /home/cvs/maven-plugins/plugin/xdocs/goals.xml,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- goals.xml 28 Apr 2004 03:33:50 -0000      1.6
  +++ goals.xml 11 Jul 2004 00:57:59 -0000      1.7
  @@ -30,14 +30,19 @@
           <description>Build and install a plugin</description>
         </goal>
         <goal>
  -        <name>plugin:deploy</name>
  -        <description>Install an unpacked version of the plugin</description>
  -      </goal>
  -      <goal>
           <name>plugin:download</name>
           <description>
             Download and install plugin from the remote repos.
             Must provide groupId, artifactId and version variables.
  +          You will be prompted for any that are omitted.
  +        </description>
  +      </goal>
  +      <goal>
  +        <name>plugin:download-artifact</name>
  +        <description>
  +          Download plugin from the remote repos.
  +          Must provide groupId, artifactId and version variables.
  +          You will be prompted for any that are omitted.
           </description>
         </goal>
         <goal>
  @@ -82,6 +87,30 @@
         <goal>
           <name>plugin:test</name>
           <description>Run a plugin's test project</description>
  +      </goal>
  +      <goal>
  +        <name>plugin:repository-install</name>
  +        <description>
  +          Install the current plugin version to the local repository.
  +        </description>
  +      </goal>
  +      <goal>
  +        <name>plugin:repository-install-snapshot</name>
  +        <description>
  +          Install a snapshot build of the plugin to the local repository.
  +        </description>
  +      </goal>
  +      <goal>
  +        <name>plugin:repository-deploy</name>
  +        <description>
  +          Deploy the current plugin version to the remote repository.
  +        </description>
  +      </goal>
  +      <goal>
  +        <name>plugin:repository-deploy-snapshot</name>
  +        <description>
  +          Deploy a snapshot build of the plugin to the remote repository.
  +        </description>
         </goal>
       </goals>
     </body>
  
  
  
  1.13      +184 -167  maven-plugins/xdoc/xdocs/properties.xml
  
  Index: properties.xml
  ===================================================================
  RCS file: /home/cvs/maven-plugins/xdoc/xdocs/properties.xml,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- properties.xml    2 May 2004 10:16:08 -0000       1.12
  +++ properties.xml    11 Jul 2004 00:57:59 -0000      1.13
  @@ -26,7 +26,190 @@
     </properties>
   
     <body>
  -    <section name="UI Color Settings">
  +    <section name="Directory Layout Properties">
  +      <table>
  +        <tr>
  +          <td>maven.docs.dest</td>
  +          <td>Yes</td>
  +          <td>
  +            Specifies the location of the transformed xdocs. This is
  +            used by the "xdoc" goal.
  +            The default value is <code>${maven.build.dir}/docs</code>.
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.docs.src</td>
  +          <td>Yes</td>
  +          <td>
  +            Specifies the location of the project's xdoc
  +            documentation.  This is used by the "xdoc" goal.
  +            The default value is <code>${basedir}/xdocs</code>.
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.gen.docs</td>
  +          <td>Yes</td>
  +          <td>
  +            Specifies the location where Maven-generated xdocs are
  +            stored.  The generated xdocs are then later transformed to
  +            HTML.  The default value is
  +            <code>${maven.build.dir}/generated-xdocs</code>.
  +          </td>
  +        </tr>
  +      </table>
  +    </section>
  +    <section name="Localization Properties">
  +      <table>
  +        <tr>
  +          <td>maven.docs.outputencoding</td>
  +          <td>Yes</td>
  +          <td>
  +            Specifies the output encoding of the DVSL generated docs.
  +            The default value is <code>ISO-8859-1</code>, an encoding supporting
  +            english characters as well as most
  +            <a href="http://www.w3.org/International/O-charset-lang.html";>
  +            european languages.</a>
  +          </td>
  +        </tr>
  +      </table>
  +    </section>
  +    <section name="Presentation Properties">
  +      <table>
  +        <tr>
  +          <td>maven.xdoc.theme</td>
  +          <td>Yes</td>
  +          <td>
  +            The documentation theme to use. The default is <code>theme</code>,
  +            and valid values are <code>theme</code> (RC2+) or <code>classic</code>
  +            (used in Maven RC1 and below).
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.theme.url</td>
  +          <td>Yes</td>
  +          <td>
  +            The documentation theme to use. The URL should point to a CSS file
  +            that can be used in addition to maven-base.css.
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.crumb.separator</td>
  +          <td>Yes</td>
  +          <td>The separator between links. Defaults to <code>|</code></td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.date</td>
  +          <td>Yes</td>
  +          <td>
  +            Allows the user to show the site generation date on the generated 
  +            website. One can place the date in 5 locations with "maven.xdoc.date":
  +            <ul>
  +              <li>left : on the left side of the breadcrumbs</li>
  +              <li>right : on the right side of the breadcrumbs, before the 
links</li>
  +              <li>navigation-top : above the user links, in the navigation menu</li>
  +              <li>navigation-bottom : under Maven's links, in the navigation 
menu</li>
  +              <li>bottom : after the organization name, in the footer</li>
  +            </ul>
  +            If "maven.xdoc.date" is left empty, no date is shown on the site 
(default).
  +            The default "maven.xdoc.date.locale" is "en" (ie: english).
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.date.format</td>
  +          <td>Yes</td>
  +          <td>
  +            Sets the format of the date to display. 
  +            Defaults to "dd MMMM yyyy" (eg: "14 August 2002").
  +            For details on the format, see SimpleDateFormat in the jdk 
documentation.
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.date.locale</td>
  +          <td>Yes</td>
  +          <td>
  +            Sets the locale used for the date.
  +            Defaults to "en", ie english.
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.includeProjectDocumentation</td>
  +          <td>Yes</td>
  +          <td>
  +            Specifies if Maven should display the maven generated
  +            project documentation on the site's navigation bar.  By
  +            default, Maven includes numerous reports and information
  +            regarding a project.  Set this value to 'no' to prevent the
  +            inclusion on the navigation bar.  Users building a
  +            documentation site only (non-project related) will find this
  +            value useful.  
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.developmentProcessUrl</td>
  +          <td>Yes</td>
  +          <td>
  +            Sets the url of development process page.
  +            Defaults to <a href="http://maven.apache.org/development-process.html";>
  +            http://maven.apache.org/development-process.html</a>.
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.poweredby.image</td>
  +          <td>Yes</td>
  +          <td>
  +            Sets the name of the image to use (see images/logos).
  +            The default is the propaganda logo by St&#233;phane Mor.
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.poweredby.title</td>
  +          <td>Yes</td>
  +          <td>
  +            Sets the title of the link for the powered
  +            by logo. Defaults to "Powered by Maven"
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.poweredby.url</td>
  +          <td>Yes</td>
  +          <td>
  +            Sets the target of the link for the powered
  +            by logo. Defaults to "http://maven.apache.org/";
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.jsl</td>
  +          <td>Yes</td>
  +          <td>
  +            The JSL stylesheet used to convert xdocs to HTML. To override, specify 
as a
  +            <code>file:</code> URL.
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.distributionUrl</td>
  +          <td>Yes</td>
  +          <td>
  +            Location where the artifacts are distributed. This property is 
  +            optional. If it is not defined, then the Download report will 
  +            not be added to the navigation menu. NOTE: In the future this 
  +            information will be described in the POM. Usage example:
  +            
<code>maven.xdoc.distributionUrl=http://www.ibiblio.org/maven/maven/plugins</code>.
  +          </td>
  +        </tr>
  +        <tr>
  +          <td>maven.xdoc.distributionType</td>
  +          <td>Yes</td>
  +          <td>
  +            Type of the distributed artifact. Override this property if
  +            your project is distributing artifacts of a type different
  +            that the default. NOTE: In the future 
  +            this information will be described in the POM.
  +            Default value: <code>maven.xdoc.distributionType=jar</code>
  +          </td>
  +        </tr>
  +      </table>
  +    </section>
  +    <section name="UI Color Settings (Classic theme only)">
         <table>
           <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
           <tr>
  @@ -355,172 +538,6 @@
             </td>
           </tr>
           -->
  -      </table>
  -    </section>
  -    <section name="Directory Layout Properties">
  -      <table>
  -        <tr>
  -          <td>maven.docs.dest</td>
  -          <td>Yes</td>
  -          <td>
  -            Specifies the location of the transformed xdocs. This is
  -            used by the "xdoc" goal.
  -            The default value is <code>${maven.build.dir}/docs</code>.
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.docs.src</td>
  -          <td>Yes</td>
  -          <td>
  -            Specifies the location of the project's xdoc
  -            documentation.  This is used by the "xdoc" goal.
  -            The default value is <code>${basedir}/xdocs</code>.
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.gen.docs</td>
  -          <td>Yes</td>
  -          <td>
  -            Specifies the location where Maven-generated xdocs are
  -            stored.  The generated xdocs are then later transformed to
  -            HTML.  The default value is
  -            <code>${maven.build.dir}/generated-xdocs</code>.
  -          </td>
  -        </tr>
  -      </table>
  -    </section>
  -    <section name="Localization Properties">
  -      <table>
  -        <tr>
  -          <td>maven.docs.outputencoding</td>
  -          <td>Yes</td>
  -          <td>
  -            Specifies the output encoding of the DVSL generated docs.
  -            The default value is <code>ISO-8859-1</code>, an encoding supporting
  -            english characters as well as most
  -            <a href="http://www.w3.org/International/O-charset-lang.html";>
  -            european languages.</a>
  -          </td>
  -        </tr>
  -      </table>
  -    </section>
  -    <section name="Miscellaneous Properties">
  -      <table>
  -        <tr>
  -          <td>maven.xdoc.crumb.separator</td>
  -          <td>Yes</td>
  -          <td>The separator between links. Defaults to <code>|</code></td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.date</td>
  -          <td>Yes</td>
  -          <td>
  -            Allows the user to show the site generation date on the generated 
  -            website. One can place the date in 5 locations with "maven.xdoc.date":
  -            <ul>
  -              <li>left : on the left side of the breadcrumbs</li>
  -              <li>right : on the right side of the breadcrumbs, before the 
links</li>
  -              <li>navigation-top : above the user links, in the navigation menu</li>
  -              <li>navigation-bottom : under Maven's links, in the navigation 
menu</li>
  -              <li>bottom : after the organization name, in the footer</li>
  -            </ul>
  -            If "maven.xdoc.date" is left empty, no date is shown on the site 
(default).
  -            The default "maven.xdoc.date.locale" is "en" (ie: english).
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.date.format</td>
  -          <td>Yes</td>
  -          <td>
  -            Sets the format of the date to display. 
  -            Defaults to "dd MMMM yyyy" (eg: "14 August 2002").
  -            For details on the format, see SimpleDateFormat in the jdk 
documentation.
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.date.locale</td>
  -          <td>Yes</td>
  -          <td>
  -            Sets the locale used for the date.
  -            Defaults to "en", ie english.
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.includeProjectDocumentation</td>
  -          <td>Yes</td>
  -          <td>
  -            Specifies if Maven should display the maven generated
  -            project documentation on the site's navigation bar.  By
  -            default, Maven includes numerous reports and information
  -            regarding a project.  Set this value to 'no' to prevent the
  -            inclusion on the navigation bar.  Users building a
  -            documentation site only (non-project related) will find this
  -            value useful.  
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.developmentProcessUrl</td>
  -          <td>Yes</td>
  -          <td>
  -            Sets the url of development process page.
  -            Defaults to <a href="http://maven.apache.org/development-process.html";>
  -            http://maven.apache.org/development-process.html</a>.
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.poweredby.image</td>
  -          <td>Yes</td>
  -          <td>
  -            Sets the name of the image to use (see images/logos).
  -            The default is the propaganda logo by St&#233;phane Mor.
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.poweredby.title</td>
  -          <td>Yes</td>
  -          <td>
  -            Sets the title of the link for the powered
  -            by logo. Defaults to "Powered by Maven"
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.poweredby.url</td>
  -          <td>Yes</td>
  -          <td>
  -            Sets the target of the link for the powered
  -            by logo. Defaults to "http://maven.apache.org/";
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.jsl</td>
  -          <td>Yes</td>
  -          <td>
  -            The JSL stylesheet used to convert xdocs to HTML. To override, specify 
as a
  -            <code>file:</code> URL.
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.distributionUrl</td>
  -          <td>Yes</td>
  -          <td>
  -            Location where the artifacts are distributed. This property is 
  -            optional. If it is not defined, then the Download report will 
  -            not be added to the navigation menu. NOTE: In the future this 
  -            information will be described in the POM. Usage example:
  -            
<code>maven.xdoc.distributionUrl=http://www.ibiblio.org/maven/maven/plugins</code>.
  -          </td>
  -        </tr>
  -        <tr>
  -          <td>maven.xdoc.distributionType</td>
  -          <td>Yes</td>
  -          <td>
  -            Type of the distributed artifact. Override this property if
  -            your project is distributing artifacts of a type different
  -            that the default. NOTE: In the future 
  -            this information will be described in the POM.
  -            Default value: <code>maven.xdoc.distributionType=jar</code>
  -          </td>
  -        </tr>
         </table>
       </section>
     </body>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to