[Sommaire] [Imprimer]

   1  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2  <html>
   3  <head>
   4    <title>Geeklog Documentation - Calendar Plugin</title>
   5    <link rel="stylesheet" type="text/css" href="docstyle.css" title="Dev Stylesheet">
   6  </head>
   7  
   8  <body>
   9  <table>
  10  <tr>
  11    <td><a href="index.html" style="background:transparent"><img src="images/newlogo.gif" alt="Geeklog Documentation" width="243" height="90" border="0"></a></td>
  12  </tr>
  13  <tr>
  14    <td class="menu"><a href="index.html">Geeklog Documentation</a> - Calendar Plugin</td>
  15  </tr>
  16  </table>
  17  
  18  <h1>Calendar Plugin</h1>
  19  
  20  <p>Events and the calendar used to be an integral part of the Geeklog core code,
  21  but have been moved to a plugin as of Geeklog 1.4.1.</p>
  22  
  23  <h2><a name="config.php">Configuration File</a></h2>
  24  
  25  <p>The calendar plugin has its own configuration file, located at <tt>/path/to/geeklog/plugins/calendar/config.php</tt>. There you will find the following options:</p>
  26  
  27  <table>
  28  <tr><th width="25%">Variable</th>
  29      <th width="25%">Default Value</th>
  30      <th width="50%">Description</th>
  31  </tr>
  32  <tr>
  33    <td><a name="desc_calendarloginrequired">calendarloginrequired</a></td>
  34    <td>0</td>
  35    <td>When set to 1, only registered users can access the calendar<br>
  36      Please note that <code>$_CONF['<a
  37      href="config.html#desc_loginrequired">loginrequired</a>']</code> in
  38      <tt>config.php</tt> takes precedence over this setting. So when
  39      <code>'loginrequired'</code> is set to 1, anonymous users can not access
  40      the calendar even when <code>'calendarloginrequired'</code> is set
  41      to 0.</td>
  42  </tr>
  43  <tr class="r2">
  44    <td><a name="desc_delete_event">delete_event</a></td>
  45    <td>0</td>
  46    <td>Defines what to do when a user is deleted that is the owner of an event.
  47      When set to 0, all events owned by the deleted user will be assigned to a
  48      user of the "Root" group (e.g. the site admin). When set to 1, the events
  49      are deleted. This only applies to site events - a user's personal events
  50      are always deleted.</td>
  51  </tr>
  52  <tr>
  53    <td><a name="desc_eventsubmission">eventsubmission</a></td>
  54    <td>1</td>
  55    <td>Whether events submitted by users will have to be approved by an admin
  56      first (when set = 1) or show up immediately (when set = 0).</td>
  57  </tr>
  58  <tr class="r2">
  59    <td><a name="desc_event_types">event_types</a></td>
  60    <td>Anniversary, Appointment, Birthday, Business, Education, Holiday, Meeting, Miscellaneous, Personal, Phone Call, Special Occasion, Travel, Vacation</td>
  61    <td>The set of event types that are used both on the public calendar and the
  62      user's personal calendar.</td>
  63  </tr>
  64  <tr>
  65    <td><a name="desc_hidecalendarmenu">hidecalendarmenu</a></td>
  66    <td>0</td>
  67    <td>Whether to hide the "Calendar" entry from Geeklog's menu bar (when set to
  68      1) or to show it (when set to 0).</td>
  69  </tr>
  70  <tr class="r2">
  71    <td><a name="desc_hour_mode">hour_mode</a></td>
  72    <td>12</td>
  73    <td>Which format to use when submitting or editing an event. Can be 12 (for
  74      the 12 hours am/pm format) or 24 (for the 24 hours format).<br>
  75      Uses the same value as <a
  76      href="config.html#desc_hour_mode">$_CONF['hour_mode']</a> by default.</td>
  77  </tr>
  78  <tr>
  79    <td><a name="desc_notification">notification</a></td>
  80    <td>0</td>
  81    <td>Whether to send an email notification when a new event was submitted for
  82      the site's calendar (when set to = 1) or not (when set to = 0).<br>
  83      No notification is ever sent for events in personal calendars.</td>
  84  </tr>
  85  <tr class="r2">
  86    <td><a name="desc_personalcalendars">personalcalendars</a></td>
  87    <td>0</td>
  88    <td>Allow account holders to have a personal calendar</td>
  89  </tr>
  90  <tr>
  91    <td><a name="desc_showupcomingevents">showupcomingevents</a></td>
  92    <td>1</td>
  93    <td>Whether to show upcoming events (0 = no, 1 = yes) in a separate
  94      block.</td>
  95  </tr>
  96  <tr class="r2">
  97    <td><a name="desc_upcomingeventsrange">upcomingeventsrange</a></td>
  98    <td>14</td>
  99    <td>Number of days that the &quot;Upcoming Events&quot; block will look
 100      ahead.</td>
 101  </tr>
 102  </table>
 103  
 104  
 105  <h2><a name="others">Other Options</a></h2>
 106  
 107  <p>Please note that some of the options from Geeklog's main <tt>config.php</tt>
 108  are also relevant for the calendar plugin:</p>
 109  <ul>
 110  <li>Times and dates are formatted according to the current language and the
 111      <a href="config.html#locale">locale settings</a> from Geeklog's main
 112      <tt>config.php</tt>.</li>
 113  <li>The names of the <a name="states">states</a> that are listed in a drop-down
 114      box when submitting an event are taken from the <code>$_STATES</code> array
 115      at the end of Geeklog's main <tt>config.php</tt>.</li>
 116  </ul>
 117  
 118  
 119  <table class="footer">
 120  <tr>
 121    <td colspan="2"><a href="http://wiki.geeklog.net/">The Geeklog Documentation Project</a><br>
 122      All trademarks and copyrights on this page are owned by their respective owners. GeekLog is copyleft.</td>
 123  </tr>
 124  </table>
 125  
 126  </body>
 127  </html>