Author: vsiveton
Date: Fri Jul 18 17:00:43 2008
New Revision: 678078
URL: http://svn.apache.org/viewvc?rev=678078&view=rev
Log:
MDOAP-14: Review and update site documentation
o updated documentation
o added license header
Added:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/doap-in-use.apt
(with props)
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/with-site-plugin.apt
(with props)
Modified:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-doap-plugin/src/site/apt/links.apt
maven/plugins/trunk/maven-doap-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-doap-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-doap-plugin/src/site/site.xml
Added:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/doap-in-use.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/doap-in-use.apt?rev=678078&view=auto
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/doap-in-use.apt
(added)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/doap-in-use.apt
Fri Jul 18 17:00:43 2008
@@ -0,0 +1,61 @@
+ ------
+ Generated DOAP In Use
+ ------
+ Vincent Siveton
+ ------
+ 2008-07-17
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Generated DOAP In Use
+
+ DOAP is used to share informations (metadata) about a software project. Now
that you have a generated DOAP from
+ POM by the DOAP Plugin, you need to publish it and diffuse it.
+
+* How To Publish A DOAP File
+
+ You need to publish it somewhere where the DOAP file will be accessible via
an HTTP or HTTPS request like a web
+ server or SVN.
+
+ By default, the DOAP Plugin generates the file in the reporting output
directory (i.e. $\{project.reporting.outputDirectory\}).
+ So, it will be available when you will deploy the Maven site via the
+
<<<{{{http://maven.apache.org/plugins/maven-site-plugin/usage.html}site:deploy}}>>>
goal. See
+ {{{./with-site-plugin.html}Integrated DOAP Plugin With The Site Plugin}} part
for more information.
+
+* How To Diffuse A DOAP File
+
+ Several Semantic Web directories like
{{{http://doapspace.org/}http://doapspace.org/}} or
+ {{{http://doapstore.org}http://doapstore.org}} provide metadatas relating to
open source projects into a public
+ catalog. You need to enter the DOAP file URL to their catalogs.
+
+ You could also use the {{{http://pingthesemanticweb.com/}Ping the Semantic
Web}} which share RDF data with the World.
+
+Examples for the Maven DOAP
+
+ Our Maven DOAP file is share on SVN
{{{http://svn.apache.org/repos/asf/maven/components/trunk/doap_Maven.rdf}here}}.
+ Here are the result from some Semantic Web directories:
+
+ *
{{{http://doapstore.org/view.php?uri=http%3A%2F%2FMaven.rdf.apache.org%2F}Doapstore}}
+
+ *
{{{http://dataviewer.zitgist.com/?uri=http%3A//svn.apache.org/repos/asf/maven/components/trunk/doap_Maven.rdf}Zigtgist
RDF Viewer}}
+
+ []
Propchange:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/doap-in-use.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/doap-in-use.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/with-site-plugin.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/with-site-plugin.apt?rev=678078&view=auto
==============================================================================
---
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/with-site-plugin.apt
(added)
+++
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/with-site-plugin.apt
Fri Jul 18 17:00:43 2008
@@ -0,0 +1,79 @@
+ ------
+ Integrated DOAP Plugin in the Site Plugin
+ ------
+ Vincent Siveton
+ ------
+ 2008-07-17
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Integrated DOAP Plugin With The Site Plugin
+
+ As described in {{{./doap-in-use.html}DOAP In Use}}, you need to publish the
generated DOAP file.
+
+ By default, the generated DOAP file will be deploy using the
+
<<<{{{http://maven.apache.org/plugins/maven-site-plugin/usage.html}site:deploy}}>>>
goal in the site specified in
+ the <distributionManagement> section of the POM.
+
+* Including DOAP In The Site Phase
+
+ You could always generate the DOAP file for your project by sticking the DOAP
Plugin in the <<<site>>> phase, like the following:
+
++-----+
+<project>
+ <build>
+ <plugins>
+ ...
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-doap-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>site</id>
+ <phase>site</phase>
+ <goals>
+ <goal>generate</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ ...
+ </plugins>
+ </build>
+</project>
++-----+
+
+* Defining Meta Tag
+
+ To make the DOAP file available for all HTML files deployed on the site, you
could modify the <<<src/site/site.xml>>>
+ to specify a \<link/\> tag, i.e.:
+
++-----+
+<project>
+ <body>
+ <head>
+ <link rel="meta" title="DOAP"
href="${project.url}/doap_maven-doap-plugin.rdf" type="application/rdf+xml"/>
+ </head>
+ ...
+ </body>
+</project>
++-----+
Propchange:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/with-site-plugin.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-doap-plugin/src/site/apt/examples/with-site-plugin.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
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=678078&r1=678077&r2=678078&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 Fri Jul 18
17:00:43 2008
@@ -3,20 +3,45 @@
------
Jason van Zyl
------
- 20 July 2006
+ 2008-07-18
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Maven 2 DOAP Plugin
- 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 that would 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.
-
-
+ Maven 2 DOAP Plugin is used to generate compliant
{{{http://usefulinc.com/doap}Description of a Project (DOAP)}}
+ file from a POM. The main goal is to be able to provide DOAP files for
Semantic Web systems that use them as
+ primary input but that would also alleviate the burden of maintaining two
sets of metadata.
+
+ Version 1.0 of this plugin is specifically tailored for use by projects at
+ {{{http://projects.apache.org/doap.html}Apache}}, but this will change in
subsequent versions as more people become
+ interested in DOAP.
+
+ If you are not aware about RDF or Semantic Web concepts, refer you to the
{{{./links.html}Links part}} to getting started.
+
* Goals Overview
+ The DOAP Plugin has one goal:
+
* {{{generate-mojo.html}doap:generate}} Generates a DOAP file from the POM.
[]
@@ -27,9 +52,11 @@
* 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.}}
+ To provide you with better understanding of some usages of the DOAP Plugin,
you can take a look at the following
+ examples:
+
+ * {{{examples/doap-in-use.html}Generated DOAP in use}}
+
+ * {{{examples/with-site-plugin.html}Integrated DOAP Plugin in the Site
Plugin}}
[]
Modified: maven/plugins/trunk/maven-doap-plugin/src/site/apt/links.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/apt/links.apt?rev=678078&r1=678077&r2=678078&view=diff
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/apt/links.apt (original)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/apt/links.apt Fri Jul 18
17:00:43 2008
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- 2008-07-03
+ 2008-07-18
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,7 +28,19 @@
Further Links
-* Articles
+* Definitions
+
+ * {{{http://en.wikipedia.org/wiki/Semantic_web}Semantic Web}}
+
+ * {{{http://en.wikipedia.org/wiki/DOAP}Wikipedia DOAP}}
+
+ *
{{{http://semanticplanet.com/2003/05/parsingFOAFWithPHP#threeMinuteRdf}Three
Minute RDF}}
+
+ *
{{{http://semanticplanet.com/2003/05/parsingFOAFWithPHP#threeMinuteFoaf}Three
Minute FOAF}}
+
+ []
+
+* Articles On DOAP
* {{{http://www.ibm.com/developerworks/xml/library/x-osproj3/}XML Watch:
Describe open source projects with XML, Part 3}}
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=678078&r1=678077&r2=678078&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 Fri Jul 18
17:00:43 2008
@@ -3,38 +3,120 @@
------
Jason van Zyl
------
- 20 July 2006
+ 2008-07-17
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Usage
- 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 DOAP Plugin generates DOAP and ASF DOAP compliant files. The following
examples describe the basic usage of
+ the Plugin.
+
+* Pur DOAP Configuration
+
++-----+
<project>
...
<build>
- ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-doap-plugin</artifactId>
+ <version>1.0</version>
<configuration>
- <category>build-management</category>
- <language>Intercal</language>
+ <doapOptions>
+ <programmingLanguage>java</programmingLanguage>
+ <category>build-management</category>
+ ...
+ </doapOptions>
+
+ <asfExtOptions>
+ <included>false</included>
+ </asfExtOptions>
</configuration>
</plugin>
</plugins>
- ...
</build>
- ...
+ ...
</project>
++-----+
+
+ To generate the DOAP file you would use the following command:
+
++-----
+mvn doap:generate
+-----
+* DOAP ASF Configuration
+
++-----+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-doap-plugin</artifactId>
+ <version>1.0</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>
+
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
++-----+
+
+* Generate DOAP File
+
To generate the DOAP file you would use the following command:
+-----
-mvn -N doap:generate
+mvn doap:generate
+-----
+
+* Further Links
+
+ * {{{./generate-mojo.html}doap:generate parameters}}
+
+ * {{{http://usefulinc.com/ns/doap#}http://usefulinc.com/ns/doap#}}
+
+ *
{{{http://projects.apache.org/docs/pmc.html}http://projects.apache.org/docs/pmc.html}}
+
+ *
{{{http://projects.apache.org/docs/standards.html}http://projects.apache.org/docs/standards.html}}
+
+ * {{{http://www.w3.org/RDF/Validator/}W3C RDF Validation Service}}
+
+ []
Modified: maven/plugins/trunk/maven-doap-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/site/fml/faq.fml?rev=678078&r1=678077&r2=678078&view=diff
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/fml/faq.fml Fri Jul 18
17:00:43 2008
@@ -20,29 +20,43 @@
-->
<faqs id="FAQ" title="Frequently Asked Questions">
- <part id="General">
- <faq id="what-is-doap">
- <question>What is DOAP?</question>
- <answer>
- <p>
- DOAP stands for "Description of a Project" and you can find out
everything there is to
- know about DOAP <a href="http://usefulinc.com/doap";>here</a>.
- </p>
- </answer>
- </faq>
- <faq id="why-use-doap">
- <question>Why would I use DOAP when I have a POM?</question>
- <answer>
- <p>
- That's a very good question! The answer is that generating a DOAP
file should take no effort if you
- are using Maven DOAP Plugin and it helps disseminate project
information which can only be a good thing.
- Cataloging tools like <a href="http://www.codezoo.com/";>CodeZoo</a>
and <a href="http://swik.net/";>SWiK</a>
- can benefit from you generating DOAP files and that can also only be
a good thing. Ultimately the Maven
- team plans to provide an index of all POMs that have been submitted
to the central repository so we are most
- likely going to have the most up-to-date information about projects.
Even so, it is still important to spread
- as much information about projects around as possible so there is no
downside to creating DOAP files.
- </p>
- </answer>
- </faq>
- </part>
+ <part id="General">
+ <faq id="What is DOAP">
+ <question>What is DOAP?</question>
+ <answer>
+ <p>DOAP stands for "Description of a Project" and you can find out
everything there is to
+ know about DOAP in its <a
href="http://usefulinc.com/doap";>homepage</a> and in this <a
+
href="http://www.ibm.com/developerworks/xml/library/x-osproj3/";>article</a>.</p>
+ </answer>
+ </faq>
+ <faq id="What are the benefits of DOAP">
+ <question>What are the benefits of DOAP?</question>
+ <answer>
+ <p>The <a href="http://en.wikipedia.org/wiki/Semantic_web";>Semantic
Web</a> provides
+ mechanisms to process data provided in a form that is easily
processed by machines. Thus,
+ a DOAP is a machine readable document which facilitates projects
research: it becomes much
+ easier to seek information in the mass of data of the Web, since the
data have a given
+ foreseeable format.</p>
+ </answer>
+ </faq>
+ <faq id="Why would I use DOAP when I have a POM">
+ <question>Why would I use DOAP when I have a POM?</question>
+ <answer>
+ <p>That's a very good question! The answer is that generating a DOAP
file should take no
+ effort if you are using Maven DOAP Plugin and it helps disseminate
project information
+ which can only be a good thing. Cataloging tools like <a
href="http://swik.net/";>SWiK</a>
+ or like <a href="http://doapstore.org/";>DoapStore</a> can benefit
from you generating DOAP
+ files and that can also only be a good thing. Even so, it is still
important to spread as
+ much information about projects around as possible so there is no
downside to creating
+ DOAP files.</p>
+ </answer>
+ </faq>
+ <faq id="What to do with the generated DOAP file">
+ <question>What to do with the generated DOAP file?</question>
+ <answer>
+ <p>Maven DOAP plugin has generated a DOAP file, what's next? See <a
+ href="./examples/doap-in-use.html">DOAP in Use</a> part.</p>
+ </answer>
+ </faq>
+ </part>
</faqs>
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=678078&r1=678077&r2=678078&view=diff
==============================================================================
--- maven/plugins/trunk/maven-doap-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-doap-plugin/src/site/site.xml Fri Jul 18 17:00:43
2008
@@ -28,6 +28,9 @@
<item name="FAQ" href="faq.html"/>
<item name="Further Links" href="links.html"/>
</menu>
- <!-- TODO: examples of usage -->
+ <menu name="Examples">
+ <item name="Using DOAP File" href="examples/doap-in-use.html"/>
+ <item name="Integration With Site Plugin"
href="examples/with-site-plugin.html"/>
+ </menu>
</body>
</project>
