Author: jvanzyl
Date: Thu Jul 20 17:32:02 2006
New Revision: 424147
URL: http://svn.apache.org/viewvc?rev=424147&view=rev
Log:
o adding more doco
Modified:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-doap-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-doap-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/apt/index.apt?rev=424147&r1=424146&r2=424147&view=diff
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/apt/index.apt Thu Jul 20
17:32:02 2006
@@ -15,4 +15,21 @@
subsequent versions as more people become interested in DOAP.
+* Goals Overview
+ * {{{plugin-mojo.html}doap:generate}Generates a DOAP file from the POM}}.
+
+ []
+
+* Usage
+
+ Instructions on how to use the DOAP Plugin can be found {{{usage.html}here}}.
+
+* Examples
+
+ To provide you with better understanding of some usages of the DOAP Plugin,
+ you can take a look at the following examples:
+
+ * {{{examples/options.html}Setting the category and language options.}}
+
+ []
Modified: maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt?rev=424147&r1=424146&r2=424147&view=diff
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt Thu Jul 20
17:32:02 2006
@@ -5,16 +5,14 @@
------
20 July 2006
-How to Use
+Usage
- 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>. You will probably want to set the <category> option but the
+ language will default to "Java". You would setup your POM as follows before
+ attempting to generate a DOAP file for your project:
- 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>
@@ -22,10 +20,10 @@
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-idea-plugin</artifactId>
+ <artifactId>maven-doap-plugin</artifactId>
<configuration>
<category>build-management</category>
- <language>Java</language>
+ <language>Intercal</language>
</configuration>
</plugin>
</plugins>
@@ -33,7 +31,10 @@
</build>
...
</project>
--------------------
++-----
- For full documentation, click {{{index.html}here}}.
-
+ To generate the DOAP file you would use the following command:
+
++-----
+mvn -N doap:generate
++-----
Modified: 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=424147&r1=424146&r2=424147&view=diff
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/site.xml Thu Jul 20 17:32:02
2006
@@ -33,8 +33,10 @@
</links>
<menu name="Overview">
- <item name="Introduction" href="introduction.html"/>
- <item name="How to Use" href="howto.html"/>
+ <item name="Introduction" href="index.html"/>
+ <item name="Usage" href="usage.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="FAQ" href="faq.html"/>
</menu>
${reports}
</body>
