Author: vsiveton
Date: Thu Dec 30 15:00:38 2010
New Revision: 1053907
URL: http://svn.apache.org/viewvc?rev=1053907&view=rev
Log:
o updated doc
Modified:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt.vm
Modified: maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt.vm?rev=1053907&r1=1053906&r2=1053907&view=diff
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt.vm Thu Dec 30
15:00:38 2010
@@ -31,7 +31,7 @@ Usage
The DOAP Plugin generates DOAP and ASF DOAP compliant files. The following
examples describe the basic usage of
the Plugin.
-* Pure DOAP Configuration
+* {Pure DOAP Configuration}
+-----+
<project>
@@ -43,15 +43,18 @@ Usage
<artifactId>maven-doap-plugin</artifactId>
<version>${project.version}</version>
<configuration>
- <doapOptions>
- <programmingLanguage>java</programmingLanguage>
- <category>build-management</category>
- ...
- </doapOptions>
-
- <asfExtOptions>
- <included>false</included>
- </asfExtOptions>
+ <doapOptions>
+ <!-- Default values -->
+ <created>\${project.inceptionYear}-01-01</created>
+ <description>\${project.description}</description>
+
<downloadPage>\${project.distributionManagement.downloadUrl}</downloadPage>
+ <homepage>\${project.url}</homepage>
+ <mailingList>\${project.url}/mail-lists.html</mailingList>
+ <name>\${project.name}</name>
+ <shortdesc>\${project.description}</shortdesc>
+ <vendor>\${project.organization.name}</vendor>
+ ...
+ </doapOptions>
</configuration>
</plugin>
</plugins>
@@ -60,11 +63,69 @@ Usage
</project>
+-----+
-* DOAP ASF Configuration
+ <<Note>>: See the
{{{./apidocs/org/apache/maven/plugin/doap/options/DoapOptions.html}DoapOptions
Javadoc}} for
+ advanced DOAP options.
+
+* {DOAP ASF Configuration}
+
+This is the minimal POM to be ASF compliant.
+-----+
<project>
- ...
+ <!-- To retrieve the ASF organization and the ASF license -->
+ <parent>
+ <groupId>org.apache</groupId>
+ <artifactId>apache</artifactId>
+ <version>8</version>
+ </parent>
+
+ <groupId>org.apache.XXX</groupId>
+ <artifactId>XXX</artifactId>
+ <packaging>jar</packaging>
+ <version>1.0-SNAPSHOT</version>
+
+ <name>Apache XXX Project</name>
+ <description>Apache XXX is ...</description>
+ <url>http://XXX.apache.org</url>
+ <inceptionYear>2010</inceptionYear>
+
+ <scm>
+ <connection>scm:svn:http://svn.apache.org/repos/asf/XXX/trunk</connection>
+
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/XXX/trunk</developerConnection>
+ <url>http://svn.apache.org/viewvc/XXX/trunk</url>
+ </scm>
+ <issueManagement>
+ <system>jira</system>
+ <url>http://issues.apache.org/jira/browse/XXX</url>
+ </issueManagement>
+ <distributionManagement>
+ <downloadUrl>http://XXX.apache.org/download.html</downloadUrl>
+ </distributionManagement>
+
+ <developers>
+ <!-- PMC Chair -->
+ <developer>
+ <id>XXX</id>
+ <name>XXX</name>
+ <email>x...@apache.org</email>
+ <organization>ASF</organization>
+ <roles>
+ <!-- For <asfext:chair/> -->
+ <role>PMC Chair</role>
+ </roles>
+ </developer>
+ <!-- PMC -->
+ <developer>
+ <id>XXX</id>
+ <name>XXX</name>
+ <email>x...@apache.org</email>
+ <organization>ASF</organization>
+ <roles>
+ <role>PMC Member</role>
+ </roles>
+ </developer>
+ </developers>
+
<build>
<plugins>
<plugin>
@@ -72,27 +133,53 @@ Usage
<artifactId>maven-doap-plugin</artifactId>
<version>${project.version}</version>
<configuration>
- <doapOptions>
- <programmingLanguage>java</programmingLanguage>
- <category>build-management</category>
- ...
- </doapOptions>
-
- <asfExtOptions>
- <included>true</included>
- <charter>The mission of the Apache XXX project is to create and
maintain software
- libraries that provide ...</charter>
- ...
- </asfExtOptions>
+ <doapOptions>
+ <!-- See http://projects.apache.org/languages.html -->
+ <programmingLanguage>Java</programmingLanguage>
+ <!-- http://projects.apache.org/categories.html -->
+ <category>build-management</category>
+
+ <!-- Default values -->
+ <created>\${project.inceptionYear}-01-01</created>
+ <description>\${project.description}</description>
+
<downloadPage>\${project.distributionManagement.downloadUrl}</downloadPage>
+ <homepage>\${project.url}</homepage>
+ <mailingList>\${project.url}/mail-lists.html</mailingList>
+ <name>\${project.name}</name>
+ <shortdesc>\${project.description}</shortdesc>
+ <vendor>\${project.organization.name}</vendor>
+ ...
+ </doapOptions>
+
+ <asfExtOptions>
+ <charter>The mission of the Apache XXX project is to create and
maintain software
+ libraries that provide ...</charter>
+ ...
+ <!-- Default values -->
+ <pmc>\${project.url}</pmc>
+ <name>\${project.name}</name>
+
+ <!-- If this Apache project implements a standard -->
+ <standards>
+ <standard>
+ <title>Extensible Stylesheet Language - Formatting Objects
(XSL-FO 1.1)</title>
+ <body>W3C</body>
+ <id>XSL 1.1</id>
+ <url>http://www.w3.org/TR/xsl11/</url>
+ </standard>
+ </standards>
+ </asfExtOptions>
</configuration>
</plugin>
</plugins>
</build>
- ...
</project>
+-----+
+ <<Note>>: See the
{{{./apidocs/org/apache/maven/plugin/doap/options/DoapOptions.html}DoapOptions
Javadoc}} and
+ the
{{{./apidocs/org/apache/maven/plugin/doap/options/ASFExtOptions.html}ASFExtOptions
Javadoc}} for advanced options.
+
* Advanced DOAP Configuration
+-----+
@@ -124,7 +211,6 @@ Usage
</project>
+-----+
-
* Generate DOAP File
To generate the DOAP file you would use the following command:
