Google Git
Sign in
apache / creadur-site / fb7a63593366e36906aa7e2def960c8265faab53 / . / whisker / apache-whisker-plugin4maven / plugin-info.html
blob: bea18a3511087471eb1d38a1900ed4eee9646e8d [file] [log] [blame]
<!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 - Plugin Documentation</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>
&nbsp;| <span id="projectVersion">Version: 0.1-SNAPSHOT</span>
| <a href="http://www.apache.org/" class="externalLink" title="Apache">Apache</a>
&gt;
<a href="http://creadur.apache.org/" class="externalLink" title="Creadur">Creadur</a>
&gt;
<a href="http://creadur.apache.org/whisker/" class="externalLink" title="Whisker">Whisker</a>
&gt;
<a href="./" title="Apache Whisker::Plugin4Maven">Apache Whisker::Plugin4Maven</a>
&gt;
Plugin Documentation
</div>
<div class="xright">
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Overview</h5>
<ul>
<li class="none">
<a href="index.html" title="Introduction">Introduction</a>
</li>
<li class="none">
<strong>Goals</strong>
</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="collapsed">
<a href="project-info.html" title="Project Information">Project Information</a>
</li>
<li class="expanded">
<a href="project-reports.html" title="Project Reports">Project Reports</a>
<ul>
<li class="none">
<a href="surefire-report.html" title="Surefire Report">Surefire Report</a>
</li>
<li class="none">
<strong>Plugin Documentation</strong>
</li>
<li class="none">
<a href="apidocs/index.html" title="JavaDocs">JavaDocs</a>
</li>
<li class="none">
<a href="testapidocs/index.html" title="Test JavaDocs">Test JavaDocs</a>
</li>
</ul>
</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">
<div class="section"><h2>Plugin Documentation<a name="Plugin_Documentation"></a></h2><a name="Plugin_Documentation"></a><p>Goals available for this plugin:</p><table border="0" class="bodyTable"><tr class="a"><th>Goal</th><th>Description</th></tr><tr class="b"><td><a href="generate-mojo.html">apache-whisker4:generate</a></td><td>Generates licensing related materials such as LICENSE and NOTICE
documents for assembled applications.</td></tr></table><div class="section"><h3>System Requirements<a name="System_Requirements"></a></h3><a name="System_Requirements"></a><p>The following specifies the minimum requirements to run this Maven plugin:</p><table border="0" class="bodyTable"><tr class="a"><td>Maven</td><td>2.0</td></tr><tr class="b"><td>JDK</td><td>1.5</td></tr><tr class="a"><td>Memory</td><td>No minimum requirement.</td></tr><tr class="b"><td>Disk Space</td><td>No minimum requirement.</td></tr></table></div><div class="section"><h3>Usage<a name="Usage"></a></h3><a name="Usage"></a><p>You should specify the version in your project's plugin configuration:</p><div class="source"><pre>&lt;project&gt;
...
&lt;build&gt;
&lt;!-- To define the plugin version in your parent POM --&gt;
&lt;pluginManagement&gt;
&lt;plugins&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.apache.creadur.whisker&lt;/groupId&gt;
&lt;artifactId&gt;apache-whisker-plugin4maven&lt;/artifactId&gt;
&lt;version&gt;0.1-SNAPSHOT&lt;/version&gt;
&lt;/plugin&gt;
...
&lt;/plugins&gt;
&lt;/pluginManagement&gt;
&lt;!-- To use the plugin goals in your POM or parent POM --&gt;
&lt;plugins&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.apache.creadur.whisker&lt;/groupId&gt;
&lt;artifactId&gt;apache-whisker-plugin4maven&lt;/artifactId&gt;
&lt;version&gt;0.1-SNAPSHOT&lt;/version&gt;
&lt;/plugin&gt;
...
&lt;/plugins&gt;
&lt;/build&gt;
...
&lt;/project&gt;
</pre></div><p>For more information, see <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-configuring-plugins.html">&quot;Guide to Configuring Plug-ins&quot;</a></p></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>