This is an automated email from the ASF dual-hosted git repository. sjaranowski pushed a commit to branch MPLUGIN-391-docs in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
commit 3c51fd77d330d41edcf3428100f1785fdac1c488 Author: Slawomir Jaranowski <[email protected]> AuthorDate: Fri Oct 14 17:57:09 2022 +0200 [MPLUGIN-391] Remove examples with scripting As scripting support was deprecated we can also remove examples to not teach users how to use it --- .../src/site/apt/examples/ant-mojo.apt.vm | 80 ---------------------- .../src/site/apt/examples/beanshell-mojo.apt.vm | 73 -------------------- maven-plugin-plugin/src/site/site.xml | 2 - src/site/site.xml | 4 +- src/site/xdoc/index.xml | 9 ++- 5 files changed, 6 insertions(+), 162 deletions(-) diff --git a/maven-plugin-plugin/src/site/apt/examples/ant-mojo.apt.vm b/maven-plugin-plugin/src/site/apt/examples/ant-mojo.apt.vm deleted file mode 100644 index a5be6d8c..00000000 --- a/maven-plugin-plugin/src/site/apt/examples/ant-mojo.apt.vm +++ /dev/null @@ -1,80 +0,0 @@ - ------ - Writing an Ant Maven Plugin - ------ - 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: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Writing an Ant Maven Plugin - - You can write Maven plugins based on Ant scripts. - -* Pom configuration - -+------------+ -<project> - ... - <dependencies> - <dependency> - <groupId>org.apache.maven</groupId> - <artifactId>maven-script-ant</artifactId> - <version>2.2.1</version> - </dependency> - </dependencies> - ... - <build> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-plugin-plugin</artifactId> - <version>${project.version}</version> - <dependencies> - <dependency> - <groupId>org.apache.maven.plugin-tools</groupId> - <artifactId>maven-plugin-tools-ant</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> - </plugin> - </plugins> - </build> - ... -</project> -+------------+ - -* Files structure - - The Ant plugin consists in two files. If you want to create a <<<touch>>> plugin, you must have: - - * <<<src/main/scripts/touch.mojos.xml>>>: contains Mojo(s) descriptor informations, - - * <<<src/main/scripts/touch.build.xml>>>: contains the Ant xml to execute. - -** Ant Mojos descriptor - -%{snippet|id=ant-mojo|url=http://svn.apache.org/repos/asf/maven/plugin-tools/trunk/maven-plugin-plugin/src/it/ant-basic/src/main/scripts/touch.mojos.xml} - -** Ant script - -%{snippet|id=ant-build|url=http://svn.apache.org/repos/asf/maven/plugin-tools/trunk/maven-plugin-plugin/src/it/ant-basic/src/main/scripts/touch.build.xml} diff --git a/maven-plugin-plugin/src/site/apt/examples/beanshell-mojo.apt.vm b/maven-plugin-plugin/src/site/apt/examples/beanshell-mojo.apt.vm deleted file mode 100644 index 3051e8fb..00000000 --- a/maven-plugin-plugin/src/site/apt/examples/beanshell-mojo.apt.vm +++ /dev/null @@ -1,73 +0,0 @@ - ------ - Writing a Beanshell Maven Plugin - ------ - 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: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Writing a Beanshell Maven Plugin - - You can write a Maven plugin using {{{http://www.beanshell.org}Beanshell}}. - -* Pom configuration - -+------------------ - <dependencies> - <dependency> - <groupId>org.apache-extras.beanshell</groupId> - <artifactId>bsh</artifactId> - <version>2.0b6</version> - </dependency> - <dependency> - <groupId>org.apache.maven</groupId> - <artifactId>maven-script-beanshell</artifactId> - <version>3.6.4</version> - </dependency> - </dependencies> - - <build> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-plugin-plugin</artifactId> - <version>${project.version}</version> - <dependencies> - <dependency> - <groupId>org.apache.maven.plugin-tools</groupId> - <artifactId>maven-plugin-tools-beanshell</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> - </plugin> - </plugins> - </build> -+------------------ - -* Beanshell plugin - - A Beanshell mojo uses same javadoc tags as a Java mojo with javadoc tags. - - Sample script content: - -%{snippet|id=beanshell-mojo|url=http://svn.apache.org/repos/asf/maven/plugin-tools/trunk/maven-plugin-plugin/src/it/beanshell-simple/src/main/scripts/touch.bsh} diff --git a/maven-plugin-plugin/src/site/site.xml b/maven-plugin-plugin/src/site/site.xml index 367b87bd..05c75725 100644 --- a/maven-plugin-plugin/src/site/site.xml +++ b/maven-plugin-plugin/src/site/site.xml @@ -39,8 +39,6 @@ under the License. <item name="Configuring Generation of Plugin Descriptor" href="/examples/generate-descriptor.html"/> <item name="Configuring Generation of Plugin Documentation" href="/examples/generate-report.html"/> <item name="Configuring Generation of HelpMojo" href="/examples/generate-help.html"/> - <item name="Ant Mojo" href="/examples/ant-mojo.html"/> - <item name="Beanshell Mojo" href="/examples/beanshell-mojo.html"/> </menu> <menu name="Developers"> diff --git a/src/site/site.xml b/src/site/site.xml index dcbe948d..2c185da5 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -19,8 +19,8 @@ specific language governing permissions and limitations under the License. --> -<project xmlns="https://maven.apache.org/DECORATION/1.8.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="https://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd";> +<project xmlns="http://maven.apache.org/DECORATION/1.8.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd";> <body> <breadcrumbs> diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index af0d2963..94b4cf64 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -34,8 +34,7 @@ <section name="Maven Plugin Tools"> <p>The Maven Plugin Tools contains the necessary tools to generate rebarbative content like descriptor, - help and documentation. In addition, it provides tools to write Maven Plugins in scripting languages - like Ant or Beanshell.</p> + help and documentation.</p> <p> <img src="images/plugin-tools-deps.png" width="759" height="474" border="0" usemap="#PluginTools_dependencies" /> @@ -54,11 +53,11 @@ <area shape="rect" coords="514,95,759,131" alt="plugin-tools-generators" href="./maven-plugin-tools-generators"/> <area shape="rect" coords="44,263,570,432" alt="maven-script" href="./maven-script"/> <area shape="rect" coords="340,438,529,474" alt="maven-plugin-api" href="/ref/current/maven-plugin-api/"/> - <area shape="rect" coords="510,154,582,190" alt="qdox" href="http://qdox.codehaus.org/"/> - <area shape="rect" coords="510,212,583,248" alt="asm" href="http://asm.ow2.org/"/> + <area shape="rect" coords="510,154,582,190" alt="qdox" href="https://github.com/paul-hammant/qdox"/> + <area shape="rect" coords="510,212,583,248" alt="asm" href="https://asm.ow2.org/"/> <area shape="rect" coords="656,134,747,169" alt="Doxia" href="/doxia/"/> <area shape="rect" coords="599,271,715,306" alt="Beanshell" href="http://www.beanshell.org/"/> - <area shape="rect" coords="600,329,670,366" alt="Ant" href="http://ant.apache.maven/"/> + <area shape="rect" coords="600,329,670,366" alt="Ant" href="https://ant.apache.org/"/> </map> </p>
