diff --git a/maven-plugin-annotations/src/site/apt/index.apt.vm b/maven-plugin-annotations/src/site/apt/index.apt.vm deleted file mode 100644 index dbc2ce963..000000000 --- a/maven-plugin-annotations/src/site/apt/index.apt.vm +++ /dev/null @@ -1,38 +0,0 @@ - ------ - About ${project.name} - ------ - Hervé Boutemy - ------ - 2012-06-03 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -About ${project.name} - - ${project.description} - -* Usage - - To be able to {{{../maven-plugin-tools-annotations/index.html}use Maven Plugin Tools Java Annotations}}, - some configuration has to be done in <<>>: see - {{{../maven-plugin-plugin/examples/using-annotations.html#POM_configuration} Using Plugin Tools Java5 Annotations}} - example in {{{../maven-plugin-plugin} <<>>}} documentation. diff --git a/maven-plugin-annotations/src/site/markdown/index.md.vm b/maven-plugin-annotations/src/site/markdown/index.md.vm new file mode 100644 index 000000000..c9676dd1b --- /dev/null +++ b/maven-plugin-annotations/src/site/markdown/index.md.vm @@ -0,0 +1,35 @@ +--- +title: About ${project.name} +author: + - Hervé Boutemy +date: 2012-06-03 +--- + + + +# About ${project.name} + +${project.description} + +Usage +----- + +To be able to [use Maven Plugin Tools Java Annotations](../maven-plugin-tools-annotations/index.html), some configuration has to be done in `pom.xml`: see [ Using Plugin Tools Java5 Annotations](../maven-plugin-plugin/examples/using-annotations.html#POM_configuration) example in [ `maven-plugin-plugin`](../maven-plugin-plugin) documentation. + diff --git a/maven-plugin-plugin/src/site/apt/examples/generate-help.apt.vm b/maven-plugin-plugin/src/site/apt/examples/generate-help.apt.vm deleted file mode 100644 index b6dfd976e..000000000 --- a/maven-plugin-plugin/src/site/apt/examples/generate-help.apt.vm +++ /dev/null @@ -1,58 +0,0 @@ - ------ - Configuring Generation of Help Mojo - ------ - Vincent Siveton - ------ - 2008-01-01 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Configuring Generation of Help Mojo - - To configure the generation of a <<>> mojo, add the following to the project's POM: - -+-----+ - - ... - - - - org.apache.maven.plugins - maven-plugin-plugin - ${project.version} - - - generated-helpmojo - - helpmojo - - - - - - ... - - ... - -+-----+ - - The mojo is generated by default in <<<$\{project.build.directory\}/generated-sources/plugin>>>. diff --git a/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm b/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm deleted file mode 100644 index ef81c29c5..000000000 --- a/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm +++ /dev/null @@ -1,120 +0,0 @@ - ------ - Using Plugin Tools Java5 Annotations - ------ - Olivier Lamy - ------ - 2012-05-14 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ https://maven.apache.org/doxia/references/apt-format.html - -Using Plugin Tools Java Annotations - - You can use Java annotations to generate the plugin descriptor file. - - <> With annotations, your Mojo super class does not have to be in the same project: provided that the superclass also uses annotations, it - can now come from reactor projects or external dependencies. By default all dependencies are scanned, but this can be reduced with the <<>> - parameter. BUT as javadoc doclets are still useful for goals and parameters description, <<<@since>>> and <<<@deprecated>>>, the sources are still scanned. So if you use an external - dependency, you must still provide an artifact with sources (<<>> classifier) to provide documentation (the tooling will skip error if this artifact - sources is missing). - -* Annotations - - Information for plugin descriptor generation is specified using 4 annotations: - - * 2 class level annotations: - - * <<<@Mojo>>>: This annotation will mark your class as a Mojo, - - * <<<@Execute>>>: Used if your Mojo needs to fork a lifecycle, - - [] - - * 1 field or method level annotations: - - * <<<@Parameter>>>: Used to configure your Mojo parameters, - - [] - - * 1 field level annotations: - - * <<<@Component>>>: Used to configure injection of Plexus components or Maven context components. - - [] - - [] - - For more information on these annotations, see the - {{{../../maven-plugin-tools-annotations/index.html#Supported_Annotations}corresponding documentation}}. - - Notice that Plugin Tools Java Annotations are named after Plugin Tools Javadoc Tags - with following little differences: - -*-------------------------------+---------------+ -|| {{{../../maven-plugin-tools-java/index.html}Plugin Tools Javadoc Tags}} || {{{../../maven-plugin-tools-annotations/index.html}Plugin Tools Java Annotation}} || -*-------------------------------+---------------+ -| <<<@goal "goal-name">>> | <<<@Mojo( name = "goal-name" )>>> -*-------------------------------+---------------+ -| <<<@phase "\">>> | <<<@Mojo( defaultPhase = LifecyclePhase.\ )>>> -*-------------------------------+---------------+ - -* POM configuration - - To use these Java annotations, add a dependency on - <<>> to your pom, preferably with <<>> scope. - -+-----+ - - ... - maven-plugin - ... - - - - org.apache.maven.plugin-tools - maven-plugin-annotations - ${project.version} - provided - - - ... - - - - org.apache.maven.plugins - maven-plugin-plugin - ${project.version} - - - - help-goal - - helpmojo - - - - - - ... - - ... - -+-----+ diff --git a/maven-plugin-plugin/src/site/apt/index.apt b/maven-plugin-plugin/src/site/apt/index.apt deleted file mode 100644 index 371d77347..000000000 --- a/maven-plugin-plugin/src/site/apt/index.apt +++ /dev/null @@ -1,79 +0,0 @@ - ------ - Introduction - ------ - Maria Odea Ching - ------ - 2008-01-01 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Maven Plugin Plugin - - The Maven Plugin Plugin is used to create a {{{/ref/current/maven-plugin-api/plugin.html}Maven plugin descriptor}} for any - {{{/general.html#What_is_a_Mojo}Mojo}}'s found in the source tree, to include in the JAR. - It is also used to generate report files for the Mojos as well as the artifact metadata and generating a generic help goal. - -* Goals Overview - - The Plugin Plugin has four goals: - - * {{{./descriptor-mojo.html}plugin:descriptor}} generates a plugin descriptor, - - * {{{./addPluginArtifactMetadata-mojo.html}plugin:addPluginArtifactMetadata}} injects any plugin-specific artifact - metadata to the project's artifact, for subsequent installation and deployment, - - * {{{./helpmojo-mojo.html}plugin:helpmojo}} generates a help mojo which describes all mojos in a plugin, - - * {{{./help-mojo.html}plugin:help}} display help information on maven-plugin-plugin. - - [] - -* Usage - - General instructions on how to use the Plugin Plugin can be found on the {{{./usage.html}usage page}}. Some more - specific use cases are described in the examples given below. Last but not least, users occasionally contribute - additional examples, tips or errata to the - {{{https://maven.apache.org/plugin-developers/index.html}Plugin Developers Centre page}}. - - In case you still have questions regarding the plugin's usage feel free to contact the {{{./mailing-lists.html}user mailing list}}. - The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. - Hence, it is also worth browsing/searching the {{{./mailing-lists.html}mail archive}}. - - If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our - {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your - concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, - entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. - Of course, patches are welcome, too. Contributors can check out the project from our - {{{./scm.html}source repository}} and will find supplementary information in the - {{{/guides/development/guide-helping.html}guide to helping with Maven}}. - -* Examples - - The following examples shows how to use the Plugin Plugin in more advanced usecases: - - * {{{./examples/using-annotations.html}Using Plugin Tools Java5 annotations for your Mojo}} - - * {{{./examples/generate-descriptor.html}Configuring Generation of Plugin Descriptor}} - - * {{{./examples/generate-help.html}Configuring Generation of Help Mojo}} - - [] diff --git a/maven-plugin-plugin/src/site/apt/usage.apt b/maven-plugin-plugin/src/site/apt/usage.apt deleted file mode 100644 index c39844ace..000000000 --- a/maven-plugin-plugin/src/site/apt/usage.apt +++ /dev/null @@ -1,74 +0,0 @@ - ------ - Usage - ------ - Maria Odea Ching - Vincent Siveton - ------ - 2008-01-01 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Usage - - The Plugin Plugin is generally used for Maven plugins. Its goals are bound to different phases in the build life cycle. - So when you execute a specific phase, the Plugin Plugin goals bound to it are also executed. Aside from this, each goal can - also be explicitly executed from the command line. - -* The <<>> Goal - - The <<>> goal is bound to the <<>> phase since 3.0; it was bound to <<>> phase previously. - This goal generates the plugin descriptor, which is an xml file that contains information about the plugin - (see {{{/ref/current/maven-plugin-api/plugin.html}descriptor's reference}}). - - For example, you want to create an archive of your plugin and you execute - -+-----+ -mvn package -+-----+ - - You will see that the <<>> file is generated in the <<>> directory of your project. The file is - also bundled in the generated JAR file. - - To explicitly execute the <<>> goal, type the following in the command line: - -+-----+ -mvn plugin:descriptor -+-----+ - -* The <<>> Goal - - The <<>> goal, on the other hand, is bound to the <<>> phase of the build life cycle. - This goal will add the metadata to the project artifact. To do this, execute - -+-----+ -mvn package -+-----+ - -* The <<>> Goal - - To generate a <<>> for the mojos of your plugin, execute the following on the command line: - -+-----+ -mvn plugin:helpmojo -+-----+ - - The mojo is generated by default in <<<$\{project.build.directory\}/generated-sources/plugin>>>. diff --git a/maven-plugin-plugin/src/site/apt/examples/generate-descriptor.apt.vm b/maven-plugin-plugin/src/site/markdown/examples/generate-descriptor.md.vm similarity index 57% rename from maven-plugin-plugin/src/site/apt/examples/generate-descriptor.apt.vm rename to maven-plugin-plugin/src/site/markdown/examples/generate-descriptor.md.vm index 83cc6bead..0e8827945 100644 --- a/maven-plugin-plugin/src/site/apt/examples/generate-descriptor.apt.vm +++ b/maven-plugin-plugin/src/site/markdown/examples/generate-descriptor.md.vm @@ -1,36 +1,34 @@ - ------ - Configuring Generation of Plugin Descriptor - ------ - Maria Odea Ching - ------ - 2008-02-01 - ------ +--- +title: Configuring Generation of Plugin Descriptor +author: + - Maria Odea Ching +date: 2008-02-01 +--- -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. + - To configure the generation of the plugin descriptor, add the following to the project's POM: +# Configuring Generation of Plugin Descriptor -+-----+ +To configure the generation of the plugin descriptor, add the following to the project's POM: + +```unknown ... @@ -49,26 +47,25 @@ Configuring Generation of Plugin Descriptor ... -+-----+ +``` - The <<>> parameter will set the goal prefix for the plugin that is specified in the descriptor. The <<>> - parameter, on the other hand, specifies the target location of the generated plugin descriptor. +The `goalPrefix` parameter will set the goal prefix for the plugin that is specified in the descriptor. The `outputDirectory` parameter, on the other hand, specifies the target location of the generated plugin descriptor. -* Example +Example +------- - For instance, if we make reference on <<>> from <<>> which is generated by the - Maven Archetype Plugin, i.e.: +For instance, if we make reference on `MyMojo` from `maven-my-plugin` which is generated by the Maven Archetype Plugin, i.e.: ------ +``` mvn archetype:create \ -DgroupId=org.apache.maven.plugin.my \ -DartifactId=maven-my-plugin \ -DarchetypeArtifactId=maven-archetype-mojo ------ +``` - The plugin descriptor generated by <<>> should be: +The plugin descriptor generated by `mvn package` should be: ------ +``` org.apache.maven.plugin.my @@ -115,4 +112,5 @@ mvn archetype:create \ ------ \ No newline at end of file +``` + diff --git a/maven-plugin-plugin/src/site/markdown/examples/generate-help.md.vm b/maven-plugin-plugin/src/site/markdown/examples/generate-help.md.vm new file mode 100644 index 000000000..63c59e47f --- /dev/null +++ b/maven-plugin-plugin/src/site/markdown/examples/generate-help.md.vm @@ -0,0 +1,57 @@ +--- +title: Configuring Generation of Help Mojo +author: + - Vincent Siveton +date: 2008-01-01 +--- + + + +# Configuring Generation of Help Mojo + +To configure the generation of a `help` mojo, add the following to the project's POM: + +```unknown + + ... + + + + org.apache.maven.plugins + maven-plugin-plugin + ${project.version} + + + generated-helpmojo + + helpmojo + + + + + + ... + + ... + +``` + +The mojo is generated by default in `${esc.d}{project.build.directory}/generated-sources/plugin`. + diff --git a/maven-plugin-plugin/src/site/markdown/examples/using-annotations.md.vm b/maven-plugin-plugin/src/site/markdown/examples/using-annotations.md.vm new file mode 100644 index 000000000..3578a459d --- /dev/null +++ b/maven-plugin-plugin/src/site/markdown/examples/using-annotations.md.vm @@ -0,0 +1,97 @@ +--- +title: Using Plugin Tools Java5 Annotations +author: + - Olivier Lamy +date: 2012-05-14 +--- + + + +# Using Plugin Tools Java Annotations + +You can use Java annotations to generate the plugin descriptor file. + +**NOTE** With annotations, your Mojo super class does not have to be in the same project: provided that the superclass also uses annotations, it can now come from reactor projects or external dependencies. By default all dependencies are scanned, but this can be reduced with the `mojoDependencies` parameter. BUT as javadoc doclets are still useful for goals and parameters description, `@since` and `@deprecated`, the sources are still scanned. So if you use an external dependency, you must still provide an artifact with sources (`sources` classifier) to provide documentation (the tooling will skip error if this artifact sources is missing). + +Annotations +----------- + +Information for plugin descriptor generation is specified using 4 annotations: + +- 2 class level annotations: + - `@Mojo`: This annotation will mark your class as a Mojo, + - `@Execute`: Used if your Mojo needs to fork a lifecycle, +- 1 field or method level annotations: + - `@Parameter`: Used to configure your Mojo parameters, +- 1 field level annotations: + - `@Component`: Used to configure injection of Plexus components or Maven context components. + +For more information on these annotations, see the [corresponding documentation](../../maven-plugin-tools-annotations/index.html#Supported_Annotations). + +Notice that Plugin Tools Java Annotations are named after Plugin Tools Javadoc Tags with following little differences: + +|[Plugin Tools Javadoc Tags](../../maven-plugin-tools-java/index.html)|[Plugin Tools Java Annotation](../../maven-plugin-tools-annotations/index.html)| +|:---|:---| +|`@goal "goal-name"`|`@Mojo( name = "goal-name" )`| +|`@phase ""`|`@Mojo( defaultPhase = LifecyclePhase. )`| + +POM configuration +----------------- + +To use these Java annotations, add a dependency on `maven-plugin-annotations` to your pom, preferably with `provided` scope. + +```unknown + + ... + maven-plugin + ... + + + + org.apache.maven.plugin-tools + maven-plugin-annotations + ${project.version} + provided + + + ... + + + + org.apache.maven.plugins + maven-plugin-plugin + ${project.version} + + + + help-goal + + helpmojo + + + + + + ... + + ... + +``` + diff --git a/maven-plugin-plugin/src/site/markdown/index.md b/maven-plugin-plugin/src/site/markdown/index.md new file mode 100644 index 000000000..48bdc9155 --- /dev/null +++ b/maven-plugin-plugin/src/site/markdown/index.md @@ -0,0 +1,57 @@ +--- +title: Introduction +author: + - Maria Odea Ching +date: 2008-01-01 +--- + + + +# Maven Plugin Plugin + +The Maven Plugin Plugin is used to create a [Maven plugin descriptor](/ref/current/maven-plugin-api/plugin.html) for any [Mojo](/general.html#What_is_a_Mojo)'s found in the source tree, to include in the JAR. It is also used to generate report files for the Mojos as well as the artifact metadata and generating a generic help goal. + +Goals Overview +-------------- + +The Plugin Plugin has four goals: + +- [plugin:descriptor](./descriptor-mojo.html) generates a plugin descriptor, +- [plugin:addPluginArtifactMetadata](./addPluginArtifactMetadata-mojo.html) injects any plugin-specific artifact metadata to the project's artifact, for subsequent installation and deployment, +- [plugin:helpmojo](./helpmojo-mojo.html) generates a help mojo which describes all mojos in a plugin, +- [plugin:help](./help-mojo.html) display help information on maven-plugin-plugin. + +Usage +----- + +General instructions on how to use the Plugin Plugin can be found on the [usage page](./usage.html). Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the [Plugin Developers Centre page](https://maven.apache.org/plugin-developers/index.html). + +In case you still have questions regarding the plugin's usage feel free to contact the [user mailing list](./mailing-lists.html). The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the [mail archive](./mailing-lists.html). + +If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our [issue tracker](./issue-management.html). When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our [source repository](./scm.html) and will find supplementary information in the [guide to helping with Maven](/guides/development/guide-helping.html). + +Examples +-------- + +The following examples shows how to use the Plugin Plugin in more advanced usecases: + +- [Using Plugin Tools Java5 annotations for your Mojo](./examples/using-annotations.html) +- [Configuring Generation of Plugin Descriptor](./examples/generate-descriptor.html) +- [Configuring Generation of Help Mojo](./examples/generate-help.html) diff --git a/maven-plugin-plugin/src/site/markdown/usage.md b/maven-plugin-plugin/src/site/markdown/usage.md new file mode 100644 index 000000000..8980dacd4 --- /dev/null +++ b/maven-plugin-plugin/src/site/markdown/usage.md @@ -0,0 +1,70 @@ +--- +title: Usage +author: + - Maria Odea Ching + - Vincent Siveton +date: 2008-01-01 +--- + + + +# Usage + +The Plugin Plugin is generally used for Maven plugins. Its goals are bound to different phases in the build life cycle. So when you execute a specific phase, the Plugin Plugin goals bound to it are also executed. Aside from this, each goal can also be explicitly executed from the command line. + +The `plugin:descriptor` Goal +---------------------------- + +The `plugin:descriptor` goal is bound to the `process-classes` phase since 3.0; it was bound to `generate-resources` phase previously. This goal generates the plugin descriptor, which is an xml file that contains information about the plugin (see [descriptor's reference](/ref/current/maven-plugin-api/plugin.html)). + +For example, you want to create an archive of your plugin and you execute + +```unknown +mvn package +``` + +You will see that the `plugin.xml` file is generated in the `target/classes/META-INF/maven` directory of your project. The file is also bundled in the generated JAR file. + +To explicitly execute the `plugin:descriptor` goal, type the following in the command line: + +```unknown +mvn plugin:descriptor +``` + +The `plugin:addPluginArtifactMetadata` Goal +------------------------------------------- + +The `plugin:addPluginArtifactMetadata` goal, on the other hand, is bound to the `package` phase of the build life cycle. This goal will add the metadata to the project artifact. To do this, execute + +```unknown +mvn package +``` + +The `plugin:helpmojo` Goal +-------------------------- + +To generate a `HelpMojo` for the mojos of your plugin, execute the following on the command line: + +```unknown +mvn plugin:helpmojo +``` + +The mojo is generated by default in `${project.build.directory}/generated-sources/plugin`. + diff --git a/maven-plugin-report-plugin/src/site/apt/examples/generate-report.apt.vm b/maven-plugin-report-plugin/src/site/apt/examples/generate-report.apt.vm deleted file mode 100644 index 7f0e7e31a..000000000 --- a/maven-plugin-report-plugin/src/site/apt/examples/generate-report.apt.vm +++ /dev/null @@ -1,95 +0,0 @@ - ------ - Configuring Generation of Documentation Reports - ------ - Vincent Siveton - ------ - 2008-01-01 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Configuring Generation of Documentation Reports - - To configure the generation of the documentation reports, add the following to the project's POM: - -+-----+ - - ... - - - - org.apache.maven.plugins - maven-plugin-report-plugin - ${project.version} - - - - report - - - - - - - ... - - ... - -+-----+ - -* Generate Plugin Report without duplicate execution of phase process-classes - - The standard report goal <<>> invokes separate lifecyle of <<>>. - In a CI environment you now might execute something like <<>>. - During <<>> build the standard reports will trigger <<>> again. - Depending on your build this may take some time because - stuff like <<>> or generating stubs from a WSDL will be invoked again, which may lead - to longer build times. - - As of version 3.14.0 a new report goal is defined, <<>> which will not trigger - the above phase a second time. - - Configure this in your <<>> section as follows: - -+-----+ - - ... - - - - org.apache.maven.plugins - maven-plugin-report-plugin - ${project.version} - - - - report-no-fork - - - - - - - ... - -+-----+ - - The documentation is generated by default in <<<$\{project.build.directory\}/site>>>. diff --git a/maven-plugin-report-plugin/src/site/apt/index.apt b/maven-plugin-report-plugin/src/site/apt/index.apt deleted file mode 100644 index 24117bbc9..000000000 --- a/maven-plugin-report-plugin/src/site/apt/index.apt +++ /dev/null @@ -1,65 +0,0 @@ - ------ - Introduction - ------ - Maria Odea Ching - ------ - 2008-01-01 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Maven Plugin Report Plugin - - The Maven Plugin Report Plugin is used to create report files for the Mojos. - -* Goals Overview - - The Plugin Report Plugin has two goals: - - * {{{./report-mojo.html}plugin-report:report}} which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo). - - * {{{./report-no-fork-mojo.html}plugin-report:report-no-fork}} which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo) without forking the <<>> phase again. Note that this goal does require generation of classes before site generation, e.g. by invoking <<>>. - - [] - -* Usage - - General instructions on how to use the Plugin Report Plugin can be found on the {{{./usage.html}usage page}}. - - In case you still have questions regarding the plugin's usage feel free to contact the {{{./mailing-lists.html}user mailing list}}. - The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. - Hence, it is also worth browsing/searching the {{{./mailing-lists.html}mail archive}}. - - If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our - {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your - concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, - entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. - Of course, patches are welcome, too. Contributors can check out the project from our - {{{./scm.html}source repository}} and will find supplementary information in the - {{{/guides/development/guide-helping.html}guide to helping with Maven}}. - -* Examples - - The following examples shows how to use the Plugin Report Plugin in more advanced usecases: - - * {{{./examples/generate-report.html}Configuring Generation of Documentation Reports}} - - [] diff --git a/maven-plugin-report-plugin/src/site/apt/usage.apt b/maven-plugin-report-plugin/src/site/apt/usage.apt deleted file mode 100644 index d53b1d2d3..000000000 --- a/maven-plugin-report-plugin/src/site/apt/usage.apt +++ /dev/null @@ -1,46 +0,0 @@ - ------ - Usage - ------ - Maria Odea Ching - Vincent Siveton - ------ - 2008-01-01 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Usage - - The Plugin Report Plugin is used to create reports about the plugin being built. - -* The <<>> Goal - - To generate the documentation of your plugin, execute the following on the command line: - -+-----+ -mvn plugin-report:report -+-----+ - - The xdoc files, one per goal, are generated by default in <<<$\{project.build.directory\}/generated-site/xdoc>>>, - and an overview is generated in the site output. - - If you add the plugin to the <<>> section of your pom, you'll get the full report as html with <<>>. - diff --git a/maven-plugin-report-plugin/src/site/markdown/examples/generate-report.md.vm b/maven-plugin-report-plugin/src/site/markdown/examples/generate-report.md.vm new file mode 100644 index 000000000..9a31ca63b --- /dev/null +++ b/maven-plugin-report-plugin/src/site/markdown/examples/generate-report.md.vm @@ -0,0 +1,89 @@ +--- +title: Configuring Generation of Documentation Reports +author: + - Vincent Siveton +date: 2008-01-01 +--- + + + +# Configuring Generation of Documentation Reports + +To configure the generation of the documentation reports, add the following to the project's POM: + +```unknown + + ... + + + + org.apache.maven.plugins + maven-plugin-report-plugin + ${project.version} + + + + report + + + + + + + ... + + ... + +``` + +Generate Plugin Report without duplicate execution of phase process-classes +--------------------------------------------------------------------------- + +The standard report goal `report` invokes separate lifecyle of `process-classes`. In a CI environment you now might execute something like `mvn clean deploy site-deploy`. During `site` build the standard reports will trigger `process-classes` again. Depending on your build this may take some time because stuff like `enforcer` or generating stubs from a WSDL will be invoked again, which may lead to longer build times. + +As of version 3.14.0 a new report goal is defined, `report-no-fork` which will not trigger the above phase a second time. + +Configure this in your `reporting` section as follows: + +```unknown + + ... + + + + org.apache.maven.plugins + maven-plugin-report-plugin + ${project.version} + + + + report-no-fork + + + + + + + ... + +``` + +The documentation is generated by default in `${esc.d}{project.build.directory}/site`. + diff --git a/maven-plugin-report-plugin/src/site/markdown/index.md b/maven-plugin-report-plugin/src/site/markdown/index.md new file mode 100644 index 000000000..eff8709d6 --- /dev/null +++ b/maven-plugin-report-plugin/src/site/markdown/index.md @@ -0,0 +1,53 @@ +--- +title: Introduction +author: + - Maria Odea Ching +date: 2008-01-01 +--- + + + +# Maven Plugin Report Plugin + +The Maven Plugin Report Plugin is used to create report files for the Mojos. + +Goals Overview +-------------- + +The Plugin Report Plugin has two goals: + +- [plugin-report:report](./report-mojo.html) which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo). +- [plugin-report:report-no-fork](./report-no-fork-mojo.html) which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo) without forking the `process-classes` phase again. Note that this goal does require generation of classes before site generation, e.g. by invoking `mvn clean verify site`. + +Usage +----- + +General instructions on how to use the Plugin Report Plugin can be found on the [usage page](./usage.html). + +In case you still have questions regarding the plugin's usage feel free to contact the [user mailing list](./mailing-lists.html). The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the [mail archive](./mailing-lists.html). + +If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our [issue tracker](./issue-management.html). When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our [source repository](./scm.html) and will find supplementary information in the [guide to helping with Maven](/guides/development/guide-helping.html). + +Examples +-------- + +The following examples shows how to use the Plugin Report Plugin in more advanced usecases: + +- [Configuring Generation of Documentation Reports](./examples/generate-report.html) diff --git a/maven-plugin-report-plugin/src/site/markdown/usage.md b/maven-plugin-report-plugin/src/site/markdown/usage.md new file mode 100644 index 000000000..23a1e1f2d --- /dev/null +++ b/maven-plugin-report-plugin/src/site/markdown/usage.md @@ -0,0 +1,44 @@ +--- +title: Usage +author: + - Maria Odea Ching + - Vincent Siveton +date: 2008-01-01 +--- + + + +# Usage + +The Plugin Report Plugin is used to create reports about the plugin being built. + +The `plugin-report:report` Goal +------------------------------- + +To generate the documentation of your plugin, execute the following on the command line: + +```unknown +mvn plugin-report:report +``` + +The xdoc files, one per goal, are generated by default in `${project.build.directory}/generated-site/xdoc`, and an overview is generated in the site output. + +If you add the plugin to the `reporting` section of your pom, you'll get the full report as html with `mvn site`. + diff --git a/maven-plugin-tools-annotations/src/site/apt/index.apt b/maven-plugin-tools-annotations/src/site/markdown/index.md similarity index 63% rename from maven-plugin-tools-annotations/src/site/apt/index.apt rename to maven-plugin-tools-annotations/src/site/markdown/index.md index a4f156b33..9f5fa6aff 100644 --- a/maven-plugin-tools-annotations/src/site/apt/index.apt +++ b/maven-plugin-tools-annotations/src/site/markdown/index.md @@ -1,41 +1,37 @@ - ------ - Introduction - ------ - Hervé Boutemy - ------ - 2012-05-12 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Maven Plugin Tool for Annotations - - The Maven Plugin Tool for Annotations is the <<>> implementation of - {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}} - to extract descriptors from plugins written in Java with - {{{../maven-plugin-annotations/index.html}Maven Plugin Tools Java Annotations}}. - -* Supported Annotations - -+---------+ +--- +title: Introduction +author: + - Hervé Boutemy +date: 2012-05-12 +--- + + + +# Maven Plugin Tool for Annotations + +The Maven Plugin Tool for Annotations is the `java-annotations` implementation of [maven-plugin-tools-api](../maven-plugin-tools-api/index.html) to extract descriptors from plugins written in Java with [Maven Plugin Tools Java Annotations](../maven-plugin-annotations/index.html). + +Supported Annotations +--------------------- + +```unknown import org.apache.maven.execution.MavenSession; import org.apache.maven.plugin.AbstractMojo; import org.apache.maven.plugin.MojoExecution; @@ -145,23 +141,15 @@ public class MyMojo ... } } -+---------+ - - -* See also - - * {{{../maven-plugin-annotations/index.html}Maven Plugin Tools Java Annotations}} - - * {{{/developers/mojo-api-specification.html#The_Descriptor_and_Annotations}Mojo API Specification}} - - * {{{/ref/current/maven-plugin-api/plugin.html}META-INF/maven/plugin.xml plugin descriptor}} - - * {{{/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html}PluginParameterExpressionEvaluator}}, - used to evaluate plugin parameters values during Mojo configuration, - - * pseudo parameters: - - * <<>> {{{https://maven.apache.org/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html}javadoc}} / - {{{https://maven.apache.org/ref/current/maven-core/xref/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html}source}} - - * {{{https://issues.apache.org/jira/browse/MNG-5695}MNG-5695}}: scoped objects added to Guice/Sisu in {{{https://maven.apache.org/ref/current/maven-core/}maven-core}} 3.2.5 +``` + +See also +-------- + +- [Maven Plugin Tools Java Annotations](../maven-plugin-annotations/index.html) +- [Mojo API Specification](/developers/mojo-api-specification.html#The_Descriptor_and_Annotations) +- [META-INF/maven/plugin.xml plugin descriptor](/ref/current/maven-plugin-api/plugin.html) +- [PluginParameterExpressionEvaluator](/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html), used to evaluate plugin parameters values during Mojo configuration, +- pseudo parameters: + - `PluginParameterExpressionEvaluator` [javadoc](https://maven.apache.org/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html) / [source](https://maven.apache.org/ref/current/maven-core/xref/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html) + - [MNG-5695](https://issues.apache.org/jira/browse/MNG-5695): scoped objects added to Guice/Sisu in [maven-core](https://maven.apache.org/ref/current/maven-core/) 3.2.5 diff --git a/maven-plugin-tools-api/src/site/apt/index.apt b/maven-plugin-tools-api/src/site/apt/index.apt deleted file mode 100644 index 72644a073..000000000 --- a/maven-plugin-tools-api/src/site/apt/index.apt +++ /dev/null @@ -1,36 +0,0 @@ - ------ - Introduction - ------ - Vincent Siveton - ------ - 2012-05-14 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Maven Plugin Tool API - - The Maven Plugin Tool API is the API to extract descriptors for all supported Maven plugins. - - Main component is {{{./apidocs/org/apache/maven/tools/plugin/scanner/MojoScanner.html}MojoScanner}}. - - Each descriptor extractor needs to implement - {{{./apidocs/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.html}MojoDescriptorExtractor}}. diff --git a/maven-plugin-tools-api/src/site/markdown/index.md b/maven-plugin-tools-api/src/site/markdown/index.md new file mode 100644 index 000000000..6d710422f --- /dev/null +++ b/maven-plugin-tools-api/src/site/markdown/index.md @@ -0,0 +1,34 @@ +--- +title: Introduction +author: + - Vincent Siveton +date: 2012-05-14 +--- + + + +# Maven Plugin Tool API + +The Maven Plugin Tool API is the API to extract descriptors for all supported Maven plugins. + +Main component is [MojoScanner](./apidocs/org/apache/maven/tools/plugin/scanner/MojoScanner.html). + +Each descriptor extractor needs to implement [MojoDescriptorExtractor](./apidocs/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.html). + diff --git a/maven-plugin-tools-java/src/site/apt/index.apt b/maven-plugin-tools-java/src/site/markdown/index.md similarity index 53% rename from maven-plugin-tools-java/src/site/apt/index.apt rename to maven-plugin-tools-java/src/site/markdown/index.md index 186e9bd39..4b738c68c 100644 --- a/maven-plugin-tools-java/src/site/apt/index.apt +++ b/maven-plugin-tools-java/src/site/markdown/index.md @@ -1,43 +1,40 @@ - ------ - Introduction - ------ - Vincent Siveton - Hervé Boutemy - ------ - 2011-10-23 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Maven Plugin Tool for Java Annotated with Mojo Javadoc Tags - - <> - - The Maven Plugin Tool for Java is the <<>> implementation of - {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}} - to extract descriptors for plugins written in Java annotated with Mojo Javadoc Tags. - -* Supported Mojo Javadoc Tags - -+---------+ +--- +title: Introduction +author: + - Vincent Siveton + - Hervé Boutemy +date: 2011-10-23 +--- + + + +# Maven Plugin Tool for Java Annotated with Mojo Javadoc Tags + +**This Mojo descriptor extractor is deprecated and should no longer be used. Rely on [Maven Plugin Tool for Annotations](../maven-plugin-tools-annotations/index.html) instead.** + +The Maven Plugin Tool for Java is the `java-javadoc` implementation of [maven-plugin-tools-api](../maven-plugin-tools-api/index.html) to extract descriptors for plugins written in Java annotated with Mojo Javadoc Tags. + +Supported Mojo Javadoc Tags +--------------------------- + +```unknown import org.apache.maven.execution.MavenSession; import org.apache.maven.plugin.AbstractMojo; import org.apache.maven.plugin.MojoExecution; @@ -134,16 +131,13 @@ public class MyMojo ... } } -+---------+ +``` - <>: before 3.0, <<>> was replaced by <<>>, with <<<$\{ }>>> required (<<>>), - but starting with 3.0, you can omit it (<<>>), or preferably use <<>>. +**Notice**: before 3.0, `property` was replaced by `expression`, with `${ }` required (`expression="${aProperty}"`), but starting with 3.0, you can omit it (`expression="aProperty"`), or preferably use `property="aProperty"`. -* See also +See also +-------- - * {{{/developers/mojo-api-specification.html#The_Descriptor_and_Annotations}Mojo API Specification}} - - * {{{/ref/current/maven-plugin-api/plugin.html}<<>> plugin descriptor}} - - * {{{/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html}PluginParameterExpressionEvaluator}}, - used to evaluate plugin parameters values during Mojo configuration, +- [Mojo API Specification](/developers/mojo-api-specification.html#The_Descriptor_and_Annotations) +- [`META-INF/maven/plugin.xml` plugin descriptor](/ref/current/maven-plugin-api/plugin.html) +- [PluginParameterExpressionEvaluator](/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html), used to evaluate plugin parameters values during Mojo configuration, diff --git a/maven-script/maven-plugin-tools-ant/src/site/apt/index.apt b/maven-script/maven-plugin-tools-ant/src/site/apt/index.apt deleted file mode 100644 index 7d4889825..000000000 --- a/maven-script/maven-plugin-tools-ant/src/site/apt/index.apt +++ /dev/null @@ -1,39 +0,0 @@ - ------ - Introduction - ------ - Vincent Siveton - ------ - 2008-07-15 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Maven Plugin Tool for Ant - - <> - - The Maven Plugin Tool for Ant is the <<>> implementation of - {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}} to - extract descriptors for plugins written in Ant. - - An Ant Maven Plugin has to be written in a file ending in <<<.build.xml>>> in <<>>, - with {{{../maven-plugin-tools-model/plugin-metadata.html}plugin metadata}} in corresponding <<<.mojos.xml>>> file - to generate the plugin descriptor. diff --git a/maven-script/maven-plugin-tools-ant/src/site/markdown/index.md b/maven-script/maven-plugin-tools-ant/src/site/markdown/index.md new file mode 100644 index 000000000..2d59bdab3 --- /dev/null +++ b/maven-script/maven-plugin-tools-ant/src/site/markdown/index.md @@ -0,0 +1,34 @@ +--- +title: Introduction +author: + - Vincent Siveton +date: 2008-07-15 +--- + + + +# Maven Plugin Tool for Ant + +**This Mojo descriptor extractor is deprecated and should no longer be used. With Maven 4 only Java based Mojos will be supported. Use Java and rely on [Maven Plugin Tool for Annotations](../maven-plugin-tools-annotations/index.html) instead.** + +The Maven Plugin Tool for Ant is the `ant` implementation of [maven-plugin-tools-api](../maven-plugin-tools-api/index.html) to extract descriptors for plugins written in Ant. + +An Ant Maven Plugin has to be written in a file ending in `.build.xml` in `src/main/scripts`, with [plugin metadata](../maven-plugin-tools-model/plugin-metadata.html) in corresponding `.mojos.xml` file to generate the plugin descriptor. + diff --git a/maven-script/maven-plugin-tools-beanshell/src/site/apt/index.apt b/maven-script/maven-plugin-tools-beanshell/src/site/apt/index.apt deleted file mode 100644 index a079dbe15..000000000 --- a/maven-script/maven-plugin-tools-beanshell/src/site/apt/index.apt +++ /dev/null @@ -1,35 +0,0 @@ - ------ - Introduction - ------ - Vincent Siveton - ------ - 2008-07-15 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Maven Plugin Tool for Beanshell - - <> - - The Maven Plugin Tool for Beanshell is the <<>> implementation of - {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}} - to extract descriptors for plugins written in Beanshell. diff --git a/maven-script/maven-plugin-tools-beanshell/src/site/markdown/index.md b/maven-script/maven-plugin-tools-beanshell/src/site/markdown/index.md new file mode 100644 index 000000000..e099b0407 --- /dev/null +++ b/maven-script/maven-plugin-tools-beanshell/src/site/markdown/index.md @@ -0,0 +1,32 @@ +--- +title: Introduction +author: + - Vincent Siveton +date: 2008-07-15 +--- + + + +# Maven Plugin Tool for Beanshell + +**This Mojo descriptor extractor is deprecated and should no longer be used. With Maven 4 only Java based Mojos will be supported. Use Java and rely on [Maven Plugin Tool for Annotations](../maven-plugin-tools-annotations/index.html) instead.** + +The Maven Plugin Tool for Beanshell is the `bsh` implementation of [maven-plugin-tools-api](../maven-plugin-tools-api/index.html) to extract descriptors for plugins written in Beanshell. + diff --git a/maven-script/maven-plugin-tools-model/src/site/apt/index.apt b/maven-script/maven-plugin-tools-model/src/site/apt/index.apt deleted file mode 100644 index 77d128c14..000000000 --- a/maven-script/maven-plugin-tools-model/src/site/apt/index.apt +++ /dev/null @@ -1,41 +0,0 @@ - ------ - Introduction - ------ - Vincent Siveton - ------ - 2008-07-15 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Maven Plugin Tool Model - - The Maven Plugin Tool Model is a model to extract descriptors information from plugins. - - The following are generated from this model: - - * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the Xpp3 XML parser - - * A {{{./plugin-metadata.html}Descriptor Reference}} - - * An {{{./plugin-metadata-1.1.0.xsd}XSD}}. - - [] diff --git a/maven-script/maven-plugin-tools-model/src/site/markdown/index.md b/maven-script/maven-plugin-tools-model/src/site/markdown/index.md new file mode 100644 index 000000000..1907317f2 --- /dev/null +++ b/maven-script/maven-plugin-tools-model/src/site/markdown/index.md @@ -0,0 +1,35 @@ +--- +title: Introduction +author: + - Vincent Siveton +date: 2008-07-15 +--- + + + +# Maven Plugin Tool Model + +The Maven Plugin Tool Model is a model to extract descriptors information from plugins. + +The following are generated from this model: + +- [Java sources](./apidocs/index.html) with Reader and Writers for the Xpp3 XML parser +- A [Descriptor Reference](./plugin-metadata.html) +- An [XSD](./plugin-metadata-1.1.0.xsd).