You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by er...@apache.org on 2012/04/17 10:09:44 UTC

svn commit: r1326982 - in /james/mailbox/trunk/src/site: site.xml xdoc/index.xml xdoc/mailbox-api.xml xdoc/mailbox-guice.xml xdoc/mailbox-hbase.xml xdoc/mailbox-jcr.xml xdoc/mailbox-jpa.xml xdoc/mailbox-maildir.xml xdoc/mailbox-memory.xml

Author: eric
Date: Tue Apr 17 08:09:43 2012
New Revision: 1326982

URL: http://svn.apache.org/viewvc?rev=1326982&view=rev
Log:
Document James 3.0b4, mailbox project (JAMES-1399)

Modified:
    james/mailbox/trunk/src/site/site.xml
    james/mailbox/trunk/src/site/xdoc/index.xml
    james/mailbox/trunk/src/site/xdoc/mailbox-api.xml
    james/mailbox/trunk/src/site/xdoc/mailbox-guice.xml
    james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml
    james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml
    james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml
    james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml
    james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml

Modified: james/mailbox/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/site.xml?rev=1326982&r1=1326981&r2=1326982&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/site.xml (original)
+++ james/mailbox/trunk/src/site/site.xml Tue Apr 17 08:09:43 2012
@@ -19,6 +19,12 @@
 -->
 <project name="Apache James Mailbox">
 
+  <skin>
+    <groupId>org.apache.james</groupId>
+    <artifactId>james-skin</artifactId>
+    <version>${james-skin.version}</version>
+  </skin>
+
   <bannerLeft>
     <name>James Server</name>
     <src>images/logos/james-server-logo.gif</src>

Modified: james/mailbox/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/index.xml?rev=1326982&r1=1326981&r2=1326982&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/index.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/index.xml Tue Apr 17 08:09:43 2012
@@ -21,7 +21,7 @@
 <document>
 
  <properties>
-  <title>Introduction</title>
+  <title>Apache James Mailbox Introduction</title>
   <author email="server-dev@james.apache.org">Apache James Mailbox</author>
  </properties>
 
@@ -43,7 +43,7 @@
        mechanisms: MailDir, SQL Database via Apache OpenJPA, JCR (Java Content Repository based on Apache Jackrabbit) 
        and Apache HBase.
     </p>
-    <p>You can <a href="http://james.apache.org/download.cgi">download</a> current 0.3 release. 
+    <p>You can <a href="http://james.apache.org/download.cgi">download</a> current 0.4 release. 
        The <a href="apidocs/">API</a> as the schemas for the different implementations are susceptible to evolve.
     </p>
   </section>

Modified: james/mailbox/trunk/src/site/xdoc/mailbox-api.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-api.xml?rev=1326982&r1=1326981&r2=1326982&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-api.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-api.xml Tue Apr 17 08:09:43 2012
@@ -73,14 +73,12 @@ Image is no more in line with trunk
     </subsection>
 
   </section>
-  
-  <section name="Other Interfaces and Classes">
 <!-- 
+  <section name="Other Interfaces and Classes">
 Image is no more in line with trunk
       <p><img src="images/uml/org-apache-james-mailbox-api-msc.png"/></p>
--->
   </section>
-
+-->
 </body>
 
 </document>

Modified: james/mailbox/trunk/src/site/xdoc/mailbox-guice.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-guice.xml?rev=1326982&r1=1326981&r2=1326982&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-guice.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-guice.xml Tue Apr 17 08:09:43 2012
@@ -25,6 +25,8 @@
 
 <body>
 
+  <section name="Mailbox Guice Responsability">
+  </section>
 
 </body>
 

Modified: james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml?rev=1326982&r1=1326981&r2=1326982&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml Tue Apr 17 08:09:43 2012
@@ -30,8 +30,12 @@
         </section>
         
         <section name="Overview">
-            <p>This should provide an overview of the design and implementation of Mailbox HBase. The current design is illustrated in </p>
-            <img src="apache-james-mailbox-hbase/images/james-hbase-mailbox-schema.svg"/>. It is generated from a MindMap file that you can find in the sources.
+            <p>
+              This should provide an overview of the design and implementation of Mailbox HBase.
+              <!-- 
+                The current design is illustrated in <img src="apache-james-mailbox-hbase/images/james-hbase-mailbox-schema.svg"/>. It is generated from a MindMap file that you can find in the sources.
+              -->
+            </p>
             <subsection name="Tables">
                 <p>The current implementations stores Messages, Mailboxes and Subscriptions in their own tables.</p> There are:
                 <ul>
