david: doc/kolab-formats commonfields.sgml, 1.16, 1.17 contacts.sgml, 1.13, 1.14 events.sgml, 1.10, 1.11 folders.sgml, 1.6, 1.7 journals.sgml, 1.9, 1.10 kolabformat.sgml, 1.7, 1.8 notes.sgml, 1.9, 1.10 overview.sgml, 1.14, 1.15 tasks.sgml, 1.9, 1.10
cvs at intevation.de
cvs at intevation.de
Thu Oct 7 18:07:32 CEST 2004
Author: david
Update of /kolabrepository/doc/kolab-formats
In directory doto:/tmp/cvs-serv17968
Modified Files:
commonfields.sgml contacts.sgml events.sgml folders.sgml
journals.sgml kolabformat.sgml notes.sgml overview.sgml
tasks.sgml
Log Message:
Made most changes suggested by Bernhard Reiter in his mail "Text Remarks".
Will answer the remaining ones on the list shortly.
Index: commonfields.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/commonfields.sgml,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -d -r1.16 -r1.17
--- commonfields.sgml 7 Oct 2004 14:39:26 -0000 1.16
+++ commonfields.sgml 7 Oct 2004 16:07:30 -0000 1.17
@@ -1,6 +1,6 @@
<chapter><title>Common Fields</title>
-<sect1><title>Common In All Types</title>
+<sect1 id="common_in_all_types"><title>Common In All Types</title>
<para>There are a number of fields that are present in all non-mail
folder types. These are:</para>
@@ -45,7 +45,7 @@
</sect1>
-<sect1><title>Common In Tasks And Events</title>
+<sect1 id="common_in_tasks_and_events"><title>Common In Tasks And Events</title>
<para>These are the fields that are both in tasks and events. This
base class can be called incidence.</para>
@@ -98,19 +98,19 @@
attribute cycle that is one of "daily", "weekly", "monthly", or
"yearly". Depending on the cycle, different subtags are valid:</para>
-<para>Daily: Interval specifies "every X days".</para>
+<para>daily: Interval specifies "every X days".</para>
-<para>Weekly: Interval specifies "every X weeks". Day can be monday,
+<para>weekly: Interval specifies "every X weeks". Day can be monday,
tuesday wednesday, thursday, friday, saturday, and sunday. There can
be 1 to 7 of these days.</para>
-<para>Monthly: The recurrence tag has a second attribute type, which
+<para>monthly: The recurrence tag has a second attribute type, which
can be either "daynumber" or "weekday". In both cases, interval
specifies "every X months". In the case of daynumber, tag <date>
gives the date in the month this recurs on. For weekday, tags
<daynumber> and <day> must be there.</para>
-<para>Yearly: The recurrence tag has a second attribute type, which
+<para>yearly: The recurrence tag has a second attribute type, which
can be either "monthday" or "yearday". In both cases, interval
specifies "every X years". If it's monthday, tags <date> and
<month> apply. For yearday, <daynumber> is needed.</para>
@@ -130,15 +130,7 @@
</sect2>
-<sect2><title>Attendees</title>
-
-<para>There can be any number of attendees.</para>
-
-<para>The status must be one of none, tentative, accepted, or
-declined. role is one of required, optional, or resource.</para>
-</sect2>
-
-<sect2><title>Examples</title>
+<sect2><title>Recurrence examples</title>
<para>Neverending incidence every 4 days with no exclusions:</para>
@@ -222,6 +214,14 @@
<range type="none"/>
</recurrence>
]]></programlisting></para>
+
+<sect2><title>Attendees</title>
+
+<para>There can be any number of attendees.</para>
+
+<para>The status must be one of none, tentative, accepted, or
+declined. role is one of required, optional, or resource.</para>
+
</sect2>
</sect1>
Index: contacts.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/contacts.sgml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- contacts.sgml 4 Oct 2004 19:08:35 -0000 1.13
+++ contacts.sgml 7 Oct 2004 16:07:30 -0000 1.14
@@ -6,7 +6,7 @@
<para><programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<contact version="1.0">
- <!-- Base class attributes -->
+ <!-- Common fields -->
<uid>(string, no default)</uid>
<body>(string, default empty)</body>
<categories>(string, default empty)</categories>
@@ -15,8 +15,9 @@
<sensitivity>(string, default public)</sensitivity>
{<inline-attachment>(string, no default)</inline-attachment>}
{<link-attachment>(string, no default)</link-attachment>}
+ <product-id>(string, default empty)</product-id>
- <!-- Contact specific attributes -->
+ <!-- Contact specific fields -->
<name>
<given-name>(string, default empty)</given-name>
<middle-names>(string, default empty)</middle-names>
@@ -65,6 +66,8 @@
<longitude>(float, no default)</longitude>
</contact>
]]></programlisting></para>
+
+<para>See <xref linkend="common_in_all_types"/> for the description of the common fields</para>
<para>A contact has a field for free text for it. This is usually
called a note on the contact. This note is stored in the body tag.
Index: events.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/events.sgml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- events.sgml 7 Oct 2004 09:17:20 -0000 1.10
+++ events.sgml 7 Oct 2004 16:07:30 -0000 1.11
@@ -6,7 +6,7 @@
<para><programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<event version="1.0">
- <!-- Base class attributes -->
+ <!-- Common fields -->
<uid>(string, no default)</uid>
<body>(string, default empty)</body>
<categories>(string, default empty)</categories>
@@ -15,8 +15,9 @@
<sensitivity>(string, default public)</sensitivity>
{<inline-attachment>(string, no default)</inline-attachment>}
{<link-attachment>(string, no default)</link-attachment>}
+ <product-id>(string, default empty)</product-id>
- <!-- Incidence base class specific attributes -->
+ <!-- Incidence fields -->
<summary>(string, default empty)</summary>
<location>(string, default empty)</location>
<organizer>
@@ -42,12 +43,16 @@
<role>(string, default required)</role>
</attendee>}
- <!-- Event specific attributes -->
+ <!-- Event specific fields -->
<show-time-as>(string, default busy)</show-time-as>
<color-label>(string, default none)</color-label>
<end-date>(date or datetime, default not present)</end-date>
</event>
]]></programlisting></para>
+
+<para>See <xref linkend="common_in_all_types"/> for the description of the common fields</para>
+
+<para>See <xref linkend="common_in_tasks_and_events"/> for the description of the incidence fields</para>
<para>show-time-as is one of free, tentative, busy, or
outofoffice.</para>
Index: folders.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/folders.sgml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- folders.sgml 29 Jun 2004 09:16:56 -0000 1.6
+++ folders.sgml 7 Oct 2004 16:07:30 -0000 1.7
@@ -11,9 +11,9 @@
(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 INBOX will have the IMAP resource subfolders
-(like we do today in the clients), and this location can not be set by
-the user.</para>
+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>
<para>We will annotate all folders with an entry /vendor/kolab/folder-type
containing the attribute value.shared set to: <![CDATA[ <type>[.<subtype>] ]]>
@@ -27,22 +27,19 @@
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,
+should be prefixed with "k-" for KMail, "h-" for Horde and "o-" for Outlook,
and look like for example "kolab.o-voicemail".</para>
<para>We will use "application/x-vnd.kolab.<type>" as the
mimetype for the emails used for storage.</para>
<para>The annotation must be set on creation, and can not be
-changed. (TODO: We need to discuss what we should do with folders created
-with other IMAP clients.) If a folder has no annotation, Outlook and
+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>This is all quite restricted, but this is the only way Outlook
-can do it. And when thinking of these rules, we could not come up with
-many problems with them.</para>
</sect1>
<sect1><title>Mail contents</title>
Index: journals.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/journals.sgml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- journals.sgml 4 Oct 2004 19:08:35 -0000 1.9
+++ journals.sgml 7 Oct 2004 16:07:30 -0000 1.10
@@ -6,7 +6,7 @@
<para><programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<journal version="1.0">
- <!-- Base class attributes -->
+ <!-- Common fields -->
<uid>(string, no default)</uid>
<body>(string, default empty)</body>
<categories>(string, default empty)</categories>
@@ -15,8 +15,9 @@
<sensitivity>(string, default public)</sensitivity>
{<inline-attachment>(string, no default)</inline-attachment>}
{<link-attachment>(string, no default)</link-attachment>}
+ <product-id>(string, default empty)</product-id>
- <!-- Journal specific attributes -->
+ <!-- Journal specific fields -->
<summary>(string, default empty)</summary>
<start-date>(datetime, default not present)</start-date>
<end-date>(datetime, default not present)</end-date>
@@ -26,6 +27,8 @@
</contact>}
</journal>
]]></programlisting></para>
+
+<para>See <xref linkend="common_in_all_types"/> for the description of the common fields</para>
<para>There can be any number of contacts, which is
why these are in {}.</para>
Index: kolabformat.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/kolabformat.sgml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- kolabformat.sgml 7 Oct 2004 14:39:26 -0000 1.7
+++ kolabformat.sgml 7 Oct 2004 16:07:30 -0000 1.8
@@ -95,7 +95,15 @@
<revnumber>cvs20041007</revnumber>
<date>October 7th 2004</date>
<revremark>
-Updated start-date, attachements. Removed invitation-send. Added creator.
+Updated start-date, attachements. Removed invitation-sent. Added creator.
+</revremark>
+</revision>
+
+<revision>
+<revnumber>cvs20041010</revnumber>
+<date>October 10th 2004</date>
+<revremark>
+Added version attribute.
</revremark>
</revision>
Index: notes.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/notes.sgml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- notes.sgml 4 Oct 2004 19:08:35 -0000 1.9
+++ notes.sgml 7 Oct 2004 16:07:30 -0000 1.10
@@ -6,7 +6,7 @@
<para><programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<note version="1.0">
- <!-- Base class attributes -->
+ <!-- Common fields -->
<uid>(string, no default)</uid>
<body>(string, default empty)</body>
<categories>(string, default empty)</categories>
@@ -15,12 +15,15 @@
<sensitivity>(string, default public)</sensitivity>
{<inline-attachment>(string, no default)</inline-attachment>}
{<link-attachment>(string, no default)</link-attachment>}
+ <product-id>(string, default empty)</product-id>
- <!-- Note specific attributes -->
+ <!-- Note specific fields -->
<summary>(string, default empty)</summary>
<background-color>(color, default #000000)</background-color>
<foreground-color>(color, default #ffff00)</foreground-color>
</note>
]]></programlisting></para>
+
+<para>See <xref linkend="common_in_all_types"/> for the description of the common fields</para>
</chapter>
Index: overview.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/overview.sgml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- overview.sgml 20 Jul 2004 22:42:40 -0000 1.14
+++ overview.sgml 7 Oct 2004 16:07:30 -0000 1.15
@@ -46,7 +46,7 @@
last modification dates. If there are attributes with a limited amount
of options, these are specified after the text.</para>
-<para>All tag names are case sensitive.</para>
+<para>All tag names, attribute names, and attribute values are case sensitive.</para>
<para>If a client sees a tag it does not understand, this tag must be
preserved and saved back to the file. This allows for client specific
@@ -65,7 +65,7 @@
... This looks like:</para>
<para><programlisting><![CDATA[
- <type>
+ <type version="1.0">
Entry fields go here
</type>
]]></programlisting></para>
@@ -74,11 +74,14 @@
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>Here is a short example of a note:</para>
<para><programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
- <note>
+ <note version="1.0">
Note stuff goes here
</note>
]]></programlisting></para>
Index: tasks.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/tasks.sgml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- tasks.sgml 7 Oct 2004 09:17:20 -0000 1.9
+++ tasks.sgml 7 Oct 2004 16:07:30 -0000 1.10
@@ -6,7 +6,7 @@
<para><programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<task version="1.0">
- <!-- Base class attributes -->
+ <!-- Common fields -->
<uid>(string, no default)</uid>
<body>(string, default empty)</body>
<categories>(string, default empty)</categories>
@@ -15,8 +15,9 @@
<sensitivity>(string, default public)</sensitivity>
{<inline-attachment>(string, no default)</inline-attachment>}
{<link-attachment>(string, no default)</link-attachment>}
+ <product-id>(string, default empty)</product-id>
- <!-- Incidence base class specific attributes -->
+ <!-- Incidence fields -->
<summary>(string, default empty)</summary>
<location>(string, default empty)</location>
<organizer>
@@ -42,7 +43,7 @@
<role>(string, default required)</role>
</attendee>}
- <!-- Task specific attributes -->
+ <!-- Task specific fields -->
<priority>(number, default 3)</priority>
<completed>(number, default 0)</completed>
<status>(string, default not-started)</status>
@@ -50,6 +51,10 @@
<parent>(string, default empty)</parent>
</task>
]]></programlisting></para>
+
+<para>See <xref linkend="common_in_all_types"/> for the description of the common fields</para>
+
+<para>See <xref linkend="common_in_tasks_and_events"/> for the description of the incidence fields</para>
<para>status can be one of not-started, in-progress, completed,
waiting-on-someone-else, or deferred.</para>
More information about the commits
mailing list