Author: eric
Date: Mon Oct 25 10:31:56 2010
New Revision: 1027033
URL: http://svn.apache.org/viewvc?rev=1027033&view=rev
Log:
Add source code page and diagrams to imap web site.
Added:
james/imap/trunk/src/site/resources/images/uml/org.apache.james.imap.api.png
(with props)
james/imap/trunk/src/site/resources/images/uml/org.apache.james.imap_withtest_package.png
- copied unchanged from r1026622,
james/imap/trunk/src/site/resources/images/uml/org.apache.james.imap_package.png
james/imap/trunk/src/site/xdoc/source_code.xml
Modified:
james/imap/trunk/src/site/resources/images/uml/org.apache.james.imap_package.png
james/imap/trunk/src/site/site.xml
james/imap/trunk/src/site/xdoc/index.xml
Added:
james/imap/trunk/src/site/resources/images/uml/org.apache.james.imap.api.png
URL:
http://svn.apache.org/viewvc/james/imap/trunk/src/site/resources/images/uml/org.apache.james.imap.api.png?rev=1027033&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
james/imap/trunk/src/site/resources/images/uml/org.apache.james.imap.api.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified:
james/imap/trunk/src/site/resources/images/uml/org.apache.james.imap_package.png
URL:
http://svn.apache.org/viewvc/james/imap/trunk/src/site/resources/images/uml/org.apache.james.imap_package.png?rev=1027033&r1=1027032&r2=1027033&view=diff
==============================================================================
Binary files - no diff available.
Modified: james/imap/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/james/imap/trunk/src/site/site.xml?rev=1027033&r1=1027032&r2=1027033&view=diff
==============================================================================
--- james/imap/trunk/src/site/site.xml (original)
+++ james/imap/trunk/src/site/site.xml Mon Oct 25 10:31:56 2010
@@ -39,7 +39,15 @@
<body>
- <menu ref="reports" />
+ <menu name="Documentation">
+ <item name="Introduction" href="/index.html" />
+ </menu>
+
+ <menu name="References">
+ <item name="Source Code" href="/source_code.html" />
+ </menu>
+
+ <menu ref="reports" />
</body>
Modified: james/imap/trunk/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/james/imap/trunk/src/site/xdoc/index.xml?rev=1027033&r1=1027032&r2=1027033&view=diff
==============================================================================
--- james/imap/trunk/src/site/xdoc/index.xml (original)
+++ james/imap/trunk/src/site/xdoc/index.xml Mon Oct 25 10:31:56 2010
@@ -27,31 +27,38 @@
<body>
-<section name='Introduction'>
+ <section name="What Is James IMAP?">
+
+ <p>A library providing a flexible codec for IMAP, command processors
+ and a sample data access layer. In combination with a socket layer,
+ this library can be used to create an IMAP server.</p>
+
+ </section>
+
+ <section name='Status'>
+
+ <p><a
href='http://james.apache.org/server/rfclist/imap4/rfc2060.txt'>RFC2060</a> is
functionally complete, tested
+ and usable. The data access layer is still under optimization on
performance perspectives.
+ Database schema and API changes are susceptible to change.</p>
+
+ </section>
+
+ <section name='IMAP in James Server'>
+
+ <p><a href='http://james.apache.org/server/head'>JAMES Server 3</a>
supports IMAP
+ (using this library). A backport to <a
href='http://james.apache.org/server/2.3.2'>JAMES
+ Server 2.3.2</a> would require a volunteer.</p>
+
+ </section>
+
+ <section name='Use James IMAP as a component in you application'>
+
+ <p>The <a href="source_code.html">source code</a> page contains
information on how
+ to develop on James IMAP.</p>
-<subsection name="What Is James IMAP?">
-<p>A library providing a flexible codec for IMAP, command processors
-and a sample data access layer. In combination with a socket layer,
-this library can be used to create an IMAP server.</p>
-</subsection>
-
-<subsection name='Status'>
-<p><a
href='http://james.apache.org/server/rfclist/imap4/rfc2060.txt'>RFC2060</a> is
functionally complete, tested
-and usable. The data access layer is still under optimization on performance
perspectives.
-Database schema and API changes are susceptible to change.</p>
-</subsection>
-
-<subsection name='IMAP in James Server'>
-<p><a href='http://james.apache.org/server/head'>JAMES Server 3</a> supports
IMAP (using this library).
-A backport to <a href='http://james.apache.org/server/2.3.2'>JAMES Server
2.3.2</a> would require
-a volunteer.</p>
-</subsection>
-
-<subsection name='Develop IMAP'>
-<img src="images/uml/org.apache.james.imap_package.png"/>
-</subsection>
+ <img src="images/uml/org.apache.james.imap_package.png"/>
-</section>
+ </section>
</body>
Added: james/imap/trunk/src/site/xdoc/source_code.xml
URL:
http://svn.apache.org/viewvc/james/imap/trunk/src/site/xdoc/source_code.xml?rev=1027033&view=auto
==============================================================================
--- james/imap/trunk/src/site/xdoc/source_code.xml (added)
+++ james/imap/trunk/src/site/xdoc/source_code.xml Mon Oct 25 10:31:56 2010
@@ -0,0 +1,95 @@
+<?xml version="1.0"?>
+<!--
+ 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.
+-->
+
+<document>
+
+ <properties>
+ <title>Apache James - IMAP - Source Code</title>
+ <author email="[email protected]">Apache James Project</author>
+ </properties>
+
+<body>
+
+ <section name="Get Source Code">
+
+ <subsection name="Anonymous Access">
+
+ <p>The source can be checked out anonymously from SVN with the following
command.</p>
+
+ <code>$ svn checkout http://svn.apache.org/repos/asf/james/imap/trunk
james-imap</code>
+
+ </subsection>
+
+ <subsection name="Developer Access">
+
+ <p>Everyone can access the Subversion repository via HTTP, but
Committers must checkout the Subversion repository via HTTPS.</p>
+
+ <code>$ svn checkout https://svn.apache.org/repos/asf/james/imap/trunk
james-imap</code>
+
+ </subsection>
+
+ </section>
+
+ <section name='Source Projects'>
+
+ <subsection name="Organization">
+
+ <div style="float:left; margin:4px;">
+ <img src="images/uml/org.apache.james.imap_withtest_package.png"/>
+ </div>
+
+ <p><code>apache-james-imap-api</code> contains the interfaces,
exceptions and Constants needed by the other projects.</p>
+
+ <p><code>apache-james-imap-message</code> allows to encode, decode and
structure the IMAP requests and responses.
+ It will provide among other the ImapRequestMessage and
ImapResponseMessage implementation to be processed
+ by the apache-james-imap-processor project.</p>
+
+ <p><code>apache-james-imap-processor</code> implements the Chain Of
Responsibility design pattern.
+ ImapRequestMessage and ImapResponder will be passed to the list of
Processors that
+ will execute doProcess if applicable.</p>
+
+ <p><code>apache-james-imap-protocol-tester</code> can be used by other
projects to test the IMAP
+ protocol in conjunction with a <a
href="http://james.apache.org/mailbox";>James mailbox</a>.</p>
+
+ </subsection>
+
+ <div style="clear:both; float:none;"/>
+
+ <subsection name="James IMAP API - apache-james-imap-api">
+
+ <p>The following diagram represents some key (not all) interfaces of the
IMAP API project.</p>
+
+ <img src="images/uml/org.apache.james.imap.api.png"/>
+
+ </subsection>
+
+ <subsection name="James IMAP Message - apache-james-imap-message">
+
+ </subsection>
+
+ <subsection name="James IMAP Processor - apache-james-imap-processor">
+
+ </subsection>
+
+ </section>
+
+</body>
+
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
