public_html/docs/english/calendar.html
author Dirk Haun <dirk@haun-online.de>
Sat, 07 Nov 2009 15:55:10 +0100
branchHEAD
changeset 7450 6e857a94c80e
parent 6958 0774a19f037c
child 7451 42760e758229
permissions -rw-r--r--
Fixed link to the "locale" section of config.html
     1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
     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 <p><a href="http://www.geeklog.net/" style="background:transparent"><img src="../images/newlogo.gif" alt="Geeklog" width="243" height="90"></a></p>
    10 <div class="menu"><a href="index.html">Geeklog Documentation</a> - Calendar Plugin</div>
    11 
    12 <h1>Calendar Plugin</h1>
    13 
    14 <p>Events and the calendar used to be an integral part of the Geeklog core code,
    15 but have been moved to a plugin as of Geeklog 1.4.1.</p>
    16 
    17 <h2><a name="config.php">Configuration</a></h2>
    18 
    19 <p>The calendar's configuration can be changed from the Configuration admin
    20 panel:</p>
    21 
    22 <h3><a name="general">General Calendar Settings</a></h3>
    23 
    24 <table>
    25 <tr><th style="width:25%">Variable</th>
    26     <th style="width:25%">Default Value</th>
    27     <th style="width:50%">Description</th>
    28 </tr>
    29 <tr>
    30   <td><a name="desc_calendarloginrequired">calendarloginrequired</a></td>
    31   <td>0</td>
    32   <td>When set to 1, only registered users can access the calendar<br>
    33     Please note that <code>$_CONF['<a
    34     href="config.html#desc_loginrequired">loginrequired</a>']</code> in
    35     Geeklog's main configuration takes precedence over this setting. So when
    36     <code>'loginrequired'</code> is set to 1, anonymous users can not access
    37     the calendar even when <code>'calendarloginrequired'</code> is set
    38     to 0.</td>
    39 </tr>
    40 <tr class="r2">
    41   <td><a name="desc_hidecalendarmenu">hidecalendarmenu</a></td>
    42   <td>0</td>
    43   <td>Whether to hide the "Calendar" entry from Geeklog's menu bar (when set to
    44     1) or to show it (when set to 0).</td>
    45 </tr>
    46 <tr>
    47   <td><a name="desc_personalcalendars">personalcalendars</a></td>
    48   <td>0</td>
    49   <td>Allow account holders to have a personal calendar</td>
    50 </tr>
    51 <tr class="r2">
    52   <td><a name="desc_eventsubmission">eventsubmission</a></td>
    53   <td>1</td>
    54   <td>Whether events submitted by users will have to be approved by an admin
    55     first (when set = 1) or show up immediately (when set = 0).</td>
    56 </tr>
    57 <tr>
    58   <td><a name="desc_showupcomingevents">showupcomingevents</a></td>
    59   <td>1</td>
    60   <td>Whether to show upcoming events (0 = no, 1 = yes) in a separate
    61     block.</td>
    62 </tr>
    63 <tr class="r2">
    64   <td><a name="desc_upcomingeventsrange">upcomingeventsrange</a></td>
    65   <td>14</td>
    66   <td>Number of days that the &quot;Upcoming Events&quot; block will look
    67     ahead.</td>
    68 </tr>
    69 <tr>
    70   <td><a name="desc_hour_mode">hour_mode</a></td>
    71   <td>12</td>
    72   <td>Which format to use when submitting or editing an event. Can be 12 (for
    73     the 12 hours am/pm format) or 24 (for the 24 hours format).<br>
    74     Uses the same value as <a
    75     href="config.html#desc_hour_mode">$_CONF['hour_mode']</a> by default.</td>
    76 </tr>
    77 <tr class="r2">
    78   <td><a name="desc_event_types">event_types</a></td>
    79   <td>Anniversary, Appointment, Birthday, Business, Education, Holiday, Meeting, Miscellaneous, Personal, Phone Call, Special Occasion, Travel, Vacation</td>
    80   <td>The set of event types that are used both on the public calendar and the
    81     user's personal calendar.</td>
    82 </tr>
    83 <tr>
    84   <td><a name="desc_notification">notification</a></td>
    85   <td>0</td>
    86   <td>Whether to send an email notification when a new event was submitted for
    87     the site's calendar (when set to = 1) or not (when set to = 0).<br>
    88     No notification is ever sent for events in personal calendars.</td>
    89 </tr>
    90 <tr class="r2">
    91   <td><a name="desc_delete_event">delete_event</a></td>
    92   <td>0</td>
    93   <td>Defines what to do when a user is deleted that is the owner of an event.
    94     When set to 0, all events owned by the deleted user will be assigned to a
    95     user of the "Root" group (e.g. the site admin). When set to 1, the events
    96     are deleted. This only applies to site events - a user's personal events
    97     are always deleted.</td>
    98 </tr>
    99 <tr>
   100   <td><a name="desc_aftersave">aftersave</a></td>
   101   <td>'list'</td>
   102   <td>Which page to go to after an event has been saved:
   103     <ul>
   104     <li>'item': display the event details</li>
   105     <li>'list': show admin's list of events (default)</li>
   106     <li>'plugin': display the calendar</li>
   107     <li>'home': display the site's homepage</li>
   108     <li>'admin': go to the "Admin Home" page, i.e. Command &amp; Control</li>
   109     </ul></td>
   110 </tr>
   111 </table>
   112 
   113 
   114 <h2><a name="others">Other Options</a></h2>
   115 
   116 <p>Please note that some of the options from Geeklog's main configuration
   117 are also relevant for the calendar plugin:</p>
   118 <ul>
   119 <li>Times and dates are formatted according to the current language and the
   120     <a href="config.html#languages_locale">locale settings</a> from Geeklog's
   121     main configuration.</li>
   122 </ul>
   123 
   124 
   125 <div class="footer">
   126     <a href="http://wiki.geeklog.net/">The Geeklog Documentation Project</a><br>
   127     All trademarks and copyrights on this page are owned by their respective owners. Geeklog is copyleft.
   128 </div>
   129 
   130 </body>
   131 </html>