bo: doc/kolab-formats commonfields.sgml, 1.4, 1.5 contacts.sgml, 1.4, 1.5 events.sgml, 1.4, 1.5 journals.sgml, 1.4, 1.5 notes.sgml, 1.5, 1.6 overview.sgml, 1.6, 1.7 tasks.sgml, 1.4, 1.5
cvs at intevation.de
cvs at intevation.de
Tue Jun 15 15:56:52 CEST 2004
Author: bo
Update of /kolabrepository/doc/kolab-formats
In directory doto:/tmp/cvs-serv21471
Modified Files:
commonfields.sgml contacts.sgml events.sgml journals.sgml
notes.sgml overview.sgml tasks.sgml
Log Message:
Make the enums lower-case and case sensitive for consistency
Index: commonfields.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/commonfields.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- commonfields.sgml 15 Jun 2004 12:59:40 -0000 1.4
+++ commonfields.sgml 15 Jun 2004 13:56:48 -0000 1.5
@@ -17,12 +17,10 @@
<listitem><para>last-modification-date (datetime)</para></listitem>
-<listitem><para>sensitivity (string, possibilites are Private,
-Confidential and Public)</para></listitem>
+<listitem><para>sensitivity (string, possibilites are private,
+confidential and public)</para></listitem>
</itemizedlist>
-<para>The sensitivity (aka access) is sort of an enum. The enums are
-all case insensitive.</para>
</sect1>
<sect1><title>Common In Tasks And Events</title>
@@ -54,7 +52,7 @@
<status>(string, default none)</status>
<request-response>(bool, default true)</request-response>
<invitation-sent>(bool, default false)<invitation-sent>
- <role>(string, default Required)</role>
+ <role>(string, default required)</role>
</attendee>}
]]></programlisting></para>
@@ -71,25 +69,25 @@
<sect2><title>Recurrence</title>
<para>There can be one <recurrence> tag. This tag has an
-attribute cycle that is one of "Daily", "Weekly", "Monthly", or
-"Yearly". Depending on the Cycle, different subtags are valid:</para>
+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>Weekly: Interval specifies "every X weeks". Day can be Monday,
-Tuesday Wednesday, Thursday, Friday, Saturday, and Sunday. There can
+<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
-can be either "Daynumber" or "Weekday". In both cases, interval
+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
+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
-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>
+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>
<para>And the range must also be present. Finally there can be any
number of exclusions. These are dates that are removed from the list
@@ -102,10 +100,10 @@
<para>There can be any number of attendees.</para>
-<para>The status must be one of None, Tentative, Accepted, or
-Declined. invitation-sent only makes sense if request-response is
+<para>The status must be one of none, tentative, accepted, or
+declined. invitation-sent only makes sense if request-response is
true. If it's false, invitation-sent should be ignored. role is one of
-Required, Optional, or Resource.</para>
+required, optional, or resource.</para>
</sect2>
<sect2><title>Examples</title>
@@ -113,7 +111,7 @@
<para>Neverending incidence every 4 days with no exceptions:</para>
<para><programlisting><![CDATA[
- <recurrence cycle="Daily">
+ <recurrence cycle="daily">
<interval>4</interval>
<range type="None"/>
</recurrence>
@@ -123,11 +121,11 @@
happened. No exceptions:</para>
<para><programlisting><![CDATA[
- <recurrence cycle="Weekly">
+ <recurrence cycle="weekly">
<interval>3</interval>
- <day>Monday</day>
- <day>Thursday</day>
- <range type="Number">5</range>
+ <day>monday</day>
+ <day>thursday</day>
+ <range type="number">5</range>
</recurrence>
]]></programlisting></para>
@@ -136,11 +134,11 @@
happened:</para>
<para><programlisting><![CDATA[
- <recurrence cycle="Weekly">
+ <recurrence cycle="weekly">
<interval>3</interval>
- <day>Monday</day>
- <day>Thursday</day>
- <range type="Number">5</range>
+ <day>monday</day>
+ <day>thursday</day>
+ <range type="number">5</range>
<exception>2005-05-04</exception>
</recurrence>
]]></programlisting></para>
@@ -149,10 +147,10 @@
every second month with no exceptions:</para>
<para><programlisting><![CDATA[
- <recurrence cycle="Monthly" type="Daynumber">
+ <recurrence cycle="monthly" type="daynumber">
<interval>2</interval>
<date>3</date>
- <range type="Date">2006-06-01</range>
+ <range type="date">2006-06-01</range>
</recurrence>
]]></programlisting></para>
@@ -160,11 +158,11 @@
second thursday of every sixth month:</para>
<para><programlisting><![CDATA[
- <recurrence cycle="Monthly" type="Weekday">
+ <recurrence cycle="monthly" type="weekday">
<interval>6</interval>
<daynumber>2</daynumber>
- <day>Thursday</day>
- <range type="None"/>
+ <day>thursday</day>
+ <range type="none"/>
<exception>2005-12-12</exception>
<exception>2006-06-15</exception>
</recurrence>
@@ -174,11 +172,11 @@
every May 4th:</para>
<para><programlisting><![CDATA[
- <recurrence cycle="Yearly" type="Monthday">
+ <recurrence cycle="yearly" type="monthday">
<interval>1</interval>
<date>4</date>
- <month>June</month>
- <range type="Date">2005-12-31</range>
+ <month>june</month>
+ <range type="date">2005-12-31</range>
</recurrence>
]]></programlisting></para>
@@ -186,10 +184,10 @@
second year on the 125th day:</para>
<para><programlisting><![CDATA[
- <recurrence cycle="Yearly" type="Yearday">
+ <recurrence cycle="yearly" type="yearday">
<interval>2</interval>
<daynumber>125</daynumber>
- <range type="None"/>
+ <range type="none"/>
</recurrence>
]]></programlisting></para>
</sect2>
Index: contacts.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/contacts.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- contacts.sgml 15 Jun 2004 12:45:41 -0000 1.4
+++ contacts.sgml 15 Jun 2004 13:56:48 -0000 1.5
@@ -12,7 +12,7 @@
<categories>(string, default empty)</categories>
<creation-date>(datetime, no default)</creation-date>
<last-modified>(datetime, no default)</last-modified>
- <sensitivity>(string, default Public)</sensitivity>
+ <sensitivity>(string, default public)</sensitivity>
{<attachment>(string, no default)</attachment>}
<!-- Contact specific attributes -->
@@ -53,29 +53,29 @@
<email>(string, default empty)</email>
</email>}
{<address>
- <type>(string, default Home)</type>
+ <type>(string, default home)</type>
<street>(string, default empty)</street>
<city>(string, default empty)</city>
<state>(string, default empty)</state>
<zip>(string, default empty)</zip>
<country>(string, default empty)</country>
</address>}
- <preferred-address>(string, default None)</preferred-address>
+ <preferred-address>(string, default none)</preferred-address>
</contact>
]]></programlisting></para>
<para>In a contact, the body is the note.</para>
<para>You can have one phone number of each type. The types are:
-Business1, Business2, BusinessFax, Callback, Car, Company, Home1,
-Home2, HomeFax, ISDN, Mobile, Pager, Primary, Radio, Telex, TTYTDD,
-Assistant, and Other.</para>
+business1, business2, businessfax, callback, car, company, home1,
+home2, homefax, isdn, mobile, pager, primary, radio, telex, ttytdd,
+assistant, and other.</para>
<para>The Kontact and Horde address books have the notion of a
preferred email address. This could be done by a bool on the emails or
a separate tag like for preferred address.</para>
-<para>The Address Type can be Home, Business, and Other. The preferred
-address can be set to one of these or None.</para>
+<para>The address type can be home, business, and other. The preferred
+address can be set to one of these or none.</para>
</chapter>
Index: events.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/events.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- events.sgml 15 Jun 2004 12:45:41 -0000 1.4
+++ events.sgml 15 Jun 2004 13:56:48 -0000 1.5
@@ -12,9 +12,9 @@
<categories>(string, default empty)</categories>
<creation-date>(datetime, no default)</creation-date>
<last-modified>(datetime, no default)</last-modified>
- <sensitivity>(string, default Public)</sensitivity>
+ <sensitivity>(string, default public)</sensitivity>
{<attachment>(string, no default)</attachment>}
-
+
<!-- Incidence base class specific attributes -->
<summary>(string, default empty)</summary>
<location>(string, default empty)</location>
@@ -24,7 +24,7 @@
</organizer>
<start-date>(date or datetime, default not present)</start-date>
<alarm>(number, no default)</alarm>
- <recurrence cycle="cycletype" [type="Extra type"]>
+ <recurrence cycle="cycletype" [type="extra type"]>
<interval>(number, default 1)</interval>
{<day>(string, no default)</day>}
<daynumber>(number, no default)</daynumber>
@@ -36,21 +36,21 @@
{<attendee>
<display-name>(string, default empty)</display-name>
<email>(string, default empty)</email>
- <status>(string, default None)</status>
+ <status>(string, default none)</status>
<request-response>(bool, default true)</request-response>
<invitation-sent>(bool, default false)<invitation-sent>
- <role>(string, default Required)</role>
+ <role>(string, default required)</role>
</attendee>}
<!-- Event specific attributes -->
- <show-time-as>(string, default Busy)</show-time-as>
+ <show-time-as>(string, default busy)</show-time-as>
<color-label>TODO: Joon will do this</color-label>
<end-date>(date or datetime, default not present)</end-date>
</event>
]]></programlisting></para>
-<para>show-time-as is one of Free, Tentative, Busy, or
-OutOfOffice.</para>
+<para>show-time-as is one of free, tentative, busy, or
+outofoffice.</para>
<para>TODO: Joon will add the info on the possible entries in
color-label.</para>
Index: journals.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/journals.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- journals.sgml 15 Jun 2004 12:45:41 -0000 1.4
+++ journals.sgml 15 Jun 2004 13:56:48 -0000 1.5
@@ -12,7 +12,7 @@
<categories>(string, default empty)</categories>
<creation-date>(datetime, no default)</creation-date>
<last-modified>(datetime, no default)</last-modified>
- <sensitivity>(string, default Public)</sensitivity>
+ <sensitivity>(string, default public)</sensitivity>
{<attachment>(string, no default)</attachment>}
<!-- Journal specific attributes -->
@@ -29,7 +29,7 @@
<para>There can be any number of attachments and contacts, which is
why these are in {}.</para>
-<para>The sensitivity can only be one of Public, Confidential, or
-Private.</para>
+<para>The sensitivity can only be one of public, confidential, or
+private.</para>
</chapter>
Index: notes.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/notes.sgml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- notes.sgml 15 Jun 2004 13:02:37 -0000 1.5
+++ notes.sgml 15 Jun 2004 13:56:48 -0000 1.6
@@ -12,7 +12,7 @@
<categories>(string, default empty)</categories>
<creation-date>(datetime, no default)</creation-date>
<last-modified>(datetime, no default)</last-modified>
- <sensitivity>(string, default Public)</sensitivity>
+ <sensitivity>(string, default public)</sensitivity>
{<attachment>(string, no default)</attachment>}
<!-- Note specific attributes -->
@@ -25,7 +25,7 @@
<para>There can be any number of attachments, which is why these are
in {}.</para>
-<para>The sensitivity can only be one of Public, Confidential, or
-Private.</para>
+<para>The sensitivity can only be one of public, confidential, or
+private.</para>
</chapter>
Index: overview.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/overview.sgml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- overview.sgml 15 Jun 2004 13:02:37 -0000 1.6
+++ overview.sgml 15 Jun 2004 13:56:48 -0000 1.7
@@ -78,10 +78,8 @@
<listitem><para>Color #RRGGBB -- The rgb values are case insensitive,
so for example #00aaFF is allowed.</para></listitem>
-<listitem><para>Bool (True or False)</para></listitem>
+<listitem><para>Bool (true or false)</para></listitem>
</itemizedlist>
-
-<para>The color and bool types are also case insensitive.</para>
</sect2>
</sect1>
Index: tasks.sgml
===================================================================
RCS file: /kolabrepository/doc/kolab-formats/tasks.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- tasks.sgml 15 Jun 2004 12:45:41 -0000 1.4
+++ tasks.sgml 15 Jun 2004 13:56:48 -0000 1.5
@@ -12,9 +12,9 @@
<categories>(string, default empty)</categories>
<creation-date>(datetime, no default)</creation-date>
<last-modified>(datetime, no default)</last-modified>
- <sensitivity>(string, default Public)</sensitivity>
+ <sensitivity>(string, default public)</sensitivity>
{<attachment>(string, no default)</attachment>}
-
+
<!-- Incidence base class specific attributes -->
<summary>(string, default empty)</summary>
<location>(string, default empty)</location>
@@ -24,7 +24,7 @@
</organizer>
<start-date>(date or datetime, default not present)</start-date>
<alarm>(number, no default)</alarm>
- <recurrence cycle="cycletype" [type="Extra type"]>
+ <recurrence cycle="cycletype" [type="extra type"]>
<interval>(number, default 1)</interval>
{<day>(string, no default)</day>}
<daynumber>(number, no default)</daynumber>
@@ -36,23 +36,23 @@
{<attendee>
<display-name>(string, default empty)</display-name>
<email>(string, default empty)</email>
- <status>(string, default None)</status>
+ <status>(string, default none)</status>
<request-response>(bool, default true)</request-response>
<invitation-sent>(bool, default false)<invitation-sent>
- <role>(string, default Required)</role>
+ <role>(string, default required)</role>
</attendee>}
<!-- Task specific attributes -->
<priority>(number, default 3)</priority>
<completed>(number, default 0)</completed>
- <status>(string, default NotStarted)</status>
+ <status>(string, default not-started)</status>
<due-date>(date or datetime, default not present)</due-date>
<parent>(string, default empty)</parent>
</task>
]]></programlisting></para>
-<para>status can be one of NotStarted, InProgress, Completed,
-WaitingOnSomeElse, or Deferred.</para>
+<para>status can be one of not-started, in-progress, completed,
+waiting-on-someone-else, or deferred.</para>
<para>The priority can be a number between 1 and 5, with 1 being the
highest priority.</para>
More information about the commits
mailing list