| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- Generated by Apache Maven Doxia Site Renderer 1.3 at Jul 31, 2013 --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| <title>Apache Whisker::Plugin4Maven - Introduction</title> |
| <style type="text/css" media="all"> |
| @import url("./css/maven-base.css"); |
| @import url("./css/maven-theme.css"); |
| @import url("./css/site.css"); |
| </style> |
| <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
| <meta name="Date-Revision-yyyymmdd" content="20130731" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| |
| <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Mate+SC"/> |
| |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <div id="bannerLeft"> |
| Apache Whisker::Plugin(Maven) |
| </div> |
| <a href="http://www.apache.org/" id="bannerRight"> |
| <img src="http://www.apache.org/images/asf_logo_wide.jpg" alt="The Apache Software Foundation" title="The Apache Software Foundation" /> |
| </a> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| |
| |
| <div class="xleft"> |
| <span id="publishDate">Last Published: 2013-07-31</span> |
| | <span id="projectVersion">Version: 0.1-SNAPSHOT</span> |
| | <a href="http://www.apache.org/" class="externalLink" title="Apache">Apache</a> |
| > |
| <a href="http://creadur.apache.org/" class="externalLink" title="Creadur">Creadur</a> |
| > |
| <a href="http://creadur.apache.org/whisker/" class="externalLink" title="Whisker">Whisker</a> |
| > |
| <a href="./" title="Apache Whisker::Plugin4Maven">Apache Whisker::Plugin4Maven</a> |
| > |
| Introduction |
| </div> |
| <div class="xright"> |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| |
| |
| <h5>Overview</h5> |
| <ul> |
| <li class="none"> |
| <strong>Introduction</strong> |
| </li> |
| <li class="none"> |
| <a href="plugin-info.html" title="Goals">Goals</a> |
| </li> |
| <li class="none"> |
| <a href="usage.html" title="Usage">Usage</a> |
| </li> |
| <li class="none"> |
| <a href="faq.html" title="FAQ">FAQ</a> |
| </li> |
| </ul> |
| <h5>Examples</h5> |
| <ul> |
| <li class="none"> |
| <a href="examples/generation-in-5-mins.html" title="In 5 Minutes">In 5 Minutes</a> |
| </li> |
| </ul> |
| <h5>Parent Project</h5> |
| <ul> |
| <li class="none"> |
| <a href="../index.html" title="Apache Whisker">Apache Whisker</a> |
| </li> |
| </ul> |
| <h5>Project Documentation</h5> |
| <ul> |
| <li class="expanded"> |
| <a href="project-info.html" title="Project Information">Project Information</a> |
| <ul> |
| <li class="none"> |
| <a href="distribution-management.html" title="Distribution Management">Distribution Management</a> |
| </li> |
| <li class="none"> |
| <strong>About</strong> |
| </li> |
| <li class="none"> |
| <a href="dependencies.html" title="Dependencies">Dependencies</a> |
| </li> |
| <li class="none"> |
| <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a> |
| </li> |
| <li class="none"> |
| <a href="plugins.html" title="Project Plugins">Project Plugins</a> |
| </li> |
| <li class="none"> |
| <a href="integration.html" title="Continuous Integration">Continuous Integration</a> |
| </li> |
| <li class="none"> |
| <a href="license.html" title="Project License">Project License</a> |
| </li> |
| <li class="none"> |
| <a href="dependency-management.html" title="Dependency Management">Dependency Management</a> |
| </li> |
| <li class="none"> |
| <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a> |
| </li> |
| <li class="none"> |
| <a href="team-list.html" title="Project Team">Project Team</a> |
| </li> |
| <li class="none"> |
| <a href="dependency-convergence.html" title="Dependency Convergence">Dependency Convergence</a> |
| </li> |
| <li class="none"> |
| <a href="source-repository.html" title="Source Repository">Source Repository</a> |
| </li> |
| <li class="none"> |
| <a href="plugin-management.html" title="Plugin Management">Plugin Management</a> |
| </li> |
| <li class="none"> |
| <a href="project-summary.html" title="Project Summary">Project Summary</a> |
| </li> |
| </ul> |
| </li> |
| <li class="collapsed"> |
| <a href="project-reports.html" title="Project Reports">Project Reports</a> |
| </li> |
| </ul> |
| <h5>Apache Whisker™</h5> |
| <ul> |
| <li class="none"> |
| <a href="../index.html" title="Introducing Whisker">Introducing Whisker</a> |
| </li> |
| <li class="none"> |
| <a href="../meta-data.html" title="Meta Data">Meta Data</a> |
| </li> |
| <li class="none"> |
| <a href="../apache-whisker-plugin4maven/index.html" title="Maven Plugin">Maven Plugin</a> |
| </li> |
| <li class="none"> |
| <a href="../apache-whisker-cli/index.html" title="Command Line">Command Line</a> |
| </li> |
| <li class="none"> |
| <a href="../apidocs/index.html" title="Javadocs">Javadocs</a> |
| </li> |
| <li class="none"> |
| <a href="../xref/index.html" title="Source Cross-ref">Source Cross-ref</a> |
| </li> |
| <li class="none"> |
| <a href="../faq.html" title="FAQ">FAQ</a> |
| </li> |
| </ul> |
| <h5>Apache Creadur ™</h5> |
| <ul> |
| <li class="none"> |
| <a href="http://creadur.apache.org" class="externalLink" title="Creadur Project Home">Creadur Project Home</a> |
| </li> |
| <li class="none"> |
| <a href="http://creadur.apache.org/rat" class="externalLink" title="Apache Rat">Apache Rat</a> |
| </li> |
| <li class="none"> |
| <a href="http://creadur.apache.org/tentacles" class="externalLink" title="Apache Tentacles">Apache Tentacles</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/security/" class="externalLink" title="Security">Security</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/licenses/" class="externalLink" title="License">License</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a> |
| </li> |
| </ul> |
| <h5>The Apache Software Foundation</h5> |
| <ul> |
| <li class="none"> |
| <a href="http://www.apache.org/foundation" class="externalLink" title="About the Foundation">About the Foundation</a> |
| </li> |
| <li class="none"> |
| <a href="http://projects.apache.org" class="externalLink" title="The projects">The projects</a> |
| </li> |
| <li class="none"> |
| <a href="http://people.apache.org" class="externalLink" title="The people">The people</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How we work">How we work</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/foundation/how-it-works.html#history" class="externalLink" title="Our history">Our history</a> |
| </li> |
| <li class="none"> |
| <a href="http://blogs.apache.org/foundation/" class="externalLink" title="News">News</a> |
| </li> |
| </ul> |
| <h5>Contribute</h5> |
| <ul> |
| <li class="none"> |
| <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">Get Involved</a> |
| </li> |
| </ul> |
| <h5>Committer Info</h5> |
| <ul> |
| <li class="none"> |
| <a href="http://www.apache.org/dev/committers.html" class="externalLink" title="Committers' FAQ">Committers' FAQ</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/dev/new-committers-guide.html" class="externalLink" title="New Committers Guide">New Committers Guide</a> |
| </li> |
| <li class="none"> |
| <a href="http://planet.apache.org/committers/" class="externalLink" title="Plant Apache">Plant Apache</a> |
| </li> |
| <li class="none"> |
| <a href="http://community.apache.org/" class="externalLink" title="Community">Community</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/legal/" class="externalLink" title="Legal">Legal</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/foundation/marks/" class="externalLink" title="Branding">Branding</a> |
| </li> |
| <li class="none"> |
| <a href="http://www.apache.org/press/" class="externalLink" title="Media Relations">Media Relations</a> |
| </li> |
| </ul> |
| <a href="http://maven.apache.org/" title="Maven" class="poweredBy"> |
| <img class="poweredBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" /> |
| </a> |
| |
| |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --><!-- --><!-- 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. --><!-- --><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --><div class="section"><h2>What Is Apache Whisker?<a name="What_Is_Apache_Whisker"></a></h2><p>Apache Whisker assists assembled applications maintain correct legal documentation. Read more about how Whisker can help <a href="../index.html"> here</a>.</p></div><div class="section"><h2>How Can Apache Whisker Plugins For Maven Help?<a name="How_Can_Apache_Whisker_Plugins_For_Maven_Help"></a></h2><p><a class="externalLink" href="http://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><div class="section"><h3>Goals Overview<a name="Goals_Overview"></a></h3><p>The <a class="externalLink" href="http://creadur.apache.org/whisker"> Apache Whisker</a> plugin for Maven supports the follow goal:</p><ul><li><a href="./generate-mojo.html">apache-whisker4:generate</a> generates licensing related materials such as <tt>LICENSE</tt> and <tt>NOTICE</tt> documents for assembled applications.</li></ul></div><div class="section"><h3>Usage<a name="Usage"></a></h3><p>General instructions on how to use the Apache Whisker plugin for Maven 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="./mail-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="./mail-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-tracking.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="./source-repository.html">source repository</a>. Apache Whisker is developed collaboratively by the <a class="externalLink" href="http://creadur.apache.org">Apache Creadur</a> <a class="externalLink" href="http://community.apache.org/">community</a>. We create and maintain a range of <a class="externalLink" href="http://www.opensource.org">open source</a> software tools which assist in the audit, review and comprehension of software distributions. Please <a href="./mail-lists.html">drop in and say hello</a>.</p></div><div class="section"><h3>Examples<a name="Examples"></a></h3><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></div></div> |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright"> |
| <?xml version="1.0" encoding="UTF-8"?> |
| <footer>Copyright © 2012 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache Rat, Apache Tentacles, Apache Whisker, Apache and the Apache feather 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.</footer> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |
