goba Mon Jul 22 13:01:33 2002 EDT
Added files:
/phpdoc/en/reference/mcal constants.xml
Modified files:
/phpdoc/en/reference/mcal reference.xml
Log:
Adding constants here, applying new structure
Index: phpdoc/en/reference/mcal/reference.xml
diff -u phpdoc/en/reference/mcal/reference.xml:1.3
phpdoc/en/reference/mcal/reference.xml:1.4
--- phpdoc/en/reference/mcal/reference.xml:1.3 Thu Apr 18 06:01:01 2002
+++ phpdoc/en/reference/mcal/reference.xml Mon Jul 22 13:01:32 2002
@@ -1,132 +1,75 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<reference id="ref.mcal">
<title>MCAL functions</title>
<titleabbrev>MCAL</titleabbrev>
<partintro>
- <para>
- MCAL stands for Modular Calendar Access Library.
- </para>
- <para>
- Libmcal is a C library for accessing calendars. It's written to be
- very modular, with pluggable drivers. MCAL is the calendar
- equivalent of the IMAP module for mailboxes.
- </para>
- <para>
- With mcal support, a calendar stream can be opened much like the
- mailbox stream with the IMAP support. Calendars can be local file
- stores, remote ICAP servers, or other formats that are supported
- by the mcal library.
- </para>
- <para>
- Calendar events can be pulled up, queried, and stored. There is
- also support for calendar triggers (alarms) and recurring events.
- </para>
- <para>
- With libmcal, central calendar servers can be accessed,
- removing the need for any specific database or local file
- programming.
- </para>
- <para>
- To get these functions to work, you have to compile PHP with
- <option role="configure">--with-mcal</option>. That requires the
- mcal library to be installed. Grab the latest version from
- <ulink url="&url.mcal;">&url.mcal;</ulink> and compile and install
- it.
- </para>
- <para>
- The following constants are defined when using the MCAL module.
- For weekdays :
- <itemizedlist>
- <listitem><simpara>
- MCAL_SUNDAY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_MONDAY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_TUESDAY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_WEDNESDAY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_THURSDAY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_FRIDAY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_SATURDAY
- </simpara></listitem>
- </itemizedlist>
- For recurrence :
- <itemizedlist>
- <listitem><simpara>
- MCAL_RECUR_NONE
- </simpara></listitem>
- <listitem><simpara>
- MCAL_RECUR_DAILY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_RECUR_WEEKLY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_RECUR_MONTHLY_MDAY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_RECUR_MONTHLY_WDAY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_RECUR_YEARLY
- </simpara></listitem>
- </itemizedlist>
- For months :
- <itemizedlist>
- <listitem><simpara>
- MCAL_JANUARY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_FEBRUARY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_MARCH
- </simpara></listitem>
- <listitem><simpara>
- MCAL_APRIL
- </simpara></listitem>
- <listitem><simpara>
- MCAL_MAY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_JUNE
- </simpara></listitem>
- <listitem><simpara>
- MCAL_JULY
- </simpara></listitem>
- <listitem><simpara>
- MCAL_AUGUST
- </simpara></listitem>
- <listitem><simpara>
- MCAL_SEPTEMBER
- </simpara></listitem>
- <listitem><simpara>
- MCAL_OCTOBER
- </simpara></listitem>
- <listitem><simpara>
- MCAL_NOVEMBER
- </simpara></listitem>
- <listitem><simpara>
- MCAL_DECEMBER
- </simpara></listitem>
- </itemizedlist>
- Most of the functions use an internal event structure that is
- unique for each stream. This alleviates the need to pass around
- large objects between functions. There are convenience functions
- for setting, initializing, and retrieving the event structure
- values.
- </para>
+
+ <section id="mcal.intro">
+ &reftitle.intro;
+ <para>
+ MCAL stands for Modular Calendar Access Library.
+ </para>
+ <para>
+ Libmcal is a C library for accessing calendars. It's written to be
+ very modular, with pluggable drivers. MCAL is the calendar
+ equivalent of the IMAP module for mailboxes.
+ </para>
+ <para>
+ With mcal support, a calendar stream can be opened much like the
+ mailbox stream with the IMAP support. Calendars can be local file
+ stores, remote ICAP servers, or other formats that are supported
+ by the mcal library.
+ </para>
+ <para>
+ Calendar events can be pulled up, queried, and stored. There is
+ also support for calendar triggers (alarms) and recurring events.
+ </para>
+ <para>
+ With libmcal, central calendar servers can be accessed,
+ removing the need for any specific database or local file
+ programming.
+ </para>
+ <para>
+ Most of the functions use an internal event structure that is
+ unique for each stream. This alleviates the need to pass around
+ large objects between functions. There are convenience functions
+ for setting, initializing, and retrieving the event structure
+ values.
+ </para>
+ </section>
+
+ <section id="mcal.requirements">
+ &reftitle.required;
+ <para>
+ This extension requires the mcal library to be installed. Grab the
+ latest version from <ulink url="&url.mcal;">&url.mcal;</ulink>
+ and compile and install it.
+ </para>
+ </section>
+
+ <section id="mcal.installation">
+ &reftitle.install;
+ <para>
+ After you installed the mcal library, to get these functions to
+ work, you have to compile PHP with
+ <option role="configure">--with-mcal</option>.
+ </para>
+ </section>
+
+ <section id="mcal.configuration">
+ &reftitle.runtime;
+ &no.config;
+ </section>
+
+ <section id="mcal.resources">
+ &reftitle.resources;
+ &no.resource;
+ </section>
+
+ &reference.mcal.constants;
+
</partintro>
&reference.mcal.functions;
Index: phpdoc/en/reference/mcal/constants.xml
+++ phpdoc/en/reference/mcal/constants.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="mcal.constants">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>MCAL_SUNDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_MONDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_TUESDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_WEDNESDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_THURSDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_FRIDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_SATURDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_JANUARY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_FEBRUARY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_MARCH</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_APRIL</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_MAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_JUNE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_JULY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_AUGUST</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_SEPTEMBER</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_OCTOBER</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_NOVEMBER</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_DECEMBER</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_RECUR_NONE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_RECUR_DAILY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_RECUR_WEEKLY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_RECUR_MONTHLY_MDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_RECUR_MONTHLY_WDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_RECUR_YEARLY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_SUNDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_MONDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_TUESDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_WEDNESDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_THURSDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_FRIDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_SATURDAY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_WEEKDAYS</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_WEEKEND</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MCAL_M_ALLDAYS</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
