php-doc-en/reference/mcal/reference.xml
2004-02-24 08:46:39 +00:00

100 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<reference id="ref.mcal">
<title>MCAL Functions</title>
<titleabbrev>MCAL</titleabbrev>
<partintro>
<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>
&note.pecl-php5;
<note>
<para>
PHP had an ICAP extension previously, but the original library
and the PHP extension is not supported anymore. The suggested
replacement is MCAL.
</para>
</note>
&note.no-windows.extension;
</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>
&reference.mcal.configure;
<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;
</reference>
<!-- 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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->