Author: jvanzyl
Date: Thu Jul 20 14:45:09 2006
New Revision: 424075
URL: http://svn.apache.org/viewvc?rev=424075&view=rev
Log:
o adding some simple doco for the doap plugin
Added:
maven/plugins/trunk/maven-doap-plugin/src/site/
maven/plugins/trunk/maven-doap-plugin/src/site/apt/
maven/plugins/trunk/maven-doap-plugin/src/site/apt/howto.apt (with props)
maven/plugins/trunk/maven-doap-plugin/src/site/apt/introduction.apt (with
props)
maven/plugins/trunk/maven-doap-plugin/src/site/site.xml (with props)
Modified:
maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java
Modified:
maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java?rev=424075&r1=424074&r2=424075&view=diff
==============================================================================
---
maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java
(original)
+++
maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java
Thu Jul 20 14:45:09 2006
@@ -34,7 +34,8 @@
import java.util.Iterator;
/**
- * A Maven2 plugin to generate an Ant build file.
+ * A Maven2 plugin to generate a Description of a Project (DOAP) file from the
information found
+ * in a POM.
*
* @author Jason van Zyl
* @version $Id$
Added: maven/plugins/trunk/maven-doap-plugin/src/site/apt/howto.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/apt/howto.apt?rev=424075&view=auto
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/apt/howto.apt (added)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/apt/howto.apt Thu Jul 20
14:45:09 2006
@@ -0,0 +1,39 @@
+ ------
+ Maven 2 DOAP Plugin
+ ------
+ Jason van Zyl
+ ------
+ 20 July 2006
+
+How to Use
+
+ You can directly use this plugin without configuring anything using the
command "mvn doap:generate". If you
+ are running it from the top-level of a project, which will typically be the
case, then you run it using the
+ non-recurse option: "mvn -N doap:generate".
+
+ The only two options you can configure are the _category_ and the
_language_. If you wish to set these options
+ you can use something like the following:
+
+-------------------
+<project>
+ ...
+ <build>
+ ...
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-idea-plugin</artifactId>
+ <configuration>
+ <category>build-management</category>
+ <language>Java</language>
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
+-------------------
+
+ For full documentation, click {{{index.html}here}}.
+
Propchange: maven/plugins/trunk/maven-doap-plugin/src/site/apt/howto.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-doap-plugin/src/site/apt/howto.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/plugins/trunk/maven-doap-plugin/src/site/apt/introduction.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/apt/introduction.apt?rev=424075&view=auto
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/apt/introduction.apt (added)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/apt/introduction.apt Thu Jul
20 14:45:09 2006
@@ -0,0 +1,18 @@
+ ------
+ Maven 2 DOAP Plugin
+ ------
+ Jason van Zyl
+ ------
+ 20 July 2006
+
+Introduction
+
+ This plugin generates a Description of a Project (DOAP) file from a POM. We
would like to be able to provide
+ DOAP files for systems that use them as primary input but what to also
alleviate the burden of maintaining
+ two sets of metadata.
+
+ Version 1.0 of this plugin is specifically tailored for use by projects at
Apache, but this will change in
+ subsequent versions as more people become interested in DOAP.
+
+
+
Propchange: maven/plugins/trunk/maven-doap-plugin/src/site/apt/introduction.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-doap-plugin/src/site/apt/introduction.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/plugins/trunk/maven-doap-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/site.xml?rev=424075&view=auto
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/site.xml (added)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/site.xml Thu Jul 20 14:45:09
2006
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+/*
+ * Copyright 2001-2005 The Apache Software Foundation.
+ *
+ * Licensed 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.
+ */
+-->
+
+<project name="Maven DOAP Plugin">
+ <bannerLeft>
+ <name>Maven DOAP Plugin</name>
+ <src>http://maven.apache.org/images/apache-maven-project.png</src>
+ <href>http://maven.apache.org/</href>
+ </bannerLeft>
+ <bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight>
+ <body>
+ <links>
+ <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
+ </links>
+
+ <menu name="Overview">
+ <item name="Introduction" href="introduction.html"/>
+ <item name="How to Use" href="howto.html"/>
+ </menu>
+ ${reports}
+ </body>
+</project>
Propchange: maven/plugins/trunk/maven-doap-plugin/src/site/site.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-doap-plugin/src/site/site.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
