You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2013/09/01 13:14:12 UTC
svn commit: r876903 [30/41] - in
/websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5:
./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/
apidocs/org/apache/maven/plugin/ apidocs/org/apache/maven/plu...
Added: websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/usage.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/usage.html (added)
+++ websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/usage.html Sun Sep 1 11:14:08 2013
@@ -0,0 +1,301 @@
+<!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 at Sep 1, 2013
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Apache Maven Remote Resources Plugin - 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="Jason van Zyl
+John Casey" />
+ <meta name="Date-Creation-yyyymmdd" content="20110120" />
+ <meta name="Date-Revision-yyyymmdd" content="20130901" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></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/>
+ </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">Plugins</a>
+ >
+ <a href="./">Apache Maven Remote Resources Plugin</a>
+ >
+ Usage
+ </div>
+ <div class="xright">
+ Last Published: 2013-09-01
+ | Version: 1.5
+ </div>
+ <div class="clear">
+ <hr/>
+ </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">
+ <a href="plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <strong>Usage</strong>
+ </li>
+ <li class="none">
+ <a href="faq.html">FAQ</a>
+ </li>
+ </ul>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="examples/sharing-resources.html">Sharing Resources</a>
+ </li>
+ </ul>
+ <h5>Advanced Usage</h5>
+ <ul>
+ <li class="none">
+ <a href="supplemental-models.html">Supplemental Models</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="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/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"><h2>Usage<a name="Usage"></a></h2><p>To handle filtering this version of Maven Remote R
esources Plugin uses <a class="externalLink" href="http://maven.apache.org/shared/maven-filtering/index.html">Maven Filtering</a> 1.1.</p><div class="section"><h3>How to Create a Resource Bundle<a name="How_to_Create_a_Resource_Bundle"></a></h3><p>To turn on the bundle resource manifest generation you need to configure the plugin as follows:</p><div><pre><project>
+ ...
+ <build>
+ <plugins>
+ <!-- Turn this into a lifecycle -->
+ <plugin>
+ <artifactId>maven-remote-resources-plugin</artifactId>
+ <version>1.5</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>bundle</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
+</pre></div><p>This will trigger the scanning of that project's <tt>$<a name="basedir">basedir</a>/src/main/resources</tt> directory and create the <tt>$<a name="basedir">basedir</a>/target/classes/META-INF/maven/remote-resources.xml</tt> manifest file.</p></div><div class="section"><h3>How to Use Remote Resource Bundles <a name="How_to_Use_Remote_Resource_Bundles"></a></h3><p>To use remote resource bundles you need to configure the plugin as follows:</p><div><pre><project>
+ ...
+ <build>
+ <plugins>
+ <!-- Turn this into a lifecycle -->
+ <plugin>
+ <artifactId>maven-remote-resources-plugin</artifactId>
+ <version>1.5</version>
+ <executions>
+ <execution>
+ <id>process-remote-resources</id>
+ <goals>
+ <goal>process</goal>
+ </goals>
+ <configuration>
+ <resourceBundles>
+ <resourceBundle>org.apache:apache-jar-resource-bundle:1.0</resourceBundle>
+ </resourceBundles>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
+</pre></div><p>This will retrieve the <tt>apache-jar-resource-bundle-1.0.jar</tt> from the remote repositories specified in your POM, process each resource in the bundle and deposit them in your projects <tt>$<a name="basedir">basedir</a>/target/classes</tt> directory. </p></div><div class="section"><h3>Running Once in a Multi-Module Build<a name="Running_Once_in_a_Multi-Module_Build"></a></h3><p><b>Note:</b> This feature was added in version 1.1.</p><p>In many cases, an application build consists of multiple Maven modules, but you only need to include the license files, dependencies listing, etc. once for the entire application. Of course, in such cases, the dependencies listing needs to aggregate all dependencies of all modules.</p><p>To accomplish this, you can use the <tt>runOnlyAtExecutionRoot</tt> parameter when you configure the Remote Resources Plugin in your application parent POM. This parameter limits execution of the Remote Resources Plugin to the root directory in which
the build was run. In most cases, the application's distribution archives will be created at this top directory, so this is a natural location into which licensing and dependency information should be generated.</p><p>To run the Remote Resources Plugin only in the execution root, use the following:</p><div class="source"><pre> <plugin>
+ <artifactId>maven-remote-resources-plugin</artifactId>
+ <version>1.5</version>
+ [...]
+
+ <executions>
+ <execution>
+ <id>process-remote-resources</id>
+ <goals>
+ <goal>process</goal>
+ </goals>
+ <configuration>
+ <runOnlyAtExecutionRoot>true</runOnlyAtExecutionRoot>
+ [...]
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+</pre></div></div><div class="section"><h3>Specifying Delimiters for Filterable Expressions<a name="Specifying_Delimiters_for_Filterable_Expressions"></a></h3><p><b>Note:</b> This feature was added in version 1.1.</p><p>By default, the Remote Resources Plugin supports expressions specified using either the '<tt>${expr}</tt>' or '<tt>@expr@</tt>' format. However, at times it may be more convenient to use a different set of filter delimiters. By configuring the <tt>filterDelimiters</tt> and <tt>useDefaultFilterDelimiters</tt> parameters, you have a high degree of control over the filtering process.</p><p>To enable the filter delimiters for the format '<tt>#{expr}</tt>' (Ruby-style), add the following to your plugin configuration:</p><div class="source"><pre> <plugin>
+ <artifactId>maven-remote-resources-plugin</artifactId>
+ <version>1.5</version>
+ <executions>
+ <execution>
+ <id>process-remote-resources</id>
+ <goals>
+ <goal>process</goal>
+ </goals>
+ <configuration>
+ <filterDelimiters>
+ <filterDelimiter>#{*}</filterDelimiter>
+ </filterDelimiters>
+ [...]
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+</pre></div><p>Notice the '<tt>*</tt>' character above. This denotes the dividing point between start and end delimiter, where the actual expression will be specified. </p><p>If your start and end delimiters are the same, you can use an even simpler configuration. For example, to enable filter delimiters for the format '<tt>#expr#</tt>', add the following to your plugin configuration:</p><div class="source"><pre> <plugin>
+ <artifactId>maven-remote-resources-plugin</artifactId>
+ <version>1.5</version>
+ <executions>
+ <execution>
+ <id>process-remote-resources</id>
+ <goals>
+ <goal>process</goal>
+ </goals>
+ <configuration>
+ <filterDelimiters>
+ <filterDelimiter>#</filterDelimiter>
+ </filterDelimiters>
+ [...]
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+</pre></div><p>When the filter processor executes and notices this delimiter specification missing a '<tt>*</tt>' character, it will simply assume the provided delimiter will be used as both the start <i>and</i> end delimiter for an expression.</p><p>All of the above assumes that you still want the ability to use '<tt>${expr}</tt>' and '<tt>@expr@</tt>' delimiters. However, in cases where this would cause trouble, you can disable these default delimiters as follows:</p><div class="source"><pre> <plugin>
+ <artifactId>maven-remote-resources-plugin</artifactId>
+ <version>1.5</version>
+ <executions>
+ <execution>
+ <id>process-remote-resources</id>
+ <goals>
+ <goal>process</goal>
+ </goals>
+ <configuration>
+ <useDefaultFilterDelimiters>false</useDefaultFilterDelimiters>
+ [...]
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+</pre></div></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2013
+ 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/>
+ </div>
+ </div>
+ </body>
+</html>
\ No newline at end of file
Added: websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/xref-test/allclasses-frame.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/xref-test/allclasses-frame.html (added)
+++ websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/xref-test/allclasses-frame.html Sun Sep 1 11:14:08 2013
@@ -0,0 +1,71 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>All Classes</title>
+ <link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>All Classes</h3>
+
+ <ul>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/AbstractIT.html" target="classFrame">AbstractIT</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/stub/ArtifactStub.html" target="classFrame">ArtifactStub</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/support/BootstrapInstaller.html" target="classFrame">BootstrapInstaller</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/IT_BadDependencyPoms.html" target="classFrame">IT_BadDependencyPoms</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/IT_CustomFilterDelimiter.html" target="classFrame">IT_CustomFilterDelimiter</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/IT_FilterLocalOverride.html" target="classFrame">IT_FilterLocalOverride</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/IT_GenerateFromBundle.html" target="classFrame">IT_GenerateFromBundle</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/IT_GenerateFromBundleWithTypeAndClassifier.html" target="classFrame">IT_GenerateFromBundleWithTypeAndClassifier</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/IT_GenerateFromOverride.html" target="classFrame">IT_GenerateFromOverride</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/IT_GetDependencyProjects.html" target="classFrame">IT_GetDependencyProjects</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/IT_RunOnlyAtExecutionRoot.html" target="classFrame">IT_RunOnlyAtExecutionRoot</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/IT_SupplementalArtifact.html" target="classFrame">IT_SupplementalArtifact</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/stub/MavenProjectBasicStub.html" target="classFrame">MavenProjectBasicStub</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/stub/MavenProjectBuildStub.html" target="classFrame">MavenProjectBuildStub</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/stub/MavenProjectResourcesStub.html" target="classFrame">MavenProjectResourcesStub</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/stub/ModelStub.html" target="classFrame">ModelStub</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/RemoteResourcesMojoTest.html" target="classFrame">RemoteResourcesMojoTest</a>
+ </li>
+ <li>
+ <a href="org/apache/maven/plugin/resources/remote/it/support/TestUtils.html" target="classFrame">TestUtils</a>
+ </li>
+ </ul>
+
+ </body>
+ </html>
\ No newline at end of file
Added: websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/xref-test/index.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/xref-test/index.html (added)
+++ websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/xref-test/index.html Sun Sep 1 11:14:08 2013
@@ -0,0 +1,23 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>Apache Maven Remote Resources Plugin 1.5 Reference</title>
+ </head>
+ <frameset cols="20%,80%">
+ <frameset rows="30%,70%">
+ <frame src="overview-frame.html" name="packageListFrame" />
+ <frame src="allclasses-frame.html" name="packageFrame" />
+ </frameset>
+ <frame src="overview-summary.html" name="classFrame" />
+ <noframes>
+ <body>
+ <h1>Frame Alert</h1>
+ <p>
+ You don't have frames. Go <a href="overview-summary.html">here</a>
+ </p>
+ </body>
+ </noframes>
+ </frameset>
+</html>