You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by jv...@apache.org on 2006/10/26 04:32:50 UTC
svn commit: r467838 - /maven/site/trunk/src/site/apt/plugins/index.apt
Author: jvanzyl
Date: Wed Oct 25 19:32:49 2006
New Revision: 467838
URL: http://svn.apache.org/viewvc?view=rev&rev=467838
Log:
MNG-2538 An attempt to organize the plugins page to make it far less confusing
Submitted by: Eric Redmond
Modified:
maven/site/trunk/src/site/apt/plugins/index.apt
Modified: maven/site/trunk/src/site/apt/plugins/index.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/plugins/index.apt?view=diff&rev=467838&r1=467837&r2=467838
==============================================================================
--- maven/site/trunk/src/site/apt/plugins/index.apt (original)
+++ maven/site/trunk/src/site/apt/plugins/index.apt Wed Oct 25 19:32:49 2006
@@ -8,108 +8,126 @@
Available Plugins
- This page lists some of the available plugins for Maven 2.0. Please bear in mind that this is not a definitive
- list, and that others can be made available immediately via the Maven repository.
-
- To see the most up-to-date list of available plugins, browse the Maven 2 plugin repository
- at {{http://www.ibiblio.org/maven2/}}.
-
- Plugins are organized according to a directory structure that resembles the standard Java package naming convention.
- To see a list of available plugins from the Maven project, look in the
- {{{http://www.ibiblio.org/maven2/org/apache/maven/plugins/} <<<org/apache/maven subfolder>>>}}
- of this directory.
+ Maven is - at its heart - a plugin execution framework; all work is done by plugins. Looking for
+ a specific goal to execute? This page lists the core plugins and others.
+
+ To see the most up-to-date list browse the Maven repository at {{http://repo1.maven.org/maven2/}}, specifically
+ the {{{http://repo1.maven.org/maven2/org/apache/maven/plugins/} <<<org/apache/maven/plugins>>>}} subfolder.
+ <(Plugins are organized according to a directory structure that resembles the standard Java package naming convention)>
~~ TODO: the repository manager should be able to produce a page like this. Ensure all descriptions are in the POM of these plugins.
-*--------------------------------------------------------------------+----------------------------------------------+
-| <<Plugin>> | <<Description>>
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-ant-plugin/} <<<ant>>>}} | Generate an Ant build file for the project.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-antlr-plugin/} <<<antlr>>> }} | Generate sources from an Antlr grammar.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-antrun-plugin/} <<<antrun>>>}} | Run a set of ant tasks from a phase of the build.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-archetype-plugin/} <<<archetype>>>}} | Generate a skeleton project structure from an archetype.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-assembly-plugin/} <<<assembly>>>}} | Build an assembly (distribution) of sources and binaries.
-*-----------------------------------------------------------------------------------+----------------------------------+
-| {{{maven-changelog-plugin/} <<<changelog>>>}} | Generate a list of recent changes from your SCM.
-*-----------------------------------------------------------------------------------+----------------------------------+
-| {{{maven-changes-plugin/} <<<changes>>>}} | Generate a report from issue tracking or a change document.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-checkstyle-plugin/} <<<checkstyle>>>}} | Generate a checkstyle report.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-clean-plugin/} <<<clean>>>}} | Clean up after the build.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-clover-plugin/} <<<clover>>>}} | Generate a Clover report.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-compiler-plugin/} <<<compiler>>>}} | Compiles Java sources.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-dependency-plugin/} <<<dependency>>>}} | Dependency manipulation.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-deploy-plugin/} <<<deploy>>>}} | Deploy the built artifact to the remote repository.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-ear-plugin/} <<<ear>>>}} | Generate an EAR from the current project.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-eclipse-plugin/} <<<eclipse>>>}} | Generate an Eclipse project file for the current project.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-ejb-plugin/} <<<ejb>>>}} | Build an EJB (and optional client) from the current project.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-help-plugin/} <<<help>>>}} | Get information about the working environment for the project.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-idea-plugin/} <<<idea>>>}} | Create/update an IDEA workspace for the current project (individual modules are created as IDEA modules)
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-install-plugin/} <<<install>>>}} | Install the built artifact into the local repository.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-jar-plugin/} <<<jar>>>}} | Build a JAR from the current project.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-javadoc-plugin/} <<<javadoc>>>}} | Generate Javadoc for the project.
-*-----------------------------------------------------------------------------------+----------------------------------+
-| {{{maven-jxr-plugin/} <<<jxr>>>}} | Generate a source cross reference.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-one-plugin/} <<<one>>>}} | A plugin for interacting with legacy Maven 1.x repositories and builds.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-plugin-plugin/} <<<plugin>>>}} | Create a Maven plugin descriptor for any Mojo's found in the source tree, to include in the JAR.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-pmd-plugin/} <<<pmd>>>}} | Generate a PMD report.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-project-info-reports-plugin/} <<<project-info-reports>>>}} | Generate a standard project reports.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-rar-plugin/} <<<rar>>>}} | Build a RAR from the current project.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-release-plugin/} <<<release>>>}} | Release the current project - updating the POM and tagging in the SCM.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-resources-plugin/} <<<resources>>>}} | Copy the resources to the output directory for including in the JAR.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{/scm/plugins/} <<<scm>>>}} | Generate a SCM for the current project.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-site-plugin/} <<<site>>>}} | Generate a site for the current project.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-source-plugin/} <<<source>>>}} | Build a JAR of sources for use in IDEs and distribution to the repository.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-surefire-plugin/} <<<surefire>>>}} | Run the Junit tests in an isolated classloader.
-*-----------------------------------------------------------------------------------+----------------------------------+
-| {{{maven-surefire-report-plugin/} <<<surefire-report>>>}} | Generate a report based on the results of unit tests.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-verifier-plugin/} <<<verifier>>>}} | Useful for integration tests - verifies the existence of certain conditions.
-*--------------------------------------------------------------------+----------------------------------------------+
-| {{{maven-war-plugin/} <<<war>>>}} | Build a WAR from the current project.
-*--------------------------------------------------------------------+----------------------------------------------+
-
- There are also many plug-ins available at the {{{http://mojo.codehaus.org} Mojo}} project at Codehaus.
-
-*-----------------------------------------------------------------------------------+----------------------------------+
-| <<Plugin>> | <<Description>>
-*-----------------------------------------------------------------------------------+----------------------------------+
-| {{{http://mojo.codehaus.org/castor-maven-plugin/} <<<castor>>>}} | Generate sources from an XSD using Castor.
-*-----------------------------------------------------------------------------------+----------------------------------+
-| {{{http://mojo.codehaus.org/javacc-maven-plugin/} <<<javacc>>>}} | Generate sources from a JavaCC grammer.
-*-----------------------------------------------------------------------------------+----------------------------------+
-| {{{http://mojo.codehaus.org/jdepend-maven-plugin/} <<<jdepend>>>}} | Generate a report on code metrics using JDepend.
-*-----------------------------------------------------------------------------------+----------------------------------+
-| {{{http://mojo.codehaus.org/taglist-maven-plugin/} <<<taglist>>>}} | Generate a list of tasks based on tags in your code.
-*-----------------------------------------------------------------------------------+----------------------------------+
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| <<Plugin>> | <<Version>> | <<Description>>
+*-----------------------------------------------------------*--------+----------------------------------------------+
+| <<core plugins>> | | <Plugins corresponding to default core phases (ie. clean, compile). They may have muliple goals as well.>
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-clean-plugin/} <<<clean>>>}} | 2.1.1 | Clean up after the build.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-compiler-plugin/} <<<compiler>>>}} | 2.0.1 | Compiles Java sources.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-deploy-plugin/} <<<deploy>>>}} | 2.2.1 | Deploy the built artifact to the remote repository.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-install-plugin/} <<<install>>>}} | 2.1 | Install the built artifact into the local repository.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-resources-plugin/} <<<resources>>>}} | 2.2 | Copy the resources to the output directory for including in the JAR.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-site-plugin/} <<<site>>>}} | 2.0-beta-5 | Generate a site for the current project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-surefire-plugin/} <<<surefire>>>}} | 2.2 | Run the Junit tests in an isolated classloader.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-verifier-plugin/} <<<verifier>>>}} | 1.0-beta-1 | Useful for integration tests - verifies the existence of certain conditions.
+*-----------------------------------------------------------*--------+----------------------------------------------+
+| <<packaging types / tools>> | | <These plugins relate to packaging respective artifact types.>
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-ear-plugin/} <<<ear>>>}} | 2.2 | Generate an EAR from the current project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-ejb-plugin/} <<<ejb>>>}} | 2.0 | Build an EJB (and optional client) from the current project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-jar-plugin/} <<<jar>>>}} | 2.1 | Build a JAR from the current project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-rar-plugin/} <<<rar>>>}} | 2.1 | Build a RAR from the current project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-war-plugin/} <<<war>>>}} | 2.0.1 | Build a WAR from the current project.
+*-----------------------------------------------------------*--------+----------------------------------------------+
+| <<reporting>> | | <Plugins which generate reports, are configured as reports in the POM and run under the site generation lifecycle.>
+*-----------------------------------------------------------+-----------------------+----------------------------------+
+| {{{maven-changelog-plugin/} <<<changelog>>>}} | | Generate a list of recent changes from your SCM.
+*-----------------------------------------------------------+-----------------------+----------------------------------+
+| {{{maven-changes-plugin/} <<<changes>>>}} | 2.0-beta-2 | Generate a report from issue tracking or a change document.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-checkstyle-plugin/} <<<checkstyle>>>}} | 2.1 | Generate a checkstyle report.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-clover-plugin/} <<<clover>>>}} | 2.3 | Generate a Clover report.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-docck-plugin/} <<<docck>>>}} | 1.0-beta-1 | Documentation checker plugin.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-javadoc-plugin/} <<<javadoc>>>}} | 2.1 | Generate Javadoc for the project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-jxr-plugin/} <<<jxr>>>}} | 2.0 | Generate a source cross reference.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-pmd-plugin/} <<<pmd>>>}} | 2.1 | Generate a PMD report.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-project-info-reports-plugin/} <<<project-info-reports>>>}} | 2.0.1 | Generate a standard project reports.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-surefire-report-plugin/} <<<surefire-report>>>}} | 2.0 | Generate a report based on the results of unit tests.
+*-----------------------------------------------------------*--------+----------------------------------------------+
+| <<tools>> | | <These are miscellaneous tools available through Maven by default.>
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-ant-plugin/} <<<ant>>>}} | 2.0-beta-1 | Generate an Ant build file for the project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-antlr-plugin/} <<<antlr>>> }} | 2.0-beta-1 | Generate sources from an Antlr grammar.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-antrun-plugin/} <<<antrun>>>}} | 1.1 | Run a set of ant tasks from a phase of the build.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-archetype-plugin/} <<<archetype>>>}} | 1.0-alpha-4 | Generate a skeleton project structure from an archetype.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-assembly-plugin/} <<<assembly>>>}} | 2.1 | Build an assembly (distribution) of sources and binaries.
+*-----------------------------------------------------------+-----------------------+----------------------------------+
+| {{{maven-dependency-plugin/} <<<dependency>>>}} | | Dependency manipulation.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-help-plugin/} <<<help>>>}} | 2.0.1 | Get information about the working environment for the project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-one-plugin/} <<<one>>>}} | 1.0 | A plugin for interacting with legacy Maven 1.x repositories and builds.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-plugin-plugin/} <<<plugin>>>}} | 2.1 | Create a Maven plugin descriptor for any Mojo's found in the source tree, to include in the JAR.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-release-plugin/} <<<release>>>}} | 2.0-beta-4 | Release the current project - updating the POM and tagging in the SCM.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| <<<repository>>> | 2.0 | Plugin to help woth repository-based tasks.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{/scm/plugins/} <<<scm>>>}} | 1.0-beta-3 | Generate a SCM for the current project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-source-plugin/} <<<source>>>}} | 2.0.1 | Build a JAR of sources for use in IDEs and distribution to the repository.
+*-----------------------------------------------------------*--------+----------------------------------------------+
+| <<IDEs>> | | <Plugins that simplify integration with integrated developer environments.>
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-eclipse-plugin/} <<<eclipse>>>}} | 2.2 | Generate an Eclipse project file for the current project.
+*-----------------------------------------------------------+--------+----------------------------------------------+
+| {{{maven-idea-plugin/} <<<idea>>>}} | 2.0 | Create/update an IDEA workspace for the current project (individual modules are created as IDEA modules)
+*-----------------------------------------------------------+--------+----------------------------------------------+
+
+ There are also many plug-ins available at the {{{http://mojo.codehaus.org} Mojo}} project at Codehaus.
+ To see the most up-to-date list browse the Codehaus repository at {{http://repository.codehaus.org/}}, specifically
+ the {{{http://repository.codehaus.org/org/codehaus/mojo/} <<<org/codehaus/mojo>>>}} subfolder. Here are a few
+ common ones:
+
+*-------------------------------------------------------------------------------+---------+----------------------------------+
+| <<Plugin>> | <<Version>> | <<Description>>
+*-------------------------------------------------------------------------------+---------+----------------------------------+
+| {{{http://mojo.codehaus.org/castor-maven-plugin/} <<<castor>>>}} | 1.0 | Generate sources from an XSD using Castor.
+*-------------------------------------------------------------------------------+---------+----------------------------------+
+| {{{http://mojo.codehaus.org/javacc-maven-plugin/} <<<javacc>>>}} | 2.1 | Generate sources from a JavaCC grammer.
+*-------------------------------------------------------------------------------+---------+----------------------------------+
+| {{{http://mojo.codehaus.org/jdepend-maven-plugin/} <<<jdepend>>>}} | 2.0-beta-1 | Generate a report on code metrics using JDepend.
+*-------------------------------------------------------------------------------+---------+----------------------------------+
+| {{{http://mojo.codehaus.org/maven-native/native-maven-plugin/} <<<native>>>}} | 1.0-alpha-1 | Compiles C and C++ code with native compilers.
+*-------------------------------------------------------------------------------+---------+----------------------------------+
+| {{{http://mojo.codehaus.org/sql-maven-plugin/} <<<sql>>>}} | 1.0-beta-2 | Executes SQL scripts from files or inline.
+*-------------------------------------------------------------------------------+---------+----------------------------------+
+| {{{http://mojo.codehaus.org/taglist-maven-plugin/} <<<taglist>>>}} | 2.0-beta-1 | Generate a list of tasks based on tags in your code.
+*-------------------------------------------------------------------------------+---------+----------------------------------+
+
A number of other projects provide their own Maven2 plugins. This includes:
@@ -120,8 +138,8 @@
*----------------------------------------------------------------------------+----------------------------------------+
| {{{http://ws.apache.org/jaxme/mp/} <<<jaxme>>>}} | Use the JaxMe JAXB implementation to generate Java sources from XML schema.
*----------------------------------------------------------------------------+----------------------------------------+
-| {{{http://jetty.mortbay.org/jetty6/maven-plugin/howto.html} <<<jetty6>>>}} | Run a Jetty container for rapid webapp development.
+| {{{http://jetty.mortbay.org/maven-plugin/howto.html} <<<jetty>>>}} | Run a Jetty container for rapid webapp development.
*----------------------------------------------------------------------------+----------------------------------------+
-| {{{http://www.triemax.com/products/jalopy/manual/plugin-maven.html} <<<jalopy>>>}} | Use Jalopy to format your source code |
+| {{{http://www.triemax.com/products/jalopy/manual/plugin-maven.html} <<<jalopy>>>}} | Use Jalopy to format your source code
*----------------------------------------------------------------------------+----------------------------------------+