martin: doc/kolab-formats folders.sgml, 1.7, 1.8 kolabformat.sgml, 1.15, 1.16

cvs at intevation.de cvs at intevation.de
Wed Jul 27 23:45:15 CEST 2005


Author: martin

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

Modified Files:
	folders.sgml kolabformat.sgml 
Log Message:
MArtin Konold: Clarifications as discussed on the ml


Index: folders.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/folders.sgml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- folders.sgml	7 Oct 2004 16:07:30 -0000	1.7
+++ folders.sgml	27 Jul 2005 21:45:13 -0000	1.8
@@ -11,11 +11,22 @@
 (i.e. folder name encoding is by RFC 3501).</para>
 
 <para>The INBOX is the default inbox of the user. The user can not
-change this default. The IMAP resource folders (one for events,
-one for contacts etc. ) are subfolders of the INBOX, and this location can
-not be set by the user.</para>
+change this default. The account specific personal IMAP resource folders 
+are subfolders of the INBOX, and this location cannot be set by the user. 
+There is exactly one default resource folder for each type which means
 
-<para>We will annotate all folders with an entry /vendor/kolab/folder-type
+<para>one default calendar folder</para>
+<para>one default contact folder</para>
+<para>one default notes folder</para>
+<para>one default task folder</para>
+<para>one default journal folder</para>
+
+<para>The actual names of the folder as stored on the IMAP folder don't matter. E.g. it does
+not matter if the default calendar is called Calendar or Kalendar as long as exactly one default
+calendar folder does exist as a direct subfolder of the INBOX folder.
+</paea>
+
+<para>All folders MUST be annotated with an entry /vendor/kolab/folder-type
 containing the attribute value.shared set to: <![CDATA[ <type>[.<subtype>] ]]>
 </para>
 
@@ -26,20 +37,21 @@
 or junkemail (this one holds spam mails). For the other <type>s, it
 can only be default, or not set.</para>
 
-<para>For other types of folders supported by the clients, these
-should be prefixed with "k-" for KMail, "h-" for Horde and "o-" for Outlook,
-and look like for example "kolab.o-voicemail".</para>
+<para>There MUST NOT be two folders of a single type having the default subtype. E.g. it
+is forbidden to have two folders of the type calendar with the subtype default within one Kolab
+account.</para>
 
-<para>We will use "application/x-vnd.kolab.<type>" as the
-mimetype for the emails used for storage.</para>
+<para>For other client-specific non standardized types of folders, these
+MUST be prefixed with "k-" for KMail, "h-" for Horde, "o-" for Outlook with the 
+Toltec Connector and "ok-" for Outlook with the KONSEC Konnektor. E.g. "kolab.o-voicemail".</para>
 
-<para>The annotation must be set on creation, and can not be
-changed. For folders created with other IMAP clients, annotations must
-be preserved. If a folder has no annotation, Outlook and
-the Toltec connector will ignore it completely. This is not an option
-for Kontact and Horde, so we will by default consider them to hold
-mail.</para>
+<para>The mimetype of the messages stored on the Kolab server is "application/x-vnd.kolab.<type>".</para>
 
+<para>All annotation MUST be set during the initial creation of a folder and cannot be altered afterwards. 
+Clients are allowed to rely upon this requirement.
+</para>
+<para>For folders created with non Kolab IMAP clients, annotations must be preserved. 
+All Kolab clients MUST assume that folders without an explicit type set are email folders.</para>
 </sect1>
 
 <sect1><title>Mail contents</title>

Index: kolabformat.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/kolabformat.sgml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- kolabformat.sgml	3 Jun 2005 08:45:39 -0000	1.15
+++ kolabformat.sgml	27 Jul 2005 21:45:13 -0000	1.16
@@ -25,7 +25,6 @@
 <othername> Martin Konold, martin.konold at erfrakon.de </othername>
 <othername> Stephan Buys, s.buys at codefusion.co.za </othername>
 <othername> Stuart Binge, s.binge at codefusion.co.za </othername>
-<othername> www.kolab.org </othername>
 </othercredit>
 </authorgroup>
 <pubdate>June 3rd, 2005</pubdate>
@@ -38,21 +37,22 @@
 <trademark class='registered'>Windows XP</trademark>,
 <trademark class='registered'>Microsoft Outlook</trademark>
 are registered trademarks of Microsoft Corporation Inc.
-<trademark>Toltec Connector</trademark>
-<trademark>K Desktop Environment</trademark> and <trademark>KDE</trademark>
-are trademarks of the KDE e.V.
 </para>
+<para> <trademark>Toltec Connector</trademark> is a trademark of Radley Network Technologies CC, South Africa.</para>
+<para> <trademark>KONSEC Konnektor</trademark> is a trademark of KONSEC GmbH, Germany.</para>
+
+</para> <trademark>K Desktop Environment</trademark> and <trademark>KDE</trademark> are trademarks of the KDE e.V. </para>
 <para>
 All other herein mentioned trademarks belong
-to their respective owners.  Use of a term in this book should not be regarded as 
+to their respective owners.  Use of a term in this document should not be regarded as 
 affecting the validity of any trademark or service mark.
 </para>
 <para>
-Finally, the authors of this book are not liable for any errors found as well
+Finally, the authors of this document are not liable for any errors found as well
 as anything that may cause a fault. However, if that does occur, please notify
 the authors so corrections can be made. Furthermore, the reader must also agree
-to use the information in this book at his/her own risk and relinquish the
-authors, from any mistakes due to this book. If not, please stop reading now.
+to use the information in this document at his/her own risk and relinquish the
+authors, from any mistakes due to this document. If not, please stop reading now.
 </para>
 <para>
 BECAUSE THE CONTENT IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE
@@ -127,6 +127,15 @@
 Distribution list have their own MIME-type now.
 </revremark>
 </revision>
+
+<revision>
+<revnumber>2.0rc4</revnumber>
+<date>July 26th, 2005</date>
+<revremark>
+Clarifications about keywords and folder annotations.
+</revremark>
+</revision>
+
 
 <!--
 <revision>





More information about the commits mailing list