Author: dennisl
Date: Sun Jul 23 15:40:11 2006
New Revision: 424844
URL: http://svn.apache.org/viewvc?rev=424844&view=rev
Log:
Add FAQ and an example.
Added:
maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt
maven/plugins/trunk/maven-one-plugin/src/site/fml/
maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml (with props)
Modified:
maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-one-plugin/src/site/site.xml
Added: maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt?rev=424844&view=auto
==============================================================================
--- maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt (added)
+++ maven/plugins/trunk/maven-one-plugin/src/site/apt/examples/pom.apt Sun Jul
23 15:40:11 2006
@@ -0,0 +1,31 @@
+ ------
+ A POM for a Maven 1.x plugin
+ ------
+ Dennis Lundberg
+ ------
+ 20 July 2006
+ ------
+
+A POM for a Maven 1.x plugin
+
+ Here is an example of how a POM for a Maven 1.x plugin would look. This is
+ for the Maven 1.x site plugin:
+
+-------
+<project>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>maven</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <packaging>maven-one-plugin</packaging>
+ <version>1.6-SNAPSHOT</version>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-one-plugin</artifactId>
+ <extensions>true</extensions>
+ </plugin>
+ </plugins>
+ </build>
+</project>
+-------
Modified: maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt?rev=424844&r1=424843&r2=424844&view=diff
==============================================================================
--- maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-one-plugin/src/site/apt/usage.apt Sun Jul 23
15:40:11 2006
@@ -10,17 +10,15 @@
* Maven 1.x Plugin Packaging
- To build a Maven 1.x plugin using Maven 2.x, you need to include this plugin
in the build section, and use a
- <<<packaging>>> of <<<maven-one-plugin>>>. The following is an example of
how such a POM would look for the
- Maven 1.x site plugin:
+ To package a Maven 1.x plugin using Maven 2.x, you need to include the Maven
+ One plugin in the build section and use a <<<packaging>>> of
+ <<<maven-one-plugin>>>. Like this:
-------
<project>
- <modelVersion>4.0.0</modelVersion>
- <groupId>maven</groupId>
- <artifactId>maven-site-plugin</artifactId>
+ ...
<packaging>maven-one-plugin</packaging>
- <version>1.6-SNAPSHOT</version>
+ ...
<build>
<plugins>
<plugin>
@@ -28,14 +26,17 @@
<artifactId>maven-one-plugin</artifactId>
<extensions>true</extensions>
</plugin>
+ ...
</plugins>
</build>
+ ...
</project>
-------
* Maven 1.x Local Repository Installation
- To have your artifact installed into a local Maven 1.x repository, add the
following lifecycle binding to your POM:
+ To have your artifact installed into a local Maven 1.x repository, add the
+ following lifecycle binding to your POM:
-------
<project>
@@ -60,14 +61,17 @@
</project>
-------
- <<Note:>> The plugin section can be shared with the one above in the case of
building a Maven 1.x plugin.
+ <<Note:>> The plugin section can be shared with the one above in the case of
+ building a Maven 1.x plugin.
- This will read the local repository location from <<<~/build.properties>>>,
defaulting to <<<~/.maven/repository>>>.
+ This will read the local repository location from <<<~/build.properties>>>,
+ defaulting to <<<~/.maven/repository>>>.
* Maven 1.x Remote Repository Deployment
- To have your artifact deployed into an additional remote Maven 1.x
repository, you need to add a lifecycle binding to
- your POM. This example will deploy your artifact to the Maven 1.x repository
at Apache:
+ To have your artifact deployed into an additional remote Maven 1.x
repository,
+ you need to add a lifecycle binding to your POM. This configuration will
+ deploy your artifact to the Maven 1.x repository at Apache:
-------
<project>
@@ -95,10 +99,12 @@
</project>
-------
- This will not read any settings from the Maven 1.x properties, so the URL is
required.
+ This will not read any settings from the Maven 1.x properties, so the URL is
+ required.
- If you configure server settings in your <<<settings.xml>>> file, use the ID
of <<<mavenOneRemoteRepository>>>.
- This can be overridden using the <<<remoteRepositoryId>>> configuration
element.
+ If you configure server settings in your <<<settings.xml>>> file, use the ID
+ of <<<mavenOneRemoteRepository>>>. This can be overridden using the
+ <<<remoteRepositoryId>>> configuration element.
For more information, see the {{{plugin-info.html} Goal Reference}}.
Added: maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml?rev=424844&view=auto
==============================================================================
--- maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml (added)
+++ maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml Sun Jul 23
15:40:11 2006
@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="question1">
+ <question>Will this plugin allow me to use Maven 1.x plugins in Maven
2?</question>
+ <answer>
+ <p>
+ No it will not, but it will allow you to package, install and deploy a
+ Maven 1.x plugin using Maven 2.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
Propchange: maven/plugins/trunk/maven-one-plugin/src/site/fml/faq.fml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: maven/plugins/trunk/maven-one-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-one-plugin/src/site/site.xml?rev=424844&r1=424843&r2=424844&view=diff
==============================================================================
--- maven/plugins/trunk/maven-one-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-one-plugin/src/site/site.xml Sun Jul 23 15:40:11
2006
@@ -36,6 +36,11 @@
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
+ <item name="FAQ" href="faq.html"/>
+ </menu>
+
+ <menu name="Examples">
+ <item name="A POM for a Maven 1.x plugin" href="examples/pom.html"/>
</menu>
${reports}
