Commit the documentation of core, ant task, maven plugin and arch
Change the NOTICE file format
git-svn-id: https://svn.apache.org/repos/asf/felix/trunk@657197 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/ipojo/plugin/NOTICE b/ipojo/plugin/NOTICE
index 439e834..0b19481 100644
--- a/ipojo/plugin/NOTICE
+++ b/ipojo/plugin/NOTICE
@@ -1,16 +1,17 @@
-Apache Felix Maven iPOJO Plugin
+Apache Felix iPOJO Maven Plugin
Copyright 2008 The Apache Software Foundation
+I. Included Software
+
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
-
-This product includes software developed at
-The OSGi Alliance (http://www.osgi.org/).
-Copyright 2006 The OSGi Alliance.
Licensed under the Apache License 2.0.
-This product includes software developed at
-The OW2 Consortium
-Copyright 2000-2005 INRIA, France Telecom
-All rights reserved.
+II. Used Software
+This product uses software developed at
+The Apache Software Foundation (http://www.apache.org/).
+Licensed under the Apache License 2.0.
+
+III. License Summary
+- Apache License 2.0
diff --git a/ipojo/plugin/doc/ipojo-maven-plug-in.html b/ipojo/plugin/doc/ipojo-maven-plug-in.html
new file mode 100644
index 0000000..4f60089
--- /dev/null
+++ b/ipojo/plugin/doc/ipojo-maven-plug-in.html
@@ -0,0 +1,249 @@
+
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<HTML>
+
+
+<HEAD>
+ <TITLE>Apache Felix - iPOJO Maven Plug-in</TITLE>
+ <LINK rel="stylesheet" href="http://felix.apache.org/site/media.data/site.css" type="text/css" media="all">
+ <META http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ </HEAD>
+ <BODY>
+ <DIV class="title"><DIV class="logo"><A href="http://felix.apache.org/site/index.html"><IMG border="0" alt="Apache Felix" src="http://felix.apache.org/site/media.data/logo.png"></A></DIV><DIV class="header"><A href="http://www.apache.org/"><IMG border="0" alt="Apache" src="http://felix.apache.org/site/media.data/apache.png"></A></DIV></DIV>
+ <DIV class="menu">
+ <UL>
+ <LI><A href="http://felix.apache.org/site/news.html" title="news">news</A></LI>
+ <LI><A href="http://felix.apache.org/site/license.html" title="license">license</A></LI>
+ <LI><SPAN class="nobr"><A href="http://felix.apache.org/site/downloads.cgi" title="Visit page outside Confluence" rel="nofollow">downloads<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>
+ <LI><A href="http://felix.apache.org/site/documentation.html" title="documentation">documentation</A></LI>
+ <LI><A href="http://felix.apache.org/site/mailinglists.html" title="mailinglists">mailing lists</A></LI>
+ <LI><A href="http://felix.apache.org/site/contributing.html" title="Contributing">contributing</A></LI>
+ <LI><SPAN class="nobr"><A href="http://www.apache.org/" title="Visit page outside Confluence" rel="nofollow">asf<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>
+ <LI><SPAN class="nobr"><A href="http://www.apache.org/foundation/sponsorship.html" title="Visit page outside Confluence" rel="nofollow">sponsorship<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>
+ <LI><SPAN class="nobr"><A href="http://www.apache.org/foundation/thanks.html" title="Visit page outside Confluence" rel="nofollow">sponsors<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN>
+<!-- ApacheCon Ad -->
+<IFRAME src="http://www.apache.org/ads/button.html" style="border-width:0; float: left" frameborder="0" scrolling="no" width="135" height="135"></IFRAME>
+<P style="height: 100px">
+<!-- ApacheCon Ad --></LI>
+</UL>
+ </DIV>
+ <DIV class="main">
+<TABLE class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><TBODY><TR>
+<TD class="confluenceTd" valign="top" width="80%">
+<H1><A name="iPOJOMavenPlug-in-HowtousetheiPOJOMavenPlugin"></A>How to use the iPOJO Maven Plug-in</H1>
+
+<P>To use the iPOJO Maven plug-in, edit the following pom.xml (replace all $xxx elements):</P>
+<DIV class="panel"><DIV class="panelContent">
+<P><project><BR>
+ <modelVersion>4.0.0</modelVersion><BR>
+ <packaging>bundle</packaging> <!-- Use the BND Maven plug-in --><BR>
+<FONT color="red"> </FONT> <FONT color="red"><groupId>$YOUR_GROUP_ID</groupId></FONT><BR>
+<FONT color="red"> </FONT><FONT color="red"><artifactId>$YOUR_ARTIFACT_ID</artifactId></FONT><BR>
+<FONT color="red"> </FONT> <FONT color="red"><version>$YOUR_ARTIFACT_VERSION</version></FONT><BR>
+<FONT color="red"> </FONT> <FONT color="red"><name>$YOUR_PROJECT_NAME</name></FONT></P>
+
+<P><FONT color="red"> </FONT> <FONT color="red"><dependencies></FONT><BR>
+<FONT color="red"> </FONT> <FONT color="red">$YOUR_MAVEN_DEPENDECIES</FONT><BR>
+<FONT color="red"> </FONT> <FONT color="red"></dependencies></FONT></P>
+
+<P> <!-- To download automatically the iPOJO Maven Plugin --><BR>
+ <pluginRepositories><BR>
+ <pluginRepository><BR>
+ <id>apache.snapshots</id><BR>
+ <name>snapshot plugins</name><BR>
+ <url><BR>
+ <SPAN class="nobr"><A href="http://people.apache.org/repo/m2-snapshot-repository" title="Visit page outside Confluence" rel="nofollow">http://people.apache.org/repo/m2-snapshot-repository<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN><BR>
+ </url><BR>
+ <releases><BR>
+ <enabled>false</enabled><BR>
+ </releases><BR>
+ <snapshots><BR>
+ <enabled>true</enabled><BR>
+ </snapshots><BR>
+ </pluginRepository><BR>
+ </pluginRepositories></P>
+
+<P> <build><BR>
+ <plugins><BR>
+ <!-- BND Maven Plugin Configuration --><BR>
+ <plugin><BR>
+ <groupId>org.apache.felix</groupId><BR>
+ <artifactId>maven-bundle-plugin</artifactId><BR>
+ <extensions>true</extensions><BR>
+ <configuration><BR>
+ <instructions><BR>
+ <Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName><BR>
+<FONT color="red"> </FONT><FONT color="red"><Private-Package>$YOUR_PRIVATE_PACKAGE</Private-Package></FONT><BR>
+<FONT color="red"> </FONT><FONT color="red"><Export-Package>$YOUR_EXPORTED_PACKAGE</Export-Package></FONT><BR>
+ </instructions><BR>
+ </configuration><BR>
+ </plugin><BR>
+ <!-- iPOJO Maven Plugin Configuration : nothing to do --><BR>
+ <plugin><BR>
+ <groupId>org.apache.felix</groupId><BR>
+ <artifactId>maven-ipojo-plugin</artifactId><BR>
+ <version>0.8.0-SNAPSHOT</version><BR>
+ <executions><BR>
+ <execution><BR>
+ <goals><BR>
+ <goal>ipojo-bundle</goal><BR>
+ </goals><BR>
+ </execution><BR>
+ </executions><BR>
+ </plugin><BR>
+ </plugins><BR>
+ </build><BR>
+</project></P>
+</DIV></DIV>
+<P>The iPOJO Maven Plug-in is generally used with the BND Maven Plug-in (more details here). However the two configurations are completely separated. So, you can use all BND Maven plug-in features. The iPOJO configuration section can be used as previously written without any changes. However it requires that your metadata file is inside the "src/main/resources" folder and is named "metadata.xml".</P>
+
+<H2><A name="iPOJOMavenPlug-in-Execution"></A>Execution</H2>
+
+<P>To manipulate your project, use the "<EM>mvn clean install</EM>" command. The output should be like:</P>
+<DIV class="panel"><DIV class="panelContent">
+<P>[INFO] Scanning for projects...<BR>
+[INFO] ----------------------------------------------------------------------------<BR>
+[INFO] Building Hello Client<BR>
+[INFO] task-segment: [clean, install]<BR>
+[INFO] ----------------------------------------------------------------------------<BR>
+[INFO] [clean:clean]<BR>
+[INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target<BR>
+[INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target\classes<BR>
+[INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target\test-classes<BR>
+[INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target\site<BR>
+[INFO] [resources:resources]<BR>
+[INFO] Using default encoding to copy filtered resources.<BR>
+[INFO] Copying 1 resource<BR>
+[INFO] [compiler:compile]<BR>
+[INFO] Compiling 1 source file to D:\clement\workspaces\iPOJO-Dev\hello.client\target\classes<BR>
+[INFO] [resources:testResources]<BR>
+[INFO] Using default encoding to copy filtered resources.<BR>
+[INFO] Resource directory does not exist: D:\clement\workspaces\iPOJO-Dev\hello.client\src\test\resources<BR>
+[INFO] [compiler:testCompile]<BR>
+[INFO] No sources to compile<BR>
+[INFO] [surefire:test]<BR>
+[INFO] No tests to run.<BR>
+[INFO] [bundle:bundle]<BR>
+[INFO] [org.apache.felix.ipojo.:ipojo-bundle {execution: default}]<BR>
+[INFO] Start bundle manipulation<BR>
+[INFO] Metadata File : D:\clement\workspaces\iPOJO-Dev\hello.client\target\classes\metadata.xml<BR>
+[INFO] Input Bundle File : D:\clement\workspaces\iPOJO-Dev\hello.client\target\hello.client-0.0.1.jar<BR>
+[INFO] Bundle manipulation - SUCCESS<BR>
+[INFO] [install:install]<BR>
+[INFO] Installing D:\clement\workspaces\iPOJO-Dev\hello.client\target\hello.client-0.0.1.jar to D:\Dev\maven-repo\ipojo\example\hello.client\0.0.1\hello.client-0.0.1.jar<BR>
+[INFO] ------------------------------------------------------------------------<BR>
+[INFO] BUILD SUCCESSFUL<BR>
+[INFO] ------------------------------------------------------------------------<BR>
+[INFO] Total time: 9 seconds<BR>
+[INFO] Finished at: Mon Aug 13 14:04:55 CEST 2007<BR>
+[INFO] Final Memory: 6M/13M<BR>
+[INFO] ------------------------------------------------------------------------</P>
+</DIV></DIV>
+<H2><A name="iPOJOMavenPlug-in-ConfigurationOptions"></A>Configuration Options</H2>
+
+<P>You can configure the localization of the iPOJO metadata file as following:</P>
+<DIV class="panel"><DIV class="panelContent">
+<P><plugin><BR>
+ <groupId>org.apache.felix</groupId><BR>
+ <artifactId>maven-ipojo-plugin</artifactId><BR>
+ <version>0.8.0-SNAPSHOT</version><BR>
+ <executions><BR>
+ <execution><BR>
+ <goals><BR>
+ <goal>ipojo-bundle</goal><BR>
+ </goals><BR>
+ <configuration><BR>
+ <FONT color="red"><metadata>ipojo/meta.xml</metadata></FONT><BR>
+ </configuration><BR>
+ </execution><BR>
+ </executions><BR>
+</plugin></P>
+</DIV></DIV>
+<P>In the metadata element, you can specify your metadata files. This file must be either in the same directory than the POM file (project root) or in one of the resource folder of the maven project (for instance, "src/main/resources/ipojo/meta.xml").</P>
+
+<P>The second option allows skipping annotations processing, by using the "<EM>ignoreAnnotations</EM>" element:</P>
+<DIV class="panel"><DIV class="panelContent">
+<P><plugin><BR>
+ <groupId>org.apache.felix</groupId><BR>
+ <artifactId>maven-ipojo-plugin</artifactId><BR>
+ <version>0.8.0-SNAPSHOT</version><BR>
+ <executions><BR>
+ <execution><BR>
+ <goals><BR>
+ <goal>ipojo-bundle</goal><BR>
+ </goals><BR>
+ <configuration><BR>
+ <FONT color="red"><ignoreAnnotations>true</ignoreAnnotations></FONT><BR>
+ </configuration><BR>
+ </execution><BR>
+ </executions><BR>
+</plugin></P>
+</DIV></DIV></TD>
+<TD class="confluenceTd" valign="top" width="20%">
+<FORM method="get" class="confluence-searchbox marginlessForm " action="http://felix.apache.org/confluence/dosearchsite.action">
+ <INPUT type="hidden" name="searchQuery.spaceKey" value="FELIX">
+ <INPUT type="text" name="searchQuery.queryString">
+ <INPUT type="submit" value="Search">
+</FORM>
+<HR>
+<H6><A name="iPOJOMavenPlug-in-Overview"></A><B>Overview</B></H6>
+<UL>
+ <LI><A href="http://felix.apache.org/site/apache-felix-ipojo.html" title="Apache Felix iPOJO">Home Page</A></LI>
+ <LI><A href="http://felix.apache.org/site/apache-felix-ipojo-feature-overview.html" title="Apache Felix iPOJO Feature Overview">iPOJO Feature Overview</A></LI>
+ <LI><A href="http://felix.apache.org/site/download.html" title="Download">Download & Install </A></LI>
+</UL>
+
+
+<H6><A name="iPOJOMavenPlug-in-GettingStarted"></A><B>Getting Started</B></H6>
+<UL>
+ <LI><A href="http://felix.apache.org/site/ipojo-in-10-minutes.html" title="iPOJO in 10 minutes">iPOJO in 10 minutes</A></LI>
+ <LI><A href="http://felix.apache.org/site/ipojo-hello-word-maven-based-tutorial.html" title="iPOJO Hello Word (Maven-Based) tutorial">iPOJO Hello Word (Maven-Based) tutorial</A></LI>
+ <LI><A href="http://felix.apache.org/site/ipojo-advanced-tutorial.html" title="iPOJO Advanced Tutorial">iPOJO Advanced Tutorial</A></LI>
+</UL>
+
+
+<H6><A name="iPOJOMavenPlug-in-UserGuide"></A><B>User Guide</B></H6>
+<UL>
+ <LI><A href="http://felix.apache.org/site/describing-components.html" title="Describing components">Describing components</A></LI>
+ <LI><A href="http://felix.apache.org/site/how-to-use-ipojo-annotations.html" title="How to use iPOJO Annotations">How to use iPOJO Annotations</A></LI>
+ <LI><A href="http://felix.apache.org/site/ipojo-advanced-topics.html" title="iPOJO Advanced Topics">Advanced Topics</A></LI>
+ <LI><A href="http://felix.apache.org/site/ipojo-faq.html" title="iPOJO FAQ">FAQ</A></LI>
+</UL>
+
+
+<H6><A name="iPOJOMavenPlug-in-Tools"></A><B>Tools</B></H6>
+<UL>
+ <LI><A href="http://felix.apache.org/site/ipojo-eclipse-plug-in.html" title="iPOJO Eclipse Plug-in">iPOJO Eclipse Plug-in</A></LI>
+ <LI><A href="http://felix.apache.org/site/ipojo-ant-task.html" title="iPOJO Ant Task">iPOJO Ant Task</A></LI>
+ <LI><A href="#" title="iPOJO Maven Plug-in">iPOJO Maven Plug-in</A></LI>
+ <LI><A href="http://felix.apache.org/site/ipojo-concepts-overview.html" title="iPOJO Concepts Overview">iPOJO concepts overview</A></LI>
+</UL>
+
+
+<H6><A name="iPOJOMavenPlug-in-DeveloperGuide"></A><B>Developer Guide</B></H6>
+<UL>
+ <LI><A href="http://felix.apache.org/site/how-to-write-your-own-handler.html" title="How to write your own handler">How to write your own handler</A></LI>
+ <LI><A href="http://felix.apache.org/site/how-to-use-ipojo-manipulation-metadata.html" title="How to use iPOJO Manipulation Metadata">How to use iPOJO Manipulation Metadata</A></LI>
+</UL>
+
+
+<H6><A name="iPOJOMavenPlug-in-Misc%26Contact"></A><B>Misc & Contact</B></H6>
+<UL>
+ <LI><A href="http://felix.apache.org/site/apache-felix-ipojo-issuestracker.html" title="apache-felix-ipojo-issuestracker">Issues Tracker</A></LI>
+ <LI><A href="http://felix.apache.org/site/apache-felix-ipojo-supportedvms.html" title="apache-felix-ipojo-supportedVMs">Supported JVMs</A></LI>
+ <LI><A href="http://felix.apache.org/site/apache-felix-ipojo-supportedosgi.html" title="apache-felix-ipojo-supportedOSGi">Supported OSGi Implementations</A></LI>
+ <LI><A href="http://felix.apache.org/site/future-ideas.html" title="Future Ideas">Future Ideas</A></LI>
+ <LI><SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=FELIX&title=Contact&linkCreation=true&fromPageId=82824" title="Create Page: Contact" class="createlink">Contact<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/plus.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>
+ <LI><A href="http://felix.apache.org/site/related-works.html" title="Related Works">Related Works</A></LI>
+ <LI><A href="http://felix.apache.org/site/article-presentations.html" title="Article & Presentations">Article & Presentations</A></LI>
+</UL>
+
+
+<HR>
+<DIV class="" align="center">
+<P><SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/createrssfeed.action?types=blogpost&statuses=created&statuses=modified&spaces=FELIX&labelString=iPOJO&rssType=atom&maxResults=10&timeSpan=5&publicFeed=true&title=iPOJO%20Atom%20Feed" title="Stay tuned!" rel="nofollow"><IMG src="http://cwiki.apache.org/confluence/images/icons/feed-icon-32x32.png" align="absmiddle" border="0"><SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></P></DIV></TD></TR></TBODY></TABLE>
+ </DIV>
+ </BODY>
+
+
+</HTML>
diff --git a/ipojo/plugin/doc/media.data/apache.png b/ipojo/plugin/doc/media.data/apache.png
new file mode 100644
index 0000000..5132f65
--- /dev/null
+++ b/ipojo/plugin/doc/media.data/apache.png
Binary files differ
diff --git a/ipojo/plugin/doc/media.data/gradient.png b/ipojo/plugin/doc/media.data/gradient.png
new file mode 100644
index 0000000..6ddc10b
--- /dev/null
+++ b/ipojo/plugin/doc/media.data/gradient.png
Binary files differ
diff --git a/ipojo/plugin/doc/media.data/logo.png b/ipojo/plugin/doc/media.data/logo.png
new file mode 100644
index 0000000..dccbddc
--- /dev/null
+++ b/ipojo/plugin/doc/media.data/logo.png
Binary files differ
diff --git a/ipojo/plugin/doc/media.data/site.css b/ipojo/plugin/doc/media.data/site.css
new file mode 100644
index 0000000..959ab0a
--- /dev/null
+++ b/ipojo/plugin/doc/media.data/site.css
@@ -0,0 +1,25 @@
+/* @override http://felix.apache.org/site/media.data/site.css */
+
+body { background-color: #ffffff; color: #3b3b3b; font-family: Tahoma, Arial, sans-serif; font-size: 10pt; line-height: 140% }
+h1, h2, h3, h4, h5, h6 { font-weight: normal; color: #000000; line-height: 100%; margin-top: 0px}
+h1 { font-size: 200% }
+h2 { font-size: 175% }
+h3 { font-size: 150% }
+h4 { font-size: 140% }
+h5 { font-size: 130% }
+h6 { font-size: 120% }
+a { color: #1980af }
+a:visited { color: #1980af }
+a:hover { color: #1faae9 }
+.title { position: absolute; left: 1px; right: 1px; top:25px; height: 81px; background: url(http://felix.apache.org/site/media.data/gradient.png) repeat-x; background-position: bottom; }
+.logo { position: absolute; width: 15em; height: 81px; text-align: center; }
+.header { text-align: right; margin-right: 20pt; margin-top: 30pt;}
+.menu { border-top: 10px solid #f9bb00; position: absolute; top: 107px; left: 1px; width: 15em; bottom: 0px; padding: 0px; background-color: #fcfcfc }
+.menu ul { background-color: #fdf5d9; list-style: none; padding-left: 4em; margin-top: 0px; padding-top: 2em; padding-bottom: 2em; margin-left: 0px; color: #4a4a43}
+.menu a { text-decoration: none; color: #4a4a43 }
+.main { position: absolute; border-top: 10px solid #cde0ea; top: 107px; left: 15em; right: 1px; margin-left: 2px; padding-right: 4em; padding-left: 1em; padding-top: 1em;}
+.code { background-color: #eeeeee; border: solid 1px black; padding: 0.5em }
+.code-keyword { color: #880000 }
+.code-quote { color: #008800 }
+.code-object { color: #0000dd }
+.code-java { margin: 0em }
\ No newline at end of file
