cvs: /phpdoc/functions icap.sgml

eschmid Mon Aug 23 16:57:04 1999 EDT Modified files: /phpdoc/functions icap.sgml Log: Some cosmetics. Mark use XEmacs. Index: phpdoc/functions/icap.sgml diff -u phpdoc/functions/icap.sgml:1.2 phpdoc/functions/icap.sgml:1.3 --- phpdoc/functions/icap.sgml:1.2 Mon Aug 23 16:04:17 1999 +++ phpdoc/functions/icap.sgml Mon Aug 23 16:57:04 1999 @@ -5,10 +5,10 @@ <partintro> <simpara> To get these functions to work, you have to compile PHP with - <option role="configure">--with-icap</option>. That requires the icap library to be - installed. Grab the latest version from <ulink - url="http://icap.chek.com/">http://icap.chek.com/</ulink> - and compile and install it. + <option role="configure">--with-icap</option>. That requires the + icap library to be installed. Grab the latest version from <ulink + url="http://icap.chek.com/">http://icap.chek.com/</ulink> and + compile and install it. </partintro> <refentry id="function.icap-open"> @@ -28,9 +28,9 @@ <para> Returns an ICAP stream on success, false on error. <para> - <function>icap_open</function> opens up an ICAP connection to the specified - <parameter>calendar</parameter> store. If the optional - <parameter>options</parameter> is specified, passes the + <function>icap_open</function> opens up an ICAP connection to the + specified <parameter>calendar</parameter> store. If the optional + <parameter>options</parameter> is specified, passes the <parameter>options</parameter> to that mailbox also. <para> </refsect1> @@ -73,49 +73,53 @@ <para> Returns an event object consisting of: - <itemizedlist> - <listitem><simpara> - int id - ID of that event. - <listitem><simpara> - int public - TRUE if the event if public, FALSE if it is private. - <listitem><simpara> - string category - Category string of the event. - <listitem><simpara> - string title - Title string of the event. - <listitem><simpara> - string description - Description string of the event. - <listitem><simpara> - int alarm - number of minutes before the event to send an alarm/reminder. - <listitem><simpara> - object start - Object containing a datetime entry. - <listitem><simpara> - object end - Object containing a datetime entry. - </itemizedlist> + <itemizedlist> + <listitem><simpara> + int id - ID of that event. + <listitem><simpara> + int public - TRUE if the event if public, FALSE if it is private. + <listitem><simpara> + string category - Category string of the event. + <listitem><simpara> + string title - Title string of the event. + <listitem><simpara> + string description - Description string of the event. + <listitem><simpara> + int alarm - number of minutes before the event to send an + alarm/reminder. + <listitem><simpara> + object start - Object containing a datetime entry. + <listitem><simpara> + object end - Object containing a datetime entry. + </itemizedlist> - All datetime entries consist of an object that contains: - <itemizedlist> + All datetime entries consist of an object that contains: + <itemizedlist> <listitem><simpara> - int year - year + int year - year <listitem><simpara> - int month - month + int month - month <listitem><simpara> - int mday - day of month + int mday - day of month <listitem><simpara> - int hour - hour - <listitem><simpara> - int min - minutes - <listitem><simpara> - int sec - seconds + int hour - hour + <listitem><simpara> + int min - minutes + <listitem><simpara> + int sec - seconds </itemizedlist> </refsect1> </refentry> - + <refentry id="function.icap-list-events"> <refnamediv> <refname>icap_list_events</refname> - <refpurpose>Return a list of events between two given datetimes</refpurpose> + + <refpurpose>Return a list of events between two given + datetimes + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -126,26 +130,29 @@ <paramdef>datetime <parameter>end_date</parameter></paramdef> </funcsynopsis> <para> - Returns an array of event ID's that are between the two given datetimes. - <para> - <function>icap_list_events</function> function takes in a beginning datetime - and an end datetime for a calendar stream. An array of event id's that are between - the given datetimes are returned. + Returns an array of event ID's that are between the two given + datetimes. + <para> + <function>icap_list_events</function> function takes in a + beginning datetime and an end datetime for a calendar stream. An + array of event id's that are between the given datetimes are + returned. + <para> + All datetime entries consist of an object that contains: - All datetime entries consist of an object that contains: - <itemizedlist> + <itemizedlist> <listitem><simpara> - int year - year + int year - year <listitem><simpara> - int month - month + int month - month <listitem><simpara> - int mday - day of month + int mday - day of month <listitem><simpara> - int hour - hour - <listitem><simpara> - int min - minutes - <listitem><simpara> - int sec - seconds + int hour - hour + <listitem><simpara> + int min - minutes + <listitem><simpara> + int sec - seconds </itemizedlist> </refsect1> </refentry> @@ -167,36 +174,40 @@ <function>icap_store_event</function> Stores an event into an ICAP calendar. an event object consists of: + <itemizedlist> - <listitem><simpara> - int public - 1 if public, 0 if private; - <listitem><simpara> - string caegory - Category string of the event. - <listitem><simpara> - string title - Title string of the event. - <listitem><simpara> - string description - Description string of the event. - <listitem><simpara> - int alarm - Number of minutes before the event to sned out an alarm. - <listitem><simpara> - datetime start - datetime object of the start of the event. - <listitem><simpara> - datetime end - datetime object of the end of the event. + <listitem><simpara> + int public - 1 if public, 0 if private; + <listitem><simpara> + string caegory - Category string of the event. + <listitem><simpara> + string title - Title string of the event. + <listitem><simpara> + string description - Description string of the event. + <listitem><simpara> + int alarm - Number of minutes before the event to sned out an alarm. + <listitem><simpara> + datetime start - datetime object of the start of the event. + <listitem><simpara> + datetime end - datetime object of the end of the event. </itemizedlist> - All datetime entries consist of an object that contains: - <itemizedlist> + + <para> + All datetime entries consist of an object that contains: + + <itemizedlist> <listitem><simpara> - int year - year + int year - year <listitem><simpara> - int month - month + int month - month <listitem><simpara> - int mday - day of month + int mday - day of month <listitem><simpara> - int hour - hour + int hour - hour <listitem><simpara> - int min - minutes + int min - minutes <listitem><simpara> - int sec - seconds + int sec - seconds </itemizedlist> <para> @@ -205,7 +216,7 @@ </refsect1> </refentry> - + <refentry id="function.icap-delete-event"> <refnamediv> <refname>icap_delete_event</refname> @@ -217,8 +228,9 @@ <funcdef>int <function>icap_delete_event</function></funcdef> <paramdef>int <parameter>uid</parameter></paramdef> </funcsynopsis> - <para> - <function>icap_delete_event</function> deletes the calendar event specified by the uid. + <para> + <function>icap_delete_event</function> deletes the calendar event + specified by the uid. <para> Returns true. </refsect1> @@ -236,7 +248,8 @@ <paramdef>int <parameter>uid</parameter></paramdef> </funcsynopsis> <para> - <function>icap_snooze</function> turns off an alarm for a calendar event specified by the uid. + <function>icap_snooze</function> turns off an alarm for a + calendar event specified by the uid. <para> Returns true. </refsect1> @@ -245,7 +258,10 @@ <refentry id="function.icap-list-alarms"> <refnamediv> <refname>icap_list_alarms</refname> - <refpurpose>Return a list of events that has an alarm triggered at the given datetime</refpurpose> + <refpurpose> + Return a list of events that has an alarm triggered at the given + datetime + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -253,29 +269,29 @@ <funcdef>array <function>icap_list_alarms</function></funcdef> <paramdef>stream <parameter>icap_stream</parameter></paramdef> <paramdef>datetime <parameter>alarm_date</parameter></paramdef> - </funcsynopsis> <para> - Returns an array of event ID's that has an alarm going off at the given datetime. - <para> - <function>icap_list_alarms</function> function takes in a datetime - for a calendar stream. An array of event id's that has an alarm should be going off - at the datetime are returned. - - All datetime entries consist of an object that contains: - <itemizedlist> + Returns an array of event ID's that has an alarm going off at the + given datetime. + <para> + <function>icap_list_alarms</function> function takes in a + datetime for a calendar stream. An array of event id's that has + an alarm should be going off at the datetime are returned. + <para> + All datetime entries consist of an object that contains: + <itemizedlist> <listitem><simpara> - int year - year + int year - year <listitem><simpara> - int month - month + int month - month <listitem><simpara> - int mday - day of month + int mday - day of month <listitem><simpara> - int hour - hour - <listitem><simpara> - int min - minutes + int hour - hour + <listitem><simpara> + int min - minutes <listitem><simpara> - int sec - seconds + int sec - seconds </itemizedlist> </refsect1> </refentry>