[CalendarServer-changes] [2005] CalendarServer/trunk/doc/ical-schema.txt

[source_changes at macosforge.org]

Revision: 2005
          http://trac.macosforge.org/projects/calendarserver/changeset/2005
Author:   dreid at apple.com
Date:     2007-11-08 11:12:01 -0800 (Thu, 08 Nov 2007)

Log Message:
-----------
Add just a little more information and some reformating.

Modified Paths:
--------------
    CalendarServer/trunk/doc/ical-schema.txt

Modified: CalendarServer/trunk/doc/ical-schema.txt
===================================================================
--- CalendarServer/trunk/doc/ical-schema.txt	2007-11-08 19:04:28 UTC (rev 2004)
+++ CalendarServer/trunk/doc/ical-schema.txt	2007-11-08 19:12:01 UTC (rev 2005)
@@ -1,28 +1,39 @@
-Computer Record - An LDAP Computer record that stores information
-    about a given server running a set of services.
+iCal Schema
+===========
 
-    Needed Attributes:
-        dsAttrTypeStandard:GeneratedUID - a GUID to be used when
-            constructing ServicesLocator entries that point to services
-            described by this computer record.
+The purpose of this document is to explain the usage of the calendar
+server and iCal for finding users, groups, locations, and resources
+provisioned on a given server.
 
-        dsAttrTypeStandard:ENetAddress - contains the MAC addresses of
-            the servers ethernet interfaces.
+Computer Record
+---------------
+An LDAP Computer record that stores information
+about a given server running a set of services.
 
-        dsAttrTypeStandard:ServicesLocator - containing '::anyService'
-            to indicate that it provides virtual host configurations.
+Needed Attributes:
+    dsAttrTypeStandard:GeneratedUID - a GUID to be used when
+        constructing ServicesLocator entries that point to services
+        described by this computer record.
 
-        dsAttrTypeNative:apple-serviceinfo - containing a "Virtual
-            Host Plist" that describes configuration information about
-            all the services provided by this server.
+    dsAttrTypeStandard:ENetAddress - contains the MAC addresses of
+        the servers ethernet interfaces.
 
+    dsAttrTypeStandard:ServicesLocator - containing '::anyService'
+        to indicate that it provides virtual host configurations.
 
-Virtual Host Plist - Stored in the dsAttrTypeNative:apple-serviceinfo
-    attribute this plist contains some basic configuration and a
-    timestamp and a number of virtual hosts.  One of which should
-    be for the calendar server.
+    dsAttrTypeNative:apple-serviceinfo - containing a "Virtual
+        Host Plist" that describes configuration information about
+        all the services provided by this server.
 
-    Example:
+
+Virtual Host Plist
+------------------
+Stored in the dsAttrTypeNative:apple-serviceinfo
+attribute this plist contains some basic configuration and a
+timestamp and a number of virtual hosts.  One of which should
+be for the calendar server.
+
+Example:
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
@@ -82,11 +93,26 @@
 </dict>
 
 
-Services Locator - An attribute on the User, Group, Resource, and
-    Location types that specifies the location of the server that his
-    hosting a given service.
+Services Locator
+----------------
+An attribute on the User, Group, Resource, and
+Location types that specifies the location of the server that his
+hosting a given service.
 
-    Of the form:
+Of the form:
+
 312395FC-363A-44D5-BA5D-98B178D5CD43:CFD9E112-9CC3-4AB7-97A6-3951C61ECECB:calendar
 \----------------------------------/ \----------------------------------/ \------/
         Computer Record GUID                Virtual Host GUID               Service name
+
+The Services Locator is used to allow the calendar server given
+a virtual host from the Virtual Host Plist to find all the
+records that have calendars provisioned on that server.  It is also
+used to allow iCal given a user record to find the following
+information:
+
+ 1) The principal URI for that user
+
+ 2) All the other records with calendars on the same server.  Which is
+    used in determing autocompletion for invitees and configuration of
+    delegates.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20071108/391a66bc/attachment.html