Google Git
Sign in
apache / creadur-site / 6d3f6ae1ea058f673d00a2cdb4bcb519a7cd07d9 / . / whisker / apache-whisker-plugin4maven / usage.html
blob: 0b80864fd1aa0c551267ec90c2a8ed0599c71f43 [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 - Usage</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;
Usage
</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">
<a href="plugin-info.html" title="Goals">Goals</a>
</li>
<li class="none">
<strong>Usage</strong>
</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="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>Usage<a name="Usage"></a></h2><p>The Apache Whisker plugin allows <a class="externalLink" href="http://creadur.apache.org/whisker"> Whisker</a> features to be integrated into a Maven built project. The following examples illustrate the basic usage of this plugin.</p><div class="section"><h3>Generate Licensing Documents From Meta-Data<a name="Generate_Licensing_Documents_From_Meta-Data"></a></h3><p><a class="externalLink" href="http://creadur.apache.org/whisker"> Apache Whisker</a> generates licensing documentation (for example, <tt>LICENSE</tt> and <tt>NOTICE</tt> documents) from a meta-data document. Read more about this format <a class="externalLink" href="http://creadur.apache.org/whisker/meta-data.html"> here</a> (in the Whisker documentation).</p><p>Configure the path (to the meta-data describing the licensing) using the <tt>descriptor</tt> element, and generate during package. </p><p>Let's say, for example, that the meta-data path in your project is <tt>descriptor.xml</tt>. Then <tt>LICENSE</tt> and <tt>NOTICE</tt> documents could be generated each build by adding (to the project <tt>pom.xml</tt>) a plugin definition something like:</p><div class="source"><pre> ...
&lt;build&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;executions&gt;
&lt;execution&gt;
&lt;id&gt;generate-licensing-docs&lt;/id&gt;
&lt;phase&gt;package&lt;/phase&gt;
&lt;goals&gt;
&lt;goal&gt;generate&lt;/goal&gt;
&lt;/goals&gt;
&lt;/execution&gt;
&lt;/executions&gt;
&lt;configuration&gt;
&lt;descriptor&gt;descriptor.xml&lt;/descriptor&gt;
&lt;/configuration&gt;
&lt;/plugin&gt;
...
&lt;/plugins&gt;
&lt;/build&gt;
...
</pre></div><p>In short:</p><ul><li>Execution whisker in <tt>generate</tt> phase</li><li>Configure descriptor path in <tt>descriptor</tt> element</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>