You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by sl...@apache.org on 2020/12/29 21:47:44 UTC
svn commit: r1884923 [8/8] - in
/maven/website/components/shared-archives/maven-shared-resources-LATEST: ./
css/ fonts/ images/ images/profiles/ img/ js/
Modified: maven/website/components/shared-archives/maven-shared-resources-LATEST/usage.html
==============================================================================
--- maven/website/components/shared-archives/maven-shared-resources-LATEST/usage.html (original)
+++ maven/website/components/shared-archives/maven-shared-resources-LATEST/usage.html Tue Dec 29 21:47:43 2020
@@ -1,178 +1,116 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2015-02-01
- | Rendered using Apache Maven Stylus Skin 1.5
+ | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src\site\apt/usage.apt.vm at 2020-12-29
+ | Rendered using Apache Maven Fluido Skin 1.7
-->
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Dennis Lundberg" />
+ <meta name="Date-Creation-yyyymmdd" content="20110501" />
+ <meta name="Date-Revision-yyyymmdd" content="20201229" />
+ <meta http-equiv="Content-Language" content="en" />
<title>Apache Maven Shared Resources – 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="author" content="Dennis Lundberg" />
- <meta name="Date-Creation-yyyymmdd" content="20110501" />
- <meta name="Date-Revision-yyyymmdd" content="20150201" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-
-<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
-
-<script type="text/javascript">_uacct = "UA-140879-1";
- urchinTracker();</script>
- </head>
- <body class="composite">
- <div id="banner">
- <a href="../../" id="bannerLeft">
- <img src="../../images/apache-maven-project-2.png" alt="" />
- </a>
- <span id="bannerRight">
- <img src="../../images/maven-logo-2.gif" alt="" />
- </span>
- <div class="clear">
- <hr/>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script>
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-140879-1']);
+ _gaq.push(['_trackPageview']);
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+ </head>
+ <body class="topBarDisabled">
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left"><a href="https://www.apache.org/" id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Shared Resources"/></a></div>
+ <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div>
+ <div class="clear"><hr/></div>
</div>
- </div>
- <div id="breadcrumbs">
-
- <div class="xleft">
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
- <a href="../../index.html">Maven</a>
- >
- <a href="../index.html">Shared Components</a>
- >
- <a href="./">Apache Maven Shared Resources</a>
- >
- Usage
- </div>
- <div class="xright">
- Last Published: 2015-02-01
- | Version: 2
- </div>
- <div class="clear">
- <hr/>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
+ <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
+ <li class=""><a href="../index.html" title="Shared Components">Shared Components</a><span class="divider">/</span></li>
+ <li class=""><a href="index.html" title="Apache Maven Shared Resources">Apache Maven Shared Resources</a><span class="divider">/</span></li>
+ <li class="active ">Usage <a href="https://github.com/apache/maven-shared-resources/tree/maven-shared-resources-3/src\site\apt/usage.apt.vm"><img src="./images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2020-12-29</li>
+ <li id="projectVersion" class="pull-right">Version: 3</li>
+ </ul>
</div>
- </div>
- <div id="leftColumn">
- <div id="navcolumn">
-
- <h5>Overview</h5>
- <ul>
- <li class="none">
- <a href="index.html">Introduction</a>
- </li>
- <li class="none">
- <strong>Usage</strong>
- </li>
- <li class="none">
- <a href="apidocs/index.html">JavaDocs</a>
- </li>
- <li class="none">
- <a href="xref/index.html">Source Xref</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
- </li>
- <li class="none">
- <a href="download.html">Download</a>
- </li>
- </ul>
- <h5>Parent Project</h5>
- <ul>
- <li class="none">
- <a href="../maven-shared-components-LATEST/index.html">Apache Maven Shared Components</a>
- </li>
- </ul>
- <h5>Project Documentation</h5>
- <ul>
- <li class="collapsed">
- <a href="project-info.html">Project Information</a>
- </li>
- <li class="collapsed">
- <a href="project-reports.html">Project Reports</a>
- </li>
- </ul>
- <h5>Maven Projects</h5>
- <ul>
- <li class="none">
- <a href="../../ant-tasks/index.html">Ant Tasks</a>
- </li>
- <li class="none">
- <a href="../../archetype/index.html">Archetype</a>
- </li>
- <li class="none">
- <a href="../../doxia/index.html">Doxia</a>
- </li>
- <li class="none">
- <a href="../../jxr/index.html">JXR</a>
- </li>
- <li class="none">
- <a href="../../ref/current">Maven</a>
- </li>
- <li class="none">
- <a href="../../pom/index.html">Parent POMs</a>
- </li>
- <li class="none">
- <a href="../../plugins/index.html">Plugins</a>
- </li>
- <li class="none">
- <a href="../../plugin-testing/index.html">Plugin Testing</a>
- </li>
- <li class="none">
- <a href="../../plugin-tools/index.html">Plugin Tools</a>
- </li>
- <li class="none">
- <a href="../../apache-resource-bundles/index.html">Resource Bundles</a>
- </li>
- <li class="none">
- <a href="../../scm/index.html">SCM</a>
- </li>
- <li class="none">
- <a href="../index.html">Shared Components</a>
- </li>
- <li class="none">
- <a href="../../skins/index.html">Skins</a>
- </li>
- <li class="none">
- <a href="../../surefire/index.html">Surefire</a>
- </li>
- <li class="none">
- <a href="../../wagon/index.html">Wagon</a>
- </li>
- </ul>
- <h5>ASF</h5>
- <ul>
- <li class="none">
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
- </li>
- </ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="./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">
+ <div class="row-fluid">
+ <div id="leftColumn" class="span2">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+ <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
+ <li class="active"><a href="#"><span class="none"></span>Usage</a></li>
+ <li><a href="apidocs/index.html" title="JavaDocs"><span class="none"></span>JavaDocs</a></li>
+ <li><a href="xref/index.html" title="Source Xref"><span class="none"></span>Source Xref</a></li>
+ <li><a href="http://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a></li>
+ <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li>
+ <li class="nav-header">Parent Project</li>
+ <li><a href="../index.html" title="Apache Maven Shared Components"><span class="none"></span>Apache Maven Shared Components</a></li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
+ <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
+ <li class="nav-header">Maven Projects</li>
+ <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li>
+ <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li>
+ <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li>
+ <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li>
+ <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li>
+ <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li>
+ <li><a href="../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li>
+ <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li>
+ <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li>
+ <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li>
+ <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li>
+ <li><a href="../index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li>
+ <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li>
+ <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li>
+ <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li>
+ <li class="nav-header">ASF</li>
+ <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li>
+ <li><a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li>
+</ul>
+<form id="search-form" action="https://www.google.com/search" method="get" >
+ <input value="maven.apache.org/shared/maven-shared-resources/" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
+ <hr />
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div id="twitter">
+ <a href="https://twitter.com/ASFMavenProject" class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a>
+ <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ </div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+ </div>
+ </div>
+ </div>
+ <div id="bodyColumn" class="span10" >
+<section>
<h2><a name="Usage"></a>Usage</h2>
-<p>There are a couple things you need to do to use Maven Shared Resources. First you need to give the plugin that will use the resources access to them. After that you configure the plugin to actually use the resources.</p>
-<div class="section">
+<p>There are a couple things you need to do to use Maven Shared Resources. First you need to give the plugin that will use the resources access to them. After that you configure the plugin to actually use the resources.</p><section>
<h3><a name="Add_the_resources_to_the_plugin"></a>Add the resources to the plugin</h3>
-<p>First you add maven-shared-resources as a dependency to a plugin in your <tt>pom.xml</tt>. This is done to give the plugin access to the resources within the maven-shared-resources JAR file. In this example we will use the resources in Maven Changes Plugin.</p>
-<div class="source">
-<pre><project>
+<p>First you add maven-shared-resources as a dependency to a plugin in your <code>pom.xml</code>. This is done to give the plugin access to the resources within the maven-shared-resources JAR file. In this example we will use the resources in Maven Changes Plugin.</p>
+<div class="source"><pre class="prettyprint linenums"><project>
...
<build>
<plugins>
@@ -187,7 +125,7 @@
<dependency>
<groupId>org.apache.maven.shared</groupId>
<artifactId>maven-shared-resources</artifactId>
- <version>2</version>
+ <version>3</version>
</dependency>
</dependencies>
<executions>
@@ -198,12 +136,10 @@
</build>
...
</project>
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h3><a name="Configure_the_plugin_to_use_the_resources"></a>Configure the plugin to use the resources</h3>
<p>Now you can use the resources in the plugin. You can use them as if they existed in your own project, like this:</p>
-<div class="source">
-<pre><project>
+<div class="source"><pre class="prettyprint linenums"><project>
...
<build>
<plugins>
@@ -227,15 +163,14 @@
</project>
</pre></div>
<p>or like this:</p>
-<div class="source">
-<pre><project>
+<div class="source"><pre class="prettyprint linenums"><project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.14</version>
+ <version>3.x.x</version>
<configuration>
<configLocation>config/maven_checks.xml</configLocation>
<headerLocation>config/maven-header.txt</headerLocation>
@@ -251,29 +186,23 @@
</build>
...
</project>
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h3><a name="Execute_the_plugin"></a>Execute the plugin</h3>
<p>All is now set up to make use of the resources in the plugin for your project. Execute the plugin like you would normally do, to see the resources put to practical use.</p>
-<div class="source">
-<pre>mvn changes:announcement-generate
-</pre></div></div></div>
+<div class="source"><pre class="prettyprint linenums">mvn changes:announcement-generate
+</pre></div></section></section>
+ </div>
</div>
</div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2002-2015
- The Apache Software Foundation
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
- Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
- </div>
- <div class="clear">
- <hr/>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>Copyright ©2002–2020
+<a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.</p>
+ </div>
</div>
- </div>
+ </footer>
</body>
</html>
\ No newline at end of file