| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.1:report at 2025-09-23 |
| | Rendered using Apache Maven Fluido Skin 2.1.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>Plugin Documentation – Apache Whisker::Plugin4Maven</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-2.1.0.min.js"></script> |
| <link href="https://creadur.apache.org/font/matesc.css" type="text/css" rel="stylesheet" /> |
| </head> |
| <body> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/creadur-whisker" data-ribbon="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/"><img src="https://www.apache.org/img/asf_logo.png" alt="The Apache Software Foundation" /> Apache Whisker</a></h1></div></div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2025-09-23<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 0.2-SNAPSHOT<span class="divider">|</span></li> |
| <li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li> |
| <li><a href="../../">Creadur</a><span class="divider">/</span></li> |
| <li><a href="../">Whisker</a><span class="divider">/</span></li> |
| <li><a href="index.html">Apache Whisker::Plugin4Maven</a><span class="divider">/</span></li> |
| <li class="active">Plugin Documentation</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Overview</li> |
| <li><a href="index.html">Introduction</a></li> |
| <li class="active"><a>Goals</a></li> |
| <li><a href="usage.html">Usage</a></li> |
| <li><a href="faq.html">FAQ</a></li> |
| <li class="nav-header">Examples</li> |
| <li><a href="examples/generation-in-5-mins.html">In 5 Minutes</a></li> |
| <li class="nav-header">Parent Project</li> |
| <li><a href="../index.html">Apache Whisker</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="project-reports.html"><span class="icon-chevron-down"></span>Project Reports</a> |
| <ul class="nav nav-list"> |
| <li><a href="rat-report.html">Rat Report</a></li> |
| <li><a href="checkstyle.html">Checkstyle</a></li> |
| <li><a href="apidocs/index.html">Javadoc</a></li> |
| <li><a href="testapidocs/index.html">Test Javadoc</a></li> |
| <li><a href="xref/index.html">Source Xref</a></li> |
| <li><a href="xref-test/index.html">Test Source Xref</a></li> |
| <li><a href="surefire.html">Surefire</a></li> |
| <li><a href="cpd.html">CPD</a></li> |
| <li><a href="pmd.html">PMD</a></li> |
| <li><a href="jira-changes.html">JIRA Report</a></li> |
| <li><a href="jdepend-report.html">JDepend</a></li> |
| <li><a href="taglist.html">Tag List</a></li> |
| <li><a href="findbugs.html">FindBugs</a></li> |
| <li class="active"><a>Plugin Documentation</a></li> |
| </ul></li> |
| <li class="nav-header">Apache Whisker™</li> |
| <li><a href="../index.html">Introducing Whisker</a></li> |
| <li><a href="../meta-data.html">Meta Data</a></li> |
| <li><a href="../apache-whisker-maven-plugin/index.html">Maven Plugin</a></li> |
| <li><a href="../apache-whisker-cli/index.html">Command Line</a></li> |
| <li><a href="../apidocs/index.html">Javadocs</a></li> |
| <li><a href="../xref/index.html">Source Cross-ref</a></li> |
| <li><a href="../faq.html">FAQ</a></li> |
| <li><a href="../download_whisker.cgi">Downloads</a></li> |
| <li><a href="../changes.html">Changes</a></li> |
| <li class="nav-header">Apache Creadur™</li> |
| <li><a href="../..">Creadur Project Home</a></li> |
| <li><a href="../../rat">Apache Rat</a></li> |
| <li><a href="../../tentacles">Apache Tentacles</a></li> |
| <li><a href="https://www.apache.org/security/">Security</a></li> |
| <li><a href="https://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="nav-header">The Apache Software Foundation</li> |
| <li><a href="https://www.apache.org/foundation">About the Foundation</a></li> |
| <li><a href="https://projects.apache.org">The projects</a></li> |
| <li><a href="https://people.apache.org">The people</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html">How we work</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html#history">Our history</a></li> |
| <li><a href="https://blogs.apache.org/foundation/">News</a></li> |
| <li class="nav-header">Contribute</li> |
| <li><a href="https://www.apache.org/foundation/getinvolved.html">Get Involved</a></li> |
| <li class="nav-header">Committer Info</li> |
| <li><a href="https://www.apache.org/dev/committers.html">Committers' FAQ</a></li> |
| <li><a href="https://www.apache.org/dev/new-committers-guide.html">New Committers Guide</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-site/blob/asf-site/README.md">Howto publish this site</a></li> |
| <li><a href="https://community.apache.org/">Community</a></li> |
| <li><a href="https://www.apache.org/legal/">Legal</a></li> |
| <li><a href="https://www.apache.org/foundation/marks/">Branding</a></li> |
| <li><a href="https://www.apache.org/press/">Media Relations</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy"><img class="builtBy" src="https://maven.apache.org/images/logos/maven-feather.png" /> Maven</a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| <section><a id="Plugin_Documentation"></a> |
| <h1>Plugin Documentation</h1> |
| <p>This report describes goals, parameters details, requirements and sample usage of this plugin.</p><section><a id="Goals"></a> |
| <h2>Goals</h2> |
| <p>Goals available for this plugin:</p> |
| <table class="table table-striped"> |
| <tr class="a"> |
| <th>Goal</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="./generate-mojo.html">apache-whisker:generate</a></td> |
| <td>Generates licensing related materials such as LICENSE and NOTICE documents for assembled applications. The plugin is not bound to a specific lifecycle phase.</td></tr> |
| <tr class="a"> |
| <td><a href="./help-mojo.html">apache-whisker:help</a></td> |
| <td>Display help information on apache-whisker-maven-plugin. |
| <br /> |
| Call <code>mvn apache-whisker:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.</td></tr></table></section><section><a id="System_Requirements"></a> |
| <h2>System Requirements</h2> |
| <p>The following specifies the minimum requirements to run this Maven plugin:</p> |
| <table class="table table-striped"> |
| <tr class="a"> |
| <td>Maven</td> |
| <td>3.9.11</td></tr> |
| <tr class="b"> |
| <td>JDK</td> |
| <td>1.8</td></tr></table></section><section><a id="Usage"></a> |
| <h2>Usage</h2> |
| <p>You should specify the version in your project's plugin configuration:</p> |
| <pre class="prettyprint"><code><project> |
| ... |
| <build> |
| <!-- To define the plugin version in your parent POM --> |
| <pluginManagement> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.creadur.whisker</groupId> |
| <artifactId>apache-whisker-maven-plugin</artifactId> |
| <version>0.2-SNAPSHOT</version> |
| </plugin> |
| ... |
| </plugins> |
| </pluginManagement> |
| <!-- To use the plugin goals in your POM or parent POM --> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.creadur.whisker</groupId> |
| <artifactId>apache-whisker-maven-plugin</artifactId> |
| </plugin> |
| ... |
| </plugins> |
| </build> |
| ... |
| </project></code></pre> |
| <p>For more information, see <a class="externalLink" href="https://maven.apache.org/guides/mini/guide-configuring-plugins.html">"Guide to Configuring Plug-ins"</a></p></section></section> </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| Copyright © 2012-2025 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache RAT, Apache Tentacles, Apache Whisker, Apache and the ASF logo are trademarks |
| of The Apache Software Foundation. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| This is user documentation, not legal advice. |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
