Author: dennisl
Date: Wed Jan 5 22:52:34 2011
New Revision: 1055674
URL: http://svn.apache.org/viewvc?rev=1055674&view=rev
Log:
Clean up the site.
Modified:
maven/shared/trunk/maven-filtering/src/site/apt/index.apt
maven/shared/trunk/maven-filtering/src/site/apt/usage.apt
Modified: maven/shared/trunk/maven-filtering/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/site/apt/index.apt?rev=1055674&r1=1055673&r2=1055674&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/site/apt/index.apt (original)
+++ maven/shared/trunk/maven-filtering/src/site/apt/index.apt Wed Jan 5
22:52:34 2011
@@ -3,7 +3,7 @@
------
Olivier Lamy
------
- 2008-01-01
+ 2011-01-05
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -27,74 +27,75 @@ Maven Filtering
These Plexus components have been built from the filtering process/code in
Maven Resources Plugin.
- The goal is to provide a shared component for all plugins which needs to
filter resources.
-
-* What's New in 1.0-beta-2 (All of this new features are configurable with the
MavenResourcesExecution bean)
+ The goal is to provide a shared component for all plugins that needs to
filter resources.
-** Release Note
- The release note is available
{{{http://jira.codehaus.org/secure/ReleaseNote.jspa?version=14488&styleName=Html&projectId=11761&Create=Create}here}}.
+* MavenResourcesExecution
-** Pom interpolation
+** POM Interpolation
- {{{http://jira.codehaus.org/browse/MSHARED-60}[MSHARED-60]}} something like
$\{foo.url\} was interpolated to the value of pom url.
- Now pom values will interpolated <<<only>>> with expressions starting with
pom or project (it's configurable).\
- This means before something like $\{foo.version\} or $\{version\} was
interpolated with the current pom version.
- <<Now it won't be interpolated with a pom value.>>
+ POM values will be interpolated <<only>> with expressions starting with
<<<pom>>> or <<<project>>> (it's configurable).
+ In previous versions something like $\{foo.version\} or $\{version\} was
interpolated with the current POM version, but
+ it won't be interpolated with a POM value any more.
** Escaping Interpolation
- {{{http://jira.codehaus.org/browse/MSHARED-51}[MSHARED-51]}} It's possible
now to define a String which will escape interpolation.\
- \$\{java.home\} will be interpolated to $\{java.home\}
+ It's possible now to define a String which will escape interpolation.
+ \$\{java.home\} will be interpolated to $\{java.home\}.
+
+** <<<targetPath>>> parameter
+
+ It also accepts absolute paths.
-** targetPath accepts now absolute paths too
+** <<<overwrite>>> parameter
-** overwrite parameter
+ The parameter <<<overwrite>>> forces file copy even if the destination file
is newer.
- {{{http://jira.codehaus.org/browse/MSHARED-67}[MSHARED-67]}} Add a new
parameter to force file copy even if the destination file is newer.
* MavenResourcesFiltering
- This component will apply filtering on a <<<List>>> of
<<<org.apache.maven.model.Resource>>>.
+ This component will apply filtering on a <<<List>>> of
<<<org.apache.maven.model.Resource>>>s.
If you want to use the default <<<List>>> of <<<FileUtils.FilterWrapper>>>
(see below)
you should use the method without the <<<filterWrappers>>> parameter.
The component will not filter a predefined set of file extensions (jpg,
jpeg, gif, bmp, png).
- Note: you can easily add extra file extensions.
+
+ <<Note:>> You can easily add extra file extensions.
+
* MavenFileFilter
- This component has a method which returns the default
<<<FileUtils.FilterWrapper>>>.
+ This component has a method which returns the default
<<<FileUtils.FilterWrapper>>>s.
These are:
- * interpolation with token $\{ \} and values from properties files,
project.build.filters, project.properties
- and mavenSession.executionProperties
+ * Interpolation with token $\{ \} and values from properties files,
<<<\<project\>>>>/<<<\<build\>>>>/<<<\<filters>>>, <<<project.properties>>>
+ and <<<mavenSession.executionProperties>>>
- * interpolation with token @ @ and values from properties files,
project.build.filters, project.properties
- and mavenSession.executionProperties
+ * Interpolation with token @ @ and values from properties files,
<<<\<project\>>>>/<<<\<build\>>>>/<<<\<filters>>>, <<<project.properties>>>
+ and <<<mavenSession.executionProperties>>>
- * interpolation with token $\{ \} and values from mavenProject
interpolation
+ * Interpolation with token $\{ \} and values from <<<mavenProject>>>
interpolation
- * interpolation with token @ @ and values from mavenProject interpolation
+ * Interpolation with token @ @ and values from <<<mavenProject>>>
interpolation
- []
+ []
- The values used for interpolation are stored in a <<<Properties>>> object
- and are loaded in the following order:
+ The values used for interpolation are stored in a <<<Properties>>> object
+ and are loaded in the following order:
- * A <<<List>>> of properties files, provided as a parameter to the method
+ * A <<<List>>> of properties files, provided as a parameter to the method
- * Filters defined in the <<<\<build\>>>>/<<<\<filters\>>>> section of the
POM
+ * Filters defined in the <<<\<build\>>>>/<<<\<filters\>>>> section of the POM
- * Properties defined in the <<<\<properties\>>>> section of the POM
+ * Properties defined in the <<<\<properties\>>>> section of the POM
- * The <<<executionProperties>>> from the current <<<MavenSession>>>
+ * The <<<executionProperties>>> from the current <<<MavenSession>>>
- []
+ []
- <<Note>>: As it's a <<<Properties>>> object, the last defined key/value
pair wins.
+ <<Note:>> As it's a <<<Properties>>> object, the last defined key/value pair
wins.
- <<Note>>: When building the <<<Properties>>> object and reading the
properties files defining the different filters,
- interpolation with the token $\{ \} is supported for these filters with
limited properties values coming from
- project.properties and mavenSession.executionProperties. The last wins
here too.
+ <<Note:>> When building the <<<Properties>>> object and reading the
properties files that defines the different filters,
+ interpolation with the token $\{ \} is supported for these filters with
limited properties values coming from
+ <<<project.properties>>> and <<<mavenSession.executionProperties>>>. The
last wins here too.
Modified: maven/shared/trunk/maven-filtering/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/site/apt/usage.apt?rev=1055674&r1=1055673&r2=1055674&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/site/apt/usage.apt (original)
+++ maven/shared/trunk/maven-filtering/src/site/apt/usage.apt Wed Jan 5
22:52:34 2011
@@ -3,7 +3,7 @@
------
Olivier Lamy
------
- 2008-07-21
+ 2011-01-05
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -25,7 +25,7 @@
Usage
-* Filter a List of org.apache.maven.model.Resource
+* Filter a <<<List>>> of <<<org.apache.maven.model.Resource>>>
Lookup the component in your Mojo:
@@ -38,7 +38,7 @@ Usage
private MavenResourcesFiltering mavenResourcesFiltering;
+-----+
- Apply filtering on your <<<List>>> of resources, see
{{{./index.html}Introduction}} to see the default FilterWrappers
+ Apply filtering on your <<<List>>> of resources, see
{{{./index.html}Introduction}} for the default <<<FilterWrappers>>>
that are used.
+-----+
@@ -52,25 +52,25 @@ Usage
* Add a new filtering token
- You must use the other methods from the <<<MavenResourcesFiltering>>>
component and construct your own List of
- FilterWrappers. The following example adds interpolation for the Token @ @
using values coming from reflection
+ You must use the other methods from the <<<MavenResourcesFiltering>>>
component and construct your own <<<List>>> of
+ <<<FilterWrappers>>>. The following example adds interpolation for the token
@ @ using values coming from reflection
with the Maven Project.
+-----+
// Create your FilterWrapper
FileUtils.FilterWrapper filterWrapper = new FileUtils.FilterWrapper()
{
- public Reader getReader( Reader reader )
- {
- Interpolator propertiesInterpolator =
- new RegexBasedInterpolator( "\\@", "(.+?)\\@" );
- ValueSource valueSource = new MavenProjectValueSource(
mavenProject,
- true );
- propertiesInterpolator.addValueSource( valueSource );
- return new InterpolatorFilterReader( reader,
- propertiesInterpolator,
- "@", "@" );
- }
+ public Reader getReader( Reader reader )
+ {
+ Interpolator propertiesInterpolator =
+ new RegexBasedInterpolator( "\\@", "(.+?)\\@" );
+ ValueSource valueSource = new MavenProjectValueSource(
mavenProject,
+ true );
+ propertiesInterpolator.addValueSource( valueSource );
+ return new InterpolatorFilterReader( reader,
+ propertiesInterpolator,
+ "@", "@" );
+ }
};
// Add the new filterWrapper to your MavenResourcesExecution instance
@@ -85,8 +85,8 @@ Usage
"\\@", "(.+?)\\@", "@", "@" );
+-----+
- <<Note:>> If the <<<mavenResourcesExecution.useDefaultFilterWrappers>>> is
set to <<<true>>>,
- the default FilterWrappers will be added first.
+ <<Note:>> If <<<mavenResourcesExecution.useDefaultFilterWrappers>>> is set
to <<<true>>>,
+ the default <<<FilterWrapper>>>s will be added first.
Now it's time to filter the resources:
@@ -95,6 +95,6 @@ Usage
mavenResourcesFiltering.filterResources( mavenResourcesExecution );
+-----+
- <<Note:>> maven-filtering uses the
+ <<Note:>> Maven Filtering uses the
{{{http://plexus.codehaus.org/plexus-components/plexus-interpolation/}plexus-interpolation
component}}.
