dams Tue Aug 7 05:10:11 2001 EDT Modified files: /phpdoc/fr/functions mcal.xml Log: Corrected typosadded Jeroen updates
Index: phpdoc/fr/functions/mcal.xml diff -u phpdoc/fr/functions/mcal.xml:1.14 phpdoc/fr/functions/mcal.xml:1.15 --- phpdoc/fr/functions/mcal.xml:1.14 Sat Jul 7 18:22:13 2001 +++ phpdoc/fr/functions/mcal.xml Tue Aug 7 05:10:11 2001 @@ -1,3 +1,4 @@ +<!-- $Revision: 1.15 $ --> <reference id="ref.mcal"> <title>MCAL</title> <titleabbrev>MCAL</titleabbrev> @@ -18,7 +19,7 @@ autre format supporté par la librairie. </para> <para> - Les événements peuvent être lus, selectionnés + Les événements peuvent être lus, sélectionnés et enregistrés. Il y a aussi la possibilité d'ajouter des alarmes, et de placer des événéments récurents. </para> @@ -29,41 +30,101 @@ </para> <para> Pour faire fonctionner cette librairie, vous devez compiler PHP avec - l'option <option role="configure">--with-mcal</option>. Il vous faudra + l'option + <link linkend="install.configure.with-mcal"><option +role="configure">--with-mcal</option></link>. + Il vous faudra alors avoir installé la librairie mcal. Téléchargez la dernière version à <ulink url="&url.mcal;">&url.mcal;</ulink> et compilez-la, - puis installez la. + puis installez-la. </para> <para> - Les constantes suivantes sont définies lorsque mcal est - utilisée : - MCAL_SUNDAY, - MCAL_MONDAY, - MCAL_TUESDAY, - MCAL_WEDNESDAY, - MCAL_THURSDAY, - MCAL_FRIDAY, - MCAL_SATURDAY, - MCAL_RECUR_NONE, - MCAL_RECUR_DAILY, - MCAL_RECUR_WEEKLY, - MCAL_RECUR_MONTHLY_MDAY, - MCAL_RECUR_MONTHLY_WDAY, - MCAL_RECUR_YEARLY, - MCAL_JANUARY, - MCAL_FEBRUARY, - MCAL_MARCH, - MCAL_APRIL, - MCAL_MAY, - MCAL_JUNE, - MCAL_JULY, - MCAL_AUGUGT, - MCAL_SEPTEMBER, - MCAL_OCTOBER, - MCAL_NOVEMBER, et - MCAL_DECEMBER. - La plus part des fonctions utilisent une structure d'événement + Les constantes suivantes sont définies avec l'extension mcal. + Pour les jours de la semaine : + <itemizedlist> + <listitem><simpara> + MCAL_SUNDAY (Dimanche) + </simpara></listitem> + <listitem><simpara> + MCAL_MONDAY (Lundi) + </simpara></listitem> + <listitem><simpara> + MCAL_TUESDAY (Mardi) + </simpara></listitem> + <listitem><simpara> + MCAL_WEDNESDAY (Mercredi) + </simpara></listitem> + <listitem><simpara> + MCAL_THURSDAY (Jeudi) + </simpara></listitem> + <listitem><simpara> + MCAL_FRIDAY (Vendredi) + </simpara></listitem> + <listitem><simpara> + MCAL_SATURDAY (Samedi) + </simpara></listitem> + </itemizedlist> + Pour les récurrences : + <itemizedlist> + <listitem><simpara> + MCAL_RECUR_NONE (Aucune) + </simpara></listitem> + <listitem><simpara> + MCAL_RECUR_DAILY (Quotidienne) + </simpara></listitem> + <listitem><simpara> + MCAL_RECUR_WEEKLY (Hebdomadaire) + </simpara></listitem> + <listitem><simpara> + MCAL_RECUR_MONTHLY_MDAY (Mensuelle, date fixe) + </simpara></listitem> + <listitem><simpara> + MCAL_RECUR_MONTHLY_WDAY (Mensuelle, jour fixe ) + </simpara></listitem> + <listitem><simpara> + MCAL_RECUR_YEARLY (Annuelle) + </simpara></listitem> + </itemizedlist> + Pour les mois : + <itemizedlist> + <listitem><simpara> + MCAL_JANUARY (Janvier) + </simpara></listitem> + <listitem><simpara> + MCAL_FEBRUARY (Février) + </simpara></listitem> + <listitem><simpara> + MCAL_MARCH (Mars) + </simpara></listitem> + <listitem><simpara> + MCAL_APRIL (Avril) + </simpara></listitem> + <listitem><simpara> + MCAL_MAY (Mai) + </simpara></listitem> + <listitem><simpara> + MCAL_JUNE (Juin) + </simpara></listitem> + <listitem><simpara> + MCAL_JULY (Juillet) + </simpara></listitem> + <listitem><simpara> + MCAL_AUGUST (Août) + </simpara></listitem> + <listitem><simpara> + MCAL_SEPTEMBER (Septembre) + </simpara></listitem> + <listitem><simpara> + MCAL_OCTOBER (Octobre) + </simpara></listitem> + <listitem><simpara> + MCAL_NOVEMBER (Novembre) + </simpara></listitem> + <listitem><simpara> + MCAL_DECEMBER (Décembre) + </simpara></listitem> + </itemizedlist> + La plupart des fonctions utilisent une structure d'événement interne, qui est unique pour chaque connexion. Cela évite d'avoir à passer des objets de grande taille entre les fonctions. Il y a des accesseurs bien pratiques pour créer, @@ -83,7 +144,7 @@ <paramdef>string <parameter>calendar</parameter></paramdef> <paramdef>string <parameter>username</parameter></paramdef> <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int <parameter>options</parameter></paramdef> + <paramdef>int <parameter><option>options</option></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -95,7 +156,7 @@ <parameter>calendar</parameter>. Si <parameter>options</parameter> est spécifié, passe aussi <parameter>options</parameter> à la boîte aux lettres (???). La structure interne du - flot MCAL est initialisée à la connnexion. + flot MCAL est initialisée à la connexion. </para> </refsect1> </refentry> @@ -112,7 +173,7 @@ <paramdef>string <parameter>calendar</parameter></paramdef> <paramdef>string <parameter>username</parameter></paramdef> <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int <parameter>options</parameter></paramdef> + <paramdef>int <parameter><option>options</option></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -139,7 +200,7 @@ <funcprototype> <funcdef>resource <function>mcal_reopen</function></funcdef> <paramdef>string <parameter>calendar</parameter></paramdef> - <paramdef>int <parameter>options</parameter></paramdef> + <paramdef>int <parameter><option>options</option></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -262,123 +323,123 @@ <itemizedlist> <listitem> <simpara> - int id - ID de l'événement. - </simpara> - </listitem> + int id - ID de l'événement. + </simpara> + </listitem> <listitem> <simpara> - int public - &true; si l'événement est public, - &false; si il est privé. - </simpara> - </listitem> + int public - &true; si l'événement est public, + &false; si il est privé. + </simpara> + </listitem> <listitem> <simpara> - string category - Catégorie de l'événement. - </simpara> - </listitem> + string category - Catégorie de l'événement. + </simpara> + </listitem> <listitem> <simpara> - string title - Titre de l'événement. - </simpara> - </listitem> + string title - Titre de l'événement. + </simpara> + </listitem> <listitem> <simpara> - string description - Description de l'événement. - </simpara> - </listitem> + string description - Description de l'événement. + </simpara> + </listitem> <listitem> <simpara> - int alarm - Nombre de minutes avant d'envoyer une alerte pour cet - événement. - </simpara> - </listitem> + int alarm - Nombre de minutes avant d'envoyer une alerte pour cet + événement. + </simpara> + </listitem> <listitem> <simpara> - object start - Objet contenant une date et une heure. - </simpara> - </listitem> + object start - Objet contenant une date et une heure. + </simpara> + </listitem> <listitem> <simpara> - object end - Objet contenant une date et une heure. - </simpara> - </listitem> + object end - Objet contenant une date et une heure. + </simpara> + </listitem> <listitem> <simpara> - int recur_type - type de récurence - </simpara> - </listitem> + int recur_type - type de récurrence + </simpara> + </listitem> <listitem> <simpara> - int recur_interval - intervalle de récurence - </simpara> - </listitem> + int recur_interval - intervalle de récurrence + </simpara> + </listitem> <listitem> <simpara> - datetime recur_endate - date de fin de récurence - </simpara> - </listitem> + datetime recur_endate - date de fin de récurrence + </simpara> + </listitem> <listitem> <simpara> - int recur_data - données de récurence - </simpara> - </listitem> + int recur_data - données de récurrence + </simpara> + </listitem> </itemizedlist> Tous les objets de date et heure sont construits comme suit : <itemizedlist> <listitem><simpara> - int year - année</simpara></listitem> + int year - année</simpara></listitem> <listitem><simpara> - int month - mois</simpara></listitem> + int month - mois</simpara></listitem> <listitem><simpara> - int mday - jour du mois</simpara></listitem> + int mday - jour du mois</simpara></listitem> <listitem><simpara> - int hour - heure</simpara></listitem> + int hour - heure</simpara></listitem> <listitem><simpara> - int min - minutes</simpara></listitem> + int min - minutes</simpara></listitem> <listitem><simpara> - int sec - secondes</simpara></listitem> + int sec - secondes</simpara></listitem> <listitem><simpara> - int alarm - nombre de minutes avant de déclencher l'alarme - </simpara> - </listitem> + int alarm - nombre de minutes avant de déclencher l'alarme + </simpara> + </listitem> </itemizedlist> Les valeurs possibles de recur_type sont : <itemizedlist> <listitem> <simpara> - 0 - Indique que l'événement ne se répète jamais - </simpara> - </listitem> + 0 - Indique que l'événement ne se répète jamais + </simpara> + </listitem> <listitem> <simpara> - 1 - Indique que l'événement se répète - tous les jours - </simpara> - </listitem> + 1 - Indique que l'événement se répète + tous les jours + </simpara> + </listitem> <listitem> <simpara> - 2 - Indique que l'événement se répète - toutes les semaines - </simpara> - </listitem> + 2 - Indique que l'événement se répète + toutes les semaines + </simpara> + </listitem> <listitem> <simpara> - 3 - Indique que l'événement se répète - tous les mois, à la même date (le 10 du mois) - </simpara> - </listitem> + 3 - Indique que l'événement se répète + tous les mois, à la même date (le 10 du mois) + </simpara> + </listitem> <listitem> <simpara> - 4 - Indique que l'événement se répète - tous les mois, un certain jours (i.e., le troisième samedi du mois) - </simpara> - </listitem> + 4 - Indique que l'événement se répète + tous les mois, un certain jours (i.e., le troisième samedi du mois) + </simpara> + </listitem> <listitem> <simpara> - 5 - Indique que l'événement se répète - tous les ans - </simpara> - </listitem> + 5 - Indique que l'événement se répète + tous les ans + </simpara> + </listitem> </itemizedlist> </para> </refsect1> @@ -495,7 +556,7 @@ <refentry id="function.mcal-snooze"> <refnamediv> <refname>mcal_snooze</refname> - <refpurpose>Eteind l'alarme d'un événement.</refpurpose> + <refpurpose>Eteint l'alarme d'un événement.</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -506,7 +567,7 @@ </funcprototype> </funcsynopsis> <para> - <function>mcal_snooze</function> éteind l'alarme de + <function>mcal_snooze</function> éteint l'alarme de l'événement identifié par l'UID <parameter>uid</parameter>. </para> @@ -642,7 +703,7 @@ <refnamediv> <refname>mcal_event_set_description</refname> <refpurpose> - Fixe la déscription de la structure globale. + Fixe la description de la structure globale. </refpurpose> </refnamediv> <refsect1> @@ -802,8 +863,8 @@ </funcsynopsis> <para> <function>mcal_event_set_class</function> fixe la classe de - la structure globale. La classe vaut 0 pour public, et 1 - pour privée. + la structure globale. La classe vaut 0 pour si elle est publique, et 1 + si elle est privée. </para> <para> <function>mcal_event_set_class</function> retourne &true;. @@ -984,7 +1045,7 @@ <refnamediv> <refname>mcal_next_recurrence</refname> <refpurpose> - Retourne la prochaine occurence d'une événement. + Retourne la prochaine occurrence d'un événement. </refpurpose> </refnamediv> <refsect1> @@ -1003,7 +1064,7 @@ la date de l'événement suivant la date. <function>mcal_next_recurrence</function> retourne un objet date vide si l'événement n'a pas de - réoccurence, ou si quelquechose est invalide. Utilisez + réoccurrence, ou si quelquechose est invalide. Utilisez <parameter>weekstart</parameter> pour déterminer le premier jour. </para> </refsect1> @@ -1012,7 +1073,7 @@ <refnamediv> <refname>mcal_event_set_recur_none</refname> <refpurpose> - Supprime la récurence de la structure globale. + Supprime la récurrence de la structure globale. </refpurpose> </refnamediv> <refsect1> @@ -1027,7 +1088,7 @@ </funcsynopsis> <para> <function>mcal_event_set_recur_none</function> supprime la - récurence de la structure globale (event->recur_type + récurrence de la structure globale (event->recur_type est mis à MCAL_RECUR_NONE). </para> </refsect1> @@ -1036,7 +1097,7 @@ <refnamediv> <refname>mcal_event_set_recur_daily</refname> <refpurpose> - Fixe la récurence quotidienne. + Fixe la récurrence quotidienne. </refpurpose> </refnamediv> <refsect1> @@ -1054,7 +1115,7 @@ </funcprototype> </funcsynopsis> <para> - <function>mcal_event_set_recur_daily</function> fixe la récurence + <function>mcal_event_set_recur_daily</function> fixe la récurrence quotidienne de la structure globale, jusqu'à la date passée en paramètre. (la date de début est celle de la structure). </para> @@ -1064,7 +1125,7 @@ <refnamediv> <refname>mcal_event_set_recur_weekly</refname> <refpurpose> - Fixe la récurence hedbomadaire. + Fixe la récurrence hebdomadaire. </refpurpose> </refnamediv> <refsect1> @@ -1084,7 +1145,7 @@ </funcsynopsis> <para> <function>mcal_event_set_recur_weekly</function> fixe la - récurence hedbomadaire de la structure globale, + récurrence hebdomadaire de la structure globale, jusqu'à la date passée en paramètre. (la date de début est celle de la structure). </para> @@ -1094,7 +1155,7 @@ <refnamediv> <refname>mcal_event_set_recur_monthly_mday</refname> <refpurpose> - Fixe la récurence. + Fixe la récurrence. </refpurpose> </refnamediv> <refsect1> @@ -1113,7 +1174,7 @@ </funcsynopsis> <para> <function>mcal_event_set_recur_monthly_mday</function> fixe la - récurence de la structure globale, jusqu'à la date + récurrence de la structure globale, jusqu'à la date passée en paramètre. (la date de début est celle de la structure). </para> @@ -1123,7 +1184,7 @@ <refnamediv> <refname>mcal_event_set_recur_monthly_wday</refname> <refpurpose> - fixe la récurence mensuelle. + Fixe la récurrence mensuelle. </refpurpose> </refnamediv> <refsect1> @@ -1142,7 +1203,7 @@ </funcsynopsis> <para> <function>mcal_event_set_recur_monthly_wday</function> fixe la - récurence mensuelle de la structure globale, jusqu'à + récurrence mensuelle de la structure globale, jusqu'à la date passée en paramètre. (la date de début est celle de la structure). </para> @@ -1152,7 +1213,7 @@ <refnamediv> <refname>mcal_event_set_recur_yearly</refname> <refpurpose> - fixe la récurence annuelle. + Fixe la récurrence annuelle. </refpurpose> </refnamediv> <refsect1> @@ -1171,7 +1232,7 @@ </funcsynopsis> <para> <function>mcal_event_set_recur_yearly</function> fixe la - récurence annuelle de la structure globale, + récurrence annuelle de la structure globale, jusqu'à la date passée en paramètre. (la date de début est celle de la structure). </para> @@ -1201,121 +1262,121 @@ <itemizedlist> <listitem> <simpara> - int id - ID de l'événement. - </simpara> - </listitem> + int id - ID de l'événement. + </simpara> + </listitem> <listitem> <simpara> - int public - &true; si l'événement est public, - &false; si il est privé. - </simpara> - </listitem> + int public - &true; si l'événement est public, + &false; si il est privé. + </simpara> + </listitem> <listitem> <simpara> - string category - Catégorie de l'événement. - </simpara> - </listitem> + string category - Catégorie de l'événement. + </simpara> + </listitem> <listitem> <simpara> - string title - Titre de l'événement. - </simpara> - </listitem> + string title - Titre de l'événement. + </simpara> + </listitem> <listitem> <simpara> - string description - Description de l'événement. - </simpara> - </listitem> + string description - Description de l'événement. + </simpara> + </listitem> <listitem> <simpara> - int alarm - Nombre de minutes avant d'envoyer une alerte pour cet - événement. - </simpara> - </listitem> + int alarm - Nombre de minutes avant d'envoyer une alerte pour cet + événement. + </simpara> + </listitem> <listitem> <simpara> - object start - Objet contenant une date et une heure. - </simpara> - </listitem> + object start - Objet contenant une date et une heure. + </simpara> + </listitem> <listitem> <simpara> - object end - Objet contenant une date et une heure. - </simpara> - </listitem> + object end - Objet contenant une date et une heure. + </simpara> + </listitem> <listitem> <simpara> - int recur_type - type de récurence - </simpara> - </listitem> + int recur_type - type de récurrence + </simpara> + </listitem> <listitem> <simpara> - int recur_interval - intervalle de récurence - </simpara> - </listitem> + int recur_interval - intervalle de récurrence + </simpara> + </listitem> <listitem> <simpara> - datetime recur_endate - date de fin de récurence - </simpara> - </listitem> + datetime recur_endate - date de fin de récurrence + </simpara> + </listitem> <listitem> <simpara> - int recur_data - données de récurence - </simpara> - </listitem> + int recur_data - données de récurrence + </simpara> + </listitem> </itemizedlist> Tous les objets de date et heure sont construits comme suit : <itemizedlist> <listitem><simpara> - int year - année</simpara></listitem> + int year - année</simpara></listitem> <listitem><simpara> - int month - mois</simpara></listitem> + int month - mois</simpara></listitem> <listitem><simpara> - int mday - jour du mois</simpara></listitem> + int mday - jour du mois</simpara></listitem> <listitem><simpara> - int hour - heure</simpara></listitem> + int hour - heure</simpara></listitem> <listitem><simpara> - int min - minutes</simpara></listitem> + int min - minutes</simpara></listitem> <listitem><simpara> - int sec - secondes</simpara></listitem> + int sec - secondes</simpara></listitem> <listitem><simpara> - int alarm - nombre de minutes avant de déclencher l'alarme</simpara></listitem> + int alarm - nombre de minutes avant de déclencher +l'alarme</simpara></listitem> </itemizedlist> Les valeurs possibles de recur_type sont : <itemizedlist> <listitem> <simpara> - 0 - Indique que l'événement ne se répète jamais - </simpara> - </listitem> + 0 - Indique que l'événement ne se répète jamais + </simpara> + </listitem> <listitem> <simpara> - 1 - Indique que l'événement se répète - tous les jours - </simpara> - </listitem> + 1 - Indique que l'événement se répète + tous les jours + </simpara> + </listitem> <listitem> <simpara> - 2 - Indique que l'événement se répète - toutes les semaines - </simpara> - </listitem> + 2 - Indique que l'événement se répète + toutes les semaines + </simpara> + </listitem> <listitem> <simpara> - 3 - Indique que l'événement se répète - tous les mois, à la même date (le 10 du mois) - </simpara> - </listitem> + 3 - Indique que l'événement se répète + tous les mois, à la même date (le 10 du mois) + </simpara> + </listitem> <listitem> <simpara> - 4 - Indique que l'événement se répète - tous les mois, un certain jours (i.e., le troisième samedi du mois) - </simpara> - </listitem> + 4 - Indique que l'événement se répète + tous les mois, un certain jours (i.e., le troisième samedi du mois) + </simpara> + </listitem> <listitem> <simpara> - 5 - Indique que l'événement se répète - tous les ans - </simpara> - </listitem> + 5 - Indique que l'événement se répète + tous les ans + </simpara> + </listitem> </itemizedlist> </para> </refsect1>