Reorg a bit more, make the <PRE> section narrower, add more references to

        * camel.sgml: Reorg a bit more, make the <PRE> section narrower,
        add more references to graphics (the graphics themselves are
        still in beta), add a section on CamelStream.

svn path=/trunk/; revision=1996

4 files changed, 72 insertions, 24 deletions

diff --git a/doc/white-papers/mail/ChangeLog b/doc/white-papers/mail/ChangeLog
index 9e3830a238..6d4e8b7f8a 100644
--- a/doc/white-papers/mail/ChangeLog
+++ b/doc/white-papers/mail/ChangeLog
@@ -1,3 +1,9 @@
+2000-02-29  Dan Winship  <danw@helixcode.com>
+
+	* camel.sgml: Reorg a bit more, make the <PRE> section narrower,
+	add more references to graphics (the graphics themselves are
+	still in beta), add a section on CamelStream.
+
 2000-02-28  Dan Winship  <danw@helixcode.com>
 
 	* camel.sgml: add Bertrand to authors, edit his additions
diff --git a/doc/white-papers/mail/camel.sgml b/doc/white-papers/mail/camel.sgml
index 44b615a9ed..14f7a88747 100644
--- a/doc/white-papers/mail/camel.sgml
+++ b/doc/white-papers/mail/camel.sgml
@@ -56,10 +56,6 @@
       which set some of the boundaries on its requirements and
       extensibility.
     </para>
-  </sect1>
-
-  <sect1 id="features">
-    <title>Features</title>
 
     <para>
       &Camel; sees all message repositories as stores containing
@@ -103,6 +99,8 @@
   <sect1 id="overview">
     <title>Overview</title>
 
+    <graphic format="gif" fileref="camel"></graphic>
+
     <para>
       To begin using &Camel;, an application first creates a
       <classname>CamelSession</classname> object. This object is used
@@ -188,10 +186,6 @@
   <sect1 id="classes">
     <title>Major Subcomponents</title>
 
-    <para>
-      XXX
-    </para>
-
     <sect2 id="store">
       <title>The Message Store</title>
 
@@ -266,6 +260,8 @@
         handling for the RFC822 headers.
       </para>
 
+      <graphic format="gif" fileref="mimemessage"></graphic>
+
       <para>
         Consider a message with two parts: a text part (in both plain
         text and HTML), and an attached image:
@@ -276,18 +272,20 @@
 	  To: Matt Loper &lt;matt@helixcode.com&gt;
 	  Subject: the Camel white paper
 	  MIME-Version: 1.0
-	  Content-Type: multipart/mixed; boundary="jhTYrnsRrdhDFGa"
+	  Content-Type: multipart/mixed;
+		boundary="jhTYrnsRrdhDFGa"
 
 	  This is a multi-part message in MIME format.
 	  --jhTYrnsRrdhDFGa
-	  Content-Type: multipart/alternative; boundary="sFSenbAFDSgDfg"
+	  Content-Type: multipart/alternative;
+		boundary="sFSenbAFDSgDfg"
 
 	  --sFSenbAFDSgDfg
 	  Content-Type: text/plain
 
 	  Hey, Matt
 
-	  Check out this graphic and tell me if you think it works.
+	  Check out this graphic...
 
 	  -- Dan
 
@@ -296,7 +294,7 @@
 
 	  Hey, Matt&lt;br&gt;
 	  &lt;br&gt;
-	  Check out this graphic and tell me if you think it works.&lt;br&gt;
+	  Check out this graphic...&lt;br&gt;
 	  &lt;br&gt;
 	  -- Dan&lt;br&gt;
 	  &lt;br&gt;
@@ -317,4 +315,24 @@
         <graphic fileref="samplemsg"></graphic>
       </sect2>
 
+      <sect2 id="streams">
+        <title>Streams</title>
+
+	<para>
+	  Streams are a generic data transport layer. Two basic stream
+	  classes are <classname>CamelStreamFs</classname>, for
+	  reading and writing files, and
+	  <classname>CamelStreamMem</classname>, for reading from and
+	  writing to objects that are already in memory.
+	</para>
+
+	<para>
+	  Streams can also be chained together. So a CamelMimePart
+	  containing base64-encoded data can filter its output through
+	  a CamelStreamB64. Other parts of the application that want
+	  to read its data will never need to even realize that the
+	  original data was encoded.
+	</para>
+      </sect2>
+
 </article>
