| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/apt/index.apt.vm 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>Introduction – 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">Introduction</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 class="active"><a>Introduction</a></li> |
| <li><a href="plugin-info.html">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-down"></span>Project Information</a> |
| <ul class="nav nav-list"> |
| <li><a href="ci-management.html">CI Management</a></li> |
| <li><a href="dependencies.html">Dependencies</a></li> |
| <li><a href="dependency-info.html">Maven Coordinates</a></li> |
| <li><a href="dependency-management.html">Dependency Management</a></li> |
| <li><a href="distribution-management.html">Distribution Management</a></li> |
| <li class="active"><a>About</a></li> |
| <li><a href="issue-management.html">Issue Management</a></li> |
| <li><a href="licenses.html">Licenses</a></li> |
| <li><a href="mailing-lists.html">Mailing Lists</a></li> |
| <li><a href="plugin-management.html">Plugin Management</a></li> |
| <li><a href="plugins.html">Plugins</a></li> |
| <li><a href="scm.html">Source Code Management</a></li> |
| <li><a href="summary.html">Summary</a></li> |
| <li><a href="team.html">Team</a></li> |
| </ul></li> |
| <li><a href="project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></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="What_Is_Apache_Whisker.3F"></a> |
| <h1>What Is Apache Whisker?</h1> |
| <p>Apache Whisker assists assembled applications maintain correct legal documentation. Read more about how Whisker can help <a href="../index.html"> here</a>.</p></section><section><a id="How_Can_Apache_Whisker_Maven_Plugin_Help.3F"></a> |
| <h1>How Can Apache Whisker Maven Plugin Help?</h1> |
| <p><a class="externalLink" href="https://maven.apache.org">Apache Maven</a> is a declarative build management tool, useful not only for building components but also for assembling them into applications.</p> |
| <ul> |
| <li>Whisker <a href="./generate-mojo.html"> generates</a> licensing materials for assembled applications.</li></ul><section><a id="Goals_Overview"></a> |
| <h2>Goals Overview</h2> |
| <p>The <a class="externalLink" href="https://creadur.apache.org/whisker"> Apache Whisker</a> plugin for Maven supports the follow goal:</p> |
| <ul> |
| <li><a href="./generate-mojo.html">apache-whisker:generate</a> generates licensing related materials such as <code>LICENSE</code> and <code>NOTICE</code> documents for assembled applications.</li></ul></section><section><a id="Usage"></a> |
| <h2>Usage</h2> |
| <p>General instructions on how to use the Apache Whisker Maven Plugin can be found on the <a href="./usage.html">usage page</a>. Some more specific use cases are described in the examples given below. </p> |
| <p>In case you still have questions regarding the plugin's usage, please have a look at the <a href="./faq.html">FAQ</a> and feel free to contact the <a href="./mailing-lists.html">mailing list</a>. 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 <a href="./mailing-lists.html">mail archive</a>.</p> |
| <p>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 <a href="./issue-management.html">issue tracker</a>. 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.</p> |
| <p>Of course, patches are very welcome, too. Contributors can check out the project from our <a href="./scm.html">source repository</a>. Apache Whisker is developed collaboratively by the <a class="externalLink" href="https://creadur.apache.org">Apache Creadur</a> <a class="externalLink" href="https://community.apache.org/">community</a>. We create and maintain a range of <a class="externalLink" href="https://www.opensource.org">open source</a> software tools which assist in the audit, review and comprehension of software distributions. Please <a href="./mailing-lists.html">drop in and say hello</a>.</p></section><section><a id="Examples"></a> |
| <h2>Examples</h2> |
| <p>To provide you with better understanding of some usages of the Plugin Name, you can take a look into the following examples:</p> |
| <ul> |
| <li><a href="./examples/generation-in-5-mins.html">Generation In 5 Minutes</a></li></ul></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> |
