bernhard: doc/kolab-formats kolabformat.sgml, 1.29, 1.30 overview.sgml, 1.17, 1.18

[cvs at kolab.org]

Author: bernhard

Update of /kolabrepository/doc/kolab-formats
In directory doto:/tmp/cvs-serv15138

Modified Files:
	kolabformat.sgml overview.sgml 
Log Message:
Getting ready for "2.0 (release)"
   + Version number adjusted
   + Added Bernhard Reiter as technical editor. (Twice: logical 
		and that it gets printed somewhere.)
   + Clarification: Overview: Version attribute more pragmatic.
   + Overview: De-facto reference client implementations added.


Index: kolabformat.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/kolabformat.sgml,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -d -r1.29 -r1.30
--- kolabformat.sgml	6 Feb 2009 16:42:24 -0000	1.29
+++ kolabformat.sgml	1 Nov 2010 16:46:34 -0000	1.30
@@ -15,8 +15,8 @@
 
 <bookinfo>
 <title>The Kolab Storage Format</title>
-<!--<subtitle>2.0rc8</subtitle>-->
-<subtitle>Draft CVS</subtitle>
+<subtitle>2.0 (released)</subtitle>
+<!--<subtitle>Draft CVS</subtitle>-->
 <authorgroup>
 <author> 
   <firstname>Bo</firstname> <surname>Thorsen</surname> 
@@ -43,10 +43,19 @@
   <affiliation><address><email>s.binge at codefusion.co.za</email></address></affiliation>
 </author>
 </authorgroup>
-<!--<pubdate>April 22th, 2008</pubdate>-->
-<pubdate>$Date$ $Revision$</pubdate>
+<othercredit role="technicaleditor">
+  <firstname>Bernhard E.</firstname><surname>Reiter</surname>
+  <affiliation><address><email>bernhard.reiter at intevation.de</email></address></affiliation>
+  <contrib>Technical Editor 2004 - 2010 (up to 2.0)</contrib>
+</othercredit>
+<pubdate>November 1st, 2010</pubdate>
+<!--<pubdate>$Date$ $Revision$</pubdate>-->
 <legalnotice>
-<para> This documentation was written in SGML using the DocBook DTD. HTML
+<para><!-- not really legalinfo, but lacking a better section -->
+Technical Editor 2004 - 2010: Bernhard E. Reiter bernhard.reiter at intevation.de
+<!--</para>
+<para>-->
+This documentation was written in SGML using the DocBook DTD. HTML
 and Postscript output is generated automatically and depends on the
 tools used. </para>
 <para>
@@ -89,12 +98,10 @@
 </para>
 </legalnotice>
 <revhistory>
-
 <revision>
 <revnumber>0.0.1</revnumber>
 <date>June 9th 2004</date>
 </revision>
-
 <revision>
 <revnumber>cvs20040813</revnumber>
 <date>August 13th, 2004</date>
@@ -173,21 +180,41 @@
 </revision>
 
 <revision>
-<revnumber>CVS $Revision$</revnumber>
-<date>$Date$</date>
+<revnumber>2.0 (released)</revnumber>
+<date>November 1st, 2010</date>
 <revdescription>
+<para>
 <itemizedlist>
 <listitem><para>
+  Overview: Version attribute more pragmatic. 
+  </para></listitem>
+<listitem><para>
+  Overview: De-facto reference client implementations added.
+  </para></listitem>
+<listitem><para>
+  Format of Events: Removed ambiguous default for start and end tags.
+  </para></listitem>
+<listitem><para>
   Section Overview: Stated more precisely that connectors 
   - not Outlook itself - write the format.
   </para></listitem>
 <listitem><para>
-  Format of Events: Removed ambiguous default for start and end tags.
+  Folder Types: added new email folder subtypes "outbox" and "wastebasket".
   </para></listitem>
 </itemizedlist>
+</para>
 </revdescription>
 </revision>
 
+<!--<revision>
+<revnumber>CVS $Revision$</revnumber>
+<date>$Date$</date>
+<revdescription>
+<para>
+</para>
+</revdescription>
+</revision>
+-->
 </revhistory>
 </bookinfo>
 

Index: overview.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/overview.sgml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -d -r1.17 -r1.18
--- overview.sgml	13 Jun 2008 08:37:02 -0000	1.17
+++ overview.sgml	1 Nov 2010 16:46:34 -0000	1.18
@@ -1,10 +1,21 @@
 <chapter><title>Kolab Storage Format Overview</title>
 
-<para>This document describes what a Kolab client can store in the
-IMAP folders on a Kolab server.</para>
+<para>This document describes what a Kolab Client can store in the
+IMAP folders on a Kolab Server.</para>
 
 <para>The Kolab storage format is designed to provide a unified
-storage format for several Kolab client implementations.</para>
+storage format for several Kolab Client implementations. 
+</para>
+<para>
+Clients started to implement the first drafts in the year 2004. 
+Experiences with several implementations in the following years
+showed that in order to create a good user experience, the behaviour
+of clients would need to be described in greater detail. 
+Therefor if anything is missing, unclear or contradicting 
+within this specification, a well working behaviour
+of the client implementations "KDE Kontact Proko2" and "Toltec 2" 
+will be authoritative. 
+</para>
 
 <para>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
 "SHOULD", "SHOULD NOT", "MAY", and "OPTIONAL" in this document are to
@@ -84,8 +95,16 @@
 contact. If a client has a new type, it is allowed to implement this,
 but then other clients will not be able to handle the folder entry.</para>
 
-<para>The version attribute denotes the version of this specification.
-Until a stable version is released, the number "1.0" is used.</para>
+<para>The original idea for the version attribute was to denote 
+the version of this specification and to use "1.0" until a stable version
+was released. However client implementations using "1.0" got widely used
+and deployed before the specification itself was labled stable. Therefor
+version attribute "1.0" is now also used with the stable specification 2.0.
+Future changes of the specification will have to discuss 
+changes of the version attribute independently 
+from the revision of the specification. One guideline will be backwards
+compatibility.
+</para>
 
 <para>Here is a short example of a note:</para>