Author: wsmoak
Date: Sat Jun 2 18:27:31 2007
New Revision: 543823
URL: http://svn.apache.org/viewvc?view=rev&rev=543823
Log:
Document the new property filtering feature.
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt?view=diff&rev=543823&r1=543822&r2=543823
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt Sat Jun 2
18:27:31 2007
@@ -108,3 +108,14 @@
The server will, by default, be started on http://localhost:8080/. See
{{{http://jetty.mortbay.org/jetty/index.html}http://jetty.mortbay.org/jetty/index.html}}
for more information about
the Jetty server.
+
+* Filtering
+
+ To filter properties into any supported documentation format, add a
<<<.vm>>> extension to the filename.
+
+ For example, the module for the Maven website contains a
+
{{{http://svn.apache.org/repos/asf/maven/site/trunk/src/site/apt/download.apt.vm}<<<src/site/apt/download.apt.vm>>>}}
+ file, which uses the expression <<<$\{currentVersion}>>> to filter in a
property set in the
+ {{{http://svn.apache.org/repos/asf/maven/site/trunk/pom.xml}POM}}.
+
+ This feature is available in version 2.0-beta-6 or later.
\ No newline at end of file