@@ -73,8 +77,8 @@
         </section>
         
         <section name="Installation">
-            <p>In order for the mailbox implementation to work you have to provide it with a link to your HBase cluster. Puting 
-                <em>hbase-sites.xml</em> on the class path should be enough. Mailbox HBase will pick it up an read all the configuration parameters from it.
+            <p>In order for the mailbox implementation to work you have to provide it with a link to your HBase cluster. Putting 
+                <em>hbase-site.xml</em> on the class path should be enough. Mailbox HBase will pick it up an read all the configuration parameters from it.
             </p>
         </section>
         
@@ -118,7 +122,7 @@
             </subsection>
             <subsection name="HBaseMessage">
                 <p>Extends AbstractMessage and represents a message in the message store. 
-                What is important to rememeber is that the current implementation retrieves just the message meta-data from HBase 
+                What is important to remember is that the current implementation retrieves just the message meta-data from HBase 
                 and uses ChunkInputStream to load the message body only when needed.
                 </p>
             </subsection>            

Modified: james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml?rev=1326982&r1=1326981&r2=1326982&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml Tue Apr 17 08:09:43 2012
@@ -31,13 +31,13 @@
                 <a hfre="http://jackrabbit.apache.org/">Apache Jackrabbit</a>.
             </p>
         </section>
-
+<!-- 
         <section name="Installation">
         
         </section>
         <section name="Mailbox JCR Classes">
         </section>
-
+-->
     </body>
 
 </document>

Modified: james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml?rev=1326982&r1=1326981&r2=1326982&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml Tue Apr 17 08:09:43 2012
@@ -26,7 +26,7 @@
     <body>
 
         <section name="Mailbox JPA Responsibility">
-            <p> This mailbox implementation stores messages in a Java Persistace API store 
+            <p> This mailbox implementation stores messages in a Java Persistence API store 
             (think data bases, but not limited to that). 
             </p>
             <p>
@@ -39,25 +39,21 @@
   
         <section name="Overview">
             <p>The JPA implementation uses Java Persistenca API Annotations to map Java objects to data base tables. 
-            The current implementation also supports features such as storing messages in an encripted database and provide 
-            on the fly encryption/decryption. 
+            The current implementation also supports features such as storing messages in an encrypted database and provide 
+            on the fly encryption/decryption.
             </p>
         </section>
-        
+<!-- 
         <section name="Installation">
-            
         </section>
+
         <section name="Mailbox JPA Classes">
-  
             <subsection name="Managers">
-<!-- 
 Image is no more in line with trunk
       <p><img src="images/uml/org-apache-james-mailbox-jpa-managers.png"/></p>
--->
             </subsection>
-  
         </section>
-
+-->
     </body>
 
 </document>

Modified: james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml?rev=1326982&r1=1326981&r2=1326982&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml Tue Apr 17 08:09:43 2012
@@ -28,18 +28,13 @@
   <section name="Mailbox Maildir Responsibility">
       <p>This implementation stores messages using the popular <a href="http://en.wikipedia.org/wiki/Maildir">Maildir</a> format.</p> 
   </section>
-
+<!-- 
   <section name="Mailbox Maildir Classes">
-
     <subsection name="Managers">
-<!-- 
-Image is no more in line with trunk
       <p><img src="images/uml/org-apache-james-mailbox-maildir-managers.png"/></p>
--->
     </subsection>
-    
   </section>
-
+-->
 </body>
 
 </document>

Modified: james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml?rev=1326982&r1=1326981&r2=1326982&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml Tue Apr 17 08:09:43 2012
@@ -28,18 +28,14 @@
         <section name="Mailbox Memory Responsibility">
             <p>Provides an in-memory mail store.</p>
         </section>
-
+<!-- 
         <section name="Mailbox Memory Classes">
-  
             <subsection name="Managers">
-<!-- 
 Image is no more in line with trunk
       <p><img src="images/uml/org-apache-james-mailbox-memory-managers.png"/></p>
--->
             </subsection>
-    
         </section>
-
+-->
     </body>
 
 </document>



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org