diff --git a/help/white-papers/mail/ChangeLog b/help/white-papers/mail/ChangeLog
index 9e3830a238..6d4e8b7f8a 100644
--- a/help/white-papers/mail/ChangeLog
+++ b/help/white-papers/mail/ChangeLog
@@ -1,3 +1,9 @@
+2000-02-29  Dan Winship  <danw@helixcode.com>
+
+	* camel.sgml: Reorg a bit more, make the <PRE> section narrower,
+	add more references to graphics (the graphics themselves are
+	still in beta), add a section on CamelStream.
+
 2000-02-28  Dan Winship  <danw@helixcode.com>
 
 	* camel.sgml: add Bertrand to authors, edit his additions
diff --git a/help/white-papers/mail/camel.sgml b/help/white-papers/mail/camel.sgml
index 44b615a9ed..14f7a88747 100644
--- a/help/white-papers/mail/camel.sgml
+++ b/help/white-papers/mail/camel.sgml
@@ -56,10 +56,6 @@
       which set some of the boundaries on its requirements and
       extensibility.
     </para>
-  </sect1>
-
-  <sect1 id="features">
-    <title>Features</title>
 
     <para>
       &Camel; sees all message repositories as stores containing
@@ -103,6 +99,8 @@
   <sect1 id="overview">
     <title>Overview</title>
 
+    <graphic format="gif" fileref="camel"></graphic>
+
     <para>
       To begin using &Camel;, an application first creates a
       <classname>CamelSession</classname> object. This object is used
@@ -188,10 +186,6 @@
   <sect1 id="classes">
     <title>Major Subcomponents</title>
 
-    <para>
-      XXX
-    </para>
-
     <sect2 id="store">
       <title>The Message Store</title>
 
@@ -266,6 +260,8 @@
         handling for the RFC822 headers.
       </para>
 
+      <graphic format="gif" fileref="mimemessage"></graphic>
+
       <para>
         Consider a message with two parts: a text part (in both plain
         text and HTML), and an attached image:
@@ -276,18 +272,20 @@
 	  To: Matt Loper &lt;matt@helixcode.com&gt;
 	  Subject: the Camel white paper
 	  MIME-Version: 1.0
-	  Content-Type: multipart/mixed; boundary="jhTYrnsRrdhDFGa"
+	  Content-Type: multipart/mixed;
+		boundary="jhTYrnsRrdhDFGa"
 
 	  This is a multi-part message in MIME format.
 	  --jhTYrnsRrdhDFGa
-	  Content-Type: multipart/alternative; boundary="sFSenbAFDSgDfg"
+	  Content-Type: multipart/alternative;
+		boundary="sFSenbAFDSgDfg"
 
 	  --sFSenbAFDSgDfg
 	  Content-Type: text/plain
 
 	  Hey, Matt
 
-	  Check out this graphic and tell me if you think it works.
+	  Check out this graphic...
 
 	  -- Dan
 
@@ -296,7 +294,7 @@
 
 	  Hey, Matt&lt;br&gt;
 	  &lt;br&gt;
-	  Check out this graphic and tell me if you think it works.&lt;br&gt;
+	  Check out this graphic...&lt;br&gt;
 	  &lt;br&gt;
 	  -- Dan&lt;br&gt;
 	  &lt;br&gt;
@@ -317,4 +315,24 @@
         <graphic fileref="samplemsg"></graphic>
       </sect2>
 
+      <sect2 id="streams">
+        <title>Streams</title>
+
+	<para>
+	  Streams are a generic data transport layer. Two basic stream
+	  classes are <classname>CamelStreamFs</classname>, for
+	  reading and writing files, and
+	  <classname>CamelStreamMem</classname>, for reading from and
+	  writing to objects that are already in memory.
+	</para>
+
+	<para>
+	  Streams can also be chained together. So a CamelMimePart
+	  containing base64-encoded data can filter its output through
+	  a CamelStreamB64. Other parts of the application that want
+	  to read its data will never need to even realize that the
+	  original data was encoded.
+	</para>
+      </sect2>
+
 </article